diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 3dd38df33..7eb386101 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -1,5 +1,7 @@ __webpack_public_path__ = "/docs/"; +const resolveGlob = require('resolve-glob'); + module.exports = { title: "vcluster docs | Virtual Clusters for Kubernetes", tagline: "Virtual Clusters for Kubernetes", @@ -77,11 +79,15 @@ module.exports = { editUrl: "https://github.com/loft-sh/vcluster/edit/main/docs/", }, theme: { - customCss: require.resolve("./src/css/custom.css"), + // customCss: require.resolve("./src/css/custom.css"), + customCss: resolveGlob.sync(['./src/css/**/*.scss']) }, }, ], ], + plugins: [ + 'docusaurus-plugin-sass', + ], scripts: [ { src: "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js", diff --git a/docs/package.json b/docs/package.json index 73a15330a..86e3e586c 100644 --- a/docs/package.json +++ b/docs/package.json @@ -13,9 +13,12 @@ "@docusaurus/preset-classic": "^2.4.1", "classnames": "^2.2.6", "docusaurus-gtm-plugin": "^0.0.2", + "docusaurus-plugin-sass": "^0.2.5", "mdx-link-checker": "^0.1.1", "react": "^16.8.4", - "react-dom": "^16.8.4" + "react-dom": "^16.8.4", + "resolve-glob": "^1.0.0", + "sass": "^1.71.1" }, "browserslist": { "production": [ diff --git a/docs/pages/configuration/_partials/access.mdx b/docs/pages/configuration/_partials/access.mdx new file mode 100755 index 000000000..818af2903 --- /dev/null +++ b/docs/pages/configuration/_partials/access.mdx @@ -0,0 +1,17 @@ + +import PartialAccessreference from "./access_reference.mdx" + + +
+ + +## `access` required {#access} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit.mdx b/docs/pages/configuration/_partials/access/audit.mdx new file mode 100755 index 000000000..9b04f8d3c --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit.mdx @@ -0,0 +1,17 @@ + +import PartialAuditreference from "./audit_reference.mdx" + + +
+ + +### `audit` required {#access-audit} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/enabled.mdx b/docs/pages/configuration/_partials/access/audit/enabled.mdx new file mode 100755 index 000000000..923379cda --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#access-audit-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/level.mdx b/docs/pages/configuration/_partials/access/audit/level.mdx new file mode 100755 index 000000000..e0f668391 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/level.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `level` required integer {#access-audit-level} + +TODO validate log levels + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy.mdx b/docs/pages/configuration/_partials/access/audit/policy.mdx new file mode 100755 index 000000000..28dbce563 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy.mdx @@ -0,0 +1,17 @@ + +import PartialPolicyreference from "./policy_reference.mdx" + + +
+ + +#### `policy` required {#access-audit-policy} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy/rules.mdx b/docs/pages/configuration/_partials/access/audit/policy/rules.mdx new file mode 100755 index 000000000..183ab1f57 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy/rules.mdx @@ -0,0 +1,17 @@ + +import PartialRulesreference from "./rules_reference.mdx" + + +
+ + +##### `rules` required object[] {#access-audit-policy-rules} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy/rules/apiGroups.mdx b/docs/pages/configuration/_partials/access/audit/policy/rules/apiGroups.mdx new file mode 100755 index 000000000..2cb474c04 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy/rules/apiGroups.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `apiGroups` required string[] {#access-audit-policy-rules-apiGroups} + +APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of +the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups. + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy/rules/nonResourceURLs.mdx b/docs/pages/configuration/_partials/access/audit/policy/rules/nonResourceURLs.mdx new file mode 100755 index 000000000..cd7855df7 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy/rules/nonResourceURLs.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `nonResourceURLs` required string[] {#access-audit-policy-rules-nonResourceURLs} + +NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path +Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. +Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy/rules/resourceNames.mdx b/docs/pages/configuration/_partials/access/audit/policy/rules/resourceNames.mdx new file mode 100755 index 000000000..fd9d40df8 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy/rules/resourceNames.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `resourceNames` required string[] {#access-audit-policy-rules-resourceNames} + +ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy/rules/resources.mdx b/docs/pages/configuration/_partials/access/audit/policy/rules/resources.mdx new file mode 100755 index 000000000..6baf9b447 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy/rules/resources.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `resources` required string[] {#access-audit-policy-rules-resources} + +Resources is a list of resources this rule applies to. '*' represents all resources. + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy/rules/verbs.mdx b/docs/pages/configuration/_partials/access/audit/policy/rules/verbs.mdx new file mode 100755 index 000000000..fa8781661 --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy/rules/verbs.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `verbs` required string[] {#access-audit-policy-rules-verbs} + +Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs. + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit/policy/rules_reference.mdx b/docs/pages/configuration/_partials/access/audit/policy/rules_reference.mdx new file mode 100755 index 000000000..86272421d --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy/rules_reference.mdx @@ -0,0 +1,20 @@ + +import PartialVerbs from "./rules/verbs.mdx" +import PartialApigroups from "./rules/apiGroups.mdx" +import PartialResources from "./rules/resources.mdx" +import PartialResourcenames from "./rules/resourceNames.mdx" +import PartialNonresourceurls from "./rules/nonResourceURLs.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/access/audit/policy_reference.mdx b/docs/pages/configuration/_partials/access/audit/policy_reference.mdx new file mode 100755 index 000000000..f244aa1ba --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit/policy_reference.mdx @@ -0,0 +1,17 @@ + +import PartialRulesreference from "./policy/rules_reference.mdx" + + +
+ + +##### `rules` required object[] {#access-audit-policy-rules} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/access/audit_reference.mdx b/docs/pages/configuration/_partials/access/audit_reference.mdx new file mode 100755 index 000000000..c72a1cdfc --- /dev/null +++ b/docs/pages/configuration/_partials/access/audit_reference.mdx @@ -0,0 +1,25 @@ + +import PartialEnabled from "./audit/enabled.mdx" +import PartialLevel from "./audit/level.mdx" +import PartialPolicyreference from "./audit/policy_reference.mdx" + + + + + + + + +
+ + +#### `policy` required {#access-audit-policy} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/access_reference.mdx b/docs/pages/configuration/_partials/access_reference.mdx new file mode 100755 index 000000000..e8debe238 --- /dev/null +++ b/docs/pages/configuration/_partials/access_reference.mdx @@ -0,0 +1,17 @@ + +import PartialAuditreference from "./access/audit_reference.mdx" + + +
+ + +### `audit` required {#access-audit} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane.mdx b/docs/pages/configuration/_partials/controlPlane.mdx new file mode 100755 index 000000000..c4ff21ca2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane.mdx @@ -0,0 +1,17 @@ + +import PartialControlplanereference from "./controlPlane_reference.mdx" + + +
+ + +## `controlPlane` required {#controlPlane} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced.mdx b/docs/pages/configuration/_partials/controlPlane/advanced.mdx new file mode 100755 index 000000000..5f1519885 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced.mdx @@ -0,0 +1,17 @@ + +import PartialAdvancedreference from "./advanced_reference.mdx" + + +
+ + +### `advanced` required {#controlPlane-advanced} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/defaultImageRegistry.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/defaultImageRegistry.mdx new file mode 100755 index 000000000..b98363bbb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/defaultImageRegistry.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `defaultImageRegistry` required string {#controlPlane-advanced-defaultImageRegistry} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/headless.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/headless.mdx new file mode 100755 index 000000000..a2d44f71c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/headless.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `headless` required boolean false {#controlPlane-advanced-headless} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata.mdx new file mode 100755 index 000000000..6a03531a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata.mdx @@ -0,0 +1,17 @@ + +import PartialMetadatareference from "./metadata_reference.mdx" + + +
+ + +#### `metadata` required {#controlPlane-advanced-metadata} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources.mdx new file mode 100755 index 000000000..b9d10f0c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources.mdx @@ -0,0 +1,17 @@ + +import PartialAllresourcesreference from "./allResources_reference.mdx" + + +
+ + +##### `allResources` required {#controlPlane-advanced-metadata-allResources} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources/annotations.mdx new file mode 100755 index 000000000..99981a6c0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `annotations` required object {#controlPlane-advanced-metadata-allResources-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources/labels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources/labels.mdx new file mode 100755 index 000000000..b0003e9e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `labels` required object {#controlPlane-advanced-metadata-allResources-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources_reference.mdx new file mode 100755 index 000000000..cf483fb21 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources_reference.mdx @@ -0,0 +1,8 @@ + +import PartialLabels from "./allResources/labels.mdx" +import PartialAnnotations from "./allResources/annotations.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods.mdx new file mode 100755 index 000000000..a381ffb54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods.mdx @@ -0,0 +1,17 @@ + +import PartialPodsreference from "./pods_reference.mdx" + + +
+ + +##### `pods` required {#controlPlane-advanced-metadata-pods} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods/annotations.mdx new file mode 100755 index 000000000..7040dc20b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `annotations` required object {#controlPlane-advanced-metadata-pods-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods/labels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods/labels.mdx new file mode 100755 index 000000000..85f97bb97 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `labels` required object {#controlPlane-advanced-metadata-pods-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods_reference.mdx new file mode 100755 index 000000000..79d303509 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/pods_reference.mdx @@ -0,0 +1,8 @@ + +import PartialLabels from "./pods/labels.mdx" +import PartialAnnotations from "./pods/annotations.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet.mdx new file mode 100755 index 000000000..889af1e37 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet.mdx @@ -0,0 +1,17 @@ + +import PartialStatefulsetreference from "./statefulSet_reference.mdx" + + +
+ + +##### `statefulSet` required {#controlPlane-advanced-metadata-statefulSet} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet/annotations.mdx new file mode 100755 index 000000000..76a92b6dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `annotations` required object {#controlPlane-advanced-metadata-statefulSet-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet/labels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet/labels.mdx new file mode 100755 index 000000000..40b56c165 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `labels` required object {#controlPlane-advanced-metadata-statefulSet-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet_reference.mdx new file mode 100755 index 000000000..33511ab86 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata/statefulSet_reference.mdx @@ -0,0 +1,8 @@ + +import PartialLabels from "./statefulSet/labels.mdx" +import PartialAnnotations from "./statefulSet/annotations.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/metadata_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/metadata_reference.mdx new file mode 100755 index 000000000..5b37c4bce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/metadata_reference.mdx @@ -0,0 +1,51 @@ + +import PartialStatefulsetreference from "./metadata/statefulSet_reference.mdx" +import PartialPodsreference from "./metadata/pods_reference.mdx" +import PartialAllresourcesreference from "./metadata/allResources_reference.mdx" + + +
+ + +##### `statefulSet` required {#controlPlane-advanced-metadata-statefulSet} + + + + + + + + +
+ + + +
+ + +##### `pods` required {#controlPlane-advanced-metadata-pods} + + + + + + + + +
+ + + +
+ + +##### `allResources` required {#controlPlane-advanced-metadata-allResources} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence.mdx new file mode 100755 index 000000000..3ae01396b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence.mdx @@ -0,0 +1,17 @@ + +import PartialPersistencereference from "./persistence_reference.mdx" + + +
+ + +#### `persistence` required {#controlPlane-advanced-persistence} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts.mdx new file mode 100755 index 000000000..695812401 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts.mdx @@ -0,0 +1,17 @@ + +import PartialAddvolumemountsreference from "./addVolumeMounts_reference.mdx" + + +
+ + +##### `addVolumeMounts` required object[] {#controlPlane-advanced-persistence-addVolumeMounts} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/mountPath.mdx new file mode 100755 index 000000000..653810a5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `mountPath` required string {#controlPlane-advanced-persistence-addVolumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..6923fdbb4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `mountPropagation` required string {#controlPlane-advanced-persistence-addVolumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/name.mdx new file mode 100755 index 000000000..a362de697 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-advanced-persistence-addVolumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/readOnly.mdx new file mode 100755 index 000000000..225819d6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `readOnly` required boolean false {#controlPlane-advanced-persistence-addVolumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/subPath.mdx new file mode 100755 index 000000000..76560bf6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `subPath` required string {#controlPlane-advanced-persistence-addVolumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..8377e7ed6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `subPathExpr` required string {#controlPlane-advanced-persistence-addVolumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts_reference.mdx new file mode 100755 index 000000000..458ae552f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/addVolumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./addVolumeMounts/name.mdx" +import PartialReadonly from "./addVolumeMounts/readOnly.mdx" +import PartialMountpath from "./addVolumeMounts/mountPath.mdx" +import PartialSubpath from "./addVolumeMounts/subPath.mdx" +import PartialMountpropagation from "./addVolumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./addVolumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/enabled.mdx new file mode 100755 index 000000000..5465e9d19 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#controlPlane-advanced-persistence-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts.mdx new file mode 100755 index 000000000..5acea82c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts.mdx @@ -0,0 +1,17 @@ + +import PartialOverwritevolumemountsreference from "./overwriteVolumeMounts_reference.mdx" + + +
+ + +##### `overwriteVolumeMounts` required object[] {#controlPlane-advanced-persistence-overwriteVolumeMounts} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/mountPath.mdx new file mode 100755 index 000000000..0c5ee89c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `mountPath` required string {#controlPlane-advanced-persistence-overwriteVolumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..0b9bdc96b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `mountPropagation` required string {#controlPlane-advanced-persistence-overwriteVolumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/name.mdx new file mode 100755 index 000000000..50fae9d79 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-advanced-persistence-overwriteVolumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/readOnly.mdx new file mode 100755 index 000000000..edc6c44c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `readOnly` required boolean false {#controlPlane-advanced-persistence-overwriteVolumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/subPath.mdx new file mode 100755 index 000000000..41cfa422e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `subPath` required string {#controlPlane-advanced-persistence-overwriteVolumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..f806b25fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `subPathExpr` required string {#controlPlane-advanced-persistence-overwriteVolumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts_reference.mdx new file mode 100755 index 000000000..c84e62c5c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/overwriteVolumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./overwriteVolumeMounts/name.mdx" +import PartialReadonly from "./overwriteVolumeMounts/readOnly.mdx" +import PartialMountpath from "./overwriteVolumeMounts/mountPath.mdx" +import PartialSubpath from "./overwriteVolumeMounts/subPath.mdx" +import PartialMountpropagation from "./overwriteVolumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./overwriteVolumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/retentionPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/retentionPolicy.mdx new file mode 100755 index 000000000..4b3c1f973 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/retentionPolicy.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `retentionPolicy` required string {#controlPlane-advanced-persistence-retentionPolicy} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size.mdx new file mode 100755 index 000000000..bd011025d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size.mdx @@ -0,0 +1,17 @@ + +import PartialSizereference from "./size_reference.mdx" + + +
+ + +##### `size` required {#controlPlane-advanced-persistence-size} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size/Format.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size/Format.mdx new file mode 100755 index 000000000..7523ef9f8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `Format` required string {#controlPlane-advanced-persistence-size-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size_reference.mdx new file mode 100755 index 000000000..18e25dcb9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/size_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./size/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence/storageClass.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/storageClass.mdx new file mode 100755 index 000000000..4db04a5ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence/storageClass.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `storageClass` required string {#controlPlane-advanced-persistence-storageClass} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/persistence_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/persistence_reference.mdx new file mode 100755 index 000000000..f4cb4c604 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/persistence_reference.mdx @@ -0,0 +1,63 @@ + +import PartialEnabled from "./persistence/enabled.mdx" +import PartialRetentionpolicy from "./persistence/retentionPolicy.mdx" +import PartialSizereference from "./persistence/size_reference.mdx" +import PartialStorageclass from "./persistence/storageClass.mdx" +import PartialAddvolumemountsreference from "./persistence/addVolumeMounts_reference.mdx" +import PartialOverwritevolumemountsreference from "./persistence/overwriteVolumeMounts_reference.mdx" + + + + + + + + +
+ + +##### `size` required {#controlPlane-advanced-persistence-size} + + + + + + + + +
+ + + + + + +
+ + +##### `addVolumeMounts` required object[] {#controlPlane-advanced-persistence-addVolumeMounts} + + + + + + + + +
+ + + +
+ + +##### `overwriteVolumeMounts` required object[] {#controlPlane-advanced-persistence-overwriteVolumeMounts} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes.mdx new file mode 100755 index 000000000..07568759b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes.mdx @@ -0,0 +1,17 @@ + +import PartialProbesreference from "./probes_reference.mdx" + + +
+ + +#### `probes` required {#controlPlane-advanced-probes} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe.mdx new file mode 100755 index 000000000..6b3b892b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe.mdx @@ -0,0 +1,17 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +##### `livenessProbe` required {#controlPlane-advanced-probes-livenessProbe} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe/enabled.mdx new file mode 100755 index 000000000..f9d0810d1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `enabled` required boolean false {#controlPlane-advanced-probes-livenessProbe-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe_reference.mdx new file mode 100755 index 000000000..16326b634 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes/livenessProbe_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./livenessProbe/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe.mdx new file mode 100755 index 000000000..5e7809b7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe.mdx @@ -0,0 +1,17 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +##### `readinessProbe` required {#controlPlane-advanced-probes-readinessProbe} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe/enabled.mdx new file mode 100755 index 000000000..9c9cae89f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `enabled` required boolean false {#controlPlane-advanced-probes-readinessProbe-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe_reference.mdx new file mode 100755 index 000000000..4e453dc59 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes/readinessProbe_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./readinessProbe/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/probes_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/probes_reference.mdx new file mode 100755 index 000000000..aa78d156d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/probes_reference.mdx @@ -0,0 +1,34 @@ + +import PartialLivenessprobereference from "./probes/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./probes/readinessProbe_reference.mdx" + + +
+ + +##### `livenessProbe` required {#controlPlane-advanced-probes-livenessProbe} + + + + + + + + +
+ + + +
+ + +##### `readinessProbe` required {#controlPlane-advanced-probes-readinessProbe} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling.mdx new file mode 100755 index 000000000..d5ba0e597 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling.mdx @@ -0,0 +1,17 @@ + +import PartialSchedulingreference from "./scheduling_reference.mdx" + + +
+ + +#### `scheduling` required {#controlPlane-advanced-scheduling} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity.mdx new file mode 100755 index 000000000..0d26ec5e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity.mdx @@ -0,0 +1,17 @@ + +import PartialAffinityreference from "./affinity_reference.mdx" + + +
+ + +##### `affinity` required {#controlPlane-advanced-scheduling-affinity} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity.mdx new file mode 100755 index 000000000..1488805dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity.mdx @@ -0,0 +1,17 @@ + +import PartialNodeaffinityreference from "./nodeAffinity_reference.mdx" + + +
+ + +###### `nodeAffinity` required {#controlPlane-advanced-scheduling-affinity-nodeAffinity} + +Describes node affinity scheduling rules for the pod. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..99b4a5f41 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,25 @@ + +import PartialPreferredduringschedulingignoredduringexecutionreference from "./preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node matches the corresponding matchExpressions; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference.mdx new file mode 100755 index 000000000..404e18012 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference.mdx @@ -0,0 +1,17 @@ + +import PartialPreferencereference from "./preference_reference.mdx" + + +
+ + +######## `preference` required {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference} + +A node selector term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions.mdx new file mode 100755 index 000000000..725638444 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/key.mdx new file mode 100755 index 000000000..d57e814ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/operator.mdx new file mode 100755 index 000000000..d2c40ed9a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/values.mdx new file mode 100755 index 000000000..6a1a906e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/values.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields.mdx new file mode 100755 index 000000000..708402a03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields.mdx @@ -0,0 +1,17 @@ + +import PartialMatchfieldsreference from "./matchFields_reference.mdx" + + +
+ + +######### `matchFields` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/key.mdx new file mode 100755 index 000000000..8afbc2219 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/operator.mdx new file mode 100755 index 000000000..4b3a63930 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/values.mdx new file mode 100755 index 000000000..a0b28361c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/values.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields_reference.mdx new file mode 100755 index 000000000..c2de56c6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchFields/key.mdx" +import PartialOperator from "./matchFields/operator.mdx" +import PartialValues from "./matchFields/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx new file mode 100755 index 000000000..4a02c2b57 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx @@ -0,0 +1,34 @@ + +import PartialMatchexpressionsreference from "./preference/matchExpressions_reference.mdx" +import PartialMatchfieldsreference from "./preference/matchFields_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
+ + + +
+ + +######### `matchFields` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx new file mode 100755 index 000000000..4c5040cae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `weight` required integer {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-weight} + +Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..0cd04a590 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,21 @@ + +import PartialWeight from "./preferredDuringSchedulingIgnoredDuringExecution/weight.mdx" +import PartialPreferencereference from "./preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx" + + + + + +
+ + +######## `preference` required {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference} + +A node selector term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..ede80330f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,21 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `requiredDuringSchedulingIgnoredDuringExecution` required {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to an update), the system +may or may not try to eventually evict the pod from its node. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms.mdx new file mode 100755 index 000000000..f147bd6a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms.mdx @@ -0,0 +1,17 @@ + +import PartialNodeselectortermsreference from "./nodeSelectorTerms_reference.mdx" + + +
+ + +######## `nodeSelectorTerms` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms} + +Required. A list of node selector terms. The terms are ORed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions.mdx new file mode 100755 index 000000000..a4e5c49ea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/key.mdx new file mode 100755 index 000000000..4e37ca9a7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/operator.mdx new file mode 100755 index 000000000..dcf69c201 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/values.mdx new file mode 100755 index 000000000..f5f017842 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/values.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields.mdx new file mode 100755 index 000000000..8abbf4dc6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields.mdx @@ -0,0 +1,17 @@ + +import PartialMatchfieldsreference from "./matchFields_reference.mdx" + + +
+ + +######### `matchFields` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/key.mdx new file mode 100755 index 000000000..1c48be043 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/operator.mdx new file mode 100755 index 000000000..31016b3b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/values.mdx new file mode 100755 index 000000000..688c00b69 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/values.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields_reference.mdx new file mode 100755 index 000000000..c2de56c6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchFields/key.mdx" +import PartialOperator from "./matchFields/operator.mdx" +import PartialValues from "./matchFields/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx new file mode 100755 index 000000000..3d96aad50 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx @@ -0,0 +1,34 @@ + +import PartialMatchexpressionsreference from "./nodeSelectorTerms/matchExpressions_reference.mdx" +import PartialMatchfieldsreference from "./nodeSelectorTerms/matchFields_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
+ + + +
+ + +######### `matchFields` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..63f711935 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,17 @@ + +import PartialNodeselectortermsreference from "./requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx" + + +
+ + +######## `nodeSelectorTerms` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms} + +Required. A list of node selector terms. The terms are ORed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity_reference.mdx new file mode 100755 index 000000000..63c0931c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/nodeAffinity_reference.mdx @@ -0,0 +1,46 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" +import PartialPreferredduringschedulingignoredduringexecutionreference from "./nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `requiredDuringSchedulingIgnoredDuringExecution` required {#controlPlane-advanced-scheduling-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to an update), the system +may or may not try to eventually evict the pod from its node. + + + + + + +
+ + + +
+ + +####### `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node matches the corresponding matchExpressions; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity.mdx new file mode 100755 index 000000000..b90b73f3d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity.mdx @@ -0,0 +1,17 @@ + +import PartialPodaffinityreference from "./podAffinity_reference.mdx" + + +
+ + +###### `podAffinity` required {#controlPlane-advanced-scheduling-affinity-podAffinity} + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..0db3b972c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,25 @@ + +import PartialPreferredduringschedulingignoredduringexecutionreference from "./preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx new file mode 100755 index 000000000..051c334bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx @@ -0,0 +1,17 @@ + +import PartialPodaffinitytermreference from "./podAffinityTerm_reference.mdx" + + +
+ + +######## `podAffinityTerm` required {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx new file mode 100755 index 000000000..5a39f5b1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +######### `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..d0e56c9cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..e70beb733 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `key` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..3e99006b4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `operator` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..7fa3c647e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..11a80a414 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx new file mode 100755 index 000000000..dbd79eb97 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx new file mode 100755 index 000000000..7a7abdaa7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######### `matchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx new file mode 100755 index 000000000..31cbb90d3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######### `mismatchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx new file mode 100755 index 000000000..3d74cbb49 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +######### `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..a889daf34 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..7fbfbb559 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `key` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..fed022b1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `operator` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..70d0a2d7c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..5002abe19 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx new file mode 100755 index 000000000..a7e992ed6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx new file mode 100755 index 000000000..b3694f44b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `namespaces` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx new file mode 100755 index 000000000..65bed073b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `topologyKey` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx new file mode 100755 index 000000000..e966b2445 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./podAffinityTerm/labelSelector_reference.mdx" +import PartialNamespaces from "./podAffinityTerm/namespaces.mdx" +import PartialTopologykey from "./podAffinityTerm/topologyKey.mdx" +import PartialNamespaceselectorreference from "./podAffinityTerm/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./podAffinityTerm/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./podAffinityTerm/mismatchLabelKeys.mdx" + + +
+ + +######### `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +######### `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx new file mode 100755 index 000000000..9108f5c99 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `weight` required integer {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-weight} + +weight associated with matching the corresponding podAffinityTerm, +in the range 1-100. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..848d9cc1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,21 @@ + +import PartialWeight from "./preferredDuringSchedulingIgnoredDuringExecution/weight.mdx" +import PartialPodaffinitytermreference from "./preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx" + + + + + +
+ + +######## `podAffinityTerm` required {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..3b8cfadad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,23 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx new file mode 100755 index 000000000..76d8c875f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +######## `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..1304baf26 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..d084e6032 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..611af32e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..5559fc4eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..8a9257cce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx new file mode 100755 index 000000000..247aaea3d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx new file mode 100755 index 000000000..9e9c1eb63 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######## `matchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx new file mode 100755 index 000000000..d87900596 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######## `mismatchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx new file mode 100755 index 000000000..9fd6678f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +######## `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..0c9f161d9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..2e5d8014c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..24ff5b8bb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..ad819f315 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..94ee0d9df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx new file mode 100755 index 000000000..a1653b289 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx new file mode 100755 index 000000000..cbd2427b1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `namespaces` required string[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx new file mode 100755 index 000000000..e6f083cca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `topologyKey` required string {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..82401b5fb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx" +import PartialNamespaces from "./requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx" +import PartialTopologykey from "./requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx" +import PartialNamespaceselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx" + + +
+ + +######## `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +######## `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity_reference.mdx new file mode 100755 index 000000000..929b755e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAffinity_reference.mdx @@ -0,0 +1,48 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" +import PartialPreferredduringschedulingignoredduringexecutionreference from "./podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
+ + + +
+ + +####### `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity.mdx new file mode 100755 index 000000000..3842479f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity.mdx @@ -0,0 +1,17 @@ + +import PartialPodantiaffinityreference from "./podAntiAffinity_reference.mdx" + + +
+ + +###### `podAntiAffinity` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity} + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..88f196f41 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,25 @@ + +import PartialPreferredduringschedulingignoredduringexecutionreference from "./preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the anti-affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling anti-affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx new file mode 100755 index 000000000..ba4fa8f3d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx @@ -0,0 +1,17 @@ + +import PartialPodaffinitytermreference from "./podAffinityTerm_reference.mdx" + + +
+ + +######## `podAffinityTerm` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx new file mode 100755 index 000000000..36995ad4e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +######### `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..b8a950076 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..a86b09a1c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `key` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..0910f7070 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `operator` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..626b7328c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..c5e7c7f4f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx new file mode 100755 index 000000000..08469271b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx new file mode 100755 index 000000000..4fb439254 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######### `matchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx new file mode 100755 index 000000000..9ad795757 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######### `mismatchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx new file mode 100755 index 000000000..821f4b48e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +######### `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..056cccc8f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..20c1c5069 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `key` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..98e03c456 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `operator` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..3ad3e3a68 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..2ac177d8f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx new file mode 100755 index 000000000..e0161bf59 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx new file mode 100755 index 000000000..064f118f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `namespaces` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx new file mode 100755 index 000000000..168856e0e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `topologyKey` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx new file mode 100755 index 000000000..c1f576ec6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./podAffinityTerm/labelSelector_reference.mdx" +import PartialNamespaces from "./podAffinityTerm/namespaces.mdx" +import PartialTopologykey from "./podAffinityTerm/topologyKey.mdx" +import PartialNamespaceselectorreference from "./podAffinityTerm/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./podAffinityTerm/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./podAffinityTerm/mismatchLabelKeys.mdx" + + +
+ + +######### `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +######### `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx new file mode 100755 index 000000000..2febded58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `weight` required integer {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-weight} + +weight associated with matching the corresponding podAffinityTerm, +in the range 1-100. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..11e5199b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,21 @@ + +import PartialWeight from "./preferredDuringSchedulingIgnoredDuringExecution/weight.mdx" +import PartialPodaffinitytermreference from "./preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx" + + + + + +
+ + +######## `podAffinityTerm` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..1f7a25c10 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,23 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the anti-affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the anti-affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx new file mode 100755 index 000000000..5887829ce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +######## `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..91ce700ad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..d7cd47b0e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..1eaf735fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..25edb30bc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..168eb163b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx new file mode 100755 index 000000000..6e61603f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx new file mode 100755 index 000000000..36a5c4814 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######## `matchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx new file mode 100755 index 000000000..d5f1d54ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +######## `mismatchLabelKeys` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx new file mode 100755 index 000000000..329cabd44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +######## `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..fe9e79aec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..c467a5037 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `key` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..19473c336 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `operator` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..cfcdd4070 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `values` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..acbc09bf4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `matchLabels` required object {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx new file mode 100755 index 000000000..e73fd230a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +######### `matchExpressions` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx new file mode 100755 index 000000000..4de9e6c31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `namespaces` required string[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx new file mode 100755 index 000000000..f1d9ac684 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `topologyKey` required string {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..6e4c35194 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx" +import PartialNamespaces from "./requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx" +import PartialTopologykey from "./requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx" +import PartialNamespaceselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx" + + +
+ + +######## `labelSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +######## `namespaceSelector` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity_reference.mdx new file mode 100755 index 000000000..0602fcb66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity/podAntiAffinity_reference.mdx @@ -0,0 +1,48 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" +import PartialPreferredduringschedulingignoredduringexecutionreference from "./podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +####### `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the anti-affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the anti-affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
+ + + +
+ + +####### `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-advanced-scheduling-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the anti-affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling anti-affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity_reference.mdx new file mode 100755 index 000000000..c12640600 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/affinity_reference.mdx @@ -0,0 +1,51 @@ + +import PartialNodeaffinityreference from "./affinity/nodeAffinity_reference.mdx" +import PartialPodaffinityreference from "./affinity/podAffinity_reference.mdx" +import PartialPodantiaffinityreference from "./affinity/podAntiAffinity_reference.mdx" + + +
+ + +###### `nodeAffinity` required {#controlPlane-advanced-scheduling-affinity-nodeAffinity} + +Describes node affinity scheduling rules for the pod. + + + + + + +
+ + + +
+ + +###### `podAffinity` required {#controlPlane-advanced-scheduling-affinity-podAffinity} + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
+ + + +
+ + +###### `podAntiAffinity` required {#controlPlane-advanced-scheduling-affinity-podAntiAffinity} + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/nodeSelector.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/nodeSelector.mdx new file mode 100755 index 000000000..207a2dd1c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/nodeSelector.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `nodeSelector` required object {#controlPlane-advanced-scheduling-nodeSelector} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/priorityClassName.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/priorityClassName.mdx new file mode 100755 index 000000000..7d0f90670 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/priorityClassName.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `priorityClassName` required string {#controlPlane-advanced-scheduling-priorityClassName} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations.mdx new file mode 100755 index 000000000..0415bd6be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations.mdx @@ -0,0 +1,17 @@ + +import PartialTolerationsreference from "./tolerations_reference.mdx" + + +
+ + +##### `tolerations` required object[] {#controlPlane-advanced-scheduling-tolerations} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/effect.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/effect.mdx new file mode 100755 index 000000000..2a6141d60 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/effect.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `effect` required string {#controlPlane-advanced-scheduling-tolerations-effect} + +Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/key.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/key.mdx new file mode 100755 index 000000000..b0a2813f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/key.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `key` required string {#controlPlane-advanced-scheduling-tolerations-key} + +Key is the taint key that the toleration applies to. Empty means match all taint keys. +If the key is empty, operator must be Exists; this combination means to match all values and all keys. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/operator.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/operator.mdx new file mode 100755 index 000000000..27055648d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/operator.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `operator` required string {#controlPlane-advanced-scheduling-tolerations-operator} + +Operator represents a key's relationship to the value. +Valid operators are Exists and Equal. Defaults to Equal. +Exists is equivalent to wildcard for value, so that a pod can +tolerate all taints of a particular category. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/tolerationSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/tolerationSeconds.mdx new file mode 100755 index 000000000..10093928e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/tolerationSeconds.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `tolerationSeconds` required integer {#controlPlane-advanced-scheduling-tolerations-tolerationSeconds} + +TolerationSeconds represents the period of time the toleration (which must be +of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, +it is not set, which means tolerate the taint forever (do not evict). Zero and +negative values will be treated as 0 (evict immediately) by the system. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/value.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/value.mdx new file mode 100755 index 000000000..832f6458b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations/value.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `value` required string {#controlPlane-advanced-scheduling-tolerations-value} + +Value is the taint value the toleration matches to. +If the operator is Exists, the value should be empty, otherwise just a regular string. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations_reference.mdx new file mode 100755 index 000000000..faf95152f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling/tolerations_reference.mdx @@ -0,0 +1,20 @@ + +import PartialKey from "./tolerations/key.mdx" +import PartialOperator from "./tolerations/operator.mdx" +import PartialValue from "./tolerations/value.mdx" +import PartialEffect from "./tolerations/effect.mdx" +import PartialTolerationseconds from "./tolerations/tolerationSeconds.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/scheduling_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling_reference.mdx new file mode 100755 index 000000000..ec56f18d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/scheduling_reference.mdx @@ -0,0 +1,42 @@ + +import PartialNodeselector from "./scheduling/nodeSelector.mdx" +import PartialAffinityreference from "./scheduling/affinity_reference.mdx" +import PartialTolerationsreference from "./scheduling/tolerations_reference.mdx" +import PartialPriorityclassname from "./scheduling/priorityClassName.mdx" + + + + + +
+ + +##### `affinity` required {#controlPlane-advanced-scheduling-affinity} + + + + + + + + +
+ + + +
+ + +##### `tolerations` required object[] {#controlPlane-advanced-scheduling-tolerations} + + + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security.mdx new file mode 100755 index 000000000..6c31f2f32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security.mdx @@ -0,0 +1,17 @@ + +import PartialSecurityreference from "./security_reference.mdx" + + +
+ + +#### `security` required {#controlPlane-advanced-security} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext.mdx new file mode 100755 index 000000000..cad1cac9f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext.mdx @@ -0,0 +1,17 @@ + +import PartialContainersecuritycontextreference from "./containerSecurityContext_reference.mdx" + + +
+ + +##### `containerSecurityContext` required {#controlPlane-advanced-security-containerSecurityContext} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..9c1eeef66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `allowPrivilegeEscalation` required boolean false {#controlPlane-advanced-security-containerSecurityContext-allowPrivilegeEscalation} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities.mdx new file mode 100755 index 000000000..c820453e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities.mdx @@ -0,0 +1,17 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +###### `capabilities` required {#controlPlane-advanced-security-containerSecurityContext-capabilities} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities/add.mdx new file mode 100755 index 000000000..8cf32028a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `add` required string[] {#controlPlane-advanced-security-containerSecurityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities/drop.mdx new file mode 100755 index 000000000..1f71df7ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `drop` required string[] {#controlPlane-advanced-security-containerSecurityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/runAsGroup.mdx new file mode 100755 index 000000000..2554803e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/runAsGroup.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `runAsGroup` required integer {#controlPlane-advanced-security-containerSecurityContext-runAsGroup} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/runAsUser.mdx new file mode 100755 index 000000000..f603f7e9f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext/runAsUser.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `runAsUser` required integer {#controlPlane-advanced-security-containerSecurityContext-runAsUser} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext_reference.mdx new file mode 100755 index 000000000..1ad042b20 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/containerSecurityContext_reference.mdx @@ -0,0 +1,29 @@ + +import PartialAllowprivilegeescalation from "./containerSecurityContext/allowPrivilegeEscalation.mdx" +import PartialCapabilitiesreference from "./containerSecurityContext/capabilities_reference.mdx" +import PartialRunasuser from "./containerSecurityContext/runAsUser.mdx" +import PartialRunasgroup from "./containerSecurityContext/runAsGroup.mdx" + + + + + +
+ + +###### `capabilities` required {#controlPlane-advanced-security-containerSecurityContext-capabilities} + + + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext.mdx new file mode 100755 index 000000000..c0cac0474 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext.mdx @@ -0,0 +1,17 @@ + +import PartialPodsecuritycontextreference from "./podSecurityContext_reference.mdx" + + +
+ + +##### `podSecurityContext` required {#controlPlane-advanced-security-podSecurityContext} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/fsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/fsGroup.mdx new file mode 100755 index 000000000..76f8fa96c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/fsGroup.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `fsGroup` required integer {#controlPlane-advanced-security-podSecurityContext-fsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/fsGroupChangePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/fsGroupChangePolicy.mdx new file mode 100755 index 000000000..a9ee6d7fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/fsGroupChangePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `fsGroupChangePolicy` required string {#controlPlane-advanced-security-podSecurityContext-fsGroupChangePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsGroup.mdx new file mode 100755 index 000000000..2b6b52d81 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsGroup.mdx @@ -0,0 +1,18 @@ + +
+ + +###### `runAsGroup` required integer {#controlPlane-advanced-security-podSecurityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..05a8e19c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +###### `runAsNonRoot` required boolean false {#controlPlane-advanced-security-podSecurityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsUser.mdx new file mode 100755 index 000000000..36cb015f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/runAsUser.mdx @@ -0,0 +1,18 @@ + +
+ + +###### `runAsUser` required integer {#controlPlane-advanced-security-podSecurityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..c879cfbec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions.mdx @@ -0,0 +1,22 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +###### `seLinuxOptions` required {#controlPlane-advanced-security-podSecurityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..003d1c184 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `level` required string {#controlPlane-advanced-security-podSecurityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..fb317ecfd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `role` required string {#controlPlane-advanced-security-podSecurityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..76bc1c43c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `type` required string {#controlPlane-advanced-security-podSecurityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..94f6c7e80 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `user` required string {#controlPlane-advanced-security-podSecurityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile.mdx new file mode 100755 index 000000000..23b89aa69 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile.mdx @@ -0,0 +1,18 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +###### `seccompProfile` required {#controlPlane-advanced-security-podSecurityContext-seccompProfile} + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..2c0d428b4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `localhostProfile` required string {#controlPlane-advanced-security-podSecurityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..ad5a4bfb6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +####### `type` required string {#controlPlane-advanced-security-podSecurityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/supplementalGroups.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/supplementalGroups.mdx new file mode 100755 index 000000000..89b873fe0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/supplementalGroups.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `supplementalGroups` required integer[] {#controlPlane-advanced-security-podSecurityContext-supplementalGroups} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls.mdx new file mode 100755 index 000000000..9b1851f77 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls.mdx @@ -0,0 +1,19 @@ + +import PartialSysctlsreference from "./sysctls_reference.mdx" + + +
+ + +###### `sysctls` required object[] {#controlPlane-advanced-security-podSecurityContext-sysctls} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls/name.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls/name.mdx new file mode 100755 index 000000000..f251a69df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-advanced-security-podSecurityContext-sysctls-name} + +Name of a property to set + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls/value.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls/value.mdx new file mode 100755 index 000000000..99d7d7934 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls/value.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `value` required string {#controlPlane-advanced-security-podSecurityContext-sysctls-value} + +Value of a property to set + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls_reference.mdx new file mode 100755 index 000000000..dd3a7e504 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/sysctls_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./sysctls/name.mdx" +import PartialValue from "./sysctls/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions.mdx new file mode 100755 index 000000000..eea11aafa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +###### `windowsOptions` required {#controlPlane-advanced-security-podSecurityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..a368bf8f1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `gmsaCredentialSpec` required string {#controlPlane-advanced-security-podSecurityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..44fc6f1a9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `gmsaCredentialSpecName` required string {#controlPlane-advanced-security-podSecurityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..2f6487e80 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `hostProcess` required boolean false {#controlPlane-advanced-security-podSecurityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..975d2db0d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `runAsUserName` required string {#controlPlane-advanced-security-podSecurityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext_reference.mdx new file mode 100755 index 000000000..017693bdd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security/podSecurityContext_reference.mdx @@ -0,0 +1,103 @@ + +import PartialSelinuxoptionsreference from "./podSecurityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./podSecurityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./podSecurityContext/runAsUser.mdx" +import PartialRunasgroup from "./podSecurityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./podSecurityContext/runAsNonRoot.mdx" +import PartialSupplementalgroups from "./podSecurityContext/supplementalGroups.mdx" +import PartialFsgroup from "./podSecurityContext/fsGroup.mdx" +import PartialSysctlsreference from "./podSecurityContext/sysctls_reference.mdx" +import PartialFsgroupchangepolicy from "./podSecurityContext/fsGroupChangePolicy.mdx" +import PartialSeccompprofilereference from "./podSecurityContext/seccompProfile_reference.mdx" + + +
+ + +###### `seLinuxOptions` required {#controlPlane-advanced-security-podSecurityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +###### `windowsOptions` required {#controlPlane-advanced-security-podSecurityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ + +###### `sysctls` required object[] {#controlPlane-advanced-security-podSecurityContext-sysctls} + +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. + + + + + + +
+ + + + + + +
+ + +###### `seccompProfile` required {#controlPlane-advanced-security-podSecurityContext-seccompProfile} + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/security_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/security_reference.mdx new file mode 100755 index 000000000..42748cc3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/security_reference.mdx @@ -0,0 +1,34 @@ + +import PartialPodsecuritycontextreference from "./security/podSecurityContext_reference.mdx" +import PartialContainersecuritycontextreference from "./security/containerSecurityContext_reference.mdx" + + +
+ + +##### `podSecurityContext` required {#controlPlane-advanced-security-podSecurityContext} + + + + + + + + +
+ + + +
+ + +##### `containerSecurityContext` required {#controlPlane-advanced-security-containerSecurityContext} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts.mdx new file mode 100755 index 000000000..42a7d94b5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts.mdx @@ -0,0 +1,17 @@ + +import PartialServiceaccountsreference from "./serviceAccounts_reference.mdx" + + +
+ + +#### `serviceAccounts` required {#controlPlane-advanced-serviceAccounts} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/create.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/create.mdx new file mode 100755 index 000000000..ca6ed050f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/create.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `create` required boolean false {#controlPlane-advanced-serviceAccounts-create} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets.mdx new file mode 100755 index 000000000..62abd89ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets.mdx @@ -0,0 +1,17 @@ + +import PartialImagepullsecretsreference from "./imagePullSecrets_reference.mdx" + + +
+ + +##### `imagePullSecrets` required object[] {#controlPlane-advanced-serviceAccounts-imagePullSecrets} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets/name.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets/name.mdx new file mode 100755 index 000000000..ff45dea5e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets/name.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `name` required string {#controlPlane-advanced-serviceAccounts-imagePullSecrets-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets_reference.mdx new file mode 100755 index 000000000..b667edd40 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/imagePullSecrets_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./imagePullSecrets/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/name.mdx new file mode 100755 index 000000000..e07c8263e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `name` required string {#controlPlane-advanced-serviceAccounts-name} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts_reference.mdx new file mode 100755 index 000000000..9f16c0fec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/serviceAccounts_reference.mdx @@ -0,0 +1,25 @@ + +import PartialCreate from "./serviceAccounts/create.mdx" +import PartialName from "./serviceAccounts/name.mdx" +import PartialImagepullsecretsreference from "./serviceAccounts/imagePullSecrets_reference.mdx" + + + + + + + + +
+ + +##### `imagePullSecrets` required object[] {#controlPlane-advanced-serviceAccounts-imagePullSecrets} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount.mdx new file mode 100755 index 000000000..2e63954ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount.mdx @@ -0,0 +1,17 @@ + +import PartialWorkloadserviceaccountreference from "./workloadServiceAccount_reference.mdx" + + +
+ + +#### `workloadServiceAccount` required {#controlPlane-advanced-workloadServiceAccount} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/annotations.mdx new file mode 100755 index 000000000..b1dfdde1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `annotations` required object {#controlPlane-advanced-workloadServiceAccount-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/create.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/create.mdx new file mode 100755 index 000000000..451b80221 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/create.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `create` required boolean false {#controlPlane-advanced-workloadServiceAccount-create} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/name.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/name.mdx new file mode 100755 index 000000000..cb643b012 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount/name.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `name` required string {#controlPlane-advanced-workloadServiceAccount-name} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount_reference.mdx new file mode 100755 index 000000000..25bff3ada --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced/workloadServiceAccount_reference.mdx @@ -0,0 +1,12 @@ + +import PartialCreate from "./workloadServiceAccount/create.mdx" +import PartialName from "./workloadServiceAccount/name.mdx" +import PartialAnnotations from "./workloadServiceAccount/annotations.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/advanced_reference.mdx b/docs/pages/configuration/_partials/controlPlane/advanced_reference.mdx new file mode 100755 index 000000000..71bf02d94 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/advanced_reference.mdx @@ -0,0 +1,127 @@ + +import PartialDefaultimageregistry from "./advanced/defaultImageRegistry.mdx" +import PartialHeadless from "./advanced/headless.mdx" +import PartialPersistencereference from "./advanced/persistence_reference.mdx" +import PartialSchedulingreference from "./advanced/scheduling_reference.mdx" +import PartialServiceaccountsreference from "./advanced/serviceAccounts_reference.mdx" +import PartialWorkloadserviceaccountreference from "./advanced/workloadServiceAccount_reference.mdx" +import PartialProbesreference from "./advanced/probes_reference.mdx" +import PartialSecurityreference from "./advanced/security_reference.mdx" +import PartialMetadatareference from "./advanced/metadata_reference.mdx" + + + + + + + + +
+ + +#### `persistence` required {#controlPlane-advanced-persistence} + + + + + + + + +
+ + + +
+ + +#### `scheduling` required {#controlPlane-advanced-scheduling} + + + + + + + + +
+ + + +
+ + +#### `serviceAccounts` required {#controlPlane-advanced-serviceAccounts} + + + + + + + + +
+ + + +
+ + +#### `workloadServiceAccount` required {#controlPlane-advanced-workloadServiceAccount} + + + + + + + + +
+ + + +
+ + +#### `probes` required {#controlPlane-advanced-probes} + + + + + + + + +
+ + + +
+ + +#### `security` required {#controlPlane-advanced-security} + + + + + + + + +
+ + + +
+ + +#### `metadata` required {#controlPlane-advanced-metadata} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore.mdx new file mode 100755 index 000000000..b126087bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore.mdx @@ -0,0 +1,17 @@ + +import PartialBackingstorereference from "./backingStore_reference.mdx" + + +
+ + +### `backingStore` required {#controlPlane-backingStore} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd.mdx new file mode 100755 index 000000000..123e84914 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd.mdx @@ -0,0 +1,17 @@ + +import PartialEmbeddedetcdreference from "./embeddedEtcd_reference.mdx" + + +
+ + +#### `embeddedEtcd` required {#controlPlane-backingStore-embeddedEtcd} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/enabled.mdx new file mode 100755 index 000000000..58054ef2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#controlPlane-backingStore-embeddedEtcd-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom.mdx new file mode 100755 index 000000000..cf6aa02e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom.mdx @@ -0,0 +1,17 @@ + +import PartialMigratefromreference from "./migrateFrom_reference.mdx" + + +
+ + +##### `migrateFrom` required {#controlPlane-backingStore-embeddedEtcd-migrateFrom} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom/etcd.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom/etcd.mdx new file mode 100755 index 000000000..c0a0457be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom/etcd.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `etcd` required boolean false {#controlPlane-backingStore-embeddedEtcd-migrateFrom-etcd} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom/sqlite.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom/sqlite.mdx new file mode 100755 index 000000000..16ec8b9d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom/sqlite.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `sqlite` required boolean false {#controlPlane-backingStore-embeddedEtcd-migrateFrom-sqlite} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom_reference.mdx new file mode 100755 index 000000000..d50a22795 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd/migrateFrom_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSqlite from "./migrateFrom/sqlite.mdx" +import PartialEtcd from "./migrateFrom/etcd.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd_reference.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd_reference.mdx new file mode 100755 index 000000000..87b2dfe3c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/embeddedEtcd_reference.mdx @@ -0,0 +1,21 @@ + +import PartialEnabled from "./embeddedEtcd/enabled.mdx" +import PartialMigratefromreference from "./embeddedEtcd/migrateFrom_reference.mdx" + + + + + +
+ + +##### `migrateFrom` required {#controlPlane-backingStore-embeddedEtcd-migrateFrom} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd.mdx new file mode 100755 index 000000000..d57bf85aa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd.mdx @@ -0,0 +1,17 @@ + +import PartialExternaletcdreference from "./externalEtcd_reference.mdx" + + +
+ + +#### `externalEtcd` required {#controlPlane-backingStore-externalEtcd} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/image.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/image.mdx new file mode 100755 index 000000000..f1fe0b1e6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/image.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `image` required string {#controlPlane-backingStore-externalEtcd-image} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata.mdx new file mode 100755 index 000000000..a2ce09505 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata.mdx @@ -0,0 +1,17 @@ + +import PartialMetadatareference from "./metadata_reference.mdx" + + +
+ + +##### `metadata` required {#controlPlane-backingStore-externalEtcd-metadata} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/annotations.mdx new file mode 100755 index 000000000..38cfd6e54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `annotations` required object {#controlPlane-backingStore-externalEtcd-metadata-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/labels.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/labels.mdx new file mode 100755 index 000000000..e16c1cef9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `labels` required object {#controlPlane-backingStore-externalEtcd-metadata-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/podAnnotations.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/podAnnotations.mdx new file mode 100755 index 000000000..7a2f972dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/podAnnotations.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `podAnnotations` required object {#controlPlane-backingStore-externalEtcd-metadata-podAnnotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/podLabels.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/podLabels.mdx new file mode 100755 index 000000000..fb3b2ba27 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata/podLabels.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `podLabels` required object {#controlPlane-backingStore-externalEtcd-metadata-podLabels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata_reference.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata_reference.mdx new file mode 100755 index 000000000..9a3428736 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/metadata_reference.mdx @@ -0,0 +1,16 @@ + +import PartialLabels from "./metadata/labels.mdx" +import PartialAnnotations from "./metadata/annotations.mdx" +import PartialPodlabels from "./metadata/podLabels.mdx" +import PartialPodannotations from "./metadata/podAnnotations.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/replicas.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/replicas.mdx new file mode 100755 index 000000000..def0f29c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd/replicas.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `replicas` required integer {#controlPlane-backingStore-externalEtcd-replicas} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd_reference.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd_reference.mdx new file mode 100755 index 000000000..ccf3b5ce2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/externalEtcd_reference.mdx @@ -0,0 +1,25 @@ + +import PartialImage from "./externalEtcd/image.mdx" +import PartialReplicas from "./externalEtcd/replicas.mdx" +import PartialMetadatareference from "./externalEtcd/metadata_reference.mdx" + + + + + + + + +
+ + +##### `metadata` required {#controlPlane-backingStore-externalEtcd-metadata} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite.mdx new file mode 100755 index 000000000..fca353507 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite.mdx @@ -0,0 +1,17 @@ + +import PartialSqlitereference from "./sqlite_reference.mdx" + + +
+ + +#### `sqlite` required {#controlPlane-backingStore-sqlite} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite/enabled.mdx new file mode 100755 index 000000000..c7e7e9607 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#controlPlane-backingStore-sqlite-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite_reference.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite_reference.mdx new file mode 100755 index 000000000..ed32c435d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore/sqlite_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./sqlite/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/backingStore_reference.mdx b/docs/pages/configuration/_partials/controlPlane/backingStore_reference.mdx new file mode 100755 index 000000000..c7c1d9bd4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/backingStore_reference.mdx @@ -0,0 +1,51 @@ + +import PartialSqlitereference from "./backingStore/sqlite_reference.mdx" +import PartialEmbeddedetcdreference from "./backingStore/embeddedEtcd_reference.mdx" +import PartialExternaletcdreference from "./backingStore/externalEtcd_reference.mdx" + + +
+ + +#### `sqlite` required {#controlPlane-backingStore-sqlite} + + + + + + + + +
+ + + +
+ + +#### `embeddedEtcd` required {#controlPlane-backingStore-embeddedEtcd} + + + + + + + + +
+ + + +
+ + +#### `externalEtcd` required {#controlPlane-backingStore-externalEtcd} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns.mdx b/docs/pages/configuration/_partials/controlPlane/coredns.mdx new file mode 100755 index 000000000..0d3d32db3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns.mdx @@ -0,0 +1,17 @@ + +import PartialCorednsreference from "./coredns_reference.mdx" + + +
+ + +### `coredns` required {#controlPlane-coredns} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment.mdx new file mode 100755 index 000000000..d14a807a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment.mdx @@ -0,0 +1,17 @@ + +import PartialDeploymentreference from "./deployment_reference.mdx" + + +
+ + +#### `deployment` required {#controlPlane-coredns-deployment} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/annotations.mdx new file mode 100755 index 000000000..4267d2064 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `annotations` required object {#controlPlane-coredns-deployment-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/labels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/labels.mdx new file mode 100755 index 000000000..6eda8e7ba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `labels` required object {#controlPlane-coredns-deployment-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec.mdx new file mode 100755 index 000000000..99a36c0b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec.mdx @@ -0,0 +1,17 @@ + +import PartialSpecreference from "./spec_reference.mdx" + + +
+ + +##### `spec` required {#controlPlane-coredns-deployment-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/minReadySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/minReadySeconds.mdx new file mode 100755 index 000000000..caba8c299 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/minReadySeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `minReadySeconds` required integer {#controlPlane-coredns-deployment-spec-minReadySeconds} + +Minimum number of seconds for which a newly created pod should be ready +without any of its container crashing, for it to be considered available. +Defaults to 0 (pod will be considered available as soon as it is ready) + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/paused.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/paused.mdx new file mode 100755 index 000000000..65b917ef8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/paused.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `paused` required boolean false {#controlPlane-coredns-deployment-spec-paused} + +Indicates that the deployment is paused. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/progressDeadlineSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/progressDeadlineSeconds.mdx new file mode 100755 index 000000000..480c5b933 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/progressDeadlineSeconds.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `progressDeadlineSeconds` required integer {#controlPlane-coredns-deployment-spec-progressDeadlineSeconds} + +The maximum time in seconds for a deployment to make progress before it +is considered to be failed. The deployment controller will continue to +process failed deployments and a condition with a ProgressDeadlineExceeded +reason will be surfaced in the deployment status. Note that progress will +not be estimated during the time a deployment is paused. Defaults to 600s. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/replicas.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/replicas.mdx new file mode 100755 index 000000000..4b4c3b172 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/replicas.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `replicas` required integer {#controlPlane-coredns-deployment-spec-replicas} + +Number of desired pods. This is a pointer to distinguish between explicit +zero and not specified. Defaults to 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/revisionHistoryLimit.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/revisionHistoryLimit.mdx new file mode 100755 index 000000000..ced30caee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/revisionHistoryLimit.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `revisionHistoryLimit` required integer {#controlPlane-coredns-deployment-spec-revisionHistoryLimit} + +The number of old ReplicaSets to retain to allow rollback. +This is a pointer to distinguish between explicit zero and not specified. +Defaults to 10. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector.mdx new file mode 100755 index 000000000..0f2ddd307 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector.mdx @@ -0,0 +1,19 @@ + +import PartialSelectorreference from "./selector_reference.mdx" + + +
+ + +###### `selector` required {#controlPlane-coredns-deployment-spec-selector} + +Label selector for pods. Existing ReplicaSets whose pods are +selected by this will be the ones affected by this deployment. +It must match the pod template's labels. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions.mdx new file mode 100755 index 000000000..02f4d3d7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +####### `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-selector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/key.mdx new file mode 100755 index 000000000..413200452 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `key` required string {#controlPlane-coredns-deployment-spec-selector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/operator.mdx new file mode 100755 index 000000000..b29ea4c7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `operator` required string {#controlPlane-coredns-deployment-spec-selector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/values.mdx new file mode 100755 index 000000000..e941418f9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `values` required string[] {#controlPlane-coredns-deployment-spec-selector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchLabels.mdx new file mode 100755 index 000000000..8b622556d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `matchLabels` required object {#controlPlane-coredns-deployment-spec-selector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector_reference.mdx new file mode 100755 index 000000000..8f5c5abd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/selector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./selector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./selector/matchExpressions_reference.mdx" + + + + + +
+ + +####### `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-selector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy.mdx new file mode 100755 index 000000000..23b2dd187 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy.mdx @@ -0,0 +1,17 @@ + +import PartialStrategyreference from "./strategy_reference.mdx" + + +
+ + +###### `strategy` required {#controlPlane-coredns-deployment-spec-strategy} + +The deployment strategy to use to replace existing pods with new ones. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate.mdx new file mode 100755 index 000000000..8ed29cf5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate.mdx @@ -0,0 +1,21 @@ + +import PartialRollingupdatereference from "./rollingUpdate_reference.mdx" + + +
+ + +####### `rollingUpdate` required {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate} + +Rolling update config params. Present only if DeploymentStrategyType = +RollingUpdate. +--- +TODO: Update this to follow our convention for oneOf, whatever we decide it +to be. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge.mdx new file mode 100755 index 000000000..1e796c368 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge.mdx @@ -0,0 +1,27 @@ + +import PartialMaxsurgereference from "./maxSurge_reference.mdx" + + +
+ + +######## `maxSurge` required {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxSurge} + +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%. +Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when +the rolling update starts, such that the total number of old and new pods do not exceed +130% of desired pods. Once old pods have been killed, +new ReplicaSet can be scaled up further, ensuring that total number of pods running +at any time during the update is at most 130% of desired pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/IntVal.mdx new file mode 100755 index 000000000..d54a637e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxSurge-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/StrVal.mdx new file mode 100755 index 000000000..fb7ba5b66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxSurge-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/Type.mdx new file mode 100755 index 000000000..1da7e6ecc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxSurge-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge_reference.mdx new file mode 100755 index 000000000..b7bbfe624 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxSurge_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./maxSurge/Type.mdx" +import PartialIntval from "./maxSurge/IntVal.mdx" +import PartialStrval from "./maxSurge/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable.mdx new file mode 100755 index 000000000..2f97a10d2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable.mdx @@ -0,0 +1,26 @@ + +import PartialMaxunavailablereference from "./maxUnavailable_reference.mdx" + + +
+ + +######## `maxUnavailable` required {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxUnavailable} + +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%. +Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods +immediately when the rolling update starts. Once new pods are ready, old ReplicaSet +can be scaled down further, followed by scaling up the new ReplicaSet, ensuring +that the total number of pods available at all times during the update is at +least 70% of desired pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/IntVal.mdx new file mode 100755 index 000000000..17484204f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxUnavailable-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/StrVal.mdx new file mode 100755 index 000000000..f6114a0b5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxUnavailable-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/Type.mdx new file mode 100755 index 000000000..567242a41 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxUnavailable-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable_reference.mdx new file mode 100755 index 000000000..0070fef38 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate/maxUnavailable_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./maxUnavailable/Type.mdx" +import PartialIntval from "./maxUnavailable/IntVal.mdx" +import PartialStrval from "./maxUnavailable/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate_reference.mdx new file mode 100755 index 000000000..ebae03db2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/rollingUpdate_reference.mdx @@ -0,0 +1,53 @@ + +import PartialMaxunavailablereference from "./rollingUpdate/maxUnavailable_reference.mdx" +import PartialMaxsurgereference from "./rollingUpdate/maxSurge_reference.mdx" + + +
+ + +######## `maxUnavailable` required {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxUnavailable} + +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%. +Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods +immediately when the rolling update starts. Once new pods are ready, old ReplicaSet +can be scaled down further, followed by scaling up the new ReplicaSet, ensuring +that the total number of pods available at all times during the update is at +least 70% of desired pods. + + + + + + +
+ + + +
+ + +######## `maxSurge` required {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate-maxSurge} + +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%. +Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when +the rolling update starts, such that the total number of old and new pods do not exceed +130% of desired pods. Once old pods have been killed, +new ReplicaSet can be scaled up further, ensuring that total number of pods running +at any time during the update is at most 130% of desired pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/type.mdx new file mode 100755 index 000000000..abf2e3498 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy/type.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `type` required string {#controlPlane-coredns-deployment-spec-strategy-type} + +Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy_reference.mdx new file mode 100755 index 000000000..6bbe13753 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/strategy_reference.mdx @@ -0,0 +1,25 @@ + +import PartialType from "./strategy/type.mdx" +import PartialRollingupdatereference from "./strategy/rollingUpdate_reference.mdx" + + + + + +
+ + +####### `rollingUpdate` required {#controlPlane-coredns-deployment-spec-strategy-rollingUpdate} + +Rolling update config params. Present only if DeploymentStrategyType = +RollingUpdate. +--- +TODO: Update this to follow our convention for oneOf, whatever we decide it +to be. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template.mdx new file mode 100755 index 000000000..beb02f99c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template.mdx @@ -0,0 +1,18 @@ + +import PartialTemplatereference from "./template_reference.mdx" + + +
+ + +###### `template` required {#controlPlane-coredns-deployment-spec-template} + +Template describes the pods that will be created. +The only allowed template.spec.restartPolicy value is "Always". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata.mdx new file mode 100755 index 000000000..19adbae43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata.mdx @@ -0,0 +1,17 @@ + +import PartialMetadatareference from "./metadata_reference.mdx" + + +
+ + +####### `metadata` required {#controlPlane-coredns-deployment-spec-template-metadata} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/annotations.mdx new file mode 100755 index 000000000..bc1612c42 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/annotations.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `annotations` required object {#controlPlane-coredns-deployment-spec-template-metadata-annotations} + +Annotations is an unstructured key value map stored with a resource that may be +set by external tools to store and retrieve arbitrary metadata. They are not +queryable and should be preserved when modifying objects. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/creationTimestamp.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/creationTimestamp.mdx new file mode 100755 index 000000000..280bd8a89 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/creationTimestamp.mdx @@ -0,0 +1,24 @@ + +import PartialCreationtimestampreference from "./creationTimestamp_reference.mdx" + + +
+ + +######## `creationTimestamp` required {#controlPlane-coredns-deployment-spec-template-metadata-creationTimestamp} + +CreationTimestamp is a timestamp representing the server time when this object was +created. It is not guaranteed to be set in happens-before order across separate operations. +Clients may not set this value. It is represented in RFC3339 form and is in UTC. + +Populated by the system. +Read-only. +Null for lists. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/creationTimestamp_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/creationTimestamp_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionGracePeriodSeconds.mdx new file mode 100755 index 000000000..89501ba77 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionGracePeriodSeconds.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `deletionGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-metadata-deletionGracePeriodSeconds} + +Number of seconds allowed for this object to gracefully terminate before +it will be removed from the system. Only set when deletionTimestamp is also set. +May only be shortened. +Read-only. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionTimestamp.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionTimestamp.mdx new file mode 100755 index 000000000..9fdc0543d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionTimestamp.mdx @@ -0,0 +1,34 @@ + +import PartialDeletiontimestampreference from "./deletionTimestamp_reference.mdx" + + +
+ + +######## `deletionTimestamp` required {#controlPlane-coredns-deployment-spec-template-metadata-deletionTimestamp} + +DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This +field is set by the server when a graceful deletion is requested by the user, and is not +directly settable by a client. The resource is expected to be deleted (no longer visible +from resource lists, and not reachable by name) after the time in this field, once the +finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. +Once the deletionTimestamp is set, this value may not be unset or be set further into the +future, although it may be shortened or the resource may be deleted prior to this time. +For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react +by sending a graceful termination signal to the containers in the pod. After that 30 seconds, +the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, +remove the pod from the API. In the presence of network partitions, this object may still +exist after this timestamp, until an administrator or automated process can determine the +resource is fully terminated. +If not set, graceful deletion of the object has not been requested. + +Populated by the system when a graceful deletion is requested. +Read-only. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionTimestamp_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/deletionTimestamp_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/finalizers.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/finalizers.mdx new file mode 100755 index 000000000..e321d2eed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/finalizers.mdx @@ -0,0 +1,25 @@ + +
+ + +######## `finalizers` required string[] {#controlPlane-coredns-deployment-spec-template-metadata-finalizers} + +Must be empty before the object is deleted from the registry. Each entry +is an identifier for the responsible component that will remove the entry +from the list. If the deletionTimestamp of the object is non-nil, entries +in this list can only be removed. +Finalizers may be processed and removed in any order. Order is NOT enforced +because it introduces significant risk of stuck finalizers. +finalizers is a shared field, any actor with permission can reorder it. +If the finalizer list is processed in order, then this can lead to a situation +in which the component responsible for the first finalizer in the list is +waiting for a signal (field value, external system, or other) produced by a +component responsible for a finalizer later in the list, resulting in a deadlock. +Without enforced ordering finalizers are free to order amongst themselves and +are not vulnerable to ordering changes in the list. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/generateName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/generateName.mdx new file mode 100755 index 000000000..c807fac7e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/generateName.mdx @@ -0,0 +1,24 @@ + +
+ + +######## `generateName` required string {#controlPlane-coredns-deployment-spec-template-metadata-generateName} + +GenerateName is an optional prefix, used by the server, to generate a unique +name ONLY IF the Name field has not been provided. +If this field is used, the name returned to the client will be different +than the name passed. This value will also be combined with a unique suffix. +The provided value has the same validation rules as the Name field, +and may be truncated by the length of the suffix required to make the value +unique on the server. + +If this field is specified and the generated name exists, the server will return a 409. + +Applied only if Name is not specified. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/generation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/generation.mdx new file mode 100755 index 000000000..e7eb2e48b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/generation.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `generation` required integer {#controlPlane-coredns-deployment-spec-template-metadata-generation} + +A sequence number representing a specific generation of the desired state. +Populated by the system. Read-only. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/labels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/labels.mdx new file mode 100755 index 000000000..cffd0679d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/labels.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `labels` required object {#controlPlane-coredns-deployment-spec-template-metadata-labels} + +Map of string keys and values that can be used to organize and categorize +(scope and select) objects. May match selectors of replication controllers +and services. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields.mdx new file mode 100755 index 000000000..b01861dd5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields.mdx @@ -0,0 +1,24 @@ + +import PartialManagedfieldsreference from "./managedFields_reference.mdx" + + +
+ + +######## `managedFields` required object[] {#controlPlane-coredns-deployment-spec-template-metadata-managedFields} + +ManagedFields maps workflow-id and version to the set of fields +that are managed by that workflow. This is mostly for internal +housekeeping, and users typically shouldn't need to set or +understand this field. A workflow can be the user's name, a +controller's name, or the name of a specific apply path like +"ci-cd". The set of fields is always in the version that the +workflow used when modifying the object. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/apiVersion.mdx new file mode 100755 index 000000000..ae8c2c73c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/apiVersion.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-apiVersion} + +APIVersion defines the version of this resource that this field set +applies to. The format is "group/version" just like the top-level +APIVersion field. It is necessary to track the version of a field +set because it cannot be automatically converted. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsType.mdx new file mode 100755 index 000000000..9e61010e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsType.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `fieldsType` required string {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-fieldsType} + +FieldsType is the discriminator for the different fields format and version. +There is currently only one possible value: "FieldsV1" + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsV1.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsV1.mdx new file mode 100755 index 000000000..524e94c4f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsV1.mdx @@ -0,0 +1,17 @@ + +import PartialFieldsv1reference from "./fieldsV1_reference.mdx" + + +
+ + +######### `fieldsV1` required {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-fieldsV1} + +FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsV1_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/fieldsV1_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/manager.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/manager.mdx new file mode 100755 index 000000000..f26552380 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/manager.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `manager` required string {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-manager} + +Manager is an identifier of the workflow managing these fields. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/operation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/operation.mdx new file mode 100755 index 000000000..8490d924c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/operation.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `operation` required string {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-operation} + +Operation is the type of operation which lead to this ManagedFieldsEntry being created. +The only valid values for this field are 'Apply' and 'Update'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/subresource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/subresource.mdx new file mode 100755 index 000000000..db6400cb8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/subresource.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `subresource` required string {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-subresource} + +Subresource is the name of the subresource used to update that object, or +empty string if the object was updated through the main resource. The +value of this field is used to distinguish between managers, even if they +share the same name. For example, a status update will be distinct from a +regular update using the same manager name. +Note that the APIVersion field is not related to the Subresource field and +it always corresponds to the version of the main resource. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/time.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/time.mdx new file mode 100755 index 000000000..7d756f860 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/time.mdx @@ -0,0 +1,21 @@ + +import PartialTimereference from "./time_reference.mdx" + + +
+ + +######### `time` required {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-time} + +Time is the timestamp of when the ManagedFields entry was added. The +timestamp will also be updated if a field is added, the manager +changes any of the owned fields value or removes a field. The +timestamp does not update when a field is removed from the entry +because another manager took it over. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/time_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields/time_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields_reference.mdx new file mode 100755 index 000000000..6ac803bb1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/managedFields_reference.mdx @@ -0,0 +1,58 @@ + +import PartialManager from "./managedFields/manager.mdx" +import PartialOperation from "./managedFields/operation.mdx" +import PartialApiversion from "./managedFields/apiVersion.mdx" +import PartialTimereference from "./managedFields/time_reference.mdx" +import PartialFieldstype from "./managedFields/fieldsType.mdx" +import PartialFieldsv1reference from "./managedFields/fieldsV1_reference.mdx" +import PartialSubresource from "./managedFields/subresource.mdx" + + + + + + + + + + + +
+ + +######### `time` required {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-time} + +Time is the timestamp of when the ManagedFields entry was added. The +timestamp will also be updated if a field is added, the manager +changes any of the owned fields value or removes a field. The +timestamp does not update when a field is removed from the entry +because another manager took it over. + + + + + + +
+ + + + + + +
+ + +######### `fieldsV1` required {#controlPlane-coredns-deployment-spec-template-metadata-managedFields-fieldsV1} + +FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/name.mdx new file mode 100755 index 000000000..e44fc115f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/name.mdx @@ -0,0 +1,18 @@ + +
+ + +######## `name` required string {#controlPlane-coredns-deployment-spec-template-metadata-name} + +Name must be unique within a namespace. Is required when creating resources, although +some resources may allow a client to request the generation of an appropriate name +automatically. Name is primarily intended for creation idempotence and configuration +definition. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/namespace.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/namespace.mdx new file mode 100755 index 000000000..d24b2a62c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/namespace.mdx @@ -0,0 +1,20 @@ + +
+ + +######## `namespace` required string {#controlPlane-coredns-deployment-spec-template-metadata-namespace} + +Namespace defines the space within which each name must be unique. An empty namespace is +equivalent to the "default" namespace, but "default" is the canonical representation. +Not all objects are required to be scoped to a namespace - the value of this field for +those objects will be empty. + +Must be a DNS_LABEL. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences.mdx new file mode 100755 index 000000000..9551ae006 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences.mdx @@ -0,0 +1,20 @@ + +import PartialOwnerreferencesreference from "./ownerReferences_reference.mdx" + + +
+ + +######## `ownerReferences` required object[] {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences} + +List of objects depended by this object. If ALL objects in the list have +been deleted, this object will be garbage collected. If this object is managed by a controller, +then an entry in this list will point to this controller, with the controller field set to true. +There cannot be more than one managing controller. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/apiVersion.mdx new file mode 100755 index 000000000..72072f6b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences-apiVersion} + +API version of the referent. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/blockOwnerDeletion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/blockOwnerDeletion.mdx new file mode 100755 index 000000000..a0e5f4c19 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/blockOwnerDeletion.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `blockOwnerDeletion` required boolean false {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences-blockOwnerDeletion} + +If true, AND if the owner has the "foregroundDeletion" finalizer, then +the owner cannot be deleted from the key-value store until this +reference is removed. +See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion +for how the garbage collector interacts with this field and enforces the foreground deletion. +Defaults to false. +To set this field, a user needs "delete" permission of the owner, +otherwise 422 (Unprocessable Entity) will be returned. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/controller.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/controller.mdx new file mode 100755 index 000000000..97df20102 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/controller.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `controller` required boolean false {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences-controller} + +If true, this reference points to the managing controller. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/kind.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/kind.mdx new file mode 100755 index 000000000..b3bfd9df0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/kind.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `kind` required string {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences-kind} + +Kind of the referent. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/name.mdx new file mode 100755 index 000000000..cca50b5d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/uid.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/uid.mdx new file mode 100755 index 000000000..0c47422b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences/uid.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `uid` required string {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences-uid} + +UID of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences_reference.mdx new file mode 100755 index 000000000..806af83c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/ownerReferences_reference.mdx @@ -0,0 +1,24 @@ + +import PartialApiversion from "./ownerReferences/apiVersion.mdx" +import PartialKind from "./ownerReferences/kind.mdx" +import PartialName from "./ownerReferences/name.mdx" +import PartialUid from "./ownerReferences/uid.mdx" +import PartialController from "./ownerReferences/controller.mdx" +import PartialBlockownerdeletion from "./ownerReferences/blockOwnerDeletion.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/resourceVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/resourceVersion.mdx new file mode 100755 index 000000000..719527eef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/resourceVersion.mdx @@ -0,0 +1,22 @@ + +
+ + +######## `resourceVersion` required string {#controlPlane-coredns-deployment-spec-template-metadata-resourceVersion} + +An opaque value that represents the internal version of this object that can +be used by clients to determine when objects have changed. May be used for optimistic +concurrency, change detection, and the watch operation on a resource or set of resources. +Clients must treat these values as opaque and passed unmodified back to the server. +They may only be valid for a particular resource or set of resources. + +Populated by the system. +Read-only. +Value must be treated as opaque by clients and . +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/selfLink.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/selfLink.mdx new file mode 100755 index 000000000..e6b30e67c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/selfLink.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `selfLink` required string {#controlPlane-coredns-deployment-spec-template-metadata-selfLink} + +Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/uid.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/uid.mdx new file mode 100755 index 000000000..dae17e351 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata/uid.mdx @@ -0,0 +1,19 @@ + +
+ + +######## `uid` required string {#controlPlane-coredns-deployment-spec-template-metadata-uid} + +UID is the unique in time and space value for this object. It is typically generated by +the server on successful creation of a resource and is not allowed to change on PUT +operations. + +Populated by the system. +Read-only. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata_reference.mdx new file mode 100755 index 000000000..fb3590c80 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/metadata_reference.mdx @@ -0,0 +1,146 @@ + +import PartialName from "./metadata/name.mdx" +import PartialGeneratename from "./metadata/generateName.mdx" +import PartialNamespace from "./metadata/namespace.mdx" +import PartialSelflink from "./metadata/selfLink.mdx" +import PartialUid from "./metadata/uid.mdx" +import PartialResourceversion from "./metadata/resourceVersion.mdx" +import PartialGeneration from "./metadata/generation.mdx" +import PartialCreationtimestampreference from "./metadata/creationTimestamp_reference.mdx" +import PartialDeletiontimestampreference from "./metadata/deletionTimestamp_reference.mdx" +import PartialDeletiongraceperiodseconds from "./metadata/deletionGracePeriodSeconds.mdx" +import PartialLabels from "./metadata/labels.mdx" +import PartialAnnotations from "./metadata/annotations.mdx" +import PartialOwnerreferencesreference from "./metadata/ownerReferences_reference.mdx" +import PartialFinalizers from "./metadata/finalizers.mdx" +import PartialManagedfieldsreference from "./metadata/managedFields_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +######## `creationTimestamp` required {#controlPlane-coredns-deployment-spec-template-metadata-creationTimestamp} + +CreationTimestamp is a timestamp representing the server time when this object was +created. It is not guaranteed to be set in happens-before order across separate operations. +Clients may not set this value. It is represented in RFC3339 form and is in UTC. + +Populated by the system. +Read-only. +Null for lists. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
+ + + +
+ + +######## `deletionTimestamp` required {#controlPlane-coredns-deployment-spec-template-metadata-deletionTimestamp} + +DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This +field is set by the server when a graceful deletion is requested by the user, and is not +directly settable by a client. The resource is expected to be deleted (no longer visible +from resource lists, and not reachable by name) after the time in this field, once the +finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. +Once the deletionTimestamp is set, this value may not be unset or be set further into the +future, although it may be shortened or the resource may be deleted prior to this time. +For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react +by sending a graceful termination signal to the containers in the pod. After that 30 seconds, +the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, +remove the pod from the API. In the presence of network partitions, this object may still +exist after this timestamp, until an administrator or automated process can determine the +resource is fully terminated. +If not set, graceful deletion of the object has not been requested. + +Populated by the system when a graceful deletion is requested. +Read-only. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
+ + + + + + + + + + + + +
+ + +######## `ownerReferences` required object[] {#controlPlane-coredns-deployment-spec-template-metadata-ownerReferences} + +List of objects depended by this object. If ALL objects in the list have +been deleted, this object will be garbage collected. If this object is managed by a controller, +then an entry in this list will point to this controller, with the controller field set to true. +There cannot be more than one managing controller. + + + + + + +
+ + + + + + +
+ + +######## `managedFields` required object[] {#controlPlane-coredns-deployment-spec-template-metadata-managedFields} + +ManagedFields maps workflow-id and version to the set of fields +that are managed by that workflow. This is mostly for internal +housekeeping, and users typically shouldn't need to set or +understand this field. A workflow can be the user's name, a +controller's name, or the name of a specific apply path like +"ci-cd". The set of fields is always in the version that the +workflow used when modifying the object. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec.mdx new file mode 100755 index 000000000..b0d3f84a2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec.mdx @@ -0,0 +1,18 @@ + +import PartialSpecreference from "./spec_reference.mdx" + + +
+ + +####### `spec` required {#controlPlane-coredns-deployment-spec-template-spec} + +Specification of the desired behavior of the pod. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/activeDeadlineSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/activeDeadlineSeconds.mdx new file mode 100755 index 000000000..cc47842e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/activeDeadlineSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `activeDeadlineSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-activeDeadlineSeconds} + +Optional duration in seconds the pod may be active on the node relative to +StartTime before the system will actively try to mark it failed and kill associated containers. +Value must be a positive integer. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity.mdx new file mode 100755 index 000000000..cf0a7e478 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity.mdx @@ -0,0 +1,17 @@ + +import PartialAffinityreference from "./affinity_reference.mdx" + + +
+ + +######## `affinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity} + +If specified, the pod's scheduling constraints + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity.mdx new file mode 100755 index 000000000..9e26ef551 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity.mdx @@ -0,0 +1,17 @@ + +import PartialNodeaffinityreference from "./nodeAffinity_reference.mdx" + + +
+ + +######### `nodeAffinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity} + +Describes node affinity scheduling rules for the pod. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..a31567e87 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,25 @@ + +import PartialPreferredduringschedulingignoredduringexecutionreference from "./preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node matches the corresponding matchExpressions; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference.mdx new file mode 100755 index 000000000..51de7583e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference.mdx @@ -0,0 +1,17 @@ + +import PartialPreferencereference from "./preference_reference.mdx" + + +
+ + +########### `preference` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference} + +A node selector term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions.mdx new file mode 100755 index 000000000..2b24ac6ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/key.mdx new file mode 100755 index 000000000..1d280b740 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/operator.mdx new file mode 100755 index 000000000..4afa5ee97 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/values.mdx new file mode 100755 index 000000000..f5d7ce3b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions/values.mdx @@ -0,0 +1,17 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields.mdx new file mode 100755 index 000000000..8185b3f3e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields.mdx @@ -0,0 +1,17 @@ + +import PartialMatchfieldsreference from "./matchFields_reference.mdx" + + +
+ + +############ `matchFields` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/key.mdx new file mode 100755 index 000000000..2e205ecf9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/operator.mdx new file mode 100755 index 000000000..c8f000960 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/values.mdx new file mode 100755 index 000000000..11b90185b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields/values.mdx @@ -0,0 +1,17 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields_reference.mdx new file mode 100755 index 000000000..c2de56c6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference/matchFields_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchFields/key.mdx" +import PartialOperator from "./matchFields/operator.mdx" +import PartialValues from "./matchFields/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx new file mode 100755 index 000000000..56923dd03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx @@ -0,0 +1,34 @@ + +import PartialMatchexpressionsreference from "./preference/matchExpressions_reference.mdx" +import PartialMatchfieldsreference from "./preference/matchFields_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
+ + + +
+ + +############ `matchFields` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx new file mode 100755 index 000000000..22e503401 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `weight` required integer {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-weight} + +Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..9b5343187 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,21 @@ + +import PartialWeight from "./preferredDuringSchedulingIgnoredDuringExecution/weight.mdx" +import PartialPreferencereference from "./preferredDuringSchedulingIgnoredDuringExecution/preference_reference.mdx" + + + + + +
+ + +########### `preference` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution-preference} + +A node selector term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..f6aa19103 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,21 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `requiredDuringSchedulingIgnoredDuringExecution` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to an update), the system +may or may not try to eventually evict the pod from its node. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms.mdx new file mode 100755 index 000000000..8f6be8289 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms.mdx @@ -0,0 +1,17 @@ + +import PartialNodeselectortermsreference from "./nodeSelectorTerms_reference.mdx" + + +
+ + +########### `nodeSelectorTerms` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms} + +Required. A list of node selector terms. The terms are ORed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions.mdx new file mode 100755 index 000000000..3a38b32e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/key.mdx new file mode 100755 index 000000000..84628c624 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/operator.mdx new file mode 100755 index 000000000..26c7de0fc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/values.mdx new file mode 100755 index 000000000..1a199dbe8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions/values.mdx @@ -0,0 +1,17 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields.mdx new file mode 100755 index 000000000..b6f72815b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields.mdx @@ -0,0 +1,17 @@ + +import PartialMatchfieldsreference from "./matchFields_reference.mdx" + + +
+ + +############ `matchFields` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/key.mdx new file mode 100755 index 000000000..39d24a26a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields-key} + +The label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/operator.mdx new file mode 100755 index 000000000..a673827b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields-operator} + +Represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/values.mdx new file mode 100755 index 000000000..3b8e803dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields/values.mdx @@ -0,0 +1,17 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields-values} + +An array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. If the operator is Gt or Lt, the values +array must have a single element, which will be interpreted as an integer. +This array is replaced during a strategic merge patch. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields_reference.mdx new file mode 100755 index 000000000..c2de56c6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms/matchFields_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchFields/key.mdx" +import PartialOperator from "./matchFields/operator.mdx" +import PartialValues from "./matchFields/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx new file mode 100755 index 000000000..72bcc6964 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx @@ -0,0 +1,34 @@ + +import PartialMatchexpressionsreference from "./nodeSelectorTerms/matchExpressions_reference.mdx" +import PartialMatchfieldsreference from "./nodeSelectorTerms/matchFields_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchExpressions} + +A list of node selector requirements by node's labels. + + + + + + +
+ + + +
+ + +############ `matchFields` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms-matchFields} + +A list of node selector requirements by node's fields. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..76c19c089 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,17 @@ + +import PartialNodeselectortermsreference from "./requiredDuringSchedulingIgnoredDuringExecution/nodeSelectorTerms_reference.mdx" + + +
+ + +########### `nodeSelectorTerms` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution-nodeSelectorTerms} + +Required. A list of node selector terms. The terms are ORed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity_reference.mdx new file mode 100755 index 000000000..e981e4ab4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/nodeAffinity_reference.mdx @@ -0,0 +1,46 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./nodeAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" +import PartialPreferredduringschedulingignoredduringexecutionreference from "./nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `requiredDuringSchedulingIgnoredDuringExecution` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to an update), the system +may or may not try to eventually evict the pod from its node. + + + + + + +
+ + + +
+ + +########## `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node matches the corresponding matchExpressions; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity.mdx new file mode 100755 index 000000000..a7ec5a1c8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity.mdx @@ -0,0 +1,17 @@ + +import PartialPodaffinityreference from "./podAffinity_reference.mdx" + + +
+ + +######### `podAffinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity} + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..84ebbffe9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,25 @@ + +import PartialPreferredduringschedulingignoredduringexecutionreference from "./preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx new file mode 100755 index 000000000..5e41f8005 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx @@ -0,0 +1,17 @@ + +import PartialPodaffinitytermreference from "./podAffinityTerm_reference.mdx" + + +
+ + +########### `podAffinityTerm` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx new file mode 100755 index 000000000..5aa36d0f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +############ `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..4f5649adc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..4de40dbb4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..18d289e99 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############## `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..4ed2c60cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############## `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..d14052cf1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx new file mode 100755 index 000000000..283e2a4a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx new file mode 100755 index 000000000..a32eb4fdb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +############ `matchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx new file mode 100755 index 000000000..e8f9b18ea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +############ `mismatchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx new file mode 100755 index 000000000..4a4d6fe61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +############ `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..30a9ee30a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..225d5a3ba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..f333ac563 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############## `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..fd7cf5829 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############## `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..17ec553f9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx new file mode 100755 index 000000000..9b07ee760 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx new file mode 100755 index 000000000..c9bca36bb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +############ `namespaces` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx new file mode 100755 index 000000000..e1b186866 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `topologyKey` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx new file mode 100755 index 000000000..8e8f9e8a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./podAffinityTerm/labelSelector_reference.mdx" +import PartialNamespaces from "./podAffinityTerm/namespaces.mdx" +import PartialTopologykey from "./podAffinityTerm/topologyKey.mdx" +import PartialNamespaceselectorreference from "./podAffinityTerm/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./podAffinityTerm/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./podAffinityTerm/mismatchLabelKeys.mdx" + + +
+ + +############ `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +############ `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx new file mode 100755 index 000000000..e4fae6298 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `weight` required integer {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-weight} + +weight associated with matching the corresponding podAffinityTerm, +in the range 1-100. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..e672213fa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,21 @@ + +import PartialWeight from "./preferredDuringSchedulingIgnoredDuringExecution/weight.mdx" +import PartialPodaffinitytermreference from "./preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx" + + + + + +
+ + +########### `podAffinityTerm` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..85929c6de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,23 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx new file mode 100755 index 000000000..ba896d992 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +########### `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..f6b8748eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..fb534eaaf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..187eba6ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..19d417b35 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..258ea993d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx new file mode 100755 index 000000000..22d3c0757 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx new file mode 100755 index 000000000..496601197 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +########### `matchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx new file mode 100755 index 000000000..bff30af86 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +########### `mismatchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx new file mode 100755 index 000000000..26a627a8e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +########### `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..2b75396ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..c2bc20c90 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..e2ef978cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..13009edd9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..f1ef2e406 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx new file mode 100755 index 000000000..8cc830c61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx new file mode 100755 index 000000000..9f63ff131 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `namespaces` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx new file mode 100755 index 000000000..28c0cba3f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `topologyKey` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..f9eb1ff75 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx" +import PartialNamespaces from "./requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx" +import PartialTopologykey from "./requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx" +import PartialNamespaceselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx" + + +
+ + +########### `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +########### `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity_reference.mdx new file mode 100755 index 000000000..1d2c445ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAffinity_reference.mdx @@ -0,0 +1,48 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./podAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" +import PartialPreferredduringschedulingignoredduringexecutionreference from "./podAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
+ + + +
+ + +########## `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity.mdx new file mode 100755 index 000000000..29064e84e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity.mdx @@ -0,0 +1,17 @@ + +import PartialPodantiaffinityreference from "./podAntiAffinity_reference.mdx" + + +
+ + +######### `podAntiAffinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity} + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..70a649912 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,25 @@ + +import PartialPreferredduringschedulingignoredduringexecutionreference from "./preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the anti-affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling anti-affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx new file mode 100755 index 000000000..bd07493b5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm.mdx @@ -0,0 +1,17 @@ + +import PartialPodaffinitytermreference from "./podAffinityTerm_reference.mdx" + + +
+ + +########### `podAffinityTerm` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx new file mode 100755 index 000000000..13191a80b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +############ `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..6e17f76d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..b7aeb94cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..5f60cf0de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############## `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..ab0d3a12a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############## `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..d6dbdeb16 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx new file mode 100755 index 000000000..49ee61912 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx new file mode 100755 index 000000000..d41a783da --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +############ `matchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx new file mode 100755 index 000000000..767b06034 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +############ `mismatchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx new file mode 100755 index 000000000..3230b9215 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +############ `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..e354087b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..f70a32781 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..f813b9847 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############## `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..989237ac7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############## `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..8fdb4b6fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx new file mode 100755 index 000000000..1611d14e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx new file mode 100755 index 000000000..4f6f74ae2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +############ `namespaces` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx new file mode 100755 index 000000000..c739c780c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `topologyKey` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx new file mode 100755 index 000000000..a4132ebea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./podAffinityTerm/labelSelector_reference.mdx" +import PartialNamespaces from "./podAffinityTerm/namespaces.mdx" +import PartialTopologykey from "./podAffinityTerm/topologyKey.mdx" +import PartialNamespaceselectorreference from "./podAffinityTerm/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./podAffinityTerm/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./podAffinityTerm/mismatchLabelKeys.mdx" + + +
+ + +############ `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +############ `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx new file mode 100755 index 000000000..6d0d0e403 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution/weight.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `weight` required integer {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-weight} + +weight associated with matching the corresponding podAffinityTerm, +in the range 1-100. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..4c7bb6244 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,21 @@ + +import PartialWeight from "./preferredDuringSchedulingIgnoredDuringExecution/weight.mdx" +import PartialPodaffinitytermreference from "./preferredDuringSchedulingIgnoredDuringExecution/podAffinityTerm_reference.mdx" + + + + + +
+ + +########### `podAffinityTerm` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution-podAffinityTerm} + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx new file mode 100755 index 000000000..235cfda64 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution.mdx @@ -0,0 +1,23 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the anti-affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the anti-affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx new file mode 100755 index 000000000..7af2dc599 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector.mdx @@ -0,0 +1,18 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +########### `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..b5902b2cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..36b6ed75a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..2c6358bc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..18d39778b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..d63bcfe71 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx new file mode 100755 index 000000000..39d3d9be3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx new file mode 100755 index 000000000..b388867b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +########### `matchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-matchLabelKeys} + +MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +Also, MatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx new file mode 100755 index 000000000..61692fc33 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx @@ -0,0 +1,21 @@ + +
+ + +########### `mismatchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-mismatchLabelKeys} + +MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. +Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. +This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx new file mode 100755 index 000000000..a38bbfdee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector.mdx @@ -0,0 +1,21 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +########### `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..359aebee1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..f0b2df293 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..c6bf25d99 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..2c0c7e8f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############# `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..974ebc5c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx new file mode 100755 index 000000000..8a2acd9ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############ `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx new file mode 100755 index 000000000..5b4ee5a29 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `namespaces` required string[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaces} + +namespaces specifies a static list of namespace names that the term applies to. +The term is applied to the union of the namespaces listed in this field +and the ones selected by namespaceSelector. +null or empty namespaces list and null namespaceSelector means "this pod's namespace". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx new file mode 100755 index 000000000..76fbe2584 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `topologyKey` required string {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-topologyKey} + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching +the labelSelector in the specified namespaces, where co-located is defined as running on a node +whose value of the label with key topologyKey matches that of any node on which any of the +selected pods is running. +Empty topologyKey is not allowed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx new file mode 100755 index 000000000..e8631d2be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx @@ -0,0 +1,55 @@ + +import PartialLabelselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/labelSelector_reference.mdx" +import PartialNamespaces from "./requiredDuringSchedulingIgnoredDuringExecution/namespaces.mdx" +import PartialTopologykey from "./requiredDuringSchedulingIgnoredDuringExecution/topologyKey.mdx" +import PartialNamespaceselectorreference from "./requiredDuringSchedulingIgnoredDuringExecution/namespaceSelector_reference.mdx" +import PartialMatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/matchLabelKeys.mdx" +import PartialMismatchlabelkeys from "./requiredDuringSchedulingIgnoredDuringExecution/mismatchLabelKeys.mdx" + + +
+ + +########### `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-labelSelector} + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + +
+ + + + + + + + + +
+ + +########### `namespaceSelector` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution-namespaceSelector} + +A label query over the set of namespaces that the term applies to. +The term is applied to the union of the namespaces selected by this field +and the ones listed in the namespaces field. +null selector and null or empty namespaces list means "this pod's namespace". +An empty selector ({}) matches all namespaces. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity_reference.mdx new file mode 100755 index 000000000..817e626ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity/podAntiAffinity_reference.mdx @@ -0,0 +1,48 @@ + +import PartialRequiredduringschedulingignoredduringexecutionreference from "./podAntiAffinity/requiredDuringSchedulingIgnoredDuringExecution_reference.mdx" +import PartialPreferredduringschedulingignoredduringexecutionreference from "./podAntiAffinity/preferredDuringSchedulingIgnoredDuringExecution_reference.mdx" + + +
+ + +########## `requiredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-requiredDuringSchedulingIgnoredDuringExecution} + +If the anti-affinity requirements specified by this field are not met at +scheduling time, the pod will not be scheduled onto the node. +If the anti-affinity requirements specified by this field cease to be met +at some point during pod execution (e.g. due to a pod label update), the +system may or may not try to eventually evict the pod from its node. +When there are multiple elements, the lists of nodes corresponding to each +podAffinityTerm are intersected, i.e. all terms must be satisfied. + + + + + + +
+ + + +
+ + +########## `preferredDuringSchedulingIgnoredDuringExecution` required object[] {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity-preferredDuringSchedulingIgnoredDuringExecution} + +The scheduler will prefer to schedule pods to nodes that satisfy +the anti-affinity expressions specified by this field, but it may choose +a node that violates one or more of the expressions. The node that is +most preferred is the one with the greatest sum of weights, i.e. +for each node that meets all of the scheduling requirements (resource +request, requiredDuringScheduling anti-affinity expressions, etc.), +compute a sum by iterating through the elements of this field and adding +"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the +node(s) with the highest sum are the most preferred. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity_reference.mdx new file mode 100755 index 000000000..d159ddc3e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/affinity_reference.mdx @@ -0,0 +1,51 @@ + +import PartialNodeaffinityreference from "./affinity/nodeAffinity_reference.mdx" +import PartialPodaffinityreference from "./affinity/podAffinity_reference.mdx" +import PartialPodantiaffinityreference from "./affinity/podAntiAffinity_reference.mdx" + + +
+ + +######### `nodeAffinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-nodeAffinity} + +Describes node affinity scheduling rules for the pod. + + + + + + +
+ + + +
+ + +######### `podAffinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAffinity} + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
+ + + +
+ + +######### `podAntiAffinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity-podAntiAffinity} + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/automountServiceAccountToken.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/automountServiceAccountToken.mdx new file mode 100755 index 000000000..d936d2390 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/automountServiceAccountToken.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `automountServiceAccountToken` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-automountServiceAccountToken} + +AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers.mdx new file mode 100755 index 000000000..e915b41fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers.mdx @@ -0,0 +1,20 @@ + +import PartialContainersreference from "./containers_reference.mdx" + + +
+ + +######## `containers` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers} + +List of containers belonging to the pod. +Containers cannot currently be added or removed. +There must be at least one container in a Pod. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/args.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/args.mdx new file mode 100755 index 000000000..dc4fa7fd8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/args.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `args` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/command.mdx new file mode 100755 index 000000000..c005a5cc8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/command.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env.mdx new file mode 100755 index 000000000..7f3e3da71 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +######### `env` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/name.mdx new file mode 100755 index 000000000..6f972c838 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/value.mdx new file mode 100755 index 000000000..eb6ebc6ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +########## `value` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom.mdx new file mode 100755 index 000000000..3c5f8dc08 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +########## `valueFrom` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..9ce17a079 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +########### `configMapKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..ec5e7fb11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `key` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..064513860 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..51a8f4ec6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..b4174a44f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..eae50374f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..51e8f10eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `fieldPath` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..29bec5273 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..9766804c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `containerName` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..0313b6560 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..060cea700 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Format` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..aee6ef047 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `resource` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..178afe07c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..c6eac4c5a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +########### `secretKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..64713c35c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `key` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..638e7a90a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..b275908f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom_reference.mdx new file mode 100755 index 000000000..616c6cc0a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +########### `configMapKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +########### `secretKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom.mdx new file mode 100755 index 000000000..73d7b785c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +######### `envFrom` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef.mdx new file mode 100755 index 000000000..cd9c507a7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +########## `configMapRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..ed38e270f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..f0ab1bc9e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/prefix.mdx new file mode 100755 index 000000000..255359ec5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `prefix` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef.mdx new file mode 100755 index 000000000..846297458 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..2fe522bdc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..85fed5e52 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom_reference.mdx new file mode 100755 index 000000000..e74d47bcc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +########## `configMapRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env_reference.mdx new file mode 100755 index 000000000..88f6ffe0b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +########## `valueFrom` required {#controlPlane-coredns-deployment-spec-template-spec-containers-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/image.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/image.mdx new file mode 100755 index 000000000..382e507a7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/image.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `image` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/imagePullPolicy.mdx new file mode 100755 index 000000000..91a2ee391 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `imagePullPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle.mdx new file mode 100755 index 000000000..9a10cce3c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +######### `lifecycle` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart.mdx new file mode 100755 index 000000000..82c99e006 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +########## `postStart` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..d438ac6a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..82e2ee317 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..a2b917dd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..812835ec1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..42d505e88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..e49dbfd4a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..3859cdb17 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `value` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..8e1eb56e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..43bd1e10b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..faeb2e585 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..7be3c7c31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..4855f68c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..a1c319f6b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..e97e33b1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..ff580fc4c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..1d4640136 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `seconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..4c994b44c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..52f00ea7f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..d7dc96d3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..43843c3b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..2b8cd6dad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..a7ee45dea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..e1d0d21c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..3834242b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop.mdx new file mode 100755 index 000000000..97d46e27e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +########## `preStop` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..7988a94a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..3138da9ba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..44410e3ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..bca27e3d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..5ed558b46 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..5a698bd4e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..1716ef931 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `value` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..9ea54a9dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..f9a3fdcac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..69be95d32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..6227321e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..6151ae715 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..e98e5ef39 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..a03c25df9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..30486f5c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..8433019cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `seconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..a79003f25 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..25d857524 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..bc9ef25f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..3e53bcd15 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..88f6272fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..09de8832a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..12c4f9526 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..e7e117af3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle_reference.mdx new file mode 100755 index 000000000..6e8ea2b63 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +########## `postStart` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +########## `preStop` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe.mdx new file mode 100755 index 000000000..97af6316a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +######### `livenessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec.mdx new file mode 100755 index 000000000..113912e61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..ee557c10c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..034cd815e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc.mdx new file mode 100755 index 000000000..480b841d3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..0ea089b46 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..a8d69a29d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..a04956eeb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..a719819cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..039146431 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..6688317db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..637836759 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..d5a23e85f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..83310a070 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..8dd7b55c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..6cc1ef2cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..e1f7dbd0b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..19880a749 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..b008cc5cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..44a209d0f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..21990ee19 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..316c4694f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..c6ac836a4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..dca226d73 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..66ae57e71 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..0d42bfa81 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..364ad2669 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..059ad9ad2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..5626550b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..9b5791bfc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..ba07ac985 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe_reference.mdx new file mode 100755 index 000000000..0f6b57b1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/name.mdx new file mode 100755 index 000000000..fccd52ce4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports.mdx new file mode 100755 index 000000000..9057cb1f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +######### `ports` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/containerPort.mdx new file mode 100755 index 000000000..9527f2a00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `containerPort` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/hostIP.mdx new file mode 100755 index 000000000..7b88802b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `hostIP` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/hostPort.mdx new file mode 100755 index 000000000..b4d369db0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `hostPort` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/name.mdx new file mode 100755 index 000000000..cb171383b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/protocol.mdx new file mode 100755 index 000000000..d353b8c28 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `protocol` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe.mdx new file mode 100755 index 000000000..105297dd4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +######### `readinessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec.mdx new file mode 100755 index 000000000..181798ced --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..740d6e60e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..c44e60fa8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc.mdx new file mode 100755 index 000000000..2c98acfbc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..0b9199987 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..f54e66970 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..4e4a0b615 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..714317a20 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..b3ffe900c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..d780e6112 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..66494a176 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..fd13db66f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..a04fd1e45 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..ed0501a7e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..df4994f4c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..6c3223d31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..cbff9c1ea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..0c06a64ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..2df0ee03a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..a227b4698 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..59d62e692 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..50ed3a84d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..849048257 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..f4e0ad197 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..d4753278e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..26feec38a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..834b69bbf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..5ecd77989 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..e9b10ce44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..920fcfabb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe_reference.mdx new file mode 100755 index 000000000..408b2379b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy.mdx new file mode 100755 index 000000000..ee644ed76 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +######### `resizePolicy` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..9f7459b32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `resourceName` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..a39bfa543 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `restartPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources.mdx new file mode 100755 index 000000000..08072606b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +######### `resources` required {#controlPlane-coredns-deployment-spec-template-spec-containers-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims.mdx new file mode 100755 index 000000000..430de4686 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +########## `claims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims/name.mdx new file mode 100755 index 000000000..ff54f48e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/limits.mdx new file mode 100755 index 000000000..4c4289f34 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +########## `limits` required {#controlPlane-coredns-deployment-spec-template-spec-containers-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/requests.mdx new file mode 100755 index 000000000..e3bb31583 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +########## `requests` required {#controlPlane-coredns-deployment-spec-template-spec-containers-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources_reference.mdx new file mode 100755 index 000000000..95a9cdd18 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +########## `limits` required {#controlPlane-coredns-deployment-spec-template-spec-containers-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +########## `requests` required {#controlPlane-coredns-deployment-spec-template-spec-containers-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +########## `claims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/restartPolicy.mdx new file mode 100755 index 000000000..a4fb7bbe1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +######### `restartPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext.mdx new file mode 100755 index 000000000..4de16fc10 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +######### `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..b70628220 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +########## `allowPrivilegeEscalation` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities.mdx new file mode 100755 index 000000000..79f180f7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +########## `capabilities` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..0b6f6ff39 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `add` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..97a5710e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `drop` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/privileged.mdx new file mode 100755 index 000000000..0285ad5c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `privileged` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/procMount.mdx new file mode 100755 index 000000000..533f6e002 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `procMount` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..7357df130 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnlyRootFilesystem` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..8b395690b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `runAsGroup` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..6a83101cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +########## `runAsNonRoot` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsUser.mdx new file mode 100755 index 000000000..b5f94a77d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `runAsUser` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..7c9bf20aa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +########## `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..e498b3ab1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `level` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..6a9ce8fc7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `role` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..57aa0bff6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `type` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..0f6332068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `user` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..df7d78194 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +########## `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..49f11530d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `localhostProfile` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..56ea1ee12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +########### `type` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..023b2607a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +########## `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..053cfca0e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `gmsaCredentialSpec` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..a930732c2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `gmsaCredentialSpecName` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..572984435 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `hostProcess` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..7a94eba55 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `runAsUserName` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext_reference.mdx new file mode 100755 index 000000000..8ad80652c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +########## `capabilities` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +########## `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +########## `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +########## `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe.mdx new file mode 100755 index 000000000..6c901c161 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +######### `startupProbe` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec.mdx new file mode 100755 index 000000000..ceb864204 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec/command.mdx new file mode 100755 index 000000000..ad3afacf9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..5b1c9a2d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc.mdx new file mode 100755 index 000000000..134c3897c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..e7fa0d960 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..0758ded9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet.mdx new file mode 100755 index 000000000..95721f9d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..9cc9babbd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..f0e258e68 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..e273cea53 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..7dd88e8b6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..91adb96de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..3363a4daa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..36524df9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..c89333e4c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..b84d68208 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..c5c88be2e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..e32bfe3bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..940631961 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..53638715f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..e4c086c1a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..1b056fd02 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..06af42b5e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..b23c27b20 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..9e087c89b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..8067da5e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..d5d82e0b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..aece00229 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..d37f746c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..a1dc3150e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe_reference.mdx new file mode 100755 index 000000000..ee62ac2c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/stdin.mdx new file mode 100755 index 000000000..35296cbeb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `stdin` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/stdinOnce.mdx new file mode 100755 index 000000000..fcfc7960e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `stdinOnce` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/terminationMessagePath.mdx new file mode 100755 index 000000000..266251d75 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `terminationMessagePath` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/terminationMessagePolicy.mdx new file mode 100755 index 000000000..525593a03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `terminationMessagePolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/tty.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/tty.mdx new file mode 100755 index 000000000..dd6158da7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `tty` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices.mdx new file mode 100755 index 000000000..63aec43e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +######### `volumeDevices` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..a737ed0c8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `devicePath` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices/name.mdx new file mode 100755 index 000000000..94671f2d1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts.mdx new file mode 100755 index 000000000..798de38cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +######### `volumeMounts` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..d32008b33 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `mountPath` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..196a6bfb9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `mountPropagation` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/name.mdx new file mode 100755 index 000000000..e98be072c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..dcd342c25 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/subPath.mdx new file mode 100755 index 000000000..27e4e89d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `subPath` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..053d10bb4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `subPathExpr` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/workingDir.mdx new file mode 100755 index 000000000..febe1a13a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `workingDir` required string {#controlPlane-coredns-deployment-spec-template-spec-containers-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers_reference.mdx new file mode 100755 index 000000000..91ebad777 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/containers_reference.mdx @@ -0,0 +1,282 @@ + +import PartialName from "./containers/name.mdx" +import PartialImage from "./containers/image.mdx" +import PartialCommand from "./containers/command.mdx" +import PartialArgs from "./containers/args.mdx" +import PartialWorkingdir from "./containers/workingDir.mdx" +import PartialPortsreference from "./containers/ports_reference.mdx" +import PartialEnvfromreference from "./containers/envFrom_reference.mdx" +import PartialEnvreference from "./containers/env_reference.mdx" +import PartialResourcesreference from "./containers/resources_reference.mdx" +import PartialResizepolicyreference from "./containers/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./containers/restartPolicy.mdx" +import PartialVolumemountsreference from "./containers/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./containers/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./containers/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./containers/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./containers/startupProbe_reference.mdx" +import PartialLifecyclereference from "./containers/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./containers/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./containers/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./containers/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./containers/securityContext_reference.mdx" +import PartialStdin from "./containers/stdin.mdx" +import PartialStdinonce from "./containers/stdinOnce.mdx" +import PartialTty from "./containers/tty.mdx" + + + + + + + + + + + + + + + + + +
+ + +######### `ports` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-ports} + +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. + + + + + + +
+ + + +
+ + +######### `envFrom` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-envFrom} + +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. + + + + + + +
+ + + +
+ + +######### `env` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +######### `resources` required {#controlPlane-coredns-deployment-spec-template-spec-containers-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +######### `resizePolicy` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +######### `volumeMounts` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +######### `volumeDevices` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +######### `livenessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-containers-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +######### `readinessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-containers-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +######### `startupProbe` required {#controlPlane-coredns-deployment-spec-template-spec-containers-startupProbe} + +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 + + + + + + +
+ + + +
+ + +######### `lifecycle` required {#controlPlane-coredns-deployment-spec-template-spec-containers-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +######### `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-containers-securityContext} + +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/ + + + + + + +
+ + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig.mdx new file mode 100755 index 000000000..554952499 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig.mdx @@ -0,0 +1,19 @@ + +import PartialDnsconfigreference from "./dnsConfig_reference.mdx" + + +
+ + +######## `dnsConfig` required {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig} + +Specifies the DNS parameters of a pod. +Parameters specified here will be merged to the generated DNS +configuration based on DNSPolicy. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/nameservers.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/nameservers.mdx new file mode 100755 index 000000000..caa26622e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/nameservers.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `nameservers` required string[] {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig-nameservers} + +A list of DNS name server IP addresses. +This will be appended to the base nameservers generated from DNSPolicy. +Duplicated nameservers will be removed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options.mdx new file mode 100755 index 000000000..bdd246c55 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options.mdx @@ -0,0 +1,20 @@ + +import PartialOptionsreference from "./options_reference.mdx" + + +
+ + +######### `options` required object[] {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig-options} + +A list of DNS resolver options. +This will be merged with the base options generated from DNSPolicy. +Duplicated entries will be removed. Resolution options given in Options +will override those that appear in the base DNSPolicy. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options/name.mdx new file mode 100755 index 000000000..dbb5051f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig-options-name} + +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options/value.mdx new file mode 100755 index 000000000..116e3832e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig-options-value} + ++optional + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options_reference.mdx new file mode 100755 index 000000000..e6c27d8e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/options_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./options/name.mdx" +import PartialValue from "./options/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/searches.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/searches.mdx new file mode 100755 index 000000000..ec254ab26 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig/searches.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `searches` required string[] {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig-searches} + +A list of DNS search domains for host-name lookup. +This will be appended to the base search paths generated from DNSPolicy. +Duplicated search paths will be removed. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig_reference.mdx new file mode 100755 index 000000000..d6035aa04 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsConfig_reference.mdx @@ -0,0 +1,28 @@ + +import PartialNameservers from "./dnsConfig/nameservers.mdx" +import PartialSearches from "./dnsConfig/searches.mdx" +import PartialOptionsreference from "./dnsConfig/options_reference.mdx" + + + + + + + + +
+ + +######### `options` required object[] {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig-options} + +A list of DNS resolver options. +This will be merged with the base options generated from DNSPolicy. +Duplicated entries will be removed. Resolution options given in Options +will override those that appear in the base DNSPolicy. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsPolicy.mdx new file mode 100755 index 000000000..e7197cb13 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/dnsPolicy.mdx @@ -0,0 +1,18 @@ + +
+ + +######## `dnsPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-dnsPolicy} + +Set DNS policy for the pod. +Defaults to "ClusterFirst". +Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. +DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. +To have DNS options set along with hostNetwork, you have to specify DNS policy +explicitly to 'ClusterFirstWithHostNet'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/enableServiceLinks.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/enableServiceLinks.mdx new file mode 100755 index 000000000..8f4c2fca7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/enableServiceLinks.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `enableServiceLinks` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-enableServiceLinks} + +EnableServiceLinks indicates whether information about services should be injected into pod's +environment variables, matching the syntax of Docker links. +Optional: Defaults to true. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers.mdx new file mode 100755 index 000000000..71e3d00a7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers.mdx @@ -0,0 +1,20 @@ + +import PartialEphemeralcontainersreference from "./ephemeralContainers_reference.mdx" + + +
+ + +######## `ephemeralContainers` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers} + +List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing +pod to perform user-initiated actions such as debugging. This list cannot be specified when +creating a pod, and it cannot be modified by updating the pod spec. In order to add an +ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/args.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/args.mdx new file mode 100755 index 000000000..8be60f5f8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/args.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `args` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/command.mdx new file mode 100755 index 000000000..5ae9f7fe5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/command.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env.mdx new file mode 100755 index 000000000..811432414 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +######### `env` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/name.mdx new file mode 100755 index 000000000..3ea62f5ec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/value.mdx new file mode 100755 index 000000000..3e122b7a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +########## `value` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom.mdx new file mode 100755 index 000000000..6ba0de51d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +########## `valueFrom` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..d70475b77 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +########### `configMapKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..f64186aad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `key` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..04d37d9e6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..5e1f4fb11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..37cf69a08 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..ad0d21b43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..1d299b250 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `fieldPath` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..ae2fa5390 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..c0a7d3202 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `containerName` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..240eee95d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..81e02a1c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Format` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..20f37c08f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `resource` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..4499d1da2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..ff9e7f569 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +########### `secretKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..16f22ce91 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `key` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..ea2853625 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..bb348cf5f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom_reference.mdx new file mode 100755 index 000000000..258cfacb5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +########### `configMapKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +########### `secretKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom.mdx new file mode 100755 index 000000000..bfa9c0925 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +######### `envFrom` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef.mdx new file mode 100755 index 000000000..fa32d0865 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +########## `configMapRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..1ade72ae5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..688fb5011 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/prefix.mdx new file mode 100755 index 000000000..ec199b319 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `prefix` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef.mdx new file mode 100755 index 000000000..d9ce91ddd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..31b209b1a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..dc95704a7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom_reference.mdx new file mode 100755 index 000000000..2e7e298d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +########## `configMapRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env_reference.mdx new file mode 100755 index 000000000..49f401941 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +########## `valueFrom` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/image.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/image.mdx new file mode 100755 index 000000000..7901616bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/image.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `image` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-image} + +Container image name. +More info: https://kubernetes.io/docs/concepts/containers/images + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/imagePullPolicy.mdx new file mode 100755 index 000000000..514938e92 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `imagePullPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle.mdx new file mode 100755 index 000000000..dc65c3049 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle.mdx @@ -0,0 +1,17 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +######### `lifecycle` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle} + +Lifecycle is not allowed for ephemeral containers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart.mdx new file mode 100755 index 000000000..5a889b21f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +########## `postStart` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..394be11d3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..9aaacfde4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..e0952410d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..e933892dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..214f2c9cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..b6f355212 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..8f10909df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `value` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..6d2e633bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..201e52e60 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..f32273952 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..ef2423017 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..eb13b7d11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..75531d06a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..0b0a2f94c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..15cbe3004 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..920a6368f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `seconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..1cf02862a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..6cd66e1bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..6920b9d42 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..ce69c12e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..fa05080ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..030a2a1cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..0d1514232 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..fa4532415 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop.mdx new file mode 100755 index 000000000..af9ade07c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +########## `preStop` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..42a1b3b31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..d49d19720 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..1a6c343b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..7c87c378c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..dcff6eee2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..aba86f83b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..54c14e4cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `value` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..f732c5b9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..5a146e260 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..a797cb9b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..05b9d63bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..4c868b1e3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..76708f0b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..5566e9a76 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..db1192dc4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..d9a1fe738 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `seconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..9c48d4bf6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..fc085271e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..3b084fe00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..1c105d81f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..cfbd52c39 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..67a03803d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..84fbffa26 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..b3647a233 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle_reference.mdx new file mode 100755 index 000000000..48792dd9a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +########## `postStart` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +########## `preStop` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe.mdx new file mode 100755 index 000000000..b1e6aa324 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe.mdx @@ -0,0 +1,17 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +######### `livenessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe} + +Probes are not allowed for ephemeral containers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec.mdx new file mode 100755 index 000000000..c0e988afe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..cbea316e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..6f6733082 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc.mdx new file mode 100755 index 000000000..f190f735b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..e9af35185 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..230a216aa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..d3db55848 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..b3419c302 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..56c9418b1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..ad51339df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..ab4cf1bdf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..a9f6fb27a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..49c690832 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..7ad18d850 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..c02a620ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..56b278666 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..9c16c3c89 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..958fe3689 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..4e2140695 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..cee97a77a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..833da2e32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..0a4599c7a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..748ea047f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..3e078ef8d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..eba3d826f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..f3b849c10 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..c84acd865 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..184b73552 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..f4b087d4a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..1a1c89d66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe_reference.mdx new file mode 100755 index 000000000..7fe2f1719 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/name.mdx new file mode 100755 index 000000000..3961a3d7f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-name} + +Name of the ephemeral container specified as a DNS_LABEL. +This name must be unique among all containers, init containers and ephemeral containers. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports.mdx new file mode 100755 index 000000000..58c226107 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports.mdx @@ -0,0 +1,17 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +######### `ports` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-ports} + +Ports are not allowed for ephemeral containers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/containerPort.mdx new file mode 100755 index 000000000..a8cfd0eca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `containerPort` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/hostIP.mdx new file mode 100755 index 000000000..6f47f6a23 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `hostIP` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/hostPort.mdx new file mode 100755 index 000000000..db072a4e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `hostPort` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/name.mdx new file mode 100755 index 000000000..3154eafda --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/protocol.mdx new file mode 100755 index 000000000..9e3fa1a3d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `protocol` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe.mdx new file mode 100755 index 000000000..97ed36437 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe.mdx @@ -0,0 +1,17 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +######### `readinessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe} + +Probes are not allowed for ephemeral containers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec.mdx new file mode 100755 index 000000000..67cf4ed1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..4ca49eb4c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..fbcdb2602 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc.mdx new file mode 100755 index 000000000..7e19e2ce0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..f8079306c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..6840352ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..596f2853a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..ee5635c88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..bad1cb3ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..8b6a4157d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..32ea589cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..89e1929ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..f02a0e502 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..a9939d78d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..0986bfa23 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..036383592 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..47f9fb809 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..c951cd2a3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..6f6e37d43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..0d107fa43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..b18433b8b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..fb088d476 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..7bfac8420 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..2926a5f7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..8ded5108a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..e97100f75 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..68e0e0833 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..5c6670ec9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..2b2dc8585 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..ab24a0c77 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe_reference.mdx new file mode 100755 index 000000000..0705d0ed5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy.mdx new file mode 100755 index 000000000..aa3a9438d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +######### `resizePolicy` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..7b2e8fce6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `resourceName` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..a2ff58c99 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `restartPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources.mdx new file mode 100755 index 000000000..d29f8a8ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources.mdx @@ -0,0 +1,18 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +######### `resources` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources} + +Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources +already allocated to the pod. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims.mdx new file mode 100755 index 000000000..2b1caff9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +########## `claims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims/name.mdx new file mode 100755 index 000000000..f8318d43b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/limits.mdx new file mode 100755 index 000000000..2829fd617 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +########## `limits` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/requests.mdx new file mode 100755 index 000000000..a7e620bd2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +########## `requests` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources_reference.mdx new file mode 100755 index 000000000..3927356e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +########## `limits` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +########## `requests` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +########## `claims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/restartPolicy.mdx new file mode 100755 index 000000000..8ccd8692a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/restartPolicy.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `restartPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext.mdx new file mode 100755 index 000000000..39d53d31c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext.mdx @@ -0,0 +1,18 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +######### `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..c68ecd614 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +########## `allowPrivilegeEscalation` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities.mdx new file mode 100755 index 000000000..75e3578cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +########## `capabilities` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..3a41b1884 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `add` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..93fc1761f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `drop` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/privileged.mdx new file mode 100755 index 000000000..ca92765de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `privileged` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/procMount.mdx new file mode 100755 index 000000000..94c7e041d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `procMount` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..1f34003e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnlyRootFilesystem` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..e8deff6a3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `runAsGroup` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..a50d2d24a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +########## `runAsNonRoot` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsUser.mdx new file mode 100755 index 000000000..7e9a0e646 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `runAsUser` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..6ddd7ae52 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +########## `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..e497c5663 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `level` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..4d27c1621 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `role` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..9a7b66133 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `type` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..f845bfeaa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `user` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..81edc01c4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +########## `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..cc8129b4c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `localhostProfile` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..e8ff8bc5d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +########### `type` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..42cee5881 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +########## `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..bc16bcf47 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `gmsaCredentialSpec` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..d0a9d0fd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `gmsaCredentialSpecName` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..6fe67c9f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `hostProcess` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..c2f5b3eec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `runAsUserName` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext_reference.mdx new file mode 100755 index 000000000..07f151ea2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +########## `capabilities` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +########## `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +########## `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +########## `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe.mdx new file mode 100755 index 000000000..d59818f93 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe.mdx @@ -0,0 +1,17 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +######### `startupProbe` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe} + +Probes are not allowed for ephemeral containers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec.mdx new file mode 100755 index 000000000..a2e31848e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec/command.mdx new file mode 100755 index 000000000..f5e136d59 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..001114fa3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc.mdx new file mode 100755 index 000000000..4be81f5a1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..35c3f9863 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..0cea18bd9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet.mdx new file mode 100755 index 000000000..db67c7751 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..594627fde --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..12104430e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..7ddf06299 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..3c3306f2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..693d8d9ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..f10bba09d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..8b3ea5fe9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..dd5b13548 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..c78fa4927 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..003a1e847 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..3f899a54f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..5a8374291 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..0ff7561b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..949dadceb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..bb5ada654 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..e8bd6c99a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..299ac9771 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..530b28a95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..9e76b28f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..5ae876149 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..ec9a0cb1e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..65e60d6de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..b9e0a38e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe_reference.mdx new file mode 100755 index 000000000..e554cd25f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/stdin.mdx new file mode 100755 index 000000000..d8798f65b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `stdin` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/stdinOnce.mdx new file mode 100755 index 000000000..d322f4b2c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `stdinOnce` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/targetContainerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/targetContainerName.mdx new file mode 100755 index 000000000..ce85ae62c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/targetContainerName.mdx @@ -0,0 +1,18 @@ + +
+ + +######### `targetContainerName` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-targetContainerName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/terminationMessagePath.mdx new file mode 100755 index 000000000..b967e1cb0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `terminationMessagePath` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/terminationMessagePolicy.mdx new file mode 100755 index 000000000..d22b85891 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `terminationMessagePolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/tty.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/tty.mdx new file mode 100755 index 000000000..462165b64 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `tty` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices.mdx new file mode 100755 index 000000000..0d87c243a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +######### `volumeDevices` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..13328ab25 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `devicePath` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices/name.mdx new file mode 100755 index 000000000..d9786fa0d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts.mdx new file mode 100755 index 000000000..c675e7b91 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +######### `volumeMounts` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts} + +Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..ec7042fd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `mountPath` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..4dfa96dbf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `mountPropagation` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/name.mdx new file mode 100755 index 000000000..28e9a2be3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..c71920172 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/subPath.mdx new file mode 100755 index 000000000..056cd5f95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `subPath` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..70f6b65f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `subPathExpr` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/workingDir.mdx new file mode 100755 index 000000000..1b6554d31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `workingDir` required string {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers_reference.mdx new file mode 100755 index 000000000..772a9fe60 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/ephemeralContainers_reference.mdx @@ -0,0 +1,265 @@ + +import PartialName from "./ephemeralContainers/name.mdx" +import PartialImage from "./ephemeralContainers/image.mdx" +import PartialCommand from "./ephemeralContainers/command.mdx" +import PartialArgs from "./ephemeralContainers/args.mdx" +import PartialWorkingdir from "./ephemeralContainers/workingDir.mdx" +import PartialPortsreference from "./ephemeralContainers/ports_reference.mdx" +import PartialEnvfromreference from "./ephemeralContainers/envFrom_reference.mdx" +import PartialEnvreference from "./ephemeralContainers/env_reference.mdx" +import PartialResourcesreference from "./ephemeralContainers/resources_reference.mdx" +import PartialResizepolicyreference from "./ephemeralContainers/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./ephemeralContainers/restartPolicy.mdx" +import PartialVolumemountsreference from "./ephemeralContainers/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./ephemeralContainers/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./ephemeralContainers/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./ephemeralContainers/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./ephemeralContainers/startupProbe_reference.mdx" +import PartialLifecyclereference from "./ephemeralContainers/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./ephemeralContainers/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./ephemeralContainers/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./ephemeralContainers/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./ephemeralContainers/securityContext_reference.mdx" +import PartialStdin from "./ephemeralContainers/stdin.mdx" +import PartialStdinonce from "./ephemeralContainers/stdinOnce.mdx" +import PartialTty from "./ephemeralContainers/tty.mdx" +import PartialTargetcontainername from "./ephemeralContainers/targetContainerName.mdx" + + + + + + + + + + + + + + + + + +
+ + +######### `ports` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-ports} + +Ports are not allowed for ephemeral containers. + + + + + + +
+ + + +
+ + +######### `envFrom` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-envFrom} + +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. + + + + + + +
+ + + +
+ + +######### `env` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +######### `resources` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resources} + +Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources +already allocated to the pod. + + + + + + +
+ + + +
+ + +######### `resizePolicy` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +######### `volumeMounts` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeMounts} + +Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. +Cannot be updated. + + + + + + +
+ + + +
+ + +######### `volumeDevices` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +######### `livenessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-livenessProbe} + +Probes are not allowed for ephemeral containers. + + + + + + +
+ + + +
+ + +######### `readinessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-readinessProbe} + +Probes are not allowed for ephemeral containers. + + + + + + +
+ + + +
+ + +######### `startupProbe` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-startupProbe} + +Probes are not allowed for ephemeral containers. + + + + + + +
+ + + +
+ + +######### `lifecycle` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-lifecycle} + +Lifecycle is not allowed for ephemeral containers. + + + + + + +
+ + + + + + + + + + + + +
+ + +######### `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers-securityContext} + +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. + + + + + + +
+ + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases.mdx new file mode 100755 index 000000000..9acee87c4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases.mdx @@ -0,0 +1,18 @@ + +import PartialHostaliasesreference from "./hostAliases_reference.mdx" + + +
+ + +######## `hostAliases` required object[] {#controlPlane-coredns-deployment-spec-template-spec-hostAliases} + +HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts +file if specified. This is only valid for non-hostNetwork pods. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases/hostnames.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases/hostnames.mdx new file mode 100755 index 000000000..8094ce0a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases/hostnames.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `hostnames` required string[] {#controlPlane-coredns-deployment-spec-template-spec-hostAliases-hostnames} + +Hostnames for the above IP address. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases/ip.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases/ip.mdx new file mode 100755 index 000000000..c1be510da --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases/ip.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `ip` required string {#controlPlane-coredns-deployment-spec-template-spec-hostAliases-ip} + +IP address of the host file entry. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases_reference.mdx new file mode 100755 index 000000000..0a9d552c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostAliases_reference.mdx @@ -0,0 +1,8 @@ + +import PartialIp from "./hostAliases/ip.mdx" +import PartialHostnames from "./hostAliases/hostnames.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostIPC.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostIPC.mdx new file mode 100755 index 000000000..3d40f8061 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostIPC.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `hostIPC` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-hostIPC} + +Use the host's ipc namespace. +Optional: Default to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostNetwork.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostNetwork.mdx new file mode 100755 index 000000000..7d2ef1aba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostNetwork.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `hostNetwork` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-hostNetwork} + +Host networking requested for this pod. Use the host's network namespace. +If this option is set, the ports that will be used must be specified. +Default to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostPID.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostPID.mdx new file mode 100755 index 000000000..63be92afc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostPID.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `hostPID` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-hostPID} + +Use the host's pid namespace. +Optional: Default to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostUsers.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostUsers.mdx new file mode 100755 index 000000000..917674bd9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostUsers.mdx @@ -0,0 +1,21 @@ + +
+ + +######## `hostUsers` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-hostUsers} + +Use the host's user namespace. +Optional: Default to true. +If set to true or not present, the pod will be run in the host user namespace, useful +for when the pod needs a feature only available to the host user namespace, such as +loading a kernel module with CAP_SYS_MODULE. +When set to false, a new userns is created for the pod. Setting false is useful for +mitigating container breakout vulnerabilities even allowing users to run their +containers as root without actually having root privileges on the host. +This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostname.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostname.mdx new file mode 100755 index 000000000..74f53d9b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/hostname.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `hostname` required string {#controlPlane-coredns-deployment-spec-template-spec-hostname} + +Specifies the hostname of the Pod +If not specified, the pod's hostname will be set to a system-defined value. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets.mdx new file mode 100755 index 000000000..b0549f3dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets.mdx @@ -0,0 +1,19 @@ + +import PartialImagepullsecretsreference from "./imagePullSecrets_reference.mdx" + + +
+ + +######## `imagePullSecrets` required object[] {#controlPlane-coredns-deployment-spec-template-spec-imagePullSecrets} + +ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. +If specified, these secrets will be passed to individual puller implementations for them to use. +More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets/name.mdx new file mode 100755 index 000000000..d58e43c57 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-imagePullSecrets-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets_reference.mdx new file mode 100755 index 000000000..b667edd40 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/imagePullSecrets_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./imagePullSecrets/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers.mdx new file mode 100755 index 000000000..afbac667f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers.mdx @@ -0,0 +1,29 @@ + +import PartialInitcontainersreference from "./initContainers_reference.mdx" + + +
+ + +######## `initContainers` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers} + +List of initialization containers belonging to the pod. +Init containers are executed in order prior to containers being started. If any +init container fails, the pod is considered to have failed and is handled according +to its restartPolicy. The name for an init container or normal container must be +unique among all containers. +Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. +The resourceRequirements of an init container are taken into account during scheduling +by finding the highest request/limit for each resource type, and then using the max of +of that value or the sum of the normal containers. Limits are applied to init containers +in a similar fashion. +Init containers cannot currently be added or removed. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/args.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/args.mdx new file mode 100755 index 000000000..65838c16a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/args.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `args` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/command.mdx new file mode 100755 index 000000000..a50ecd0e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/command.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env.mdx new file mode 100755 index 000000000..1a0506154 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +######### `env` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/name.mdx new file mode 100755 index 000000000..76ed8fb3e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/value.mdx new file mode 100755 index 000000000..76c0a2c7c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +########## `value` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom.mdx new file mode 100755 index 000000000..a2fdafc4b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +########## `valueFrom` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..03f50a43c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +########### `configMapKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..58ca198dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `key` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..6ea80bbdf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..5d513eb9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..182ed0144 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..5a7ccd815 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..8d24a5cff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `fieldPath` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..ddf65fb88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..9baf0add6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `containerName` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..eeb13e2e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..e79b49a7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Format` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..51080fdf6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `resource` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..538773812 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..b10a5f935 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +########### `secretKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..0fa00bb59 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `key` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..8d7e2cabf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..e61f0f6fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom_reference.mdx new file mode 100755 index 000000000..2f6736e46 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +########### `configMapKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +########### `secretKeyRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom.mdx new file mode 100755 index 000000000..bc2eec787 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +######### `envFrom` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef.mdx new file mode 100755 index 000000000..433385b37 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +########## `configMapRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..30daa7bbc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..8cf9266f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/prefix.mdx new file mode 100755 index 000000000..e4fe1d7ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `prefix` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef.mdx new file mode 100755 index 000000000..06bd9f0b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..67357d61f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..abfaf3dec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom_reference.mdx new file mode 100755 index 000000000..388ed146f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +########## `configMapRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env_reference.mdx new file mode 100755 index 000000000..50719ade9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +########## `valueFrom` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/image.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/image.mdx new file mode 100755 index 000000000..b5e289aed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/image.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `image` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/imagePullPolicy.mdx new file mode 100755 index 000000000..956cebc6a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `imagePullPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle.mdx new file mode 100755 index 000000000..46996d469 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +######### `lifecycle` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart.mdx new file mode 100755 index 000000000..e6d9c7c67 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +########## `postStart` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..e1b21f53d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..04b7dddda --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..43abbf361 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..5dd118dbc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..f33d4c9e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..d70ef9c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..cd7c78978 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `value` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..258909d9d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..c6e4a69e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..8ef0c570d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..d39374768 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..b6d0747a4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..cb0597b19 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..b306820ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..eb55e8916 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..9457914eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `seconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..4e3639de7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..b162d91e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..f16ac5a30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..f92219b24 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..9854c4cfc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..e89b2a0d4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..4f299cbd2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..70393997b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop.mdx new file mode 100755 index 000000000..cc79cd2bc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +########## `preStop` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..8e864e94f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..927e8eff6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..e4a40560d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..6f291680a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..e1f10e408 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..46f73801a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..19e93bb32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `value` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..9feb87e6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..52858ae3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..7e4c0edd5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..c0bfdc3ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..faf89c9d1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..3aa8382bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..da5172e96 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +############ `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..535336c95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..3f8465c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `seconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..43b6e8b41 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..524043c80 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..af45dac98 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..500d95882 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..72144e26f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..6761c5c68 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..0772a2fa6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +############ `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..14b3a9ac1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +########### `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########### `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########### `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +########### `sleep` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle_reference.mdx new file mode 100755 index 000000000..ee2484ee4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +########## `postStart` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +########## `preStop` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe.mdx new file mode 100755 index 000000000..02770c07b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +######### `livenessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec.mdx new file mode 100755 index 000000000..7aab64867 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..04b9d4264 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..dc7aa53a1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc.mdx new file mode 100755 index 000000000..774079073 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..252c2093a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..a7de80ada --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..36372f3be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..16bd916ba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..fcfc25854 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..7d5c01457 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..8eb9d5f31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..0b4ec43b1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..b32fb5e50 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..82e2df0be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..490c9624c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..1e78111c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..96e48e547 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..d01fed7d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..51b55f31e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..5e2e4a836 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..b3cf3f782 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..256922569 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..d80555d2d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..861e1d2ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..b88e609a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..6cdb596b1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..e55dfd15a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..7207f5d6a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..53c86678f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..f0a5e473c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe_reference.mdx new file mode 100755 index 000000000..b8bcf6de4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/name.mdx new file mode 100755 index 000000000..99cfc949b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports.mdx new file mode 100755 index 000000000..39d698d96 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +######### `ports` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/containerPort.mdx new file mode 100755 index 000000000..9848aa6a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `containerPort` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/hostIP.mdx new file mode 100755 index 000000000..4b8604002 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `hostIP` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/hostPort.mdx new file mode 100755 index 000000000..63564e345 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `hostPort` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/name.mdx new file mode 100755 index 000000000..931e1e369 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/protocol.mdx new file mode 100755 index 000000000..4fc4735ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `protocol` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe.mdx new file mode 100755 index 000000000..51ae11a8a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +######### `readinessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec.mdx new file mode 100755 index 000000000..d3d8d39bc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..6299f471e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..22068c48f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc.mdx new file mode 100755 index 000000000..4b2203143 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..65fd30759 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..45b47efe9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..8528069e6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..6d8b4241a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..239f7ba3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..93d696b07 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..75a289a06 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..7771dbe6a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..d904d2b9a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..b280c3949 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..bdac5d8cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..41b33789e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..7b32c024d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..776f844ca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..3578c2577 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..788ca6d36 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..165357f93 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..b79337739 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..04ffbe8ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..86e5176e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..92ced844d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..d6d434ccc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..949809415 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..49f4c1f62 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..451c36bc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..e96af8445 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe_reference.mdx new file mode 100755 index 000000000..ccfcf2288 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy.mdx new file mode 100755 index 000000000..a6a0b93fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +######### `resizePolicy` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..fb986dd27 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `resourceName` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..1d51ef57f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `restartPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources.mdx new file mode 100755 index 000000000..16485c432 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +######### `resources` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims.mdx new file mode 100755 index 000000000..a8b8840b5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +########## `claims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims/name.mdx new file mode 100755 index 000000000..a96a5c1da --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/limits.mdx new file mode 100755 index 000000000..c216d1d0f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +########## `limits` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/requests.mdx new file mode 100755 index 000000000..d4ff7e794 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +########## `requests` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources_reference.mdx new file mode 100755 index 000000000..a48222db6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +########## `limits` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +########## `requests` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +########## `claims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/restartPolicy.mdx new file mode 100755 index 000000000..53d3431f6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +######### `restartPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext.mdx new file mode 100755 index 000000000..a9494fe81 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +######### `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..b249f496c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +########## `allowPrivilegeEscalation` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities.mdx new file mode 100755 index 000000000..9866d4164 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +########## `capabilities` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..4e626e3fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `add` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..1e78349c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `drop` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/privileged.mdx new file mode 100755 index 000000000..4f669f614 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `privileged` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/procMount.mdx new file mode 100755 index 000000000..072c285b4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `procMount` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..f7a3b8c0a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnlyRootFilesystem` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..6da356756 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `runAsGroup` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..a3d2a0f4e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +########## `runAsNonRoot` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsUser.mdx new file mode 100755 index 000000000..dbc143fbf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `runAsUser` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..3271167a3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +########## `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..5c2d76491 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `level` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..7eeea920e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `role` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..ea09163d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `type` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..3d88b3e0f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `user` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..865c0bb87 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +########## `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..22bb67fed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `localhostProfile` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..8e4c46d14 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +########### `type` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..9462dea2d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +########## `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..21f2e2a97 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `gmsaCredentialSpec` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..3fe45f085 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `gmsaCredentialSpecName` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..bc540bcdd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `hostProcess` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..47d20e03e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `runAsUserName` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext_reference.mdx new file mode 100755 index 000000000..c9a96deaf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +########## `capabilities` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +########## `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +########## `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +########## `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe.mdx new file mode 100755 index 000000000..ca3e1bf67 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +######### `startupProbe` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec.mdx new file mode 100755 index 000000000..4e4162a2e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec/command.mdx new file mode 100755 index 000000000..dbfa30ea3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +########### `command` required string[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..8bbad7872 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `failureThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc.mdx new file mode 100755 index 000000000..e990e649b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..ecc5feab4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `port` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..c8a8adb20 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `service` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet.mdx new file mode 100755 index 000000000..f8b245f35 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..da20af2ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..08bc245d2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..f97f29b2a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..7ac8e79ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `value` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..57d228dea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..5b39147c0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..f5500390a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..9a72a5444 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..bcd74b7f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..583fba0af --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `scheme` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..adf541817 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +########### `httpHeaders` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..d017fb8fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `initialDelaySeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..41c1ccf36 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `periodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..d89c81d94 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `successThreshold` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..bd840abad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..99b6f226d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `host` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..5938641e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..1019744dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `IntVal` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..ae93aed70 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `StrVal` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..b934ca82e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `Type` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..7dee58216 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +########### `port` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..da96a9a7e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +########## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..b664523ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `timeoutSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe_reference.mdx new file mode 100755 index 000000000..33e1bb2e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +########## `exec` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +########## `httpGet` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +########## `tcpSocket` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +########## `grpc` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/stdin.mdx new file mode 100755 index 000000000..761273266 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `stdin` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/stdinOnce.mdx new file mode 100755 index 000000000..7e981127e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `stdinOnce` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/terminationMessagePath.mdx new file mode 100755 index 000000000..4b5759b42 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `terminationMessagePath` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/terminationMessagePolicy.mdx new file mode 100755 index 000000000..5aa71b042 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `terminationMessagePolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/tty.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/tty.mdx new file mode 100755 index 000000000..43a779113 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `tty` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices.mdx new file mode 100755 index 000000000..ab566f10a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +######### `volumeDevices` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..f6508e11d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `devicePath` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices/name.mdx new file mode 100755 index 000000000..2d09d1c7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts.mdx new file mode 100755 index 000000000..f879fcfe4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +######### `volumeMounts` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..2ad60c50b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `mountPath` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..c4ffeda33 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `mountPropagation` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/name.mdx new file mode 100755 index 000000000..4cc561535 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..86d379347 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/subPath.mdx new file mode 100755 index 000000000..d0cb7827c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `subPath` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..a2d2e34c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `subPathExpr` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/workingDir.mdx new file mode 100755 index 000000000..77facd12d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `workingDir` required string {#controlPlane-coredns-deployment-spec-template-spec-initContainers-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers_reference.mdx new file mode 100755 index 000000000..768f1c27b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/initContainers_reference.mdx @@ -0,0 +1,282 @@ + +import PartialName from "./initContainers/name.mdx" +import PartialImage from "./initContainers/image.mdx" +import PartialCommand from "./initContainers/command.mdx" +import PartialArgs from "./initContainers/args.mdx" +import PartialWorkingdir from "./initContainers/workingDir.mdx" +import PartialPortsreference from "./initContainers/ports_reference.mdx" +import PartialEnvfromreference from "./initContainers/envFrom_reference.mdx" +import PartialEnvreference from "./initContainers/env_reference.mdx" +import PartialResourcesreference from "./initContainers/resources_reference.mdx" +import PartialResizepolicyreference from "./initContainers/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./initContainers/restartPolicy.mdx" +import PartialVolumemountsreference from "./initContainers/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./initContainers/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./initContainers/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./initContainers/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./initContainers/startupProbe_reference.mdx" +import PartialLifecyclereference from "./initContainers/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./initContainers/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./initContainers/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./initContainers/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./initContainers/securityContext_reference.mdx" +import PartialStdin from "./initContainers/stdin.mdx" +import PartialStdinonce from "./initContainers/stdinOnce.mdx" +import PartialTty from "./initContainers/tty.mdx" + + + + + + + + + + + + + + + + + +
+ + +######### `ports` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-ports} + +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. + + + + + + +
+ + + +
+ + +######### `envFrom` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-envFrom} + +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. + + + + + + +
+ + + +
+ + +######### `env` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +######### `resources` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +######### `resizePolicy` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +######### `volumeMounts` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +######### `volumeDevices` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +######### `livenessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +######### `readinessProbe` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +######### `startupProbe` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-startupProbe} + +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 + + + + + + +
+ + + +
+ + +######### `lifecycle` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +######### `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-initContainers-securityContext} + +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/ + + + + + + +
+ + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/nodeName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/nodeName.mdx new file mode 100755 index 000000000..cc79a5408 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/nodeName.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `nodeName` required string {#controlPlane-coredns-deployment-spec-template-spec-nodeName} + +NodeName is a request to schedule this pod onto a specific node. If it is non-empty, +the scheduler simply schedules this pod onto that node, assuming that it fits resource +requirements. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/nodeSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/nodeSelector.mdx new file mode 100755 index 000000000..21e3ebc54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/nodeSelector.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `nodeSelector` required object {#controlPlane-coredns-deployment-spec-template-spec-nodeSelector} + +NodeSelector is a selector which must be true for the pod to fit on a node. +Selector which must match a node's labels for the pod to be scheduled on that node. +More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os.mdx new file mode 100755 index 000000000..65342706c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os.mdx @@ -0,0 +1,44 @@ + +import PartialOsreference from "./os_reference.mdx" + + +
+ + +######## `os` required {#controlPlane-coredns-deployment-spec-template-spec-os} + +Specifies the OS of the containers in the pod. +Some pod and container fields are restricted if this is set. + +If the OS field is set to linux, the following fields must be unset: +-securityContext.windowsOptions + +If the OS field is set to windows, following fields must be unset: +- spec.hostPID +- spec.hostIPC +- spec.hostUsers +- spec.securityContext.seLinuxOptions +- spec.securityContext.seccompProfile +- spec.securityContext.fsGroup +- spec.securityContext.fsGroupChangePolicy +- spec.securityContext.sysctls +- spec.shareProcessNamespace +- spec.securityContext.runAsUser +- spec.securityContext.runAsGroup +- spec.securityContext.supplementalGroups +- spec.containers[*].securityContext.seLinuxOptions +- spec.containers[*].securityContext.seccompProfile +- spec.containers[*].securityContext.capabilities +- spec.containers[*].securityContext.readOnlyRootFilesystem +- spec.containers[*].securityContext.privileged +- spec.containers[*].securityContext.allowPrivilegeEscalation +- spec.containers[*].securityContext.procMount +- spec.containers[*].securityContext.runAsUser +- spec.containers[*].securityContext.runAsGroup + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os/name.mdx new file mode 100755 index 000000000..8efb82b1b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os/name.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-os-name} + +Name is the name of the operating system. The currently supported values are linux and windows. +Additional value may be defined in future and can be one of: +https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration +Clients should expect to handle additional values and treat unrecognized values in this field as os: null + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os_reference.mdx new file mode 100755 index 000000000..0d5d669e3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/os_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./os/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/overhead.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/overhead.mdx new file mode 100755 index 000000000..9fd93cbda --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/overhead.mdx @@ -0,0 +1,23 @@ + +import PartialOverheadreference from "./overhead_reference.mdx" + + +
+ + +######## `overhead` required {#controlPlane-coredns-deployment-spec-template-spec-overhead} + +Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. +This field will be autopopulated at admission time by the RuntimeClass admission controller. If +the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. +The RuntimeClass admission controller will reject Pod create requests which have the overhead already +set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value +defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. +More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/overhead_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/overhead_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/preemptionPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/preemptionPolicy.mdx new file mode 100755 index 000000000..20ebfe378 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/preemptionPolicy.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `preemptionPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-preemptionPolicy} + +PreemptionPolicy is the Policy for preempting pods with lower priority. +One of Never, PreemptLowerPriority. +Defaults to PreemptLowerPriority if unset. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/priority.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/priority.mdx new file mode 100755 index 000000000..380de5aba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/priority.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `priority` required integer {#controlPlane-coredns-deployment-spec-template-spec-priority} + +The priority value. Various system components use this field to find the +priority of the pod. When Priority Admission Controller is enabled, it +prevents users from setting this field. The admission controller populates +this field from PriorityClassName. +The higher the value, the higher the priority. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/priorityClassName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/priorityClassName.mdx new file mode 100755 index 000000000..221868279 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/priorityClassName.mdx @@ -0,0 +1,18 @@ + +
+ + +######## `priorityClassName` required string {#controlPlane-coredns-deployment-spec-template-spec-priorityClassName} + +If specified, indicates the pod's priority. "system-node-critical" and +"system-cluster-critical" are two special keywords which indicate the +highest priorities with the former being the highest priority. Any other +name must be defined by creating a PriorityClass object with that name. +If not specified, the pod priority will be default or zero if there is no +default. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates.mdx new file mode 100755 index 000000000..97d2d3d6a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessgatesreference from "./readinessGates_reference.mdx" + + +
+ + +######## `readinessGates` required object[] {#controlPlane-coredns-deployment-spec-template-spec-readinessGates} + +If specified, all readiness gates will be evaluated for pod readiness. +A pod is ready when all its containers are ready AND +all conditions specified in the readiness gates have status equal to "True" +More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates/conditionType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates/conditionType.mdx new file mode 100755 index 000000000..2e9253eb2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates/conditionType.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `conditionType` required string {#controlPlane-coredns-deployment-spec-template-spec-readinessGates-conditionType} + +ConditionType refers to a condition in the pod's condition list with matching type. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates_reference.mdx new file mode 100755 index 000000000..f1ab73b92 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/readinessGates_reference.mdx @@ -0,0 +1,4 @@ + +import PartialConditiontype from "./readinessGates/conditionType.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims.mdx new file mode 100755 index 000000000..d1221b5c6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims.mdx @@ -0,0 +1,26 @@ + +import PartialResourceclaimsreference from "./resourceClaims_reference.mdx" + + +
+ + +######## `resourceClaims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-resourceClaims} + +ResourceClaims defines which ResourceClaims must be allocated +and reserved before the Pod is allowed to start. The resources +will be made available to those containers which consume them +by name. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/name.mdx new file mode 100755 index 000000000..ed8d7e1f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-resourceClaims-name} + +Name uniquely identifies this resource claim inside the pod. +This must be a DNS_LABEL. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source.mdx new file mode 100755 index 000000000..c5654b0ec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source.mdx @@ -0,0 +1,17 @@ + +import PartialSourcereference from "./source_reference.mdx" + + +
+ + +######### `source` required {#controlPlane-coredns-deployment-spec-template-spec-resourceClaims-source} + +Source describes where to find the ResourceClaim. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source/resourceClaimName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source/resourceClaimName.mdx new file mode 100755 index 000000000..b4fa446e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source/resourceClaimName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `resourceClaimName` required string {#controlPlane-coredns-deployment-spec-template-spec-resourceClaims-source-resourceClaimName} + +ResourceClaimName is the name of a ResourceClaim object in the same +namespace as this pod. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source/resourceClaimTemplateName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source/resourceClaimTemplateName.mdx new file mode 100755 index 000000000..0354c0aa6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source/resourceClaimTemplateName.mdx @@ -0,0 +1,24 @@ + +
+ + +########## `resourceClaimTemplateName` required string {#controlPlane-coredns-deployment-spec-template-spec-resourceClaims-source-resourceClaimTemplateName} + +ResourceClaimTemplateName is the name of a ResourceClaimTemplate +object in the same namespace as this pod. + +The template will be used to create a new ResourceClaim, which will +be bound to this pod. When this pod is deleted, the ResourceClaim +will also be deleted. The pod name and resource name, along with a +generated component, will be used to form a unique name for the +ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. + +This field is immutable and no changes will be made to the +corresponding ResourceClaim by the control plane after creating the +ResourceClaim. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source_reference.mdx new file mode 100755 index 000000000..9d91776da --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims/source_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourceclaimname from "./source/resourceClaimName.mdx" +import PartialResourceclaimtemplatename from "./source/resourceClaimTemplateName.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims_reference.mdx new file mode 100755 index 000000000..0f196065c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/resourceClaims_reference.mdx @@ -0,0 +1,21 @@ + +import PartialName from "./resourceClaims/name.mdx" +import PartialSourcereference from "./resourceClaims/source_reference.mdx" + + + + + +
+ + +######### `source` required {#controlPlane-coredns-deployment-spec-template-spec-resourceClaims-source} + +Source describes where to find the ResourceClaim. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/restartPolicy.mdx new file mode 100755 index 000000000..76562c535 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/restartPolicy.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `restartPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-restartPolicy} + +Restart policy for all containers within the pod. +One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. +Default to Always. +More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/runtimeClassName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/runtimeClassName.mdx new file mode 100755 index 000000000..0a34adb03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/runtimeClassName.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `runtimeClassName` required string {#controlPlane-coredns-deployment-spec-template-spec-runtimeClassName} + +RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used +to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. +If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an +empty definition that uses the default runtime handler. +More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulerName.mdx new file mode 100755 index 000000000..f01d5c725 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulerName.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `schedulerName` required string {#controlPlane-coredns-deployment-spec-template-spec-schedulerName} + +If specified, the pod will be dispatched by specified scheduler. +If not specified, the pod will be dispatched by default scheduler. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates.mdx new file mode 100755 index 000000000..8cc04286f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates.mdx @@ -0,0 +1,24 @@ + +import PartialSchedulinggatesreference from "./schedulingGates_reference.mdx" + + +
+ + +######## `schedulingGates` required object[] {#controlPlane-coredns-deployment-spec-template-spec-schedulingGates} + +SchedulingGates is an opaque list of values that if specified will block scheduling the pod. +If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the +scheduler will not attempt to schedule the pod. + +SchedulingGates can only be set at pod creation time, and be removed only afterwards. + +This is a beta feature enabled by the PodSchedulingReadiness feature gate. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates/name.mdx new file mode 100755 index 000000000..f517a2f26 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-schedulingGates-name} + +Name of the scheduling gate. +Each scheduling gate must have a unique name field. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates_reference.mdx new file mode 100755 index 000000000..b3f6c69fa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/schedulingGates_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./schedulingGates/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext.mdx new file mode 100755 index 000000000..ca02989fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext.mdx @@ -0,0 +1,18 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +######## `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext} + +SecurityContext holds pod-level security attributes and common container settings. +Optional: Defaults to empty. See type description for default values of each field. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/fsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/fsGroup.mdx new file mode 100755 index 000000000..fa4f85bd7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/fsGroup.mdx @@ -0,0 +1,22 @@ + +
+ + +######### `fsGroup` required integer {#controlPlane-coredns-deployment-spec-template-spec-securityContext-fsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/fsGroupChangePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/fsGroupChangePolicy.mdx new file mode 100755 index 000000000..00a4fc0a3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/fsGroupChangePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `fsGroupChangePolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-fsGroupChangePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..9b50a86b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsGroup.mdx @@ -0,0 +1,18 @@ + +
+ + +######### `runAsGroup` required integer {#controlPlane-coredns-deployment-spec-template-spec-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..454daa374 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +######### `runAsNonRoot` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsUser.mdx new file mode 100755 index 000000000..9fb65b3c8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/runAsUser.mdx @@ -0,0 +1,18 @@ + +
+ + +######### `runAsUser` required integer {#controlPlane-coredns-deployment-spec-template-spec-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..8a2ee8fa6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions.mdx @@ -0,0 +1,22 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +######### `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..27f538d46 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `level` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..93ca463db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `role` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..3a832f2f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `type` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..cfee638d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `user` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..3c4b2c342 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile.mdx @@ -0,0 +1,18 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +######### `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seccompProfile} + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..fdbb3b0a9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `localhostProfile` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..66bb6ee86 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +########## `type` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/supplementalGroups.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/supplementalGroups.mdx new file mode 100755 index 000000000..f8cfb8f21 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/supplementalGroups.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `supplementalGroups` required integer[] {#controlPlane-coredns-deployment-spec-template-spec-securityContext-supplementalGroups} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls.mdx new file mode 100755 index 000000000..a7c5e3470 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls.mdx @@ -0,0 +1,19 @@ + +import PartialSysctlsreference from "./sysctls_reference.mdx" + + +
+ + +######### `sysctls` required object[] {#controlPlane-coredns-deployment-spec-template-spec-securityContext-sysctls} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls/name.mdx new file mode 100755 index 000000000..af0aa745b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-sysctls-name} + +Name of a property to set + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls/value.mdx new file mode 100755 index 000000000..5fde31eb0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-sysctls-value} + +Value of a property to set + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls_reference.mdx new file mode 100755 index 000000000..dd3a7e504 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/sysctls_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./sysctls/name.mdx" +import PartialValue from "./sysctls/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..e3443d7d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +######### `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..1aa76853d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `gmsaCredentialSpec` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..9c5b4d0c2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `gmsaCredentialSpecName` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..69b9015fb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `hostProcess` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..82eff755b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `runAsUserName` required string {#controlPlane-coredns-deployment-spec-template-spec-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext_reference.mdx new file mode 100755 index 000000000..cf6fe900a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/securityContext_reference.mdx @@ -0,0 +1,103 @@ + +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialSupplementalgroups from "./securityContext/supplementalGroups.mdx" +import PartialFsgroup from "./securityContext/fsGroup.mdx" +import PartialSysctlsreference from "./securityContext/sysctls_reference.mdx" +import PartialFsgroupchangepolicy from "./securityContext/fsGroupChangePolicy.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +######### `seLinuxOptions` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +######### `windowsOptions` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ + +######### `sysctls` required object[] {#controlPlane-coredns-deployment-spec-template-spec-securityContext-sysctls} + +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. + + + + + + +
+ + + + + + +
+ + +######### `seccompProfile` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext-seccompProfile} + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/serviceAccount.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/serviceAccount.mdx new file mode 100755 index 000000000..e9b6fa978 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/serviceAccount.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `serviceAccount` required string {#controlPlane-coredns-deployment-spec-template-spec-serviceAccount} + +DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. +Deprecated: Use serviceAccountName instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/serviceAccountName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/serviceAccountName.mdx new file mode 100755 index 000000000..7b38aaa66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/serviceAccountName.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `serviceAccountName` required string {#controlPlane-coredns-deployment-spec-template-spec-serviceAccountName} + +ServiceAccountName is the name of the ServiceAccount to use to run this pod. +More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/setHostnameAsFQDN.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/setHostnameAsFQDN.mdx new file mode 100755 index 000000000..9dceced87 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/setHostnameAsFQDN.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `setHostnameAsFQDN` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-setHostnameAsFQDN} + +If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). +In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). +In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. +If a pod does not have FQDN, this has no effect. +Default to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/shareProcessNamespace.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/shareProcessNamespace.mdx new file mode 100755 index 000000000..eb8683032 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/shareProcessNamespace.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `shareProcessNamespace` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-shareProcessNamespace} + +Share a single process namespace between all of the containers in a pod. +When this is set containers will be able to view and signal processes from other containers +in the same pod, and the first process in each container will not be assigned PID 1. +HostPID and ShareProcessNamespace cannot both be set. +Optional: Default to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/subdomain.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/subdomain.mdx new file mode 100755 index 000000000..2c5af1097 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/subdomain.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `subdomain` required string {#controlPlane-coredns-deployment-spec-template-spec-subdomain} + +If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". +If not specified, the pod will not have a domainname at all. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..b894aaafc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/terminationGracePeriodSeconds.mdx @@ -0,0 +1,20 @@ + +
+ + +######## `terminationGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-terminationGracePeriodSeconds} + +Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. +Value must be non-negative integer. The value zero indicates stop immediately via +the kill signal (no opportunity to shut down). +If this value is nil, the default grace period will be used instead. +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. +Defaults to 30 seconds. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations.mdx new file mode 100755 index 000000000..bd1257970 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations.mdx @@ -0,0 +1,17 @@ + +import PartialTolerationsreference from "./tolerations_reference.mdx" + + +
+ + +######## `tolerations` required object[] {#controlPlane-coredns-deployment-spec-template-spec-tolerations} + +If specified, the pod's tolerations. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/effect.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/effect.mdx new file mode 100755 index 000000000..d79820b28 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/effect.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `effect` required string {#controlPlane-coredns-deployment-spec-template-spec-tolerations-effect} + +Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/key.mdx new file mode 100755 index 000000000..3f58c5cae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/key.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `key` required string {#controlPlane-coredns-deployment-spec-template-spec-tolerations-key} + +Key is the taint key that the toleration applies to. Empty means match all taint keys. +If the key is empty, operator must be Exists; this combination means to match all values and all keys. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/operator.mdx new file mode 100755 index 000000000..9b7293939 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/operator.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-tolerations-operator} + +Operator represents a key's relationship to the value. +Valid operators are Exists and Equal. Defaults to Equal. +Exists is equivalent to wildcard for value, so that a pod can +tolerate all taints of a particular category. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/tolerationSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/tolerationSeconds.mdx new file mode 100755 index 000000000..116ec11b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/tolerationSeconds.mdx @@ -0,0 +1,16 @@ + +
+ + +######### `tolerationSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-tolerations-tolerationSeconds} + +TolerationSeconds represents the period of time the toleration (which must be +of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, +it is not set, which means tolerate the taint forever (do not evict). Zero and +negative values will be treated as 0 (evict immediately) by the system. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/value.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/value.mdx new file mode 100755 index 000000000..69e8eaefc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations/value.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `value` required string {#controlPlane-coredns-deployment-spec-template-spec-tolerations-value} + +Value is the taint value the toleration matches to. +If the operator is Exists, the value should be empty, otherwise just a regular string. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations_reference.mdx new file mode 100755 index 000000000..faf95152f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/tolerations_reference.mdx @@ -0,0 +1,20 @@ + +import PartialKey from "./tolerations/key.mdx" +import PartialOperator from "./tolerations/operator.mdx" +import PartialValue from "./tolerations/value.mdx" +import PartialEffect from "./tolerations/effect.mdx" +import PartialTolerationseconds from "./tolerations/tolerationSeconds.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints.mdx new file mode 100755 index 000000000..41ad1c6cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints.mdx @@ -0,0 +1,19 @@ + +import PartialTopologyspreadconstraintsreference from "./topologySpreadConstraints_reference.mdx" + + +
+ + +######## `topologySpreadConstraints` required object[] {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints} + +TopologySpreadConstraints describes how a group of pods ought to spread across topology +domains. Scheduler will schedule pods in a way which abides by the constraints. +All topologySpreadConstraints are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector.mdx new file mode 100755 index 000000000..3b4926432 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector.mdx @@ -0,0 +1,19 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +######### `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..8e59d30e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..72175f866 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `key` required string {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..b74e8831a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..2d4aa816d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..a33e19b22 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector_reference.mdx new file mode 100755 index 000000000..aa51455cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +########## `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/matchLabelKeys.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/matchLabelKeys.mdx new file mode 100755 index 000000000..0e25924e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/matchLabelKeys.mdx @@ -0,0 +1,22 @@ + +
+ + +######### `matchLabelKeys` required string[] {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-matchLabelKeys} + +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). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/maxSkew.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/maxSkew.mdx new file mode 100755 index 000000000..f07d97646 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/maxSkew.mdx @@ -0,0 +1,29 @@ + +
+ + +######### `maxSkew` required integer {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-maxSkew} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/minDomains.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/minDomains.mdx new file mode 100755 index 000000000..51cb9b10a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/minDomains.mdx @@ -0,0 +1,33 @@ + +
+ + +######### `minDomains` required integer {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-minDomains} + +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). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/nodeAffinityPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/nodeAffinityPolicy.mdx new file mode 100755 index 000000000..7c01451f9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/nodeAffinityPolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +######### `nodeAffinityPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-nodeAffinityPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/nodeTaintsPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/nodeTaintsPolicy.mdx new file mode 100755 index 000000000..9e33c1c2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/nodeTaintsPolicy.mdx @@ -0,0 +1,20 @@ + +
+ + +######### `nodeTaintsPolicy` required string {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-nodeTaintsPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/topologyKey.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/topologyKey.mdx new file mode 100755 index 000000000..903e67842 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/topologyKey.mdx @@ -0,0 +1,22 @@ + +
+ + +######### `topologyKey` required string {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-topologyKey} + +TopologyKey is the key of node labels. Nodes that have a label with this key +and identical values are considered to be in the same topology. +We consider each <key, value> as a "bucket", and try to put balanced number +of pods into each bucket. +We define a domain as a particular instance of a topology. +Also, we define an eligible domain as a domain whose nodes meet the requirements of +nodeAffinityPolicy and nodeTaintsPolicy. +e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. +And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. +It's a required field. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/whenUnsatisfiable.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/whenUnsatisfiable.mdx new file mode 100755 index 000000000..3ef45e328 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints/whenUnsatisfiable.mdx @@ -0,0 +1,30 @@ + +
+ + +######### `whenUnsatisfiable` required string {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-whenUnsatisfiable} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints_reference.mdx new file mode 100755 index 000000000..77cb1828e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/topologySpreadConstraints_reference.mdx @@ -0,0 +1,47 @@ + +import PartialMaxskew from "./topologySpreadConstraints/maxSkew.mdx" +import PartialTopologykey from "./topologySpreadConstraints/topologyKey.mdx" +import PartialWhenunsatisfiable from "./topologySpreadConstraints/whenUnsatisfiable.mdx" +import PartialLabelselectorreference from "./topologySpreadConstraints/labelSelector_reference.mdx" +import PartialMindomains from "./topologySpreadConstraints/minDomains.mdx" +import PartialNodeaffinitypolicy from "./topologySpreadConstraints/nodeAffinityPolicy.mdx" +import PartialNodetaintspolicy from "./topologySpreadConstraints/nodeTaintsPolicy.mdx" +import PartialMatchlabelkeys from "./topologySpreadConstraints/matchLabelKeys.mdx" + + + + + + + + + + + +
+ + +######### `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints-labelSelector} + +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. + + + + + + +
+ + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes.mdx new file mode 100755 index 000000000..776e5abcc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes.mdx @@ -0,0 +1,18 @@ + +import PartialVolumesreference from "./volumes_reference.mdx" + + +
+ + +######## `volumes` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes} + +List of volumes that can be mounted by containers belonging to the pod. +More info: https://kubernetes.io/docs/concepts/storage/volumes + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore.mdx new file mode 100755 index 000000000..c41082127 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore.mdx @@ -0,0 +1,19 @@ + +import PartialAwselasticblockstorereference from "./awsElasticBlockStore_reference.mdx" + + +
+ + +######### `awsElasticBlockStore` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-awsElasticBlockStore} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/fsType.mdx new file mode 100755 index 000000000..6127b6e7c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/fsType.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-awsElasticBlockStore-fsType} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/partition.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/partition.mdx new file mode 100755 index 000000000..33b2be205 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/partition.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `partition` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-awsElasticBlockStore-partition} + +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). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/readOnly.mdx new file mode 100755 index 000000000..466719419 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-awsElasticBlockStore-readOnly} + +readOnly value true will force the readOnly setting in VolumeMounts. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/volumeID.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/volumeID.mdx new file mode 100755 index 000000000..55bbbf0db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore/volumeID.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `volumeID` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-awsElasticBlockStore-volumeID} + +volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore_reference.mdx new file mode 100755 index 000000000..987eae1e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/awsElasticBlockStore_reference.mdx @@ -0,0 +1,16 @@ + +import PartialVolumeid from "./awsElasticBlockStore/volumeID.mdx" +import PartialFstype from "./awsElasticBlockStore/fsType.mdx" +import PartialPartition from "./awsElasticBlockStore/partition.mdx" +import PartialReadonly from "./awsElasticBlockStore/readOnly.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk.mdx new file mode 100755 index 000000000..e03e2945f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk.mdx @@ -0,0 +1,17 @@ + +import PartialAzurediskreference from "./azureDisk_reference.mdx" + + +
+ + +######### `azureDisk` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk} + +azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/cachingMode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/cachingMode.mdx new file mode 100755 index 000000000..4fea4f5dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/cachingMode.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `cachingMode` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk-cachingMode} + +cachingMode is the Host Caching mode: None, Read Only, Read Write. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/diskName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/diskName.mdx new file mode 100755 index 000000000..d91a94236 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/diskName.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `diskName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk-diskName} + +diskName is the Name of the data disk in the blob storage + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/diskURI.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/diskURI.mdx new file mode 100755 index 000000000..c0f0bac87 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/diskURI.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `diskURI` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk-diskURI} + +diskURI is the URI of data disk in the blob storage + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/fsType.mdx new file mode 100755 index 000000000..49007e418 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/fsType.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk-fsType} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/kind.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/kind.mdx new file mode 100755 index 000000000..0c2d7fe5f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `kind` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk-kind} + +kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/readOnly.mdx new file mode 100755 index 000000000..ccd3c6b43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk-readOnly} + +readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk_reference.mdx new file mode 100755 index 000000000..489d0b16d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureDisk_reference.mdx @@ -0,0 +1,24 @@ + +import PartialDiskname from "./azureDisk/diskName.mdx" +import PartialDiskuri from "./azureDisk/diskURI.mdx" +import PartialCachingmode from "./azureDisk/cachingMode.mdx" +import PartialFstype from "./azureDisk/fsType.mdx" +import PartialReadonly from "./azureDisk/readOnly.mdx" +import PartialKind from "./azureDisk/kind.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile.mdx new file mode 100755 index 000000000..911d03220 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile.mdx @@ -0,0 +1,17 @@ + +import PartialAzurefilereference from "./azureFile_reference.mdx" + + +
+ + +######### `azureFile` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureFile} + +azureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/readOnly.mdx new file mode 100755 index 000000000..6d5d1b6e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureFile-readOnly} + +readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/secretName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/secretName.mdx new file mode 100755 index 000000000..485852a8c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/secretName.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `secretName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureFile-secretName} + +secretName is the name of secret that contains Azure Storage Account Name and Key + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/shareName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/shareName.mdx new file mode 100755 index 000000000..dfb4d423d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile/shareName.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `shareName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureFile-shareName} + +shareName is the azure share Name + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile_reference.mdx new file mode 100755 index 000000000..ffcdcbb31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/azureFile_reference.mdx @@ -0,0 +1,12 @@ + +import PartialSecretname from "./azureFile/secretName.mdx" +import PartialSharename from "./azureFile/shareName.mdx" +import PartialReadonly from "./azureFile/readOnly.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs.mdx new file mode 100755 index 000000000..3f8d706dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs.mdx @@ -0,0 +1,17 @@ + +import PartialCephfsreference from "./cephfs_reference.mdx" + + +
+ + +######### `cephfs` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs} + +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/monitors.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/monitors.mdx new file mode 100755 index 000000000..79a6fae6a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/monitors.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `monitors` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-monitors} + +monitors is Required: Monitors is a collection of Ceph monitors +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/path.mdx new file mode 100755 index 000000000..3589bc225 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-path} + +path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/readOnly.mdx new file mode 100755 index 000000000..e274a5a7e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/readOnly.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-readOnly} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretFile.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretFile.mdx new file mode 100755 index 000000000..845fbf4ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretFile.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `secretFile` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-secretFile} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef.mdx new file mode 100755 index 000000000..3c2a15fa2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef.mdx @@ -0,0 +1,18 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-secretRef} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef/name.mdx new file mode 100755 index 000000000..3b0185503 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef_reference.mdx new file mode 100755 index 000000000..902159278 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/secretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./secretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/user.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/user.mdx new file mode 100755 index 000000000..e4aa8ac7f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs/user.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `user` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-user} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs_reference.mdx new file mode 100755 index 000000000..5f227bec5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cephfs_reference.mdx @@ -0,0 +1,38 @@ + +import PartialMonitors from "./cephfs/monitors.mdx" +import PartialPath from "./cephfs/path.mdx" +import PartialUser from "./cephfs/user.mdx" +import PartialSecretfile from "./cephfs/secretFile.mdx" +import PartialSecretrefreference from "./cephfs/secretRef_reference.mdx" +import PartialReadonly from "./cephfs/readOnly.mdx" + + + + + + + + + + + + + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs-secretRef} + +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 + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder.mdx new file mode 100755 index 000000000..c80e5035d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder.mdx @@ -0,0 +1,18 @@ + +import PartialCinderreference from "./cinder_reference.mdx" + + +
+ + +######### `cinder` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder} + +cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/fsType.mdx new file mode 100755 index 000000000..dd2e171d3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/fsType.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder-fsType} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/readOnly.mdx new file mode 100755 index 000000000..1e4a46f4e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/readOnly.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder-readOnly} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef.mdx new file mode 100755 index 000000000..e4d754e5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef.mdx @@ -0,0 +1,18 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder-secretRef} + +secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef/name.mdx new file mode 100755 index 000000000..7de26c886 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef_reference.mdx new file mode 100755 index 000000000..902159278 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/secretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./secretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/volumeID.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/volumeID.mdx new file mode 100755 index 000000000..16a7f5d92 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder/volumeID.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `volumeID` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder-volumeID} + +volumeID used to identify the volume in cinder. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder_reference.mdx new file mode 100755 index 000000000..73a87d204 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/cinder_reference.mdx @@ -0,0 +1,30 @@ + +import PartialVolumeid from "./cinder/volumeID.mdx" +import PartialFstype from "./cinder/fsType.mdx" +import PartialReadonly from "./cinder/readOnly.mdx" +import PartialSecretrefreference from "./cinder/secretRef_reference.mdx" + + + + + + + + + + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder-secretRef} + +secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap.mdx new file mode 100755 index 000000000..fff763d24 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapreference from "./configMap_reference.mdx" + + +
+ + +######### `configMap` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap} + +configMap represents a configMap that should populate this volume + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/defaultMode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/defaultMode.mdx new file mode 100755 index 000000000..d8999152c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/defaultMode.mdx @@ -0,0 +1,19 @@ + +
+ + +########## `defaultMode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-defaultMode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items.mdx new file mode 100755 index 000000000..998716b41 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items.mdx @@ -0,0 +1,23 @@ + +import PartialItemsreference from "./items_reference.mdx" + + +
+ + +########## `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-items} + +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 '..'. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/key.mdx new file mode 100755 index 000000000..69f4a5ebe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `key` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-items-key} + +key is the key to project. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/mode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/mode.mdx new file mode 100755 index 000000000..abc30b14c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/mode.mdx @@ -0,0 +1,18 @@ + +
+ + +########### `mode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-items-mode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/path.mdx new file mode 100755 index 000000000..7a5fdc82a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items/path.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-items-path} + +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 '..'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items_reference.mdx new file mode 100755 index 000000000..3fe9464f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/items_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./items/key.mdx" +import PartialPath from "./items/path.mdx" +import PartialMode from "./items/mode.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/name.mdx new file mode 100755 index 000000000..72e5518cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/optional.mdx new file mode 100755 index 000000000..eb858d55e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-optional} + +optional specify whether the ConfigMap or its keys must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap_reference.mdx new file mode 100755 index 000000000..caf947032 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/configMap_reference.mdx @@ -0,0 +1,35 @@ + +import PartialName from "./configMap/name.mdx" +import PartialItemsreference from "./configMap/items_reference.mdx" +import PartialDefaultmode from "./configMap/defaultMode.mdx" +import PartialOptional from "./configMap/optional.mdx" + + + + + +
+ + +########## `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap-items} + +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 '..'. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi.mdx new file mode 100755 index 000000000..05359ee5e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi.mdx @@ -0,0 +1,17 @@ + +import PartialCsireference from "./csi_reference.mdx" + + +
+ + +######### `csi` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi} + +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/driver.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/driver.mdx new file mode 100755 index 000000000..4e39042ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/driver.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `driver` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi-driver} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/fsType.mdx new file mode 100755 index 000000000..a456d3d05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/fsType.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi-fsType} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef.mdx new file mode 100755 index 000000000..cc8b463ca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef.mdx @@ -0,0 +1,21 @@ + +import PartialNodepublishsecretrefreference from "./nodePublishSecretRef_reference.mdx" + + +
+ + +########## `nodePublishSecretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi-nodePublishSecretRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef/name.mdx new file mode 100755 index 000000000..76736565b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi-nodePublishSecretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef_reference.mdx new file mode 100755 index 000000000..f230d6e19 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/nodePublishSecretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./nodePublishSecretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/readOnly.mdx new file mode 100755 index 000000000..795a5b6dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi-readOnly} + +readOnly specifies a read-only configuration for the volume. +Defaults to false (read/write). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/volumeAttributes.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/volumeAttributes.mdx new file mode 100755 index 000000000..471d55567 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi/volumeAttributes.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `volumeAttributes` required object {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi-volumeAttributes} + +volumeAttributes stores driver-specific properties that are passed to the CSI +driver. Consult your driver's documentation for supported values. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi_reference.mdx new file mode 100755 index 000000000..cb31c603d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/csi_reference.mdx @@ -0,0 +1,37 @@ + +import PartialDriver from "./csi/driver.mdx" +import PartialReadonly from "./csi/readOnly.mdx" +import PartialFstype from "./csi/fsType.mdx" +import PartialVolumeattributes from "./csi/volumeAttributes.mdx" +import PartialNodepublishsecretrefreference from "./csi/nodePublishSecretRef_reference.mdx" + + + + + + + + + + + + + + +
+ + +########## `nodePublishSecretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi-nodePublishSecretRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI.mdx new file mode 100755 index 000000000..00d53f804 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI.mdx @@ -0,0 +1,17 @@ + +import PartialDownwardapireference from "./downwardAPI_reference.mdx" + + +
+ + +######### `downwardAPI` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI} + +downwardAPI represents downward API about the pod that should populate this volume + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/defaultMode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/defaultMode.mdx new file mode 100755 index 000000000..82c91f9b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/defaultMode.mdx @@ -0,0 +1,20 @@ + +
+ + +########## `defaultMode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-defaultMode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items.mdx new file mode 100755 index 000000000..64454ca05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items.mdx @@ -0,0 +1,17 @@ + +import PartialItemsreference from "./items_reference.mdx" + + +
+ + +########## `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items} + +Items is a list of downward API volume file + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef.mdx new file mode 100755 index 000000000..9a5bb660f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef.mdx @@ -0,0 +1,17 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-fieldRef} + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..6aedc2401 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..6d04067a9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `fieldPath` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/mode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/mode.mdx new file mode 100755 index 000000000..acbf79773 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/mode.mdx @@ -0,0 +1,18 @@ + +
+ + +########### `mode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-mode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/path.mdx new file mode 100755 index 000000000..e94758b02 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/path.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-path} + +Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef.mdx new file mode 100755 index 000000000..5f8294989 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-resourceFieldRef} + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..954a91b58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `containerName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..4c2e8ae58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..3f75fcace --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `Format` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..b3a193f5c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `resource` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..b47708a33 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +############ `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items_reference.mdx new file mode 100755 index 000000000..95281daaa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI/items_reference.mdx @@ -0,0 +1,43 @@ + +import PartialPath from "./items/path.mdx" +import PartialFieldrefreference from "./items/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./items/resourceFieldRef_reference.mdx" +import PartialMode from "./items/mode.mdx" + + + + + +
+ + +########### `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-fieldRef} + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + +
+ + + +
+ + +########### `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items-resourceFieldRef} + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI_reference.mdx new file mode 100755 index 000000000..75623bac8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/downwardAPI_reference.mdx @@ -0,0 +1,21 @@ + +import PartialItemsreference from "./downwardAPI/items_reference.mdx" +import PartialDefaultmode from "./downwardAPI/defaultMode.mdx" + + +
+ + +########## `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI-items} + +Items is a list of downward API volume file + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir.mdx new file mode 100755 index 000000000..7c85fb84b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir.mdx @@ -0,0 +1,18 @@ + +import PartialEmptydirreference from "./emptyDir_reference.mdx" + + +
+ + +######### `emptyDir` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-emptyDir} + +emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/medium.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/medium.mdx new file mode 100755 index 000000000..a13ef32cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/medium.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `medium` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-emptyDir-medium} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit.mdx new file mode 100755 index 000000000..9a6ad8d9a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit.mdx @@ -0,0 +1,22 @@ + +import PartialSizelimitreference from "./sizeLimit_reference.mdx" + + +
+ + +########## `sizeLimit` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-emptyDir-sizeLimit} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit/Format.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit/Format.mdx new file mode 100755 index 000000000..a1ddeb922 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `Format` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-emptyDir-sizeLimit-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit_reference.mdx new file mode 100755 index 000000000..58141d147 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir/sizeLimit_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./sizeLimit/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir_reference.mdx new file mode 100755 index 000000000..81e06aca3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/emptyDir_reference.mdx @@ -0,0 +1,26 @@ + +import PartialMedium from "./emptyDir/medium.mdx" +import PartialSizelimitreference from "./emptyDir/sizeLimit_reference.mdx" + + + + + +
+ + +########## `sizeLimit` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-emptyDir-sizeLimit} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral.mdx new file mode 100755 index 000000000..18d1a0761 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral.mdx @@ -0,0 +1,41 @@ + +import PartialEphemeralreference from "./ephemeral_reference.mdx" + + +
+ + +######### `ephemeral` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral} + +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). + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate.mdx new file mode 100755 index 000000000..7b235bf99 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate.mdx @@ -0,0 +1,37 @@ + +import PartialVolumeclaimtemplatereference from "./volumeClaimTemplate_reference.mdx" + + +
+ + +########## `volumeClaimTemplate` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate} + +Will be used to create a stand-alone PVC to provision the volume. +The pod in which this EphemeralVolumeSource is embedded will be the +owner of the PVC, i.e. the PVC will be deleted together with the +pod. The name of the PVC will be `<pod name>-<volume name>` where +`<volume name>` is the name from the `PodSpec.Volumes` array +entry. Pod validation will reject the pod if the concatenated name +is not valid for a PVC (for example, too long). + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata.mdx new file mode 100755 index 000000000..cd6f17fd7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata.mdx @@ -0,0 +1,17 @@ + +import PartialMetadatareference from "./metadata_reference.mdx" + + +
+ + +########### `metadata` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/annotations.mdx new file mode 100755 index 000000000..4d6c23217 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/annotations.mdx @@ -0,0 +1,16 @@ + +
+ + +############ `annotations` required object {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-annotations} + +Annotations is an unstructured key value map stored with a resource that may be +set by external tools to store and retrieve arbitrary metadata. They are not +queryable and should be preserved when modifying objects. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/creationTimestamp.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/creationTimestamp.mdx new file mode 100755 index 000000000..b06f504d9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/creationTimestamp.mdx @@ -0,0 +1,24 @@ + +import PartialCreationtimestampreference from "./creationTimestamp_reference.mdx" + + +
+ + +############ `creationTimestamp` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-creationTimestamp} + +CreationTimestamp is a timestamp representing the server time when this object was +created. It is not guaranteed to be set in happens-before order across separate operations. +Clients may not set this value. It is represented in RFC3339 form and is in UTC. + +Populated by the system. +Read-only. +Null for lists. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/creationTimestamp_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/creationTimestamp_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionGracePeriodSeconds.mdx new file mode 100755 index 000000000..345ac28d9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionGracePeriodSeconds.mdx @@ -0,0 +1,16 @@ + +
+ + +############ `deletionGracePeriodSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-deletionGracePeriodSeconds} + +Number of seconds allowed for this object to gracefully terminate before +it will be removed from the system. Only set when deletionTimestamp is also set. +May only be shortened. +Read-only. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionTimestamp.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionTimestamp.mdx new file mode 100755 index 000000000..a97c06d4c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionTimestamp.mdx @@ -0,0 +1,34 @@ + +import PartialDeletiontimestampreference from "./deletionTimestamp_reference.mdx" + + +
+ + +############ `deletionTimestamp` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-deletionTimestamp} + +DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This +field is set by the server when a graceful deletion is requested by the user, and is not +directly settable by a client. The resource is expected to be deleted (no longer visible +from resource lists, and not reachable by name) after the time in this field, once the +finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. +Once the deletionTimestamp is set, this value may not be unset or be set further into the +future, although it may be shortened or the resource may be deleted prior to this time. +For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react +by sending a graceful termination signal to the containers in the pod. After that 30 seconds, +the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, +remove the pod from the API. In the presence of network partitions, this object may still +exist after this timestamp, until an administrator or automated process can determine the +resource is fully terminated. +If not set, graceful deletion of the object has not been requested. + +Populated by the system when a graceful deletion is requested. +Read-only. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionTimestamp_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/deletionTimestamp_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/finalizers.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/finalizers.mdx new file mode 100755 index 000000000..a76942b0e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/finalizers.mdx @@ -0,0 +1,25 @@ + +
+ + +############ `finalizers` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-finalizers} + +Must be empty before the object is deleted from the registry. Each entry +is an identifier for the responsible component that will remove the entry +from the list. If the deletionTimestamp of the object is non-nil, entries +in this list can only be removed. +Finalizers may be processed and removed in any order. Order is NOT enforced +because it introduces significant risk of stuck finalizers. +finalizers is a shared field, any actor with permission can reorder it. +If the finalizer list is processed in order, then this can lead to a situation +in which the component responsible for the first finalizer in the list is +waiting for a signal (field value, external system, or other) produced by a +component responsible for a finalizer later in the list, resulting in a deadlock. +Without enforced ordering finalizers are free to order amongst themselves and +are not vulnerable to ordering changes in the list. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/generateName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/generateName.mdx new file mode 100755 index 000000000..102fd15c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/generateName.mdx @@ -0,0 +1,24 @@ + +
+ + +############ `generateName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-generateName} + +GenerateName is an optional prefix, used by the server, to generate a unique +name ONLY IF the Name field has not been provided. +If this field is used, the name returned to the client will be different +than the name passed. This value will also be combined with a unique suffix. +The provided value has the same validation rules as the Name field, +and may be truncated by the length of the suffix required to make the value +unique on the server. + +If this field is specified and the generated name exists, the server will return a 409. + +Applied only if Name is not specified. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/generation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/generation.mdx new file mode 100755 index 000000000..37f3ade68 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/generation.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `generation` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-generation} + +A sequence number representing a specific generation of the desired state. +Populated by the system. Read-only. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/labels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/labels.mdx new file mode 100755 index 000000000..2d4ef9534 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/labels.mdx @@ -0,0 +1,16 @@ + +
+ + +############ `labels` required object {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-labels} + +Map of string keys and values that can be used to organize and categorize +(scope and select) objects. May match selectors of replication controllers +and services. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields.mdx new file mode 100755 index 000000000..c7616384e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields.mdx @@ -0,0 +1,24 @@ + +import PartialManagedfieldsreference from "./managedFields_reference.mdx" + + +
+ + +############ `managedFields` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields} + +ManagedFields maps workflow-id and version to the set of fields +that are managed by that workflow. This is mostly for internal +housekeeping, and users typically shouldn't need to set or +understand this field. A workflow can be the user's name, a +controller's name, or the name of a specific apply path like +"ci-cd". The set of fields is always in the version that the +workflow used when modifying the object. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/apiVersion.mdx new file mode 100755 index 000000000..3c636013f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/apiVersion.mdx @@ -0,0 +1,16 @@ + +
+ + +############# `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-apiVersion} + +APIVersion defines the version of this resource that this field set +applies to. The format is "group/version" just like the top-level +APIVersion field. It is necessary to track the version of a field +set because it cannot be automatically converted. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsType.mdx new file mode 100755 index 000000000..e9e004bd4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsType.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `fieldsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-fieldsType} + +FieldsType is the discriminator for the different fields format and version. +There is currently only one possible value: "FieldsV1" + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsV1.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsV1.mdx new file mode 100755 index 000000000..453fc6249 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsV1.mdx @@ -0,0 +1,17 @@ + +import PartialFieldsv1reference from "./fieldsV1_reference.mdx" + + +
+ + +############# `fieldsV1` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-fieldsV1} + +FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsV1_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/fieldsV1_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/manager.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/manager.mdx new file mode 100755 index 000000000..f7646a6e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/manager.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `manager` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-manager} + +Manager is an identifier of the workflow managing these fields. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/operation.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/operation.mdx new file mode 100755 index 000000000..dd1ee8e44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/operation.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `operation` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-operation} + +Operation is the type of operation which lead to this ManagedFieldsEntry being created. +The only valid values for this field are 'Apply' and 'Update'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/subresource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/subresource.mdx new file mode 100755 index 000000000..1d8bd659b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/subresource.mdx @@ -0,0 +1,19 @@ + +
+ + +############# `subresource` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-subresource} + +Subresource is the name of the subresource used to update that object, or +empty string if the object was updated through the main resource. The +value of this field is used to distinguish between managers, even if they +share the same name. For example, a status update will be distinct from a +regular update using the same manager name. +Note that the APIVersion field is not related to the Subresource field and +it always corresponds to the version of the main resource. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/time.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/time.mdx new file mode 100755 index 000000000..474005b08 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/time.mdx @@ -0,0 +1,21 @@ + +import PartialTimereference from "./time_reference.mdx" + + +
+ + +############# `time` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-time} + +Time is the timestamp of when the ManagedFields entry was added. The +timestamp will also be updated if a field is added, the manager +changes any of the owned fields value or removes a field. The +timestamp does not update when a field is removed from the entry +because another manager took it over. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/time_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields/time_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields_reference.mdx new file mode 100755 index 000000000..8876a7128 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/managedFields_reference.mdx @@ -0,0 +1,58 @@ + +import PartialManager from "./managedFields/manager.mdx" +import PartialOperation from "./managedFields/operation.mdx" +import PartialApiversion from "./managedFields/apiVersion.mdx" +import PartialTimereference from "./managedFields/time_reference.mdx" +import PartialFieldstype from "./managedFields/fieldsType.mdx" +import PartialFieldsv1reference from "./managedFields/fieldsV1_reference.mdx" +import PartialSubresource from "./managedFields/subresource.mdx" + + + + + + + + + + + +
+ + +############# `time` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-time} + +Time is the timestamp of when the ManagedFields entry was added. The +timestamp will also be updated if a field is added, the manager +changes any of the owned fields value or removes a field. The +timestamp does not update when a field is removed from the entry +because another manager took it over. + + + + + + +
+ + + + + + +
+ + +############# `fieldsV1` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields-fieldsV1} + +FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/name.mdx new file mode 100755 index 000000000..7c9b11e1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/name.mdx @@ -0,0 +1,18 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-name} + +Name must be unique within a namespace. Is required when creating resources, although +some resources may allow a client to request the generation of an appropriate name +automatically. Name is primarily intended for creation idempotence and configuration +definition. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/namespace.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/namespace.mdx new file mode 100755 index 000000000..5931b8132 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/namespace.mdx @@ -0,0 +1,20 @@ + +
+ + +############ `namespace` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-namespace} + +Namespace defines the space within which each name must be unique. An empty namespace is +equivalent to the "default" namespace, but "default" is the canonical representation. +Not all objects are required to be scoped to a namespace - the value of this field for +those objects will be empty. + +Must be a DNS_LABEL. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences.mdx new file mode 100755 index 000000000..373cfb38f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences.mdx @@ -0,0 +1,20 @@ + +import PartialOwnerreferencesreference from "./ownerReferences_reference.mdx" + + +
+ + +############ `ownerReferences` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences} + +List of objects depended by this object. If ALL objects in the list have +been deleted, this object will be garbage collected. If this object is managed by a controller, +then an entry in this list will point to this controller, with the controller field set to true. +There cannot be more than one managing controller. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/apiVersion.mdx new file mode 100755 index 000000000..c473e309d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences-apiVersion} + +API version of the referent. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/blockOwnerDeletion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/blockOwnerDeletion.mdx new file mode 100755 index 000000000..478f24bab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/blockOwnerDeletion.mdx @@ -0,0 +1,20 @@ + +
+ + +############# `blockOwnerDeletion` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences-blockOwnerDeletion} + +If true, AND if the owner has the "foregroundDeletion" finalizer, then +the owner cannot be deleted from the key-value store until this +reference is removed. +See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion +for how the garbage collector interacts with this field and enforces the foreground deletion. +Defaults to false. +To set this field, a user needs "delete" permission of the owner, +otherwise 422 (Unprocessable Entity) will be returned. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/controller.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/controller.mdx new file mode 100755 index 000000000..179ed4bc0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/controller.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `controller` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences-controller} + +If true, this reference points to the managing controller. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/kind.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/kind.mdx new file mode 100755 index 000000000..08b265268 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/kind.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `kind` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences-kind} + +Kind of the referent. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/name.mdx new file mode 100755 index 000000000..9e33d887f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/uid.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/uid.mdx new file mode 100755 index 000000000..366a8a476 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences/uid.mdx @@ -0,0 +1,14 @@ + +
+ + +############# `uid` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences-uid} + +UID of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences_reference.mdx new file mode 100755 index 000000000..806af83c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/ownerReferences_reference.mdx @@ -0,0 +1,24 @@ + +import PartialApiversion from "./ownerReferences/apiVersion.mdx" +import PartialKind from "./ownerReferences/kind.mdx" +import PartialName from "./ownerReferences/name.mdx" +import PartialUid from "./ownerReferences/uid.mdx" +import PartialController from "./ownerReferences/controller.mdx" +import PartialBlockownerdeletion from "./ownerReferences/blockOwnerDeletion.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/resourceVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/resourceVersion.mdx new file mode 100755 index 000000000..a76450008 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/resourceVersion.mdx @@ -0,0 +1,22 @@ + +
+ + +############ `resourceVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-resourceVersion} + +An opaque value that represents the internal version of this object that can +be used by clients to determine when objects have changed. May be used for optimistic +concurrency, change detection, and the watch operation on a resource or set of resources. +Clients must treat these values as opaque and passed unmodified back to the server. +They may only be valid for a particular resource or set of resources. + +Populated by the system. +Read-only. +Value must be treated as opaque by clients and . +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/selfLink.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/selfLink.mdx new file mode 100755 index 000000000..bb64f2531 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/selfLink.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `selfLink` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-selfLink} + +Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/uid.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/uid.mdx new file mode 100755 index 000000000..b370ea6b6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata/uid.mdx @@ -0,0 +1,19 @@ + +
+ + +############ `uid` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-uid} + +UID is the unique in time and space value for this object. It is typically generated by +the server on successful creation of a resource and is not allowed to change on PUT +operations. + +Populated by the system. +Read-only. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata_reference.mdx new file mode 100755 index 000000000..7d42a9d91 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/metadata_reference.mdx @@ -0,0 +1,146 @@ + +import PartialName from "./metadata/name.mdx" +import PartialGeneratename from "./metadata/generateName.mdx" +import PartialNamespace from "./metadata/namespace.mdx" +import PartialSelflink from "./metadata/selfLink.mdx" +import PartialUid from "./metadata/uid.mdx" +import PartialResourceversion from "./metadata/resourceVersion.mdx" +import PartialGeneration from "./metadata/generation.mdx" +import PartialCreationtimestampreference from "./metadata/creationTimestamp_reference.mdx" +import PartialDeletiontimestampreference from "./metadata/deletionTimestamp_reference.mdx" +import PartialDeletiongraceperiodseconds from "./metadata/deletionGracePeriodSeconds.mdx" +import PartialLabels from "./metadata/labels.mdx" +import PartialAnnotations from "./metadata/annotations.mdx" +import PartialOwnerreferencesreference from "./metadata/ownerReferences_reference.mdx" +import PartialFinalizers from "./metadata/finalizers.mdx" +import PartialManagedfieldsreference from "./metadata/managedFields_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +############ `creationTimestamp` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-creationTimestamp} + +CreationTimestamp is a timestamp representing the server time when this object was +created. It is not guaranteed to be set in happens-before order across separate operations. +Clients may not set this value. It is represented in RFC3339 form and is in UTC. + +Populated by the system. +Read-only. +Null for lists. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
+ + + +
+ + +############ `deletionTimestamp` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-deletionTimestamp} + +DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This +field is set by the server when a graceful deletion is requested by the user, and is not +directly settable by a client. The resource is expected to be deleted (no longer visible +from resource lists, and not reachable by name) after the time in this field, once the +finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. +Once the deletionTimestamp is set, this value may not be unset or be set further into the +future, although it may be shortened or the resource may be deleted prior to this time. +For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react +by sending a graceful termination signal to the containers in the pod. After that 30 seconds, +the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, +remove the pod from the API. In the presence of network partitions, this object may still +exist after this timestamp, until an administrator or automated process can determine the +resource is fully terminated. +If not set, graceful deletion of the object has not been requested. + +Populated by the system when a graceful deletion is requested. +Read-only. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + +
+ + + + + + + + + + + + +
+ + +############ `ownerReferences` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-ownerReferences} + +List of objects depended by this object. If ALL objects in the list have +been deleted, this object will be garbage collected. If this object is managed by a controller, +then an entry in this list will point to this controller, with the controller field set to true. +There cannot be more than one managing controller. + + + + + + +
+ + + + + + +
+ + +############ `managedFields` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata-managedFields} + +ManagedFields maps workflow-id and version to the set of fields +that are managed by that workflow. This is mostly for internal +housekeeping, and users typically shouldn't need to set or +understand this field. A workflow can be the user's name, a +controller's name, or the name of a specific apply path like +"ci-cd". The set of fields is always in the version that the +workflow used when modifying the object. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec.mdx new file mode 100755 index 000000000..12cd63b77 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec.mdx @@ -0,0 +1,20 @@ + +import PartialSpecreference from "./spec_reference.mdx" + + +
+ + +########### `spec` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/accessModes.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/accessModes.mdx new file mode 100755 index 000000000..5b3610ed6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/accessModes.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `accessModes` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-accessModes} + +accessModes contains the desired access modes the volume should have. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource.mdx new file mode 100755 index 000000000..5a1098aad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource.mdx @@ -0,0 +1,24 @@ + +import PartialDatasourcereference from "./dataSource_reference.mdx" + + +
+ + +############ `dataSource` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSource} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/apiGroup.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/apiGroup.mdx new file mode 100755 index 000000000..bf1081486 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/apiGroup.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `apiGroup` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSource-apiGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/kind.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/kind.mdx new file mode 100755 index 000000000..37a01d24b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `kind` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSource-kind} + +Kind is the type of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/name.mdx new file mode 100755 index 000000000..412c36e8d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource/name.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSource-name} + +Name is the name of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef.mdx new file mode 100755 index 000000000..589e7aaae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef.mdx @@ -0,0 +1,39 @@ + +import PartialDatasourcerefreference from "./dataSourceRef_reference.mdx" + + +
+ + +############ `dataSourceRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSourceRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/apiGroup.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/apiGroup.mdx new file mode 100755 index 000000000..2279e1c38 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/apiGroup.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `apiGroup` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSourceRef-apiGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/kind.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/kind.mdx new file mode 100755 index 000000000..596c3e850 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `kind` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSourceRef-kind} + +Kind is the type of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/name.mdx new file mode 100755 index 000000000..215fc752e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/name.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSourceRef-name} + +Name is the name of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/namespace.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/namespace.mdx new file mode 100755 index 000000000..70ffbfc09 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef/namespace.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `namespace` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSourceRef-namespace} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef_reference.mdx new file mode 100755 index 000000000..81c1fc07a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSourceRef_reference.mdx @@ -0,0 +1,16 @@ + +import PartialApigroup from "./dataSourceRef/apiGroup.mdx" +import PartialKind from "./dataSourceRef/kind.mdx" +import PartialName from "./dataSourceRef/name.mdx" +import PartialNamespace from "./dataSourceRef/namespace.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource_reference.mdx new file mode 100755 index 000000000..b3b329ede --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/dataSource_reference.mdx @@ -0,0 +1,12 @@ + +import PartialApigroup from "./dataSource/apiGroup.mdx" +import PartialKind from "./dataSource/kind.mdx" +import PartialName from "./dataSource/name.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources.mdx new file mode 100755 index 000000000..dfda04390 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources.mdx @@ -0,0 +1,21 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +############ `resources` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-resources} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/limits.mdx new file mode 100755 index 000000000..0b2d8bcd5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +############# `limits` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/requests.mdx new file mode 100755 index 000000000..a767830c0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +############# `requests` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources_reference.mdx new file mode 100755 index 000000000..ca0bf4da6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/resources_reference.mdx @@ -0,0 +1,38 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" + + +
+ + +############# `limits` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +############# `requests` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector.mdx new file mode 100755 index 000000000..8574a6a16 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector.mdx @@ -0,0 +1,17 @@ + +import PartialSelectorreference from "./selector_reference.mdx" + + +
+ + +############ `selector` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector} + +selector is a label query over volumes to consider for binding. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions.mdx new file mode 100755 index 000000000..c3fe35d79 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/key.mdx new file mode 100755 index 000000000..10093675b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `key` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/operator.mdx new file mode 100755 index 000000000..0ee769647 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############## `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/values.mdx new file mode 100755 index 000000000..f98629782 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############## `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchLabels.mdx new file mode 100755 index 000000000..26766ae32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector_reference.mdx new file mode 100755 index 000000000..76d5d6c06 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/selector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./selector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./selector/matchExpressions_reference.mdx" + + + + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/storageClassName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/storageClassName.mdx new file mode 100755 index 000000000..20520a17d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/storageClassName.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `storageClassName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-storageClassName} + +storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeAttributesClassName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeAttributesClassName.mdx new file mode 100755 index 000000000..3303ebb89 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeAttributesClassName.mdx @@ -0,0 +1,24 @@ + +
+ + +############ `volumeAttributesClassName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-volumeAttributesClassName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeMode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeMode.mdx new file mode 100755 index 000000000..fe56fb3cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeMode.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `volumeMode` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-volumeMode} + +volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeName.mdx new file mode 100755 index 000000000..86a97dd6d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec/volumeName.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `volumeName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-volumeName} + +volumeName is the binding reference to the PersistentVolume backing this claim. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec_reference.mdx new file mode 100755 index 000000000..5f55373f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate/spec_reference.mdx @@ -0,0 +1,121 @@ + +import PartialAccessmodes from "./spec/accessModes.mdx" +import PartialSelectorreference from "./spec/selector_reference.mdx" +import PartialResourcesreference from "./spec/resources_reference.mdx" +import PartialVolumename from "./spec/volumeName.mdx" +import PartialStorageclassname from "./spec/storageClassName.mdx" +import PartialVolumemode from "./spec/volumeMode.mdx" +import PartialDatasourcereference from "./spec/dataSource_reference.mdx" +import PartialDatasourcerefreference from "./spec/dataSourceRef_reference.mdx" +import PartialVolumeattributesclassname from "./spec/volumeAttributesClassName.mdx" + + + + + +
+ + +############ `selector` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-selector} + +selector is a label query over volumes to consider for binding. + + + + + + +
+ + + +
+ + +############ `resources` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-resources} + +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 + + + + + + +
+ + + + + + + + + + + + +
+ + +############ `dataSource` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSource} + +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. + + + + + + +
+ + + +
+ + +############ `dataSourceRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec-dataSourceRef} + +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. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate_reference.mdx new file mode 100755 index 000000000..5e3c68574 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral/volumeClaimTemplate_reference.mdx @@ -0,0 +1,37 @@ + +import PartialMetadatareference from "./volumeClaimTemplate/metadata_reference.mdx" +import PartialSpecreference from "./volumeClaimTemplate/spec_reference.mdx" + + +
+ + +########### `metadata` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-metadata} + + + + + + + + +
+ + + +
+ + +########### `spec` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate-spec} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral_reference.mdx new file mode 100755 index 000000000..52d4fe839 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/ephemeral_reference.mdx @@ -0,0 +1,37 @@ + +import PartialVolumeclaimtemplatereference from "./ephemeral/volumeClaimTemplate_reference.mdx" + + +
+ + +########## `volumeClaimTemplate` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral-volumeClaimTemplate} + +Will be used to create a stand-alone PVC to provision the volume. +The pod in which this EphemeralVolumeSource is embedded will be the +owner of the PVC, i.e. the PVC will be deleted together with the +pod. The name of the PVC will be `<pod name>-<volume name>` where +`<volume name>` is the name from the `PodSpec.Volumes` array +entry. Pod validation will reject the pod if the concatenated name +is not valid for a PVC (for example, too long). + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc.mdx new file mode 100755 index 000000000..65737e05d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc.mdx @@ -0,0 +1,17 @@ + +import PartialFcreference from "./fc_reference.mdx" + + +
+ + +######### `fc` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-fc} + +fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/fsType.mdx new file mode 100755 index 000000000..d6b4c32b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/fsType.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-fc-fsType} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/lun.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/lun.mdx new file mode 100755 index 000000000..b1a57a1a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/lun.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `lun` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-fc-lun} + +lun is Optional: FC target lun number + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/readOnly.mdx new file mode 100755 index 000000000..047fedfe2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-fc-readOnly} + +readOnly is Optional: Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/targetWWNs.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/targetWWNs.mdx new file mode 100755 index 000000000..69194e59c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/targetWWNs.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `targetWWNs` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-fc-targetWWNs} + +targetWWNs is Optional: FC target worldwide names (WWNs) + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/wwids.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/wwids.mdx new file mode 100755 index 000000000..d1e9bd3a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc/wwids.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `wwids` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-fc-wwids} + +wwids Optional: FC volume world wide identifiers (wwids) +Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc_reference.mdx new file mode 100755 index 000000000..0e36ac904 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/fc_reference.mdx @@ -0,0 +1,20 @@ + +import PartialTargetwwns from "./fc/targetWWNs.mdx" +import PartialLun from "./fc/lun.mdx" +import PartialFstype from "./fc/fsType.mdx" +import PartialReadonly from "./fc/readOnly.mdx" +import PartialWwids from "./fc/wwids.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume.mdx new file mode 100755 index 000000000..becb1acae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume.mdx @@ -0,0 +1,18 @@ + +import PartialFlexvolumereference from "./flexVolume_reference.mdx" + + +
+ + +######### `flexVolume` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume} + +flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/driver.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/driver.mdx new file mode 100755 index 000000000..cf1d41164 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/driver.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `driver` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume-driver} + +driver is the name of the driver to use for this volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/fsType.mdx new file mode 100755 index 000000000..6bbe6c98e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/fsType.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume-fsType} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/options.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/options.mdx new file mode 100755 index 000000000..4bc7e2002 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/options.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `options` required object {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume-options} + +options is Optional: this field holds extra command options if any. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/readOnly.mdx new file mode 100755 index 000000000..969a47298 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume-readOnly} + +readOnly is Optional: defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef.mdx new file mode 100755 index 000000000..c788d16f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef.mdx @@ -0,0 +1,21 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume-secretRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef/name.mdx new file mode 100755 index 000000000..71062d532 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef_reference.mdx new file mode 100755 index 000000000..902159278 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume/secretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./secretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume_reference.mdx new file mode 100755 index 000000000..5dd302924 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flexVolume_reference.mdx @@ -0,0 +1,37 @@ + +import PartialDriver from "./flexVolume/driver.mdx" +import PartialFstype from "./flexVolume/fsType.mdx" +import PartialSecretrefreference from "./flexVolume/secretRef_reference.mdx" +import PartialReadonly from "./flexVolume/readOnly.mdx" +import PartialOptions from "./flexVolume/options.mdx" + + + + + + + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume-secretRef} + +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. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker.mdx new file mode 100755 index 000000000..76db24900 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker.mdx @@ -0,0 +1,17 @@ + +import PartialFlockerreference from "./flocker_reference.mdx" + + +
+ + +######### `flocker` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-flocker} + +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker/datasetName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker/datasetName.mdx new file mode 100755 index 000000000..34479ae85 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker/datasetName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `datasetName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-flocker-datasetName} + +datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker +should be considered as deprecated + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker/datasetUUID.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker/datasetUUID.mdx new file mode 100755 index 000000000..4bcb28fb3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker/datasetUUID.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `datasetUUID` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-flocker-datasetUUID} + +datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker_reference.mdx new file mode 100755 index 000000000..473e02ac5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/flocker_reference.mdx @@ -0,0 +1,8 @@ + +import PartialDatasetname from "./flocker/datasetName.mdx" +import PartialDatasetuuid from "./flocker/datasetUUID.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk.mdx new file mode 100755 index 000000000..0c69fd7d1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk.mdx @@ -0,0 +1,19 @@ + +import PartialGcepersistentdiskreference from "./gcePersistentDisk_reference.mdx" + + +
+ + +######### `gcePersistentDisk` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-gcePersistentDisk} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/fsType.mdx new file mode 100755 index 000000000..dd6aa8046 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/fsType.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-gcePersistentDisk-fsType} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/partition.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/partition.mdx new file mode 100755 index 000000000..e85b317f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/partition.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `partition` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-gcePersistentDisk-partition} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/pdName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/pdName.mdx new file mode 100755 index 000000000..3c3f0040b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/pdName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `pdName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-gcePersistentDisk-pdName} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/readOnly.mdx new file mode 100755 index 000000000..85e6f0074 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk/readOnly.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-gcePersistentDisk-readOnly} + +readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk_reference.mdx new file mode 100755 index 000000000..17c9be461 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gcePersistentDisk_reference.mdx @@ -0,0 +1,16 @@ + +import PartialPdname from "./gcePersistentDisk/pdName.mdx" +import PartialFstype from "./gcePersistentDisk/fsType.mdx" +import PartialPartition from "./gcePersistentDisk/partition.mdx" +import PartialReadonly from "./gcePersistentDisk/readOnly.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo.mdx new file mode 100755 index 000000000..6c57d2471 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo.mdx @@ -0,0 +1,20 @@ + +import PartialGitreporeference from "./gitRepo_reference.mdx" + + +
+ + +######### `gitRepo` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-gitRepo} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/directory.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/directory.mdx new file mode 100755 index 000000000..79a9bc787 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/directory.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `directory` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-gitRepo-directory} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/repository.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/repository.mdx new file mode 100755 index 000000000..e248f69d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/repository.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `repository` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-gitRepo-repository} + +repository is the URL + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/revision.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/revision.mdx new file mode 100755 index 000000000..b60dea72a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo/revision.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `revision` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-gitRepo-revision} + +revision is the commit hash for the specified revision. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo_reference.mdx new file mode 100755 index 000000000..307796132 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/gitRepo_reference.mdx @@ -0,0 +1,12 @@ + +import PartialRepository from "./gitRepo/repository.mdx" +import PartialRevision from "./gitRepo/revision.mdx" +import PartialDirectory from "./gitRepo/directory.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs.mdx new file mode 100755 index 000000000..5d2418671 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs.mdx @@ -0,0 +1,18 @@ + +import PartialGlusterfsreference from "./glusterfs_reference.mdx" + + +
+ + +######### `glusterfs` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-glusterfs} + +glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/endpoints.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/endpoints.mdx new file mode 100755 index 000000000..37c6a83a2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/endpoints.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `endpoints` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-glusterfs-endpoints} + +endpoints is the endpoint name that details Glusterfs topology. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/path.mdx new file mode 100755 index 000000000..c02ae73fc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/path.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-glusterfs-path} + +path is the Glusterfs volume path. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/readOnly.mdx new file mode 100755 index 000000000..4219eb5fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs/readOnly.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-glusterfs-readOnly} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs_reference.mdx new file mode 100755 index 000000000..7238eb33d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/glusterfs_reference.mdx @@ -0,0 +1,12 @@ + +import PartialEndpoints from "./glusterfs/endpoints.mdx" +import PartialPath from "./glusterfs/path.mdx" +import PartialReadonly from "./glusterfs/readOnly.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath.mdx new file mode 100755 index 000000000..786d40a79 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath.mdx @@ -0,0 +1,24 @@ + +import PartialHostpathreference from "./hostPath_reference.mdx" + + +
+ + +######### `hostPath` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-hostPath} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath/path.mdx new file mode 100755 index 000000000..be0a8e4bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath/path.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-hostPath-path} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath/type.mdx new file mode 100755 index 000000000..3dbfbc1a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath/type.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `type` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-hostPath-type} + +type for HostPath Volume +Defaults to "" +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath_reference.mdx new file mode 100755 index 000000000..8e4dc58b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/hostPath_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPath from "./hostPath/path.mdx" +import PartialType from "./hostPath/type.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi.mdx new file mode 100755 index 000000000..07d97bf45 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi.mdx @@ -0,0 +1,19 @@ + +import PartialIscsireference from "./iscsi_reference.mdx" + + +
+ + +######### `iscsi` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/chapAuthDiscovery.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/chapAuthDiscovery.mdx new file mode 100755 index 000000000..3b0cb33c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/chapAuthDiscovery.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `chapAuthDiscovery` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-chapAuthDiscovery} + +chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/chapAuthSession.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/chapAuthSession.mdx new file mode 100755 index 000000000..dcf298d46 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/chapAuthSession.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `chapAuthSession` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-chapAuthSession} + +chapAuthSession defines whether support iSCSI Session CHAP authentication + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/fsType.mdx new file mode 100755 index 000000000..143391742 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/fsType.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-fsType} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/initiatorName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/initiatorName.mdx new file mode 100755 index 000000000..febbee189 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/initiatorName.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `initiatorName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-initiatorName} + +initiatorName is the custom iSCSI Initiator Name. +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface +<target portal>:<volume name> will be created for the connection. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/iqn.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/iqn.mdx new file mode 100755 index 000000000..9cb6376b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/iqn.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `iqn` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-iqn} + +iqn is the target iSCSI Qualified Name. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/iscsiInterface.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/iscsiInterface.mdx new file mode 100755 index 000000000..cf633ea3d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/iscsiInterface.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `iscsiInterface` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-iscsiInterface} + +iscsiInterface is the interface Name that uses an iSCSI transport. +Defaults to 'default' (tcp). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/lun.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/lun.mdx new file mode 100755 index 000000000..48dd09d8e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/lun.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `lun` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-lun} + +lun represents iSCSI Target Lun number. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/portals.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/portals.mdx new file mode 100755 index 000000000..b865f5546 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/portals.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `portals` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-portals} + +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). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/readOnly.mdx new file mode 100755 index 000000000..4d0524fbc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-readOnly} + +readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef.mdx new file mode 100755 index 000000000..1590ebf7c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-secretRef} + +secretRef is the CHAP Secret for iSCSI target and initiator authentication + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef/name.mdx new file mode 100755 index 000000000..5ba9f8b99 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef_reference.mdx new file mode 100755 index 000000000..902159278 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/secretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./secretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/targetPortal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/targetPortal.mdx new file mode 100755 index 000000000..68d953592 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi/targetPortal.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `targetPortal` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-targetPortal} + +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). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi_reference.mdx new file mode 100755 index 000000000..5952bf1c4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/iscsi_reference.mdx @@ -0,0 +1,57 @@ + +import PartialTargetportal from "./iscsi/targetPortal.mdx" +import PartialIqn from "./iscsi/iqn.mdx" +import PartialLun from "./iscsi/lun.mdx" +import PartialIscsiinterface from "./iscsi/iscsiInterface.mdx" +import PartialFstype from "./iscsi/fsType.mdx" +import PartialReadonly from "./iscsi/readOnly.mdx" +import PartialPortals from "./iscsi/portals.mdx" +import PartialChapauthdiscovery from "./iscsi/chapAuthDiscovery.mdx" +import PartialChapauthsession from "./iscsi/chapAuthSession.mdx" +import PartialSecretrefreference from "./iscsi/secretRef_reference.mdx" +import PartialInitiatorname from "./iscsi/initiatorName.mdx" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi-secretRef} + +secretRef is the CHAP Secret for iSCSI target and initiator authentication + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/name.mdx new file mode 100755 index 000000000..276a38d07 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-name} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs.mdx new file mode 100755 index 000000000..9cab361a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs.mdx @@ -0,0 +1,18 @@ + +import PartialNfsreference from "./nfs_reference.mdx" + + +
+ + +######### `nfs` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-nfs} + +nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/path.mdx new file mode 100755 index 000000000..caca2242e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/path.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-nfs-path} + +path that is exported by the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/readOnly.mdx new file mode 100755 index 000000000..4bd2247cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/readOnly.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-nfs-readOnly} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/server.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/server.mdx new file mode 100755 index 000000000..6af0edafa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs/server.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `server` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-nfs-server} + +server is the hostname or IP address of the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs_reference.mdx new file mode 100755 index 000000000..f7042ffb4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/nfs_reference.mdx @@ -0,0 +1,12 @@ + +import PartialServer from "./nfs/server.mdx" +import PartialPath from "./nfs/path.mdx" +import PartialReadonly from "./nfs/readOnly.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim.mdx new file mode 100755 index 000000000..e3fa8f6f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim.mdx @@ -0,0 +1,19 @@ + +import PartialPersistentvolumeclaimreference from "./persistentVolumeClaim_reference.mdx" + + +
+ + +######### `persistentVolumeClaim` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-persistentVolumeClaim} + +persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim/claimName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim/claimName.mdx new file mode 100755 index 000000000..0fbc80651 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim/claimName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `claimName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-persistentVolumeClaim-claimName} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim/readOnly.mdx new file mode 100755 index 000000000..ca1b3faa5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-persistentVolumeClaim-readOnly} + +readOnly Will force the ReadOnly setting in VolumeMounts. +Default false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim_reference.mdx new file mode 100755 index 000000000..04bd2e1d2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/persistentVolumeClaim_reference.mdx @@ -0,0 +1,8 @@ + +import PartialClaimname from "./persistentVolumeClaim/claimName.mdx" +import PartialReadonly from "./persistentVolumeClaim/readOnly.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk.mdx new file mode 100755 index 000000000..d9a76d67c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk.mdx @@ -0,0 +1,17 @@ + +import PartialPhotonpersistentdiskreference from "./photonPersistentDisk_reference.mdx" + + +
+ + +######### `photonPersistentDisk` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-photonPersistentDisk} + +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk/fsType.mdx new file mode 100755 index 000000000..490e727b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk/fsType.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-photonPersistentDisk-fsType} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk/pdID.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk/pdID.mdx new file mode 100755 index 000000000..f070f0a11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk/pdID.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `pdID` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-photonPersistentDisk-pdID} + +pdID is the ID that identifies Photon Controller persistent disk + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk_reference.mdx new file mode 100755 index 000000000..7b97b92cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/photonPersistentDisk_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPdid from "./photonPersistentDisk/pdID.mdx" +import PartialFstype from "./photonPersistentDisk/fsType.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume.mdx new file mode 100755 index 000000000..6021cfb55 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume.mdx @@ -0,0 +1,17 @@ + +import PartialPortworxvolumereference from "./portworxVolume_reference.mdx" + + +
+ + +######### `portworxVolume` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-portworxVolume} + +portworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/fsType.mdx new file mode 100755 index 000000000..a295eff87 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/fsType.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-portworxVolume-fsType} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/readOnly.mdx new file mode 100755 index 000000000..b9e084c29 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-portworxVolume-readOnly} + +readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/volumeID.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/volumeID.mdx new file mode 100755 index 000000000..773602655 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume/volumeID.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `volumeID` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-portworxVolume-volumeID} + +volumeID uniquely identifies a Portworx volume + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume_reference.mdx new file mode 100755 index 000000000..ebc45368e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/portworxVolume_reference.mdx @@ -0,0 +1,12 @@ + +import PartialVolumeid from "./portworxVolume/volumeID.mdx" +import PartialFstype from "./portworxVolume/fsType.mdx" +import PartialReadonly from "./portworxVolume/readOnly.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected.mdx new file mode 100755 index 000000000..0a405a72c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected.mdx @@ -0,0 +1,17 @@ + +import PartialProjectedreference from "./projected_reference.mdx" + + +
+ + +######### `projected` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected} + +projected items for all in one resources secrets, configmaps, and downward API + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/defaultMode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/defaultMode.mdx new file mode 100755 index 000000000..efdda7670 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/defaultMode.mdx @@ -0,0 +1,18 @@ + +
+ + +########## `defaultMode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-defaultMode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources.mdx new file mode 100755 index 000000000..c0660b4f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources.mdx @@ -0,0 +1,17 @@ + +import PartialSourcesreference from "./sources_reference.mdx" + + +
+ + +########## `sources` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources} + +sources is the list of volume projections + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle.mdx new file mode 100755 index 000000000..85edd8820 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle.mdx @@ -0,0 +1,30 @@ + +import PartialClustertrustbundlereference from "./clusterTrustBundle_reference.mdx" + + +
+ + +########### `clusterTrustBundle` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector.mdx new file mode 100755 index 000000000..47f2a9a83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector.mdx @@ -0,0 +1,20 @@ + +import PartialLabelselectorreference from "./labelSelector_reference.mdx" + + +
+ + +############ `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector} + +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". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions.mdx new file mode 100755 index 000000000..850f48d4e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..06a393c0c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `key` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..47f322e91 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +############## `operator` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..60b827d36 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +############## `values` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchLabels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchLabels.mdx new file mode 100755 index 000000000..75b059717 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +############# `matchLabels` required object {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector_reference.mdx new file mode 100755 index 000000000..c86cd7cc6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/labelSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./labelSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./labelSelector/matchExpressions_reference.mdx" + + + + + +
+ + +############# `matchExpressions` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/name.mdx new file mode 100755 index 000000000..4cc2ab567 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/name.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-name} + +Select a single ClusterTrustBundle by object name. Mutually-exclusive +with signerName and labelSelector. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/optional.mdx new file mode 100755 index 000000000..c54af8644 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/optional.mdx @@ -0,0 +1,17 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-optional} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/path.mdx new file mode 100755 index 000000000..497d266cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-path} + +Relative path from the volume root to write the bundle. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/signerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/signerName.mdx new file mode 100755 index 000000000..ee7a903cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle/signerName.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `signerName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-signerName} + +Select all ClusterTrustBundles that match this signer name. +Mutually-exclusive with name. The contents of all selected +ClusterTrustBundles will be unified and deduplicated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle_reference.mdx new file mode 100755 index 000000000..4165e1d53 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/clusterTrustBundle_reference.mdx @@ -0,0 +1,36 @@ + +import PartialName from "./clusterTrustBundle/name.mdx" +import PartialSignername from "./clusterTrustBundle/signerName.mdx" +import PartialLabelselectorreference from "./clusterTrustBundle/labelSelector_reference.mdx" +import PartialOptional from "./clusterTrustBundle/optional.mdx" +import PartialPath from "./clusterTrustBundle/path.mdx" + + + + + + + + +
+ + +############ `labelSelector` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle-labelSelector} + +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". + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap.mdx new file mode 100755 index 000000000..4dc8432ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapreference from "./configMap_reference.mdx" + + +
+ + +########### `configMap` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap} + +configMap information about the configMap data to project + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items.mdx new file mode 100755 index 000000000..3704dd52f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items.mdx @@ -0,0 +1,23 @@ + +import PartialItemsreference from "./items_reference.mdx" + + +
+ + +############ `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap-items} + +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 '..'. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/key.mdx new file mode 100755 index 000000000..0f0cf3578 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap-items-key} + +key is the key to project. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/mode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/mode.mdx new file mode 100755 index 000000000..9e3b9e8d9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/mode.mdx @@ -0,0 +1,18 @@ + +
+ + +############# `mode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap-items-mode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/path.mdx new file mode 100755 index 000000000..9dcf81466 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items/path.mdx @@ -0,0 +1,16 @@ + +
+ + +############# `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap-items-path} + +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 '..'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items_reference.mdx new file mode 100755 index 000000000..3fe9464f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/items_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./items/key.mdx" +import PartialPath from "./items/path.mdx" +import PartialMode from "./items/mode.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/name.mdx new file mode 100755 index 000000000..8d5184aa4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/optional.mdx new file mode 100755 index 000000000..e683ec2c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap-optional} + +optional specify whether the ConfigMap or its keys must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap_reference.mdx new file mode 100755 index 000000000..252696a4b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/configMap_reference.mdx @@ -0,0 +1,31 @@ + +import PartialName from "./configMap/name.mdx" +import PartialItemsreference from "./configMap/items_reference.mdx" +import PartialOptional from "./configMap/optional.mdx" + + + + + +
+ + +############ `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap-items} + +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 '..'. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI.mdx new file mode 100755 index 000000000..a8680ab61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI.mdx @@ -0,0 +1,17 @@ + +import PartialDownwardapireference from "./downwardAPI_reference.mdx" + + +
+ + +########### `downwardAPI` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI} + +downwardAPI information about the downwardAPI data to project + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items.mdx new file mode 100755 index 000000000..3566889d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items.mdx @@ -0,0 +1,17 @@ + +import PartialItemsreference from "./items_reference.mdx" + + +
+ + +############ `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items} + +Items is a list of DownwardAPIVolume file + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef.mdx new file mode 100755 index 000000000..470e8ee2d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef.mdx @@ -0,0 +1,17 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +############# `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-fieldRef} + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..f378e12c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `apiVersion` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..2dd09cfb5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `fieldPath` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/mode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/mode.mdx new file mode 100755 index 000000000..b7f6af566 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/mode.mdx @@ -0,0 +1,18 @@ + +
+ + +############# `mode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-mode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/path.mdx new file mode 100755 index 000000000..5f2f242b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/path.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-path} + +Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef.mdx new file mode 100755 index 000000000..ddca4bf7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +############# `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-resourceFieldRef} + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..936fcb4e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `containerName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..ee46c0a13 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +############## `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..5f9d54d2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +############### `Format` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..a802e316e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +############## `resource` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..2d05f4ecd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +############## `divisor` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items_reference.mdx new file mode 100755 index 000000000..c73709beb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI/items_reference.mdx @@ -0,0 +1,43 @@ + +import PartialPath from "./items/path.mdx" +import PartialFieldrefreference from "./items/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./items/resourceFieldRef_reference.mdx" +import PartialMode from "./items/mode.mdx" + + + + + +
+ + +############# `fieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-fieldRef} + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + +
+ + + +
+ + +############# `resourceFieldRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items-resourceFieldRef} + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI_reference.mdx new file mode 100755 index 000000000..10540a77d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/downwardAPI_reference.mdx @@ -0,0 +1,17 @@ + +import PartialItemsreference from "./downwardAPI/items_reference.mdx" + + +
+ + +############ `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI-items} + +Items is a list of DownwardAPIVolume file + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret.mdx new file mode 100755 index 000000000..817b0736c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret.mdx @@ -0,0 +1,17 @@ + +import PartialSecretreference from "./secret_reference.mdx" + + +
+ + +########### `secret` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret} + +secret information about the secret data to project + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items.mdx new file mode 100755 index 000000000..47572f334 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items.mdx @@ -0,0 +1,23 @@ + +import PartialItemsreference from "./items_reference.mdx" + + +
+ + +############ `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret-items} + +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 '..'. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/key.mdx new file mode 100755 index 000000000..89f0b3045 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/key.mdx @@ -0,0 +1,13 @@ + +
+ + +############# `key` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret-items-key} + +key is the key to project. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/mode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/mode.mdx new file mode 100755 index 000000000..f2516a589 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/mode.mdx @@ -0,0 +1,18 @@ + +
+ + +############# `mode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret-items-mode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/path.mdx new file mode 100755 index 000000000..a214a2a94 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items/path.mdx @@ -0,0 +1,16 @@ + +
+ + +############# `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret-items-path} + +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 '..'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items_reference.mdx new file mode 100755 index 000000000..3fe9464f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/items_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./items/key.mdx" +import PartialPath from "./items/path.mdx" +import PartialMode from "./items/mode.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/name.mdx new file mode 100755 index 000000000..974fbf52a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/name.mdx @@ -0,0 +1,15 @@ + +
+ + +############ `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/optional.mdx new file mode 100755 index 000000000..3a059231f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +############ `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret-optional} + +optional field specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret_reference.mdx new file mode 100755 index 000000000..e5141e189 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/secret_reference.mdx @@ -0,0 +1,31 @@ + +import PartialName from "./secret/name.mdx" +import PartialItemsreference from "./secret/items_reference.mdx" +import PartialOptional from "./secret/optional.mdx" + + + + + +
+ + +############ `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret-items} + +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 '..'. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken.mdx new file mode 100755 index 000000000..68098f1e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken.mdx @@ -0,0 +1,17 @@ + +import PartialServiceaccounttokenreference from "./serviceAccountToken_reference.mdx" + + +
+ + +########### `serviceAccountToken` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-serviceAccountToken} + +serviceAccountToken is information about the serviceAccountToken data to project + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/audience.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/audience.mdx new file mode 100755 index 000000000..2065b82e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/audience.mdx @@ -0,0 +1,16 @@ + +
+ + +############ `audience` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-serviceAccountToken-audience} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/expirationSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/expirationSeconds.mdx new file mode 100755 index 000000000..8287c41e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/expirationSeconds.mdx @@ -0,0 +1,18 @@ + +
+ + +############ `expirationSeconds` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-serviceAccountToken-expirationSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/path.mdx new file mode 100755 index 000000000..5de270844 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken/path.mdx @@ -0,0 +1,14 @@ + +
+ + +############ `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-serviceAccountToken-path} + +path is the path relative to the mount point of the file to project the +token into. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken_reference.mdx new file mode 100755 index 000000000..4f1f7aebe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources/serviceAccountToken_reference.mdx @@ -0,0 +1,12 @@ + +import PartialAudience from "./serviceAccountToken/audience.mdx" +import PartialExpirationseconds from "./serviceAccountToken/expirationSeconds.mdx" +import PartialPath from "./serviceAccountToken/path.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources_reference.mdx new file mode 100755 index 000000000..a6346cc25 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected/sources_reference.mdx @@ -0,0 +1,98 @@ + +import PartialSecretreference from "./sources/secret_reference.mdx" +import PartialDownwardapireference from "./sources/downwardAPI_reference.mdx" +import PartialConfigmapreference from "./sources/configMap_reference.mdx" +import PartialServiceaccounttokenreference from "./sources/serviceAccountToken_reference.mdx" +import PartialClustertrustbundlereference from "./sources/clusterTrustBundle_reference.mdx" + + +
+ + +########### `secret` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-secret} + +secret information about the secret data to project + + + + + + +
+ + + +
+ + +########### `downwardAPI` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-downwardAPI} + +downwardAPI information about the downwardAPI data to project + + + + + + +
+ + + +
+ + +########### `configMap` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-configMap} + +configMap information about the configMap data to project + + + + + + +
+ + + +
+ + +########### `serviceAccountToken` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-serviceAccountToken} + +serviceAccountToken is information about the serviceAccountToken data to project + + + + + + +
+ + + +
+ + +########### `clusterTrustBundle` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources-clusterTrustBundle} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected_reference.mdx new file mode 100755 index 000000000..cf3026777 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/projected_reference.mdx @@ -0,0 +1,21 @@ + +import PartialSourcesreference from "./projected/sources_reference.mdx" +import PartialDefaultmode from "./projected/defaultMode.mdx" + + +
+ + +########## `sources` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected-sources} + +sources is the list of volume projections + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte.mdx new file mode 100755 index 000000000..96bfa3e04 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte.mdx @@ -0,0 +1,17 @@ + +import PartialQuobytereference from "./quobyte_reference.mdx" + + +
+ + +######### `quobyte` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte} + +quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/group.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/group.mdx new file mode 100755 index 000000000..4a980b907 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/group.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `group` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte-group} + +group to map volume access to +Default is no group + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/readOnly.mdx new file mode 100755 index 000000000..987f904ea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte-readOnly} + +readOnly here will force the Quobyte volume to be mounted with read-only permissions. +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/registry.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/registry.mdx new file mode 100755 index 000000000..f960e72df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/registry.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `registry` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte-registry} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/tenant.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/tenant.mdx new file mode 100755 index 000000000..1142de38e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/tenant.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `tenant` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte-tenant} + +tenant owning the given Quobyte volume in the Backend +Used with dynamically provisioned Quobyte volumes, value is set by the plugin + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/user.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/user.mdx new file mode 100755 index 000000000..1b01527b6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/user.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `user` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte-user} + +user to map volume access to +Defaults to serivceaccount user + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/volume.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/volume.mdx new file mode 100755 index 000000000..d46468b95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte/volume.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `volume` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte-volume} + +volume is a string that references an already created Quobyte volume by name. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte_reference.mdx new file mode 100755 index 000000000..929c8563f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/quobyte_reference.mdx @@ -0,0 +1,24 @@ + +import PartialRegistry from "./quobyte/registry.mdx" +import PartialVolume from "./quobyte/volume.mdx" +import PartialReadonly from "./quobyte/readOnly.mdx" +import PartialUser from "./quobyte/user.mdx" +import PartialGroup from "./quobyte/group.mdx" +import PartialTenant from "./quobyte/tenant.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd.mdx new file mode 100755 index 000000000..8a23762e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd.mdx @@ -0,0 +1,18 @@ + +import PartialRbdreference from "./rbd_reference.mdx" + + +
+ + +######### `rbd` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/fsType.mdx new file mode 100755 index 000000000..bd7c75306 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/fsType.mdx @@ -0,0 +1,17 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-fsType} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/image.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/image.mdx new file mode 100755 index 000000000..9516dd9a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/image.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `image` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-image} + +image is the rados image name. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/keyring.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/keyring.mdx new file mode 100755 index 000000000..4e614dbd4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/keyring.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `keyring` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-keyring} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/monitors.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/monitors.mdx new file mode 100755 index 000000000..5bf65ecf5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/monitors.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `monitors` required string[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-monitors} + +monitors is a collection of Ceph monitors. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/pool.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/pool.mdx new file mode 100755 index 000000000..5b668bc81 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/pool.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `pool` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-pool} + +pool is the rados pool name. +Default is rbd. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/readOnly.mdx new file mode 100755 index 000000000..0b51a3627 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/readOnly.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-readOnly} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef.mdx new file mode 100755 index 000000000..1aa6e7da0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef.mdx @@ -0,0 +1,20 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-secretRef} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef/name.mdx new file mode 100755 index 000000000..8d093da68 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef_reference.mdx new file mode 100755 index 000000000..902159278 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/secretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./secretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/user.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/user.mdx new file mode 100755 index 000000000..e51d68ebf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd/user.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `user` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-user} + +user is the rados user name. +Default is admin. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd_reference.mdx new file mode 100755 index 000000000..6905861b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/rbd_reference.mdx @@ -0,0 +1,48 @@ + +import PartialMonitors from "./rbd/monitors.mdx" +import PartialImage from "./rbd/image.mdx" +import PartialFstype from "./rbd/fsType.mdx" +import PartialPool from "./rbd/pool.mdx" +import PartialUser from "./rbd/user.mdx" +import PartialKeyring from "./rbd/keyring.mdx" +import PartialSecretrefreference from "./rbd/secretRef_reference.mdx" +import PartialReadonly from "./rbd/readOnly.mdx" + + + + + + + + + + + + + + + + + + + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd-secretRef} + +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 + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO.mdx new file mode 100755 index 000000000..631ea5d5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO.mdx @@ -0,0 +1,17 @@ + +import PartialScaleioreference from "./scaleIO_reference.mdx" + + +
+ + +######### `scaleIO` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO} + +scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/fsType.mdx new file mode 100755 index 000000000..d03ad850d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/fsType.mdx @@ -0,0 +1,16 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-fsType} + +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". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/gateway.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/gateway.mdx new file mode 100755 index 000000000..03c77069e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/gateway.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `gateway` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-gateway} + +gateway is the host address of the ScaleIO API Gateway. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/protectionDomain.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/protectionDomain.mdx new file mode 100755 index 000000000..8403d55c6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/protectionDomain.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `protectionDomain` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-protectionDomain} + +protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/readOnly.mdx new file mode 100755 index 000000000..bea872dec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-readOnly} + +readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef.mdx new file mode 100755 index 000000000..40d599bd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef.mdx @@ -0,0 +1,18 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-secretRef} + +secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef/name.mdx new file mode 100755 index 000000000..a5b7b2737 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef_reference.mdx new file mode 100755 index 000000000..902159278 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/secretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./secretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/sslEnabled.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/sslEnabled.mdx new file mode 100755 index 000000000..52063a961 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/sslEnabled.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `sslEnabled` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-sslEnabled} + +sslEnabled Flag enable/disable SSL communication with Gateway, default false + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/storageMode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/storageMode.mdx new file mode 100755 index 000000000..394146969 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/storageMode.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `storageMode` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-storageMode} + +storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. +Default is ThinProvisioned. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/storagePool.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/storagePool.mdx new file mode 100755 index 000000000..fb8a3a2bb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/storagePool.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `storagePool` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-storagePool} + +storagePool is the ScaleIO Storage Pool associated with the protection domain. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/system.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/system.mdx new file mode 100755 index 000000000..f4fe7c90b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/system.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `system` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-system} + +system is the name of the storage system as configured in ScaleIO. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/volumeName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/volumeName.mdx new file mode 100755 index 000000000..088a00ac9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO/volumeName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `volumeName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-volumeName} + +volumeName is the name of a volume already created in the ScaleIO system +that is associated with this volume source. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO_reference.mdx new file mode 100755 index 000000000..41b2f6e4b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/scaleIO_reference.mdx @@ -0,0 +1,54 @@ + +import PartialGateway from "./scaleIO/gateway.mdx" +import PartialSystem from "./scaleIO/system.mdx" +import PartialSecretrefreference from "./scaleIO/secretRef_reference.mdx" +import PartialSslenabled from "./scaleIO/sslEnabled.mdx" +import PartialProtectiondomain from "./scaleIO/protectionDomain.mdx" +import PartialStoragepool from "./scaleIO/storagePool.mdx" +import PartialStoragemode from "./scaleIO/storageMode.mdx" +import PartialVolumename from "./scaleIO/volumeName.mdx" +import PartialFstype from "./scaleIO/fsType.mdx" +import PartialReadonly from "./scaleIO/readOnly.mdx" + + + + + + + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO-secretRef} + +secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret.mdx new file mode 100755 index 000000000..89672e0c8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret.mdx @@ -0,0 +1,18 @@ + +import PartialSecretreference from "./secret_reference.mdx" + + +
+ + +######### `secret` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret} + +secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/defaultMode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/defaultMode.mdx new file mode 100755 index 000000000..aea711210 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/defaultMode.mdx @@ -0,0 +1,19 @@ + +
+ + +########## `defaultMode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-defaultMode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items.mdx new file mode 100755 index 000000000..661b79210 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items.mdx @@ -0,0 +1,23 @@ + +import PartialItemsreference from "./items_reference.mdx" + + +
+ + +########## `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-items} + +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 '..'. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/key.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/key.mdx new file mode 100755 index 000000000..4dddd6203 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/key.mdx @@ -0,0 +1,13 @@ + +
+ + +########### `key` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-items-key} + +key is the key to project. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/mode.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/mode.mdx new file mode 100755 index 000000000..62f2cb4fb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/mode.mdx @@ -0,0 +1,18 @@ + +
+ + +########### `mode` required integer {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-items-mode} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/path.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/path.mdx new file mode 100755 index 000000000..effcb63e6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items/path.mdx @@ -0,0 +1,16 @@ + +
+ + +########### `path` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-items-path} + +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 '..'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items_reference.mdx new file mode 100755 index 000000000..3fe9464f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/items_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./items/key.mdx" +import PartialPath from "./items/path.mdx" +import PartialMode from "./items/mode.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/optional.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/optional.mdx new file mode 100755 index 000000000..df46c0c65 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `optional` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-optional} + +optional field specify whether the Secret or its keys must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/secretName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/secretName.mdx new file mode 100755 index 000000000..25a94d96c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret/secretName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `secretName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-secretName} + +secretName is the name of the secret in the pod's namespace to use. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret_reference.mdx new file mode 100755 index 000000000..f4b37fcd8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/secret_reference.mdx @@ -0,0 +1,35 @@ + +import PartialSecretname from "./secret/secretName.mdx" +import PartialItemsreference from "./secret/items_reference.mdx" +import PartialDefaultmode from "./secret/defaultMode.mdx" +import PartialOptional from "./secret/optional.mdx" + + + + + +
+ + +########## `items` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret-items} + +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 '..'. + + + + + + +
+ + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos.mdx new file mode 100755 index 000000000..6d66ef600 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos.mdx @@ -0,0 +1,17 @@ + +import PartialStorageosreference from "./storageos_reference.mdx" + + +
+ + +######### `storageos` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos} + +storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/fsType.mdx new file mode 100755 index 000000000..935472e9a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/fsType.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos-fsType} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/readOnly.mdx new file mode 100755 index 000000000..93fbf7545 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `readOnly` required boolean false {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos-readOnly} + +readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef.mdx new file mode 100755 index 000000000..c55e9f7e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef.mdx @@ -0,0 +1,18 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos-secretRef} + +secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef/name.mdx new file mode 100755 index 000000000..5496985d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +########### `name` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef_reference.mdx new file mode 100755 index 000000000..902159278 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/secretRef_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./secretRef/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/volumeName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/volumeName.mdx new file mode 100755 index 000000000..1b1db5839 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/volumeName.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `volumeName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos-volumeName} + +volumeName is the human-readable name of the StorageOS volume. Volume +names are only unique within a namespace. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/volumeNamespace.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/volumeNamespace.mdx new file mode 100755 index 000000000..9412f864b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos/volumeNamespace.mdx @@ -0,0 +1,18 @@ + +
+ + +########## `volumeNamespace` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos-volumeNamespace} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos_reference.mdx new file mode 100755 index 000000000..668aa5410 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/storageos_reference.mdx @@ -0,0 +1,34 @@ + +import PartialVolumename from "./storageos/volumeName.mdx" +import PartialVolumenamespace from "./storageos/volumeNamespace.mdx" +import PartialFstype from "./storageos/fsType.mdx" +import PartialReadonly from "./storageos/readOnly.mdx" +import PartialSecretrefreference from "./storageos/secretRef_reference.mdx" + + + + + + + + + + + + + + +
+ + +########## `secretRef` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos-secretRef} + +secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume.mdx new file mode 100755 index 000000000..a974764fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume.mdx @@ -0,0 +1,17 @@ + +import PartialVspherevolumereference from "./vsphereVolume_reference.mdx" + + +
+ + +######### `vsphereVolume` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-vsphereVolume} + +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/fsType.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/fsType.mdx new file mode 100755 index 000000000..bbde4da7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/fsType.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `fsType` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-vsphereVolume-fsType} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/storagePolicyID.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/storagePolicyID.mdx new file mode 100755 index 000000000..af51f22d4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/storagePolicyID.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `storagePolicyID` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-vsphereVolume-storagePolicyID} + +storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/storagePolicyName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/storagePolicyName.mdx new file mode 100755 index 000000000..6065e8e39 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/storagePolicyName.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `storagePolicyName` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-vsphereVolume-storagePolicyName} + +storagePolicyName is the storage Policy Based Management (SPBM) profile name. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/volumePath.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/volumePath.mdx new file mode 100755 index 000000000..c11c92329 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume/volumePath.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `volumePath` required string {#controlPlane-coredns-deployment-spec-template-spec-volumes-vsphereVolume-volumePath} + +volumePath is the path that identifies vSphere volume vmdk + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume_reference.mdx new file mode 100755 index 000000000..ab9f7cbf3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes/vsphereVolume_reference.mdx @@ -0,0 +1,16 @@ + +import PartialVolumepath from "./vsphereVolume/volumePath.mdx" +import PartialFstype from "./vsphereVolume/fsType.mdx" +import PartialStoragepolicyname from "./vsphereVolume/storagePolicyName.mdx" +import PartialStoragepolicyid from "./vsphereVolume/storagePolicyID.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes_reference.mdx new file mode 100755 index 000000000..66fa5655e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec/volumes_reference.mdx @@ -0,0 +1,546 @@ + +import PartialName from "./volumes/name.mdx" +import PartialHostpathreference from "./volumes/hostPath_reference.mdx" +import PartialEmptydirreference from "./volumes/emptyDir_reference.mdx" +import PartialGcepersistentdiskreference from "./volumes/gcePersistentDisk_reference.mdx" +import PartialAwselasticblockstorereference from "./volumes/awsElasticBlockStore_reference.mdx" +import PartialGitreporeference from "./volumes/gitRepo_reference.mdx" +import PartialSecretreference from "./volumes/secret_reference.mdx" +import PartialNfsreference from "./volumes/nfs_reference.mdx" +import PartialIscsireference from "./volumes/iscsi_reference.mdx" +import PartialGlusterfsreference from "./volumes/glusterfs_reference.mdx" +import PartialPersistentvolumeclaimreference from "./volumes/persistentVolumeClaim_reference.mdx" +import PartialRbdreference from "./volumes/rbd_reference.mdx" +import PartialFlexvolumereference from "./volumes/flexVolume_reference.mdx" +import PartialCinderreference from "./volumes/cinder_reference.mdx" +import PartialCephfsreference from "./volumes/cephfs_reference.mdx" +import PartialFlockerreference from "./volumes/flocker_reference.mdx" +import PartialDownwardapireference from "./volumes/downwardAPI_reference.mdx" +import PartialFcreference from "./volumes/fc_reference.mdx" +import PartialAzurefilereference from "./volumes/azureFile_reference.mdx" +import PartialConfigmapreference from "./volumes/configMap_reference.mdx" +import PartialVspherevolumereference from "./volumes/vsphereVolume_reference.mdx" +import PartialQuobytereference from "./volumes/quobyte_reference.mdx" +import PartialAzurediskreference from "./volumes/azureDisk_reference.mdx" +import PartialPhotonpersistentdiskreference from "./volumes/photonPersistentDisk_reference.mdx" +import PartialProjectedreference from "./volumes/projected_reference.mdx" +import PartialPortworxvolumereference from "./volumes/portworxVolume_reference.mdx" +import PartialScaleioreference from "./volumes/scaleIO_reference.mdx" +import PartialStorageosreference from "./volumes/storageos_reference.mdx" +import PartialCsireference from "./volumes/csi_reference.mdx" +import PartialEphemeralreference from "./volumes/ephemeral_reference.mdx" + + + + + +
+ + +######### `hostPath` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-hostPath} + +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. + + + + + + +
+ + + +
+ + +######### `emptyDir` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-emptyDir} + +emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + +
+ + + +
+ + +######### `gcePersistentDisk` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-gcePersistentDisk} + +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 + + + + + + +
+ + + +
+ + +######### `awsElasticBlockStore` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-awsElasticBlockStore} + +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 + + + + + + +
+ + + +
+ + +######### `gitRepo` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-gitRepo} + +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. + + + + + + +
+ + + +
+ + +######### `secret` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-secret} + +secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + +
+ + + +
+ + +######### `nfs` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-nfs} + +nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + +
+ + + +
+ + +######### `iscsi` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-iscsi} + +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 + + + + + + +
+ + + +
+ + +######### `glusterfs` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-glusterfs} + +glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + +
+ + + +
+ + +######### `persistentVolumeClaim` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-persistentVolumeClaim} + +persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + +
+ + + +
+ + +######### `rbd` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-rbd} + +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 + + + + + + +
+ + + +
+ + +######### `flexVolume` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-flexVolume} + +flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin. + + + + + + +
+ + + +
+ + +######### `cinder` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cinder} + +cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + +
+ + + +
+ + +######### `cephfs` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-cephfs} + +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + +
+ + + +
+ + +######### `flocker` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-flocker} + +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + +
+ + + +
+ + +######### `downwardAPI` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-downwardAPI} + +downwardAPI represents downward API about the pod that should populate this volume + + + + + + +
+ + + +
+ + +######### `fc` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-fc} + +fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + +
+ + + +
+ + +######### `azureFile` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureFile} + +azureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + +
+ + + +
+ + +######### `configMap` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-configMap} + +configMap represents a configMap that should populate this volume + + + + + + +
+ + + +
+ + +######### `vsphereVolume` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-vsphereVolume} + +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + +
+ + + +
+ + +######### `quobyte` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-quobyte} + +quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + +
+ + + +
+ + +######### `azureDisk` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-azureDisk} + +azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + +
+ + + +
+ + +######### `photonPersistentDisk` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-photonPersistentDisk} + +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + +
+ + + +
+ + +######### `projected` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-projected} + +projected items for all in one resources secrets, configmaps, and downward API + + + + + + +
+ + + +
+ + +######### `portworxVolume` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-portworxVolume} + +portworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + +
+ + + +
+ + +######### `scaleIO` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-scaleIO} + +scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + +
+ + + +
+ + +######### `storageos` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-storageos} + +storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + +
+ + + +
+ + +######### `csi` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-csi} + +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + +
+ + + +
+ + +######### `ephemeral` required {#controlPlane-coredns-deployment-spec-template-spec-volumes-ephemeral} + +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). + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec_reference.mdx new file mode 100755 index 000000000..052cfd0d3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template/spec_reference.mdx @@ -0,0 +1,443 @@ + +import PartialVolumesreference from "./spec/volumes_reference.mdx" +import PartialInitcontainersreference from "./spec/initContainers_reference.mdx" +import PartialContainersreference from "./spec/containers_reference.mdx" +import PartialEphemeralcontainersreference from "./spec/ephemeralContainers_reference.mdx" +import PartialRestartpolicy from "./spec/restartPolicy.mdx" +import PartialTerminationgraceperiodseconds from "./spec/terminationGracePeriodSeconds.mdx" +import PartialActivedeadlineseconds from "./spec/activeDeadlineSeconds.mdx" +import PartialDnspolicy from "./spec/dnsPolicy.mdx" +import PartialNodeselector from "./spec/nodeSelector.mdx" +import PartialServiceaccountname from "./spec/serviceAccountName.mdx" +import PartialServiceaccount from "./spec/serviceAccount.mdx" +import PartialAutomountserviceaccounttoken from "./spec/automountServiceAccountToken.mdx" +import PartialNodename from "./spec/nodeName.mdx" +import PartialHostnetwork from "./spec/hostNetwork.mdx" +import PartialHostpid from "./spec/hostPID.mdx" +import PartialHostipc from "./spec/hostIPC.mdx" +import PartialShareprocessnamespace from "./spec/shareProcessNamespace.mdx" +import PartialSecuritycontextreference from "./spec/securityContext_reference.mdx" +import PartialImagepullsecretsreference from "./spec/imagePullSecrets_reference.mdx" +import PartialHostname from "./spec/hostname.mdx" +import PartialSubdomain from "./spec/subdomain.mdx" +import PartialAffinityreference from "./spec/affinity_reference.mdx" +import PartialSchedulername from "./spec/schedulerName.mdx" +import PartialTolerationsreference from "./spec/tolerations_reference.mdx" +import PartialHostaliasesreference from "./spec/hostAliases_reference.mdx" +import PartialPriorityclassname from "./spec/priorityClassName.mdx" +import PartialPriority from "./spec/priority.mdx" +import PartialDnsconfigreference from "./spec/dnsConfig_reference.mdx" +import PartialReadinessgatesreference from "./spec/readinessGates_reference.mdx" +import PartialRuntimeclassname from "./spec/runtimeClassName.mdx" +import PartialEnableservicelinks from "./spec/enableServiceLinks.mdx" +import PartialPreemptionpolicy from "./spec/preemptionPolicy.mdx" +import PartialOverheadreference from "./spec/overhead_reference.mdx" +import PartialTopologyspreadconstraintsreference from "./spec/topologySpreadConstraints_reference.mdx" +import PartialSethostnameasfqdn from "./spec/setHostnameAsFQDN.mdx" +import PartialOsreference from "./spec/os_reference.mdx" +import PartialHostusers from "./spec/hostUsers.mdx" +import PartialSchedulinggatesreference from "./spec/schedulingGates_reference.mdx" +import PartialResourceclaimsreference from "./spec/resourceClaims_reference.mdx" + + +
+ + +######## `volumes` required object[] {#controlPlane-coredns-deployment-spec-template-spec-volumes} + +List of volumes that can be mounted by containers belonging to the pod. +More info: https://kubernetes.io/docs/concepts/storage/volumes + + + + + + +
+ + + +
+ + +######## `initContainers` required object[] {#controlPlane-coredns-deployment-spec-template-spec-initContainers} + +List of initialization containers belonging to the pod. +Init containers are executed in order prior to containers being started. If any +init container fails, the pod is considered to have failed and is handled according +to its restartPolicy. The name for an init container or normal container must be +unique among all containers. +Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. +The resourceRequirements of an init container are taken into account during scheduling +by finding the highest request/limit for each resource type, and then using the max of +of that value or the sum of the normal containers. Limits are applied to init containers +in a similar fashion. +Init containers cannot currently be added or removed. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + + + + + + +
+ + + +
+ + +######## `containers` required object[] {#controlPlane-coredns-deployment-spec-template-spec-containers} + +List of containers belonging to the pod. +Containers cannot currently be added or removed. +There must be at least one container in a Pod. +Cannot be updated. + + + + + + +
+ + + +
+ + +######## `ephemeralContainers` required object[] {#controlPlane-coredns-deployment-spec-template-spec-ephemeralContainers} + +List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing +pod to perform user-initiated actions such as debugging. This list cannot be specified when +creating a pod, and it cannot be modified by updating the pod spec. In order to add an +ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +######## `securityContext` required {#controlPlane-coredns-deployment-spec-template-spec-securityContext} + +SecurityContext holds pod-level security attributes and common container settings. +Optional: Defaults to empty. See type description for default values of each field. + + + + + + +
+ + + +
+ + +######## `imagePullSecrets` required object[] {#controlPlane-coredns-deployment-spec-template-spec-imagePullSecrets} + +ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. +If specified, these secrets will be passed to individual puller implementations for them to use. +More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + + + + + + +
+ + + + + + + + + +
+ + +######## `affinity` required {#controlPlane-coredns-deployment-spec-template-spec-affinity} + +If specified, the pod's scheduling constraints + + + + + + +
+ + + + + + +
+ + +######## `tolerations` required object[] {#controlPlane-coredns-deployment-spec-template-spec-tolerations} + +If specified, the pod's tolerations. + + + + + + +
+ + + +
+ + +######## `hostAliases` required object[] {#controlPlane-coredns-deployment-spec-template-spec-hostAliases} + +HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts +file if specified. This is only valid for non-hostNetwork pods. + + + + + + +
+ + + + + + + + + +
+ + +######## `dnsConfig` required {#controlPlane-coredns-deployment-spec-template-spec-dnsConfig} + +Specifies the DNS parameters of a pod. +Parameters specified here will be merged to the generated DNS +configuration based on DNSPolicy. + + + + + + +
+ + + +
+ + +######## `readinessGates` required object[] {#controlPlane-coredns-deployment-spec-template-spec-readinessGates} + +If specified, all readiness gates will be evaluated for pod readiness. +A pod is ready when all its containers are ready AND +all conditions specified in the readiness gates have status equal to "True" +More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates + + + + + + +
+ + + + + + + + + + + + +
+ + +######## `overhead` required {#controlPlane-coredns-deployment-spec-template-spec-overhead} + +Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. +This field will be autopopulated at admission time by the RuntimeClass admission controller. If +the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. +The RuntimeClass admission controller will reject Pod create requests which have the overhead already +set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value +defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. +More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md + + + + + + +
+ + + +
+ + +######## `topologySpreadConstraints` required object[] {#controlPlane-coredns-deployment-spec-template-spec-topologySpreadConstraints} + +TopologySpreadConstraints describes how a group of pods ought to spread across topology +domains. Scheduler will schedule pods in a way which abides by the constraints. +All topologySpreadConstraints are ANDed. + + + + + + +
+ + + + + + +
+ + +######## `os` required {#controlPlane-coredns-deployment-spec-template-spec-os} + +Specifies the OS of the containers in the pod. +Some pod and container fields are restricted if this is set. + +If the OS field is set to linux, the following fields must be unset: +-securityContext.windowsOptions + +If the OS field is set to windows, following fields must be unset: +- spec.hostPID +- spec.hostIPC +- spec.hostUsers +- spec.securityContext.seLinuxOptions +- spec.securityContext.seccompProfile +- spec.securityContext.fsGroup +- spec.securityContext.fsGroupChangePolicy +- spec.securityContext.sysctls +- spec.shareProcessNamespace +- spec.securityContext.runAsUser +- spec.securityContext.runAsGroup +- spec.securityContext.supplementalGroups +- spec.containers[*].securityContext.seLinuxOptions +- spec.containers[*].securityContext.seccompProfile +- spec.containers[*].securityContext.capabilities +- spec.containers[*].securityContext.readOnlyRootFilesystem +- spec.containers[*].securityContext.privileged +- spec.containers[*].securityContext.allowPrivilegeEscalation +- spec.containers[*].securityContext.procMount +- spec.containers[*].securityContext.runAsUser +- spec.containers[*].securityContext.runAsGroup + + + + + + +
+ + + + + + +
+ + +######## `schedulingGates` required object[] {#controlPlane-coredns-deployment-spec-template-spec-schedulingGates} + +SchedulingGates is an opaque list of values that if specified will block scheduling the pod. +If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the +scheduler will not attempt to schedule the pod. + +SchedulingGates can only be set at pod creation time, and be removed only afterwards. + +This is a beta feature enabled by the PodSchedulingReadiness feature gate. + + + + + + + +
+ + + +
+ + +######## `resourceClaims` required object[] {#controlPlane-coredns-deployment-spec-template-spec-resourceClaims} + +ResourceClaims defines which ResourceClaims must be allocated +and reserved before the Pod is allowed to start. The resources +will be made available to those containers which consume them +by name. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template_reference.mdx new file mode 100755 index 000000000..ffeb1d6d1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec/template_reference.mdx @@ -0,0 +1,35 @@ + +import PartialMetadatareference from "./template/metadata_reference.mdx" +import PartialSpecreference from "./template/spec_reference.mdx" + + +
+ + +####### `metadata` required {#controlPlane-coredns-deployment-spec-template-metadata} + + + + + + + + +
+ + + +
+ + +####### `spec` required {#controlPlane-coredns-deployment-spec-template-spec} + +Specification of the desired behavior of the pod. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec_reference.mdx new file mode 100755 index 000000000..81e3546b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment/spec_reference.mdx @@ -0,0 +1,74 @@ + +import PartialReplicas from "./spec/replicas.mdx" +import PartialSelectorreference from "./spec/selector_reference.mdx" +import PartialTemplatereference from "./spec/template_reference.mdx" +import PartialStrategyreference from "./spec/strategy_reference.mdx" +import PartialMinreadyseconds from "./spec/minReadySeconds.mdx" +import PartialRevisionhistorylimit from "./spec/revisionHistoryLimit.mdx" +import PartialPaused from "./spec/paused.mdx" +import PartialProgressdeadlineseconds from "./spec/progressDeadlineSeconds.mdx" + + + + + +
+ + +###### `selector` required {#controlPlane-coredns-deployment-spec-selector} + +Label selector for pods. Existing ReplicaSets whose pods are +selected by this will be the ones affected by this deployment. +It must match the pod template's labels. + + + + + + +
+ + + +
+ + +###### `template` required {#controlPlane-coredns-deployment-spec-template} + +Template describes the pods that will be created. +The only allowed template.spec.restartPolicy value is "Always". + + + + + + +
+ + + +
+ + +###### `strategy` required {#controlPlane-coredns-deployment-spec-strategy} + +The deployment strategy to use to replace existing pods with new ones. + + + + + + +
+ + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/deployment_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/deployment_reference.mdx new file mode 100755 index 000000000..fd9a0846d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/deployment_reference.mdx @@ -0,0 +1,25 @@ + +import PartialLabels from "./deployment/labels.mdx" +import PartialAnnotations from "./deployment/annotations.mdx" +import PartialSpecreference from "./deployment/spec_reference.mdx" + + + + + + + + +
+ + +##### `spec` required {#controlPlane-coredns-deployment-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/embedded.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/embedded.mdx new file mode 100755 index 000000000..2d0f93dbd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/embedded.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `embedded` required boolean false {#controlPlane-coredns-embedded} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/enabled.mdx new file mode 100755 index 000000000..844751a03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#controlPlane-coredns-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service.mdx new file mode 100755 index 000000000..b70d2c49d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service.mdx @@ -0,0 +1,17 @@ + +import PartialServicereference from "./service_reference.mdx" + + +
+ + +#### `service` required {#controlPlane-coredns-service} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/annotations.mdx new file mode 100755 index 000000000..aecc376b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `annotations` required object {#controlPlane-coredns-service-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/labels.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/labels.mdx new file mode 100755 index 000000000..2e0819ffb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `labels` required object {#controlPlane-coredns-service-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec.mdx new file mode 100755 index 000000000..8abd4fbf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec.mdx @@ -0,0 +1,17 @@ + +import PartialSpecreference from "./spec_reference.mdx" + + +
+ + +##### `spec` required {#controlPlane-coredns-service-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/allocateLoadBalancerNodePorts.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/allocateLoadBalancerNodePorts.mdx new file mode 100755 index 000000000..2c1db6e66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/allocateLoadBalancerNodePorts.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `allocateLoadBalancerNodePorts` required boolean false {#controlPlane-coredns-service-spec-allocateLoadBalancerNodePorts} + +allocateLoadBalancerNodePorts defines if NodePorts will be automatically +allocated for services with type LoadBalancer. Default is "true". It +may be set to "false" if the cluster load-balancer does not rely on +NodePorts. If the caller requests specific NodePorts (by specifying a +value), those requests will be respected, regardless of this field. +This field may only be set for services with type LoadBalancer and will +be cleared if the type is changed to any other type. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/clusterIP.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/clusterIP.mdx new file mode 100755 index 000000000..b4b768ccd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/clusterIP.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `clusterIP` required string {#controlPlane-coredns-service-spec-clusterIP} + +clusterIP is the IP address of the service and is usually assigned +randomly. If an address is specified manually, is in-range (as per +system configuration), and is not in use, it will be allocated to the +service; otherwise creation of the service will fail. This field may not +be changed through updates unless the type field is also being changed +to ExternalName (which requires this field to be blank) or the type +field is being changed from ExternalName (in which case this field may +optionally be specified, as describe above). Valid values are "None", +empty string (""), or a valid IP address. Setting this to "None" makes a +"headless service" (no virtual IP), which is useful when direct endpoint +connections are preferred and proxying is not required. Only applies to +types ClusterIP, NodePort, and LoadBalancer. If this field is specified +when creating a Service of type ExternalName, creation will fail. This +field will be wiped when updating a Service to type ExternalName. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/clusterIPs.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/clusterIPs.mdx new file mode 100755 index 000000000..a71ee3568 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/clusterIPs.mdx @@ -0,0 +1,35 @@ + +
+ + +###### `clusterIPs` required string[] {#controlPlane-coredns-service-spec-clusterIPs} + +ClusterIPs is a list of IP addresses assigned to this service, and are +usually assigned randomly. If an address is specified manually, is +in-range (as per system configuration), and is not in use, it will be +allocated to the service; otherwise creation of the service will fail. +This field may not be changed through updates unless the type field is +also being changed to ExternalName (which requires this field to be +empty) or the type field is being changed from ExternalName (in which +case this field may optionally be specified, as describe above). Valid +values are "None", empty string (""), or a valid IP address. Setting +this to "None" makes a "headless service" (no virtual IP), which is +useful when direct endpoint connections are preferred and proxying is +not required. Only applies to types ClusterIP, NodePort, and +LoadBalancer. If this field is specified when creating a Service of type +ExternalName, creation will fail. This field will be wiped when updating +a Service to type ExternalName. If this field is not specified, it will +be initialized from the clusterIP field. If this field is specified, +clients must ensure that clusterIPs[0] and clusterIP have the same +value. + +This field may hold a maximum of two entries (dual-stack IPs, in either order). +These IPs must correspond to the values of the ipFamilies field. Both +clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalIPs.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalIPs.mdx new file mode 100755 index 000000000..4093d1891 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalIPs.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `externalIPs` required string[] {#controlPlane-coredns-service-spec-externalIPs} + +externalIPs is a list of IP addresses for which nodes in the cluster +will also accept traffic for this service. These IPs are not managed by +Kubernetes. The user is responsible for ensuring that traffic arrives +at a node with this IP. A common example is external load-balancers +that are not part of the Kubernetes system. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalName.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalName.mdx new file mode 100755 index 000000000..0f416eced --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalName.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `externalName` required string {#controlPlane-coredns-service-spec-externalName} + +externalName is the external reference that discovery mechanisms will +return as an alias for this service (e.g. a DNS CNAME record). No +proxying will be involved. Must be a lowercase RFC-1123 hostname +(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalTrafficPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalTrafficPolicy.mdx new file mode 100755 index 000000000..1426b14b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/externalTrafficPolicy.mdx @@ -0,0 +1,25 @@ + +
+ + +###### `externalTrafficPolicy` required string {#controlPlane-coredns-service-spec-externalTrafficPolicy} + +externalTrafficPolicy describes how nodes distribute service traffic they +receive on one of the Service's "externally-facing" addresses (NodePorts, +ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure +the service in a way that assumes that external load balancers will take care +of balancing the service traffic between nodes, and so each node will deliver +traffic only to the node-local endpoints of the service, without masquerading +the client source IP. (Traffic mistakenly sent to a node with no endpoints will +be dropped.) The default value, "Cluster", uses the standard behavior of +routing to all endpoints evenly (possibly modified by topology and other +features). Note that traffic sent to an External IP or LoadBalancer IP from +within the cluster will always get "Cluster" semantics, but clients sending to +a NodePort from within the cluster may need to take traffic policy into account +when picking a node. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/healthCheckNodePort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/healthCheckNodePort.mdx new file mode 100755 index 000000000..5ada21c5e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/healthCheckNodePort.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `healthCheckNodePort` required integer {#controlPlane-coredns-service-spec-healthCheckNodePort} + +healthCheckNodePort specifies the healthcheck nodePort for the service. +This only applies when type is set to LoadBalancer and +externalTrafficPolicy is set to Local. If a value is specified, is +in-range, and is not in use, it will be used. If not specified, a value +will be automatically allocated. External systems (e.g. load-balancers) +can use this port to determine if a given node holds endpoints for this +service or not. If this field is specified when creating a Service +which does not need it, creation will fail. This field will be wiped +when updating a Service to no longer need it (e.g. changing type). +This field cannot be updated once set. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/internalTrafficPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/internalTrafficPolicy.mdx new file mode 100755 index 000000000..f5a2ac1df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/internalTrafficPolicy.mdx @@ -0,0 +1,18 @@ + +
+ + +###### `internalTrafficPolicy` required string {#controlPlane-coredns-service-spec-internalTrafficPolicy} + +InternalTrafficPolicy describes how nodes distribute service traffic they +receive on the ClusterIP. If set to "Local", the proxy will assume that pods +only want to talk to endpoints of the service on the same node as the pod, +dropping the traffic if there are no local endpoints. The default value, +"Cluster", uses the standard behavior of routing to all endpoints evenly +(possibly modified by topology and other features). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ipFamilies.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ipFamilies.mdx new file mode 100755 index 000000000..19d3e6730 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ipFamilies.mdx @@ -0,0 +1,28 @@ + +
+ + +###### `ipFamilies` required string[] {#controlPlane-coredns-service-spec-ipFamilies} + +IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this +service. This field is usually assigned automatically based on cluster +configuration and the ipFamilyPolicy field. If this field is specified +manually, the requested family is available in the cluster, +and ipFamilyPolicy allows it, it will be used; otherwise creation of +the service will fail. This field is conditionally mutable: it allows +for adding or removing a secondary IP family, but it does not allow +changing the primary IP family of the Service. Valid values are "IPv4" +and "IPv6". This field only applies to Services of types ClusterIP, +NodePort, and LoadBalancer, and does apply to "headless" services. +This field will be wiped when updating a Service to type ExternalName. + +This field may hold a maximum of two entries (dual-stack families, in +either order). These families must correspond to the values of the +clusterIPs field, if specified. Both clusterIPs and ipFamilies are +governed by the ipFamilyPolicy field. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ipFamilyPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ipFamilyPolicy.mdx new file mode 100755 index 000000000..005bda57e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ipFamilyPolicy.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `ipFamilyPolicy` required string {#controlPlane-coredns-service-spec-ipFamilyPolicy} + +IPFamilyPolicy represents the dual-stack-ness requested or required by +this Service. If there is no value provided, then this field will be set +to SingleStack. Services can be "SingleStack" (a single IP family), +"PreferDualStack" (two IP families on dual-stack configured clusters or +a single IP family on single-stack clusters), or "RequireDualStack" +(two IP families on dual-stack configured clusters, otherwise fail). The +ipFamilies and clusterIPs fields depend on the value of this field. This +field will be wiped when updating a service to type ExternalName. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerClass.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerClass.mdx new file mode 100755 index 000000000..20bdb924d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerClass.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `loadBalancerClass` required string {#controlPlane-coredns-service-spec-loadBalancerClass} + +loadBalancerClass is the class of the load balancer implementation this Service belongs to. +If specified, the value of this field must be a label-style identifier, with an optional prefix, +e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. +This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load +balancer implementation is used, today this is typically done through the cloud provider integration, +but should apply for any default implementation. If set, it is assumed that a load balancer +implementation is watching for Services with a matching class. Any default load balancer +implementation (e.g. cloud providers) should ignore Services that set this field. +This field can only be set when creating or updating a Service to type 'LoadBalancer'. +Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerIP.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerIP.mdx new file mode 100755 index 000000000..75e248ae6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerIP.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `loadBalancerIP` required string {#controlPlane-coredns-service-spec-loadBalancerIP} + +Only applies to Service Type: LoadBalancer. +This feature depends on whether the underlying cloud-provider supports specifying +the loadBalancerIP when a load balancer is created. +This field will be ignored if the cloud-provider does not support the feature. +Deprecated: This field was under-specified and its meaning varies across implementations. +Using it is non-portable and it may not support dual-stack. +Users are encouraged to use implementation-specific annotations when available. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerSourceRanges.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerSourceRanges.mdx new file mode 100755 index 000000000..a4684c870 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/loadBalancerSourceRanges.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `loadBalancerSourceRanges` required string[] {#controlPlane-coredns-service-spec-loadBalancerSourceRanges} + +If specified and supported by the platform, this will restrict traffic through the cloud-provider +load-balancer will be restricted to the specified client IPs. This field will be ignored if the +cloud-provider does not support the feature." +More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports.mdx new file mode 100755 index 000000000..f0c3585ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports.mdx @@ -0,0 +1,18 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +###### `ports` required object[] {#controlPlane-coredns-service-spec-ports} + +The list of ports that are exposed by this service. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/appProtocol.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/appProtocol.mdx new file mode 100755 index 000000000..4a96e8093 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/appProtocol.mdx @@ -0,0 +1,27 @@ + +
+ + +####### `appProtocol` required string {#controlPlane-coredns-service-spec-ports-appProtocol} + +The application protocol for this port. +This is used as a hint for implementations to offer richer behavior for protocols that they understand. +This field follows standard Kubernetes label syntax. +Valid values are either: + +* Un-prefixed protocol names - reserved for IANA standard service names (as per +RFC-6335 and https://www.iana.org/assignments/service-names). + +* Kubernetes-defined prefixed names: + * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- + * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 + * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 + +* Other protocols should use implementation-defined prefixed names such as +mycompany.com/my-custom-protocol. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/name.mdx new file mode 100755 index 000000000..1fc7fa0ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/name.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `name` required string {#controlPlane-coredns-service-spec-ports-name} + +The name of this port within the service. This must be a DNS_LABEL. +All ports within a ServiceSpec must have unique names. When considering +the endpoints for a Service, this must match the 'name' field in the +EndpointPort. +Optional if only one ServicePort is defined on this service. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/nodePort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/nodePort.mdx new file mode 100755 index 000000000..b9ece5ef5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/nodePort.mdx @@ -0,0 +1,21 @@ + +
+ + +####### `nodePort` required integer {#controlPlane-coredns-service-spec-ports-nodePort} + +The port on each node on which this service is exposed when type is +NodePort or LoadBalancer. Usually assigned by the system. If a value is +specified, in-range, and not in use it will be used, otherwise the +operation will fail. If not specified, a port will be allocated if this +Service requires one. If this field is specified when creating a +Service which does not need it, creation will fail. This field will be +wiped when updating a Service to no longer need it (e.g. changing type +from NodePort to ClusterIP). +More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/port.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/port.mdx new file mode 100755 index 000000000..f30476976 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/port.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `port` required integer {#controlPlane-coredns-service-spec-ports-port} + +The port that will be exposed by this service. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/protocol.mdx new file mode 100755 index 000000000..383edfd91 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `protocol` required string {#controlPlane-coredns-service-spec-ports-protocol} + +The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". +Default is TCP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort.mdx new file mode 100755 index 000000000..59e737d6c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort.mdx @@ -0,0 +1,24 @@ + +import PartialTargetportreference from "./targetPort_reference.mdx" + + +
+ + +####### `targetPort` required {#controlPlane-coredns-service-spec-ports-targetPort} + +Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/IntVal.mdx new file mode 100755 index 000000000..e6da02529 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-coredns-service-spec-ports-targetPort-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/StrVal.mdx new file mode 100755 index 000000000..66072d2fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-coredns-service-spec-ports-targetPort-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/Type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/Type.mdx new file mode 100755 index 000000000..648bb2979 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-coredns-service-spec-ports-targetPort-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort_reference.mdx new file mode 100755 index 000000000..287c53142 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports/targetPort_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./targetPort/Type.mdx" +import PartialIntval from "./targetPort/IntVal.mdx" +import PartialStrval from "./targetPort/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports_reference.mdx new file mode 100755 index 000000000..89e316f44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/ports_reference.mdx @@ -0,0 +1,44 @@ + +import PartialName from "./ports/name.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialAppprotocol from "./ports/appProtocol.mdx" +import PartialPort from "./ports/port.mdx" +import PartialTargetportreference from "./ports/targetPort_reference.mdx" +import PartialNodeport from "./ports/nodePort.mdx" + + + + + + + + + + + + + + +
+ + +####### `targetPort` required {#controlPlane-coredns-service-spec-ports-targetPort} + +Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/publishNotReadyAddresses.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/publishNotReadyAddresses.mdx new file mode 100755 index 000000000..95344ce91 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/publishNotReadyAddresses.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `publishNotReadyAddresses` required boolean false {#controlPlane-coredns-service-spec-publishNotReadyAddresses} + +publishNotReadyAddresses indicates that any agent which deals with endpoints for this +Service should disregard any indications of ready/not-ready. +The primary use case for setting this field is for a StatefulSet's Headless Service to +propagate SRV DNS records for its Pods for the purpose of peer discovery. +The Kubernetes controllers that generate Endpoints and EndpointSlice resources for +Services interpret this to mean that all endpoints are considered "ready" even if the +Pods themselves are not. Agents which consume only Kubernetes generated endpoints +through the Endpoints or EndpointSlice resources can safely assume this behavior. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/selector.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/selector.mdx new file mode 100755 index 000000000..a1e1b368e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/selector.mdx @@ -0,0 +1,18 @@ + +
+ + +###### `selector` required object {#controlPlane-coredns-service-spec-selector} + +Route service traffic to pods with label keys and values matching this +selector. If empty or not present, the service is assumed to have an +external process managing its endpoints, which Kubernetes will not +modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. +Ignored if type is ExternalName. +More info: https://kubernetes.io/docs/concepts/services-networking/service/ + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinity.mdx new file mode 100755 index 000000000..d9530f514 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinity.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `sessionAffinity` required string {#controlPlane-coredns-service-spec-sessionAffinity} + +Supports "ClientIP" and "None". Used to maintain session affinity. +Enable client IP based session affinity. +Must be ClientIP or None. +Defaults to None. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig.mdx new file mode 100755 index 000000000..3fc30e7f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig.mdx @@ -0,0 +1,17 @@ + +import PartialSessionaffinityconfigreference from "./sessionAffinityConfig_reference.mdx" + + +
+ + +###### `sessionAffinityConfig` required {#controlPlane-coredns-service-spec-sessionAffinityConfig} + +sessionAffinityConfig contains the configurations of session affinity. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP.mdx new file mode 100755 index 000000000..37ee1f42c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP.mdx @@ -0,0 +1,17 @@ + +import PartialClientipreference from "./clientIP_reference.mdx" + + +
+ + +####### `clientIP` required {#controlPlane-coredns-service-spec-sessionAffinityConfig-clientIP} + +clientIP contains the configurations of Client IP based session affinity. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP/timeoutSeconds.mdx new file mode 100755 index 000000000..e9226ab1a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `timeoutSeconds` required integer {#controlPlane-coredns-service-spec-sessionAffinityConfig-clientIP-timeoutSeconds} + +timeoutSeconds specifies the seconds of ClientIP type session sticky time. +The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". +Default value is 10800(for 3 hours). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP_reference.mdx new file mode 100755 index 000000000..fb3d0ec04 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig/clientIP_reference.mdx @@ -0,0 +1,4 @@ + +import PartialTimeoutseconds from "./clientIP/timeoutSeconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig_reference.mdx new file mode 100755 index 000000000..47517dae6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/sessionAffinityConfig_reference.mdx @@ -0,0 +1,17 @@ + +import PartialClientipreference from "./sessionAffinityConfig/clientIP_reference.mdx" + + +
+ + +####### `clientIP` required {#controlPlane-coredns-service-spec-sessionAffinityConfig-clientIP} + +clientIP contains the configurations of Client IP based session affinity. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/type.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/type.mdx new file mode 100755 index 000000000..b14169ff1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec/type.mdx @@ -0,0 +1,28 @@ + +
+ + +###### `type` required string {#controlPlane-coredns-service-spec-type} + +type determines how the Service is exposed. Defaults to ClusterIP. Valid +options are ExternalName, ClusterIP, NodePort, and LoadBalancer. +"ClusterIP" allocates a cluster-internal IP address for load-balancing +to endpoints. Endpoints are determined by the selector or if that is not +specified, by manual construction of an Endpoints object or +EndpointSlice objects. If clusterIP is "None", no virtual IP is +allocated and the endpoints are published as a set of endpoints rather +than a virtual IP. +"NodePort" builds on ClusterIP and allocates a port on every node which +routes to the same endpoints as the clusterIP. +"LoadBalancer" builds on NodePort and creates an external load-balancer +(if supported in the current cloud) which routes to the same endpoints +as the clusterIP. +"ExternalName" aliases this service to the specified externalName. +Several other fields do not apply to ExternalName services. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service/spec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec_reference.mdx new file mode 100755 index 000000000..438590eaa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service/spec_reference.mdx @@ -0,0 +1,103 @@ + +import PartialPortsreference from "./spec/ports_reference.mdx" +import PartialSelector from "./spec/selector.mdx" +import PartialClusterip from "./spec/clusterIP.mdx" +import PartialClusterips from "./spec/clusterIPs.mdx" +import PartialType from "./spec/type.mdx" +import PartialExternalips from "./spec/externalIPs.mdx" +import PartialSessionaffinity from "./spec/sessionAffinity.mdx" +import PartialLoadbalancerip from "./spec/loadBalancerIP.mdx" +import PartialLoadbalancersourceranges from "./spec/loadBalancerSourceRanges.mdx" +import PartialExternalname from "./spec/externalName.mdx" +import PartialExternaltrafficpolicy from "./spec/externalTrafficPolicy.mdx" +import PartialHealthchecknodeport from "./spec/healthCheckNodePort.mdx" +import PartialPublishnotreadyaddresses from "./spec/publishNotReadyAddresses.mdx" +import PartialSessionaffinityconfigreference from "./spec/sessionAffinityConfig_reference.mdx" +import PartialIpfamilies from "./spec/ipFamilies.mdx" +import PartialIpfamilypolicy from "./spec/ipFamilyPolicy.mdx" +import PartialAllocateloadbalancernodeports from "./spec/allocateLoadBalancerNodePorts.mdx" +import PartialLoadbalancerclass from "./spec/loadBalancerClass.mdx" +import PartialInternaltrafficpolicy from "./spec/internalTrafficPolicy.mdx" + + +
+ + +###### `ports` required object[] {#controlPlane-coredns-service-spec-ports} + +The list of ports that are exposed by this service. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `sessionAffinityConfig` required {#controlPlane-coredns-service-spec-sessionAffinityConfig} + +sessionAffinityConfig contains the configurations of session affinity. + + + + + + +
+ + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/coredns/service_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns/service_reference.mdx new file mode 100755 index 000000000..407db31d3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns/service_reference.mdx @@ -0,0 +1,25 @@ + +import PartialLabels from "./service/labels.mdx" +import PartialAnnotations from "./service/annotations.mdx" +import PartialSpecreference from "./service/spec_reference.mdx" + + + + + + + + +
+ + +##### `spec` required {#controlPlane-coredns-service-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/coredns_reference.mdx b/docs/pages/configuration/_partials/controlPlane/coredns_reference.mdx new file mode 100755 index 000000000..016d3f460 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/coredns_reference.mdx @@ -0,0 +1,42 @@ + +import PartialEnabled from "./coredns/enabled.mdx" +import PartialEmbedded from "./coredns/embedded.mdx" +import PartialServicereference from "./coredns/service_reference.mdx" +import PartialDeploymentreference from "./coredns/deployment_reference.mdx" + + + + + + + + +
+ + +#### `service` required {#controlPlane-coredns-service} + + + + + + + + +
+ + + +
+ + +#### `deployment` required {#controlPlane-coredns-deployment} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro.mdx b/docs/pages/configuration/_partials/controlPlane/distro.mdx new file mode 100755 index 000000000..ce64c0708 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro.mdx @@ -0,0 +1,17 @@ + +import PartialDistroreference from "./distro_reference.mdx" + + +
+ + +### `distro` required {#controlPlane-distro} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced.mdx new file mode 100755 index 000000000..11ad7a1d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced.mdx @@ -0,0 +1,17 @@ + +import PartialAdvancedreference from "./advanced_reference.mdx" + + +
+ + +#### `advanced` required {#controlPlane-distro-advanced} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths.mdx new file mode 100755 index 000000000..49538c210 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths.mdx @@ -0,0 +1,17 @@ + +import PartialPathsreference from "./paths_reference.mdx" + + +
+ + +##### `paths` required {#controlPlane-distro-advanced-paths} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/clientCACert.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/clientCACert.mdx new file mode 100755 index 000000000..c3d973b93 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/clientCACert.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `clientCACert` required string {#controlPlane-distro-advanced-paths-clientCACert} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/kubeConfig.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/kubeConfig.mdx new file mode 100755 index 000000000..da1958378 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/kubeConfig.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `kubeConfig` required string {#controlPlane-distro-advanced-paths-kubeConfig} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/requestHeaderCACert.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/requestHeaderCACert.mdx new file mode 100755 index 000000000..64eb5c85f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/requestHeaderCACert.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `requestHeaderCACert` required string {#controlPlane-distro-advanced-paths-requestHeaderCACert} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/serverCACert.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/serverCACert.mdx new file mode 100755 index 000000000..5ba6c2240 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/serverCACert.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `serverCACert` required string {#controlPlane-distro-advanced-paths-serverCACert} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/serverCAKey.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/serverCAKey.mdx new file mode 100755 index 000000000..eaa72b3a1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths/serverCAKey.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `serverCAKey` required string {#controlPlane-distro-advanced-paths-serverCAKey} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths_reference.mdx new file mode 100755 index 000000000..40d344db3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced/paths_reference.mdx @@ -0,0 +1,20 @@ + +import PartialKubeconfig from "./paths/kubeConfig.mdx" +import PartialServercakey from "./paths/serverCAKey.mdx" +import PartialServercacert from "./paths/serverCACert.mdx" +import PartialClientcacert from "./paths/clientCACert.mdx" +import PartialRequestheadercacert from "./paths/requestHeaderCACert.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/advanced_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/advanced_reference.mdx new file mode 100755 index 000000000..b12cfa887 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/advanced_reference.mdx @@ -0,0 +1,17 @@ + +import PartialPathsreference from "./advanced/paths_reference.mdx" + + +
+ + +##### `paths` required {#controlPlane-distro-advanced-paths} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s.mdx new file mode 100755 index 000000000..db0195fb9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s.mdx @@ -0,0 +1,17 @@ + +import PartialK0sreference from "./k0s_reference.mdx" + + +
+ + +#### `k0s` required {#controlPlane-distro-k0s} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/args.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/args.mdx new file mode 100755 index 000000000..ba33041bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/args.mdx @@ -0,0 +1,20 @@ + +
+ + +##### `args` required string[] {#controlPlane-distro-k0s-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/command.mdx new file mode 100755 index 000000000..54a325303 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/command.mdx @@ -0,0 +1,20 @@ + +
+ + +##### `command` required string[] {#controlPlane-distro-k0s-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env.mdx new file mode 100755 index 000000000..cc6682fc1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +##### `env` required object[] {#controlPlane-distro-k0s-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/name.mdx new file mode 100755 index 000000000..2a7c44f11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k0s-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/value.mdx new file mode 100755 index 000000000..c30cb03c8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +###### `value` required string {#controlPlane-distro-k0s-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom.mdx new file mode 100755 index 000000000..2c6826d97 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +###### `valueFrom` required {#controlPlane-distro-k0s-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..4b20adcce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +####### `configMapKeyRef` required {#controlPlane-distro-k0s-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..aefe13e28 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `key` required string {#controlPlane-distro-k0s-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..88138f312 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k0s-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..4085780a2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k0s-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..1e1bac80a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +####### `fieldRef` required {#controlPlane-distro-k0s-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..c56482572 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `apiVersion` required string {#controlPlane-distro-k0s-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..f1f1356ea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `fieldPath` required string {#controlPlane-distro-k0s-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..e5edf43d4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +####### `resourceFieldRef` required {#controlPlane-distro-k0s-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..66c65ebdd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `containerName` required string {#controlPlane-distro-k0s-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..dbd6320c6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +######## `divisor` required {#controlPlane-distro-k0s-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..a348d9b4a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Format` required string {#controlPlane-distro-k0s-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..16464d9c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `resource` required string {#controlPlane-distro-k0s-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..b24f05516 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +######## `divisor` required {#controlPlane-distro-k0s-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..a07f1a49e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +####### `secretKeyRef` required {#controlPlane-distro-k0s-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..fe62ad675 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `key` required string {#controlPlane-distro-k0s-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..60deb69c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k0s-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..02200534d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k0s-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom_reference.mdx new file mode 100755 index 000000000..777fe83ce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +####### `fieldRef` required {#controlPlane-distro-k0s-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +####### `resourceFieldRef` required {#controlPlane-distro-k0s-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +####### `configMapKeyRef` required {#controlPlane-distro-k0s-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +####### `secretKeyRef` required {#controlPlane-distro-k0s-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom.mdx new file mode 100755 index 000000000..435b84dab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +##### `envFrom` required object[] {#controlPlane-distro-k0s-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef.mdx new file mode 100755 index 000000000..8d071be18 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +###### `configMapRef` required {#controlPlane-distro-k0s-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..225cf0220 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k0s-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..d762a7ef0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `optional` required boolean false {#controlPlane-distro-k0s-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/prefix.mdx new file mode 100755 index 000000000..fcd04c1b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `prefix` required string {#controlPlane-distro-k0s-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef.mdx new file mode 100755 index 000000000..3be3e5543 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +###### `secretRef` required {#controlPlane-distro-k0s-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..327a9839a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k0s-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..79e21392d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `optional` required boolean false {#controlPlane-distro-k0s-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom_reference.mdx new file mode 100755 index 000000000..a05688924 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +###### `configMapRef` required {#controlPlane-distro-k0s-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +###### `secretRef` required {#controlPlane-distro-k0s-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env_reference.mdx new file mode 100755 index 000000000..f1a0e56d4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +###### `valueFrom` required {#controlPlane-distro-k0s-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/image.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/image.mdx new file mode 100755 index 000000000..08eefcfcb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/image.mdx @@ -0,0 +1,16 @@ + +
+ + +##### `image` required string {#controlPlane-distro-k0s-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/imagePullPolicy.mdx new file mode 100755 index 000000000..217ed0127 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `imagePullPolicy` required string {#controlPlane-distro-k0s-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle.mdx new file mode 100755 index 000000000..bb80115c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +##### `lifecycle` required {#controlPlane-distro-k0s-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart.mdx new file mode 100755 index 000000000..c81ecbb2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +###### `postStart` required {#controlPlane-distro-k0s-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..8e8b24318 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k0s-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..05c866b54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k0s-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..0f1f09650 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k0s-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..2dfdfbaa2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..8271d4b8e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..53654ee47 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..7d4885992 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..4f15153b6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..95395df48 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..2e136a9e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..5f0c4bfb2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..c38710208 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..98931109d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..54fb9a519 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k0s-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..9cd10a07b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +####### `sleep` required {#controlPlane-distro-k0s-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..4ef7e3f11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `seconds` required integer {#controlPlane-distro-k0s-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..819afeb17 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..827eaa715 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..11050ae50 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..33841c46f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..7156f1b61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..a68fc097c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..18628e525 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..3b4f175be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k0s-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k0s-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k0s-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +####### `sleep` required {#controlPlane-distro-k0s-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop.mdx new file mode 100755 index 000000000..83a7aa084 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +###### `preStop` required {#controlPlane-distro-k0s-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..5bf5ad8b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k0s-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..0def26a34 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k0s-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..79632911b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k0s-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..0e5c73374 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..ea3fbc711 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..4a5c8d6c2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..c6858b9d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..f1c5f9387 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..72179a6f1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..9dc936dd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..8e22aebcf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..190f6cc90 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..dd5f7f0fc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..a84202760 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k0s-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..d0bdb2d3c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +####### `sleep` required {#controlPlane-distro-k0s-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..624fa533a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `seconds` required integer {#controlPlane-distro-k0s-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..ab0c0ec1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..04f7e8069 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..12278af76 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..bc756fcf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..cb32b37e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..9f39dad26 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..c994dd82e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..1e472feb6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k0s-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k0s-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k0s-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +####### `sleep` required {#controlPlane-distro-k0s-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle_reference.mdx new file mode 100755 index 000000000..c9893eaf1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +###### `postStart` required {#controlPlane-distro-k0s-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +###### `preStop` required {#controlPlane-distro-k0s-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe.mdx new file mode 100755 index 000000000..8f09a81a2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +##### `livenessProbe` required {#controlPlane-distro-k0s-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec.mdx new file mode 100755 index 000000000..89353347e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k0s-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..5bc723829 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `command` required string[] {#controlPlane-distro-k0s-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..d0382acbb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `failureThreshold` required integer {#controlPlane-distro-k0s-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc.mdx new file mode 100755 index 000000000..f2b0e6c4f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +###### `grpc` required {#controlPlane-distro-k0s-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..5108f5e17 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `port` required integer {#controlPlane-distro-k0s-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..f50717e29 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `service` required string {#controlPlane-distro-k0s-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..2a7d8e218 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +###### `httpGet` required {#controlPlane-distro-k0s-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..90ce4cced --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k0s-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..6c5f48cf6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k0s-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..e595b925b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k0s-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..c168d4f17 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `value` required string {#controlPlane-distro-k0s-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..55bc8a59b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#controlPlane-distro-k0s-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..35ac9782f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..a4f9e8de4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k0s-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..6b2c9541b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k0s-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..3bd667570 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k0s-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..3c67a3f7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `scheme` required string {#controlPlane-distro-k0s-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..4e0856a17 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +####### `port` required {#controlPlane-distro-k0s-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k0s-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..18d1102ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `initialDelaySeconds` required integer {#controlPlane-distro-k0s-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..e2fbc06eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `periodSeconds` required integer {#controlPlane-distro-k0s-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..63c9e57e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `successThreshold` required integer {#controlPlane-distro-k0s-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..d54bf5854 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k0s-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..bb7d43c95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k0s-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..6353611e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..0a29123cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k0s-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..27c4b7336 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k0s-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..eb71cab94 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k0s-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..00a474ea2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..8d964a02d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k0s-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..9649d1681 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `timeoutSeconds` required integer {#controlPlane-distro-k0s-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe_reference.mdx new file mode 100755 index 000000000..8e1785bdd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k0s-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +###### `httpGet` required {#controlPlane-distro-k0s-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k0s-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +###### `grpc` required {#controlPlane-distro-k0s-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/name.mdx new file mode 100755 index 000000000..2b282df5c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/name.mdx @@ -0,0 +1,15 @@ + +
+ + +##### `name` required string {#controlPlane-distro-k0s-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports.mdx new file mode 100755 index 000000000..02ecf3b2c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +##### `ports` required object[] {#controlPlane-distro-k0s-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/containerPort.mdx new file mode 100755 index 000000000..adc95613d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `containerPort` required integer {#controlPlane-distro-k0s-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/hostIP.mdx new file mode 100755 index 000000000..f9c309cc9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `hostIP` required string {#controlPlane-distro-k0s-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/hostPort.mdx new file mode 100755 index 000000000..d4fdee9f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `hostPort` required integer {#controlPlane-distro-k0s-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/name.mdx new file mode 100755 index 000000000..c148a345e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k0s-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/protocol.mdx new file mode 100755 index 000000000..2b438b67d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `protocol` required string {#controlPlane-distro-k0s-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe.mdx new file mode 100755 index 000000000..e4d2192de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +##### `readinessProbe` required {#controlPlane-distro-k0s-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec.mdx new file mode 100755 index 000000000..9a462fce7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k0s-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..e5f3127d1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `command` required string[] {#controlPlane-distro-k0s-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..e8fa82f8a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `failureThreshold` required integer {#controlPlane-distro-k0s-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc.mdx new file mode 100755 index 000000000..ff2fb6100 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +###### `grpc` required {#controlPlane-distro-k0s-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..83490199a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `port` required integer {#controlPlane-distro-k0s-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..edecb5efa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `service` required string {#controlPlane-distro-k0s-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..5494ab564 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +###### `httpGet` required {#controlPlane-distro-k0s-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..e6bbc5bb5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k0s-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..a5fc45dd6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k0s-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..8a2a42eeb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k0s-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..0c6c39d9d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `value` required string {#controlPlane-distro-k0s-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..880b7b791 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#controlPlane-distro-k0s-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..bf8e81c4b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..366cb1d88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k0s-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..2a8ee3ec8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k0s-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..888d118a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k0s-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..e5ecf4174 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `scheme` required string {#controlPlane-distro-k0s-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..83debda27 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +####### `port` required {#controlPlane-distro-k0s-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k0s-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..ce4f91c16 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `initialDelaySeconds` required integer {#controlPlane-distro-k0s-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..15eaad27f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `periodSeconds` required integer {#controlPlane-distro-k0s-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..13190900f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `successThreshold` required integer {#controlPlane-distro-k0s-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..a0e0a3a0f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k0s-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..49585d464 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k0s-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..ba957084a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..b5b81a43e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k0s-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..9eae062f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k0s-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..651be9c6b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k0s-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..ddb609591 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..01039b275 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k0s-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..de2489217 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `timeoutSeconds` required integer {#controlPlane-distro-k0s-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe_reference.mdx new file mode 100755 index 000000000..5d4c94778 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k0s-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +###### `httpGet` required {#controlPlane-distro-k0s-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k0s-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +###### `grpc` required {#controlPlane-distro-k0s-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy.mdx new file mode 100755 index 000000000..f0b9e8cbc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +##### `resizePolicy` required object[] {#controlPlane-distro-k0s-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..f473f2eca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `resourceName` required string {#controlPlane-distro-k0s-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..9d746b34f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `restartPolicy` required string {#controlPlane-distro-k0s-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources.mdx new file mode 100755 index 000000000..0019db5d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +##### `resources` required {#controlPlane-distro-k0s-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims.mdx new file mode 100755 index 000000000..ea2735fd4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +###### `claims` required object[] {#controlPlane-distro-k0s-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims/name.mdx new file mode 100755 index 000000000..012d0b2bc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k0s-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/limits.mdx new file mode 100755 index 000000000..16d101a44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +###### `limits` required {#controlPlane-distro-k0s-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/requests.mdx new file mode 100755 index 000000000..1533875c2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +###### `requests` required {#controlPlane-distro-k0s-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources_reference.mdx new file mode 100755 index 000000000..d81ab502b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +###### `limits` required {#controlPlane-distro-k0s-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +###### `requests` required {#controlPlane-distro-k0s-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +###### `claims` required object[] {#controlPlane-distro-k0s-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/restartPolicy.mdx new file mode 100755 index 000000000..bcbf2e12e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +##### `restartPolicy` required string {#controlPlane-distro-k0s-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext.mdx new file mode 100755 index 000000000..570c15271 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +##### `securityContext` required {#controlPlane-distro-k0s-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..15b574a37 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `allowPrivilegeEscalation` required boolean false {#controlPlane-distro-k0s-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities.mdx new file mode 100755 index 000000000..a3d526dda --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +###### `capabilities` required {#controlPlane-distro-k0s-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..512a88df1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `add` required string[] {#controlPlane-distro-k0s-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..a47bebb42 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `drop` required string[] {#controlPlane-distro-k0s-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/privileged.mdx new file mode 100755 index 000000000..819b9da6b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `privileged` required boolean false {#controlPlane-distro-k0s-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/procMount.mdx new file mode 100755 index 000000000..066c5c2ca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `procMount` required string {#controlPlane-distro-k0s-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..b2f937e40 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `readOnlyRootFilesystem` required boolean false {#controlPlane-distro-k0s-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..c9ab65f5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `runAsGroup` required integer {#controlPlane-distro-k0s-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..fb8c8e423 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +###### `runAsNonRoot` required boolean false {#controlPlane-distro-k0s-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsUser.mdx new file mode 100755 index 000000000..c3b9a7cc0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `runAsUser` required integer {#controlPlane-distro-k0s-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..2f926661e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +###### `seLinuxOptions` required {#controlPlane-distro-k0s-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..8e2ab0a99 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `level` required string {#controlPlane-distro-k0s-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..2337d5b84 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `role` required string {#controlPlane-distro-k0s-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..08ae41d72 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `type` required string {#controlPlane-distro-k0s-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..9487e768d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `user` required string {#controlPlane-distro-k0s-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..24e66d8da --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +###### `seccompProfile` required {#controlPlane-distro-k0s-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..2b4ed1cad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `localhostProfile` required string {#controlPlane-distro-k0s-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..c40d8a0f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +####### `type` required string {#controlPlane-distro-k0s-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..faf33544c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +###### `windowsOptions` required {#controlPlane-distro-k0s-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..f4e7780fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `gmsaCredentialSpec` required string {#controlPlane-distro-k0s-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..44a88a55e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `gmsaCredentialSpecName` required string {#controlPlane-distro-k0s-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..53321bee3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `hostProcess` required boolean false {#controlPlane-distro-k0s-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..f163e33b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `runAsUserName` required string {#controlPlane-distro-k0s-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext_reference.mdx new file mode 100755 index 000000000..2479bb898 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +###### `capabilities` required {#controlPlane-distro-k0s-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +###### `seLinuxOptions` required {#controlPlane-distro-k0s-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +###### `windowsOptions` required {#controlPlane-distro-k0s-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +###### `seccompProfile` required {#controlPlane-distro-k0s-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe.mdx new file mode 100755 index 000000000..34cf8cc4a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +##### `startupProbe` required {#controlPlane-distro-k0s-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec.mdx new file mode 100755 index 000000000..ce971c176 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k0s-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec/command.mdx new file mode 100755 index 000000000..2f1482d77 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `command` required string[] {#controlPlane-distro-k0s-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..ab9d44050 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `failureThreshold` required integer {#controlPlane-distro-k0s-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc.mdx new file mode 100755 index 000000000..6d9ac6565 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +###### `grpc` required {#controlPlane-distro-k0s-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..ea78f5a8c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `port` required integer {#controlPlane-distro-k0s-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..e4553b466 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `service` required string {#controlPlane-distro-k0s-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet.mdx new file mode 100755 index 000000000..ee2186297 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +###### `httpGet` required {#controlPlane-distro-k0s-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..2fe3b14f8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k0s-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..5bcc7e683 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k0s-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..5f2a9e4c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k0s-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..9cfa2226f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `value` required string {#controlPlane-distro-k0s-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..fe778ae6c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#controlPlane-distro-k0s-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..e09fff530 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..0ff969dde --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k0s-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..816a3a0a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k0s-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..da8ab480d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k0s-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..5e9e699b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `scheme` required string {#controlPlane-distro-k0s-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..606885206 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +####### `port` required {#controlPlane-distro-k0s-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k0s-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..ec9a0ca0c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `initialDelaySeconds` required integer {#controlPlane-distro-k0s-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..1a486919b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `periodSeconds` required integer {#controlPlane-distro-k0s-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..d60768eea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `successThreshold` required integer {#controlPlane-distro-k0s-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..72647b654 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k0s-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..304a41255 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k0s-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..c2e51de6a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..3cbbb3679 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k0s-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..bd5a701a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k0s-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..c983aef3c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k0s-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..9d449bedd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k0s-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..15fa43fd6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k0s-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..7e364f4f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `timeoutSeconds` required integer {#controlPlane-distro-k0s-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe_reference.mdx new file mode 100755 index 000000000..b1459ddff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k0s-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +###### `httpGet` required {#controlPlane-distro-k0s-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k0s-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +###### `grpc` required {#controlPlane-distro-k0s-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/stdin.mdx new file mode 100755 index 000000000..bc083e9fe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +##### `stdin` required boolean false {#controlPlane-distro-k0s-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/stdinOnce.mdx new file mode 100755 index 000000000..ca6dad803 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `stdinOnce` required boolean false {#controlPlane-distro-k0s-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/terminationMessagePath.mdx new file mode 100755 index 000000000..3bbf78567 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `terminationMessagePath` required string {#controlPlane-distro-k0s-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/terminationMessagePolicy.mdx new file mode 100755 index 000000000..22591bf48 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `terminationMessagePolicy` required string {#controlPlane-distro-k0s-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/tty.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/tty.mdx new file mode 100755 index 000000000..798280e3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `tty` required boolean false {#controlPlane-distro-k0s-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices.mdx new file mode 100755 index 000000000..f640d7b5a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +##### `volumeDevices` required object[] {#controlPlane-distro-k0s-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..e1a86848b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `devicePath` required string {#controlPlane-distro-k0s-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices/name.mdx new file mode 100755 index 000000000..2dbeed841 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k0s-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts.mdx new file mode 100755 index 000000000..0057e581d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +##### `volumeMounts` required object[] {#controlPlane-distro-k0s-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..74d6f0d66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `mountPath` required string {#controlPlane-distro-k0s-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..fd687ce4d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `mountPropagation` required string {#controlPlane-distro-k0s-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/name.mdx new file mode 100755 index 000000000..30be18b80 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k0s-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..7b6155d75 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `readOnly` required boolean false {#controlPlane-distro-k0s-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/subPath.mdx new file mode 100755 index 000000000..d94e8f774 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `subPath` required string {#controlPlane-distro-k0s-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..9b5eda508 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `subPathExpr` required string {#controlPlane-distro-k0s-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s/workingDir.mdx new file mode 100755 index 000000000..5cd75322a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +##### `workingDir` required string {#controlPlane-distro-k0s-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k0s_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k0s_reference.mdx new file mode 100755 index 000000000..949336cc4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k0s_reference.mdx @@ -0,0 +1,282 @@ + +import PartialName from "./k0s/name.mdx" +import PartialImage from "./k0s/image.mdx" +import PartialCommand from "./k0s/command.mdx" +import PartialArgs from "./k0s/args.mdx" +import PartialWorkingdir from "./k0s/workingDir.mdx" +import PartialPortsreference from "./k0s/ports_reference.mdx" +import PartialEnvfromreference from "./k0s/envFrom_reference.mdx" +import PartialEnvreference from "./k0s/env_reference.mdx" +import PartialResourcesreference from "./k0s/resources_reference.mdx" +import PartialResizepolicyreference from "./k0s/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./k0s/restartPolicy.mdx" +import PartialVolumemountsreference from "./k0s/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./k0s/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./k0s/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./k0s/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./k0s/startupProbe_reference.mdx" +import PartialLifecyclereference from "./k0s/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./k0s/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./k0s/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./k0s/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./k0s/securityContext_reference.mdx" +import PartialStdin from "./k0s/stdin.mdx" +import PartialStdinonce from "./k0s/stdinOnce.mdx" +import PartialTty from "./k0s/tty.mdx" + + + + + + + + + + + + + + + + + +
+ + +##### `ports` required object[] {#controlPlane-distro-k0s-ports} + +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. + + + + + + +
+ + + +
+ + +##### `envFrom` required object[] {#controlPlane-distro-k0s-envFrom} + +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. + + + + + + +
+ + + +
+ + +##### `env` required object[] {#controlPlane-distro-k0s-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +##### `resources` required {#controlPlane-distro-k0s-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +##### `resizePolicy` required object[] {#controlPlane-distro-k0s-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +##### `volumeMounts` required object[] {#controlPlane-distro-k0s-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +##### `volumeDevices` required object[] {#controlPlane-distro-k0s-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +##### `livenessProbe` required {#controlPlane-distro-k0s-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +##### `readinessProbe` required {#controlPlane-distro-k0s-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +##### `startupProbe` required {#controlPlane-distro-k0s-startupProbe} + +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 + + + + + + +
+ + + +
+ + +##### `lifecycle` required {#controlPlane-distro-k0s-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +##### `securityContext` required {#controlPlane-distro-k0s-securityContext} + +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/ + + + + + + +
+ + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s.mdx new file mode 100755 index 000000000..511296a51 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s.mdx @@ -0,0 +1,17 @@ + +import PartialK3sreference from "./k3s_reference.mdx" + + +
+ + +#### `k3s` required {#controlPlane-distro-k3s} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/args.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/args.mdx new file mode 100755 index 000000000..bfbc75be1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/args.mdx @@ -0,0 +1,20 @@ + +
+ + +##### `args` required string[] {#controlPlane-distro-k3s-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/command.mdx new file mode 100755 index 000000000..1268487bb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/command.mdx @@ -0,0 +1,20 @@ + +
+ + +##### `command` required string[] {#controlPlane-distro-k3s-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env.mdx new file mode 100755 index 000000000..0fde79ef0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +##### `env` required object[] {#controlPlane-distro-k3s-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/name.mdx new file mode 100755 index 000000000..498d3239b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k3s-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/value.mdx new file mode 100755 index 000000000..4b81c5292 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +###### `value` required string {#controlPlane-distro-k3s-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom.mdx new file mode 100755 index 000000000..bf192de7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +###### `valueFrom` required {#controlPlane-distro-k3s-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..4bd42ede8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +####### `configMapKeyRef` required {#controlPlane-distro-k3s-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..f2fb9304c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `key` required string {#controlPlane-distro-k3s-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..a7fab35f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k3s-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..51ef32757 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k3s-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..b0be519ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +####### `fieldRef` required {#controlPlane-distro-k3s-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..ba814e0e6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `apiVersion` required string {#controlPlane-distro-k3s-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..ed8028443 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `fieldPath` required string {#controlPlane-distro-k3s-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..dae751a09 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +####### `resourceFieldRef` required {#controlPlane-distro-k3s-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..46b7eb2d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `containerName` required string {#controlPlane-distro-k3s-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..59ff497ea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +######## `divisor` required {#controlPlane-distro-k3s-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..7f6127791 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Format` required string {#controlPlane-distro-k3s-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..b3121abfe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `resource` required string {#controlPlane-distro-k3s-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..83f399015 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +######## `divisor` required {#controlPlane-distro-k3s-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..a242cd6c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +####### `secretKeyRef` required {#controlPlane-distro-k3s-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..158f22091 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `key` required string {#controlPlane-distro-k3s-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..00783bf55 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k3s-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..79e533e3f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k3s-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom_reference.mdx new file mode 100755 index 000000000..db77f5395 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +####### `fieldRef` required {#controlPlane-distro-k3s-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +####### `resourceFieldRef` required {#controlPlane-distro-k3s-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +####### `configMapKeyRef` required {#controlPlane-distro-k3s-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +####### `secretKeyRef` required {#controlPlane-distro-k3s-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom.mdx new file mode 100755 index 000000000..9e7787001 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +##### `envFrom` required object[] {#controlPlane-distro-k3s-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef.mdx new file mode 100755 index 000000000..a81a25206 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +###### `configMapRef` required {#controlPlane-distro-k3s-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..7a4129cc1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k3s-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..2c2ee5bff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `optional` required boolean false {#controlPlane-distro-k3s-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/prefix.mdx new file mode 100755 index 000000000..d0f87982b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `prefix` required string {#controlPlane-distro-k3s-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef.mdx new file mode 100755 index 000000000..f9a0fe7d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +###### `secretRef` required {#controlPlane-distro-k3s-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..d40bee587 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k3s-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..5fa9cfcd8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `optional` required boolean false {#controlPlane-distro-k3s-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom_reference.mdx new file mode 100755 index 000000000..ccef0f0c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +###### `configMapRef` required {#controlPlane-distro-k3s-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +###### `secretRef` required {#controlPlane-distro-k3s-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env_reference.mdx new file mode 100755 index 000000000..c063b6570 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +###### `valueFrom` required {#controlPlane-distro-k3s-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/image.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/image.mdx new file mode 100755 index 000000000..85dfc3e3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/image.mdx @@ -0,0 +1,16 @@ + +
+ + +##### `image` required string {#controlPlane-distro-k3s-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/imagePullPolicy.mdx new file mode 100755 index 000000000..310975edb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `imagePullPolicy` required string {#controlPlane-distro-k3s-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle.mdx new file mode 100755 index 000000000..3c1f86ae1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +##### `lifecycle` required {#controlPlane-distro-k3s-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart.mdx new file mode 100755 index 000000000..38d829f31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +###### `postStart` required {#controlPlane-distro-k3s-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..fd6a0f98d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k3s-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..96535c615 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k3s-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..0259603ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k3s-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..22ede69b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..c1afa92ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..1702671bb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..af9301741 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..468cd42c0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..bd21b0e2d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..02c5565a8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..342355143 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..d4e9d1fd4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..5a5669887 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..21c57a5cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k3s-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..fd6babeea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +####### `sleep` required {#controlPlane-distro-k3s-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..2ea5308a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `seconds` required integer {#controlPlane-distro-k3s-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..deafd2b7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..22084d89d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..405e3bd7e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..794379845 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..a37267b51 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..50ab688e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..9359d30be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..5792ae8ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k3s-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k3s-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k3s-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +####### `sleep` required {#controlPlane-distro-k3s-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop.mdx new file mode 100755 index 000000000..9ab23730b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +###### `preStop` required {#controlPlane-distro-k3s-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..85aa38ca2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k3s-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..467f759b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k3s-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..74bc2060c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k3s-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..fd356b27f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..d1348e338 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..88ed6457f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..dcdd28645 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..b057e21b1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..474c41141 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..edefa5f28 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..28f1ad451 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..e432ef6c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..1e1d35b49 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..630c5bb23 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k3s-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..4accd5ca4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +####### `sleep` required {#controlPlane-distro-k3s-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..f8a979d08 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `seconds` required integer {#controlPlane-distro-k3s-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..c2add4346 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..5edbbd423 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..4b3db8228 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..2050ef154 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..eb67ed523 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..b531bfdb6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..1a03e0954 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..ba7382c28 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k3s-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k3s-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k3s-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +####### `sleep` required {#controlPlane-distro-k3s-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle_reference.mdx new file mode 100755 index 000000000..aaac66498 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +###### `postStart` required {#controlPlane-distro-k3s-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +###### `preStop` required {#controlPlane-distro-k3s-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe.mdx new file mode 100755 index 000000000..e725ce4f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +##### `livenessProbe` required {#controlPlane-distro-k3s-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec.mdx new file mode 100755 index 000000000..dd07139f6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k3s-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..b9e1aa6aa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `command` required string[] {#controlPlane-distro-k3s-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..a6e793c6c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `failureThreshold` required integer {#controlPlane-distro-k3s-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc.mdx new file mode 100755 index 000000000..551c059a3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +###### `grpc` required {#controlPlane-distro-k3s-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..95c1ec070 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `port` required integer {#controlPlane-distro-k3s-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..1c9b2127a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `service` required string {#controlPlane-distro-k3s-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..5eb1454f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +###### `httpGet` required {#controlPlane-distro-k3s-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..653a9254e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k3s-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..2c7cb1d03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k3s-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..7c5ce2f61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k3s-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..dc4f2a792 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `value` required string {#controlPlane-distro-k3s-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..3a4b6896e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#controlPlane-distro-k3s-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..d1c9d8007 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..35d3b8e8e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k3s-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..67838aab0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k3s-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..828028a6c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k3s-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..7fc1a7178 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `scheme` required string {#controlPlane-distro-k3s-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..254756ddd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +####### `port` required {#controlPlane-distro-k3s-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k3s-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..66880b33f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `initialDelaySeconds` required integer {#controlPlane-distro-k3s-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..757b74e22 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `periodSeconds` required integer {#controlPlane-distro-k3s-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..9e809862d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `successThreshold` required integer {#controlPlane-distro-k3s-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..e0da2b9ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k3s-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..19cf5b3b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k3s-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..aab0efe63 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..f092c2fde --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k3s-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..261deb738 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k3s-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..a01740a92 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k3s-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..b41175633 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..55ee53fd7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k3s-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..616a6bb45 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `timeoutSeconds` required integer {#controlPlane-distro-k3s-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe_reference.mdx new file mode 100755 index 000000000..0652f3ed7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k3s-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +###### `httpGet` required {#controlPlane-distro-k3s-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k3s-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +###### `grpc` required {#controlPlane-distro-k3s-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/name.mdx new file mode 100755 index 000000000..26bbb533f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/name.mdx @@ -0,0 +1,15 @@ + +
+ + +##### `name` required string {#controlPlane-distro-k3s-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports.mdx new file mode 100755 index 000000000..5df9f0d27 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +##### `ports` required object[] {#controlPlane-distro-k3s-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/containerPort.mdx new file mode 100755 index 000000000..4ade70565 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `containerPort` required integer {#controlPlane-distro-k3s-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/hostIP.mdx new file mode 100755 index 000000000..72cd2afef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `hostIP` required string {#controlPlane-distro-k3s-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/hostPort.mdx new file mode 100755 index 000000000..94064212b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `hostPort` required integer {#controlPlane-distro-k3s-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/name.mdx new file mode 100755 index 000000000..638edd4ce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k3s-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/protocol.mdx new file mode 100755 index 000000000..4ded54ada --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `protocol` required string {#controlPlane-distro-k3s-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe.mdx new file mode 100755 index 000000000..fec8bd4b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +##### `readinessProbe` required {#controlPlane-distro-k3s-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec.mdx new file mode 100755 index 000000000..4439386e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k3s-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..67bca1e1a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `command` required string[] {#controlPlane-distro-k3s-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..990d1ba91 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `failureThreshold` required integer {#controlPlane-distro-k3s-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc.mdx new file mode 100755 index 000000000..c62b6983f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +###### `grpc` required {#controlPlane-distro-k3s-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..45ab41b9a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `port` required integer {#controlPlane-distro-k3s-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..0a7e37b2c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `service` required string {#controlPlane-distro-k3s-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..221c918b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +###### `httpGet` required {#controlPlane-distro-k3s-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..d29064cb9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k3s-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..7cc3bdb4d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k3s-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..9d47fad13 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k3s-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..da9b2e6f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `value` required string {#controlPlane-distro-k3s-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..db1491d7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#controlPlane-distro-k3s-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..41cfc7813 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..200509852 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k3s-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..664d837df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k3s-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..8bcbbf810 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k3s-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..00a152f49 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `scheme` required string {#controlPlane-distro-k3s-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..fe5189f2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +####### `port` required {#controlPlane-distro-k3s-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k3s-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..b36a58497 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `initialDelaySeconds` required integer {#controlPlane-distro-k3s-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..5a8db5178 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `periodSeconds` required integer {#controlPlane-distro-k3s-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..10e336fce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `successThreshold` required integer {#controlPlane-distro-k3s-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..c2c794f53 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k3s-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..9b31e26bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k3s-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..7b31f8a1d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..067b76ff6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k3s-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..ad2731b4d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k3s-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..ce0b10b7c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k3s-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..d23524741 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..a00be96d2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k3s-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..f5151f69e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `timeoutSeconds` required integer {#controlPlane-distro-k3s-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe_reference.mdx new file mode 100755 index 000000000..dec0ae6aa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k3s-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +###### `httpGet` required {#controlPlane-distro-k3s-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k3s-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +###### `grpc` required {#controlPlane-distro-k3s-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy.mdx new file mode 100755 index 000000000..da8f9b746 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +##### `resizePolicy` required object[] {#controlPlane-distro-k3s-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..5764dba43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `resourceName` required string {#controlPlane-distro-k3s-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..b813f82e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `restartPolicy` required string {#controlPlane-distro-k3s-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources.mdx new file mode 100755 index 000000000..89377725e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +##### `resources` required {#controlPlane-distro-k3s-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims.mdx new file mode 100755 index 000000000..f66c7c529 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +###### `claims` required object[] {#controlPlane-distro-k3s-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims/name.mdx new file mode 100755 index 000000000..f7ecb09a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k3s-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/limits.mdx new file mode 100755 index 000000000..07e2a7dca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +###### `limits` required {#controlPlane-distro-k3s-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/requests.mdx new file mode 100755 index 000000000..403369c94 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +###### `requests` required {#controlPlane-distro-k3s-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources_reference.mdx new file mode 100755 index 000000000..c202f20b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +###### `limits` required {#controlPlane-distro-k3s-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +###### `requests` required {#controlPlane-distro-k3s-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +###### `claims` required object[] {#controlPlane-distro-k3s-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/restartPolicy.mdx new file mode 100755 index 000000000..2dc4bc49e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +##### `restartPolicy` required string {#controlPlane-distro-k3s-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext.mdx new file mode 100755 index 000000000..5fc1d6991 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +##### `securityContext` required {#controlPlane-distro-k3s-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..972fa3675 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `allowPrivilegeEscalation` required boolean false {#controlPlane-distro-k3s-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities.mdx new file mode 100755 index 000000000..f96f15d32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +###### `capabilities` required {#controlPlane-distro-k3s-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..f30fd4df2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `add` required string[] {#controlPlane-distro-k3s-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..216fb1f5d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `drop` required string[] {#controlPlane-distro-k3s-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/privileged.mdx new file mode 100755 index 000000000..82bb3dbda --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `privileged` required boolean false {#controlPlane-distro-k3s-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/procMount.mdx new file mode 100755 index 000000000..371ea4292 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `procMount` required string {#controlPlane-distro-k3s-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..33cd42c3d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `readOnlyRootFilesystem` required boolean false {#controlPlane-distro-k3s-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..6d59fe6d9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `runAsGroup` required integer {#controlPlane-distro-k3s-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..efa51cb57 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +###### `runAsNonRoot` required boolean false {#controlPlane-distro-k3s-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsUser.mdx new file mode 100755 index 000000000..8ddcee266 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `runAsUser` required integer {#controlPlane-distro-k3s-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..e46e6361a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +###### `seLinuxOptions` required {#controlPlane-distro-k3s-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..91a6e6204 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `level` required string {#controlPlane-distro-k3s-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..f7013df58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `role` required string {#controlPlane-distro-k3s-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..ec7b0a178 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `type` required string {#controlPlane-distro-k3s-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..33e9dd420 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `user` required string {#controlPlane-distro-k3s-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..2e2899039 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +###### `seccompProfile` required {#controlPlane-distro-k3s-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..c1ac69c2c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `localhostProfile` required string {#controlPlane-distro-k3s-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..a1432e4f6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +####### `type` required string {#controlPlane-distro-k3s-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..7fe15b9db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +###### `windowsOptions` required {#controlPlane-distro-k3s-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..31f643863 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `gmsaCredentialSpec` required string {#controlPlane-distro-k3s-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..606b4de29 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `gmsaCredentialSpecName` required string {#controlPlane-distro-k3s-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..82573a9f1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `hostProcess` required boolean false {#controlPlane-distro-k3s-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..a3f7f7962 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `runAsUserName` required string {#controlPlane-distro-k3s-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext_reference.mdx new file mode 100755 index 000000000..9114f57a8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +###### `capabilities` required {#controlPlane-distro-k3s-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +###### `seLinuxOptions` required {#controlPlane-distro-k3s-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +###### `windowsOptions` required {#controlPlane-distro-k3s-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +###### `seccompProfile` required {#controlPlane-distro-k3s-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe.mdx new file mode 100755 index 000000000..7cf3262f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +##### `startupProbe` required {#controlPlane-distro-k3s-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec.mdx new file mode 100755 index 000000000..721ea0800 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k3s-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec/command.mdx new file mode 100755 index 000000000..e7e497410 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `command` required string[] {#controlPlane-distro-k3s-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..9357e9d15 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `failureThreshold` required integer {#controlPlane-distro-k3s-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc.mdx new file mode 100755 index 000000000..c80f63fe9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +###### `grpc` required {#controlPlane-distro-k3s-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..472fd658c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `port` required integer {#controlPlane-distro-k3s-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..e292c7ea4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `service` required string {#controlPlane-distro-k3s-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet.mdx new file mode 100755 index 000000000..e78df68ea --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +###### `httpGet` required {#controlPlane-distro-k3s-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..63b8474fc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k3s-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..4ccab0938 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k3s-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..0de8d1c85 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k3s-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..239046ece --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `value` required string {#controlPlane-distro-k3s-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..6e3d72b3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#controlPlane-distro-k3s-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..3f86ec21c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..292330826 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k3s-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..87e95981e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k3s-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..9ed67683c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k3s-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..003867530 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `scheme` required string {#controlPlane-distro-k3s-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..85c8f55bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +####### `port` required {#controlPlane-distro-k3s-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +####### `httpHeaders` required object[] {#controlPlane-distro-k3s-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..789f5200e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `initialDelaySeconds` required integer {#controlPlane-distro-k3s-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..1e0fb3361 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `periodSeconds` required integer {#controlPlane-distro-k3s-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..b245a1b67 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `successThreshold` required integer {#controlPlane-distro-k3s-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..60a132611 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k3s-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..f62b9b2ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `host` required string {#controlPlane-distro-k3s-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..cc12e722f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..313499842 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `IntVal` required integer {#controlPlane-distro-k3s-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..0d0c4564d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `StrVal` required string {#controlPlane-distro-k3s-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..fd7bb9cbd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `Type` required integer {#controlPlane-distro-k3s-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..25f652281 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +####### `port` required {#controlPlane-distro-k3s-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..372d5d2cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +###### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k3s-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..9aa62f25c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `timeoutSeconds` required integer {#controlPlane-distro-k3s-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe_reference.mdx new file mode 100755 index 000000000..09bb9d6e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +###### `exec` required {#controlPlane-distro-k3s-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +###### `httpGet` required {#controlPlane-distro-k3s-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +###### `tcpSocket` required {#controlPlane-distro-k3s-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +###### `grpc` required {#controlPlane-distro-k3s-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/stdin.mdx new file mode 100755 index 000000000..201485e16 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +##### `stdin` required boolean false {#controlPlane-distro-k3s-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/stdinOnce.mdx new file mode 100755 index 000000000..81b1f96b5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `stdinOnce` required boolean false {#controlPlane-distro-k3s-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/terminationMessagePath.mdx new file mode 100755 index 000000000..a8311f034 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `terminationMessagePath` required string {#controlPlane-distro-k3s-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/terminationMessagePolicy.mdx new file mode 100755 index 000000000..16eb904b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `terminationMessagePolicy` required string {#controlPlane-distro-k3s-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/token.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/token.mdx new file mode 100755 index 000000000..9fc39edc7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/token.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `token` required string {#controlPlane-distro-k3s-token} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/tty.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/tty.mdx new file mode 100755 index 000000000..4cba1a696 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `tty` required boolean false {#controlPlane-distro-k3s-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices.mdx new file mode 100755 index 000000000..9edcec112 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +##### `volumeDevices` required object[] {#controlPlane-distro-k3s-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..800594b67 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `devicePath` required string {#controlPlane-distro-k3s-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices/name.mdx new file mode 100755 index 000000000..afc773430 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k3s-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts.mdx new file mode 100755 index 000000000..6e5b2340b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +##### `volumeMounts` required object[] {#controlPlane-distro-k3s-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..bef3ba21e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `mountPath` required string {#controlPlane-distro-k3s-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..0ae550cd0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `mountPropagation` required string {#controlPlane-distro-k3s-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/name.mdx new file mode 100755 index 000000000..954ffa8a8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k3s-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..8fa45fdb7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `readOnly` required boolean false {#controlPlane-distro-k3s-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/subPath.mdx new file mode 100755 index 000000000..16c4b9be2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `subPath` required string {#controlPlane-distro-k3s-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..20fc74c48 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `subPathExpr` required string {#controlPlane-distro-k3s-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s/workingDir.mdx new file mode 100755 index 000000000..a37b9d3ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +##### `workingDir` required string {#controlPlane-distro-k3s-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k3s_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k3s_reference.mdx new file mode 100755 index 000000000..345d1aa50 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k3s_reference.mdx @@ -0,0 +1,286 @@ + +import PartialName from "./k3s/name.mdx" +import PartialImage from "./k3s/image.mdx" +import PartialCommand from "./k3s/command.mdx" +import PartialArgs from "./k3s/args.mdx" +import PartialWorkingdir from "./k3s/workingDir.mdx" +import PartialPortsreference from "./k3s/ports_reference.mdx" +import PartialEnvfromreference from "./k3s/envFrom_reference.mdx" +import PartialEnvreference from "./k3s/env_reference.mdx" +import PartialResourcesreference from "./k3s/resources_reference.mdx" +import PartialResizepolicyreference from "./k3s/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./k3s/restartPolicy.mdx" +import PartialVolumemountsreference from "./k3s/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./k3s/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./k3s/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./k3s/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./k3s/startupProbe_reference.mdx" +import PartialLifecyclereference from "./k3s/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./k3s/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./k3s/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./k3s/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./k3s/securityContext_reference.mdx" +import PartialStdin from "./k3s/stdin.mdx" +import PartialStdinonce from "./k3s/stdinOnce.mdx" +import PartialTty from "./k3s/tty.mdx" +import PartialToken from "./k3s/token.mdx" + + + + + + + + + + + + + + + + + +
+ + +##### `ports` required object[] {#controlPlane-distro-k3s-ports} + +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. + + + + + + +
+ + + +
+ + +##### `envFrom` required object[] {#controlPlane-distro-k3s-envFrom} + +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. + + + + + + +
+ + + +
+ + +##### `env` required object[] {#controlPlane-distro-k3s-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +##### `resources` required {#controlPlane-distro-k3s-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +##### `resizePolicy` required object[] {#controlPlane-distro-k3s-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +##### `volumeMounts` required object[] {#controlPlane-distro-k3s-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +##### `volumeDevices` required object[] {#controlPlane-distro-k3s-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +##### `livenessProbe` required {#controlPlane-distro-k3s-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +##### `readinessProbe` required {#controlPlane-distro-k3s-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +##### `startupProbe` required {#controlPlane-distro-k3s-startupProbe} + +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 + + + + + + +
+ + + +
+ + +##### `lifecycle` required {#controlPlane-distro-k3s-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +##### `securityContext` required {#controlPlane-distro-k3s-securityContext} + +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/ + + + + + + +
+ + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s.mdx new file mode 100755 index 000000000..bf1d618fb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s.mdx @@ -0,0 +1,17 @@ + +import PartialK8sreference from "./k8s_reference.mdx" + + +
+ + +#### `k8s` required {#controlPlane-distro-k8s} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer.mdx new file mode 100755 index 000000000..a0e5f8b64 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer.mdx @@ -0,0 +1,17 @@ + +import PartialApiserverreference from "./apiServer_reference.mdx" + + +
+ + +##### `apiServer` required {#controlPlane-distro-k8s-apiServer} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/args.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/args.mdx new file mode 100755 index 000000000..3493c4258 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/args.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `args` required string[] {#controlPlane-distro-k8s-apiServer-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/command.mdx new file mode 100755 index 000000000..779534c9d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/command.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `command` required string[] {#controlPlane-distro-k8s-apiServer-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env.mdx new file mode 100755 index 000000000..8a68fe403 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-apiServer-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/name.mdx new file mode 100755 index 000000000..038637c45 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-apiServer-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/value.mdx new file mode 100755 index 000000000..ec44a0d4a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +####### `value` required string {#controlPlane-distro-k8s-apiServer-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom.mdx new file mode 100755 index 000000000..e205a10b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-apiServer-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..c376090a4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..b7c7d214d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..c2fe52ed2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..2994138fc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-apiServer-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..943e3d8de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..479df65a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `apiVersion` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..a8589c68d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `fieldPath` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..076638570 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..689b56f2e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `containerName` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..2b5c71ed8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..df1440691 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Format` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..023f94965 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `resource` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..f78a90b61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..0845d2d6d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..76388b1a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..94229c39e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-apiServer-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..dd8479f1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-apiServer-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom_reference.mdx new file mode 100755 index 000000000..3369d5b97 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-apiServer-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom.mdx new file mode 100755 index 000000000..6a7e5890a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-apiServer-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef.mdx new file mode 100755 index 000000000..dcd085006 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-apiServer-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..4ef0f2832 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-apiServer-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..a357ceaed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-apiServer-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/prefix.mdx new file mode 100755 index 000000000..230cb25e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `prefix` required string {#controlPlane-distro-k8s-apiServer-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef.mdx new file mode 100755 index 000000000..a32cab692 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-apiServer-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..85769d3ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-apiServer-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..98eb8de52 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-apiServer-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom_reference.mdx new file mode 100755 index 000000000..3215b6ffc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-apiServer-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-apiServer-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env_reference.mdx new file mode 100755 index 000000000..60e6d1532 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-apiServer-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/image.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/image.mdx new file mode 100755 index 000000000..7f84533b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/image.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `image` required string {#controlPlane-distro-k8s-apiServer-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/imagePullPolicy.mdx new file mode 100755 index 000000000..45052df12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `imagePullPolicy` required string {#controlPlane-distro-k8s-apiServer-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle.mdx new file mode 100755 index 000000000..9063b8555 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-apiServer-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart.mdx new file mode 100755 index 000000000..76ffbd967 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..c56948138 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..6a91e6be1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..6c5453833 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..cd2080b0f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..25eb8777a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..6984cd5a1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..9cdbde19c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..5d944e216 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..2d57c30d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..a3bf0d89e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..f4cbaef07 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..c8a6b36c4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..470ec1c03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..dca235e01 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..f951ef741 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..3215ed5af --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..fafe75613 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..1642532f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..314ead798 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..d3b54bf05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..865e0799b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..b53a6fbd8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..69b3e046d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..0c292cde6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop.mdx new file mode 100755 index 000000000..e9fe9382c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..ad7b24b9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..92ce26431 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..a1fe9cde9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..8e8da4f32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..59f04558e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..5fdd5883f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..4e123a4d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..0483d1d00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..8622fc265 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..e06328f9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..dc92ce058 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..447f34118 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..65a85ed8b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..2cccf65de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..7f4b02e9b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..cee9f7aa4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..02ff430cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..98ce85cd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..decd2a8ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..76c4e9101 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..71183bf50 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..c97c44ed4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..4ec4c4f13 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..4b9fc1c14 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle_reference.mdx new file mode 100755 index 000000000..a7b68ef9b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-apiServer-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-apiServer-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe.mdx new file mode 100755 index 000000000..0db0ef495 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-apiServer-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec.mdx new file mode 100755 index 000000000..f956ed14e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-apiServer-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..ad6e6f848 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-apiServer-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..6116dc098 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc.mdx new file mode 100755 index 000000000..ea10fca81 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-apiServer-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..3e06ca66b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..db5f6e250 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..3d156dca6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..91331bf4b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..141ccfccb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..ce20211d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..cb8b8394a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..ad464038a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..5b8425391 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..a8e3bcd58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..93a5da976 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..818b9a9c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..1ed907379 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..fdfe80bda --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..e4c2628cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..f5348b9a4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..0c7e60d68 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..2cd85d0f8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..622ec22f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..2e0bdbca0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..58a891e46 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..f0c681bca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..ceeaa96e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..9d3369921 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..ef625582e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..0e0d378e9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-apiServer-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe_reference.mdx new file mode 100755 index 000000000..7246395ee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-apiServer-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-apiServer-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-apiServer-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-apiServer-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/name.mdx new file mode 100755 index 000000000..95d86e75f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/name.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k8s-apiServer-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports.mdx new file mode 100755 index 000000000..4c7729fe1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-apiServer-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/containerPort.mdx new file mode 100755 index 000000000..1bb3978d8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `containerPort` required integer {#controlPlane-distro-k8s-apiServer-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/hostIP.mdx new file mode 100755 index 000000000..674428f2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `hostIP` required string {#controlPlane-distro-k8s-apiServer-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/hostPort.mdx new file mode 100755 index 000000000..96f81d0e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `hostPort` required integer {#controlPlane-distro-k8s-apiServer-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/name.mdx new file mode 100755 index 000000000..eafebc243 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-apiServer-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/protocol.mdx new file mode 100755 index 000000000..27261b36d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `protocol` required string {#controlPlane-distro-k8s-apiServer-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe.mdx new file mode 100755 index 000000000..aa73c7dfd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-apiServer-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec.mdx new file mode 100755 index 000000000..66c56aee2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-apiServer-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..84b502721 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-apiServer-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..5b426a294 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc.mdx new file mode 100755 index 000000000..4244a03dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-apiServer-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..7a50849cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..a2dd07029 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..c61cb2b24 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..ab68d1e16 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..a81e1150f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..3c13fbeac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..42c45e618 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..471147281 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..0cdaeabbb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..7b1cd838a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..b0f1e7bec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..33f70f535 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..bdb666ea4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..b906a5860 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..ff248e04b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..c94817fbb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..8f0c1730d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..f5d0feea8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..88aa1611b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..b5da8dbc8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..60cc873d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..f65390d98 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..e1de26277 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..d08c6099d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..bad2bd1b6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..5d85890b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-apiServer-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe_reference.mdx new file mode 100755 index 000000000..4256e7b97 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-apiServer-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-apiServer-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-apiServer-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-apiServer-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy.mdx new file mode 100755 index 000000000..b0c29ae95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-apiServer-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..072b8f596 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `resourceName` required string {#controlPlane-distro-k8s-apiServer-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..4842546ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `restartPolicy` required string {#controlPlane-distro-k8s-apiServer-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources.mdx new file mode 100755 index 000000000..726512d76 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-apiServer-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims.mdx new file mode 100755 index 000000000..9965c4516 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-apiServer-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims/name.mdx new file mode 100755 index 000000000..616e06572 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-apiServer-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/limits.mdx new file mode 100755 index 000000000..bdfa38217 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-apiServer-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/requests.mdx new file mode 100755 index 000000000..1bdbe7657 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-apiServer-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources_reference.mdx new file mode 100755 index 000000000..021aac5a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-apiServer-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-apiServer-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-apiServer-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/restartPolicy.mdx new file mode 100755 index 000000000..49389db34 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `restartPolicy` required string {#controlPlane-distro-k8s-apiServer-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext.mdx new file mode 100755 index 000000000..fd69d58c4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-apiServer-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..4e591747d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +####### `allowPrivilegeEscalation` required boolean false {#controlPlane-distro-k8s-apiServer-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities.mdx new file mode 100755 index 000000000..04a980f16 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-apiServer-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..a3ac94455 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `add` required string[] {#controlPlane-distro-k8s-apiServer-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..76979f149 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `drop` required string[] {#controlPlane-distro-k8s-apiServer-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/privileged.mdx new file mode 100755 index 000000000..df60bf61e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `privileged` required boolean false {#controlPlane-distro-k8s-apiServer-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/procMount.mdx new file mode 100755 index 000000000..3dd3821f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `procMount` required string {#controlPlane-distro-k8s-apiServer-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..9bf79fa4d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `readOnlyRootFilesystem` required boolean false {#controlPlane-distro-k8s-apiServer-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..2ccd4eb72 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsGroup` required integer {#controlPlane-distro-k8s-apiServer-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..b6faed554 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +####### `runAsNonRoot` required boolean false {#controlPlane-distro-k8s-apiServer-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsUser.mdx new file mode 100755 index 000000000..3457d6a40 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsUser` required integer {#controlPlane-distro-k8s-apiServer-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..70dd6f108 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-apiServer-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..5f0db72d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `level` required string {#controlPlane-distro-k8s-apiServer-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..e9dcf7694 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `role` required string {#controlPlane-distro-k8s-apiServer-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..6970fe0fa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-apiServer-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..65ed64466 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `user` required string {#controlPlane-distro-k8s-apiServer-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..3f1444caa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-apiServer-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..4c3c7b9c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `localhostProfile` required string {#controlPlane-distro-k8s-apiServer-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..d96e7c315 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-apiServer-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..7ded3043f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-apiServer-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..fcaddca00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `gmsaCredentialSpec` required string {#controlPlane-distro-k8s-apiServer-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..41f825bb9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `gmsaCredentialSpecName` required string {#controlPlane-distro-k8s-apiServer-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..a561e1422 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `hostProcess` required boolean false {#controlPlane-distro-k8s-apiServer-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..358620c96 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `runAsUserName` required string {#controlPlane-distro-k8s-apiServer-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext_reference.mdx new file mode 100755 index 000000000..ea5813d63 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-apiServer-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-apiServer-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-apiServer-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-apiServer-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe.mdx new file mode 100755 index 000000000..764a61779 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-apiServer-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec.mdx new file mode 100755 index 000000000..ea20d55cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-apiServer-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec/command.mdx new file mode 100755 index 000000000..8db17b34f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-apiServer-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..86234038d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc.mdx new file mode 100755 index 000000000..967bd5b00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-apiServer-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..0e453e9bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..8ed2683d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-apiServer-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet.mdx new file mode 100755 index 000000000..776327f3a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..eb9d608f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..10845ad7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..cf95acb56 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..4f19a744f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..a27b573d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..eeac1d5db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..6f1e04b02 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..4aa7fc184 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..80c3590fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..0f8f51e80 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..2633618f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..5a58f1a30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..6d47a9036 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..e46e7e573 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..246e0eadd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..501372f21 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..4061c539c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..f3ad1b16f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..01b793fdf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..6ce8469b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..0242ebb76 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..2d0f9fa8c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..2f2e59b11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-apiServer-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe_reference.mdx new file mode 100755 index 000000000..2d33c6ac8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-apiServer-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-apiServer-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-apiServer-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-apiServer-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/stdin.mdx new file mode 100755 index 000000000..6a67f8519 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `stdin` required boolean false {#controlPlane-distro-k8s-apiServer-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/stdinOnce.mdx new file mode 100755 index 000000000..30b761391 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `stdinOnce` required boolean false {#controlPlane-distro-k8s-apiServer-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/terminationMessagePath.mdx new file mode 100755 index 000000000..0047ae3db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePath` required string {#controlPlane-distro-k8s-apiServer-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/terminationMessagePolicy.mdx new file mode 100755 index 000000000..9ff58a917 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePolicy` required string {#controlPlane-distro-k8s-apiServer-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/tty.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/tty.mdx new file mode 100755 index 000000000..92175eee5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `tty` required boolean false {#controlPlane-distro-k8s-apiServer-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices.mdx new file mode 100755 index 000000000..80840c2d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-apiServer-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..8976dc838 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `devicePath` required string {#controlPlane-distro-k8s-apiServer-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices/name.mdx new file mode 100755 index 000000000..0d58c7ae5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-apiServer-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts.mdx new file mode 100755 index 000000000..bc572ed11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-apiServer-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..41425e239 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `mountPath` required string {#controlPlane-distro-k8s-apiServer-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..dc5ff13ad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `mountPropagation` required string {#controlPlane-distro-k8s-apiServer-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/name.mdx new file mode 100755 index 000000000..c5546d5b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-apiServer-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..856666cdc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `readOnly` required boolean false {#controlPlane-distro-k8s-apiServer-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/subPath.mdx new file mode 100755 index 000000000..49f61ba71 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `subPath` required string {#controlPlane-distro-k8s-apiServer-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..4ed39c7e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `subPathExpr` required string {#controlPlane-distro-k8s-apiServer-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/workingDir.mdx new file mode 100755 index 000000000..22fe1fc0b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `workingDir` required string {#controlPlane-distro-k8s-apiServer-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer_reference.mdx new file mode 100755 index 000000000..67b33ee65 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/apiServer_reference.mdx @@ -0,0 +1,282 @@ + +import PartialName from "./apiServer/name.mdx" +import PartialImage from "./apiServer/image.mdx" +import PartialCommand from "./apiServer/command.mdx" +import PartialArgs from "./apiServer/args.mdx" +import PartialWorkingdir from "./apiServer/workingDir.mdx" +import PartialPortsreference from "./apiServer/ports_reference.mdx" +import PartialEnvfromreference from "./apiServer/envFrom_reference.mdx" +import PartialEnvreference from "./apiServer/env_reference.mdx" +import PartialResourcesreference from "./apiServer/resources_reference.mdx" +import PartialResizepolicyreference from "./apiServer/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./apiServer/restartPolicy.mdx" +import PartialVolumemountsreference from "./apiServer/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./apiServer/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./apiServer/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./apiServer/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./apiServer/startupProbe_reference.mdx" +import PartialLifecyclereference from "./apiServer/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./apiServer/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./apiServer/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./apiServer/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./apiServer/securityContext_reference.mdx" +import PartialStdin from "./apiServer/stdin.mdx" +import PartialStdinonce from "./apiServer/stdinOnce.mdx" +import PartialTty from "./apiServer/tty.mdx" + + + + + + + + + + + + + + + + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-apiServer-ports} + +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. + + + + + + +
+ + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-apiServer-envFrom} + +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. + + + + + + +
+ + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-apiServer-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-apiServer-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-apiServer-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-apiServer-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-apiServer-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-apiServer-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-apiServer-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-apiServer-startupProbe} + +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 + + + + + + +
+ + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-apiServer-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-apiServer-securityContext} + +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/ + + + + + + +
+ + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager.mdx new file mode 100755 index 000000000..26ae3d1dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager.mdx @@ -0,0 +1,17 @@ + +import PartialControllermanagerreference from "./controllerManager_reference.mdx" + + +
+ + +##### `controllerManager` required {#controlPlane-distro-k8s-controllerManager} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/args.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/args.mdx new file mode 100755 index 000000000..9fe3473d8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/args.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `args` required string[] {#controlPlane-distro-k8s-controllerManager-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/command.mdx new file mode 100755 index 000000000..504678949 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/command.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `command` required string[] {#controlPlane-distro-k8s-controllerManager-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env.mdx new file mode 100755 index 000000000..c75901f88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-controllerManager-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/name.mdx new file mode 100755 index 000000000..bd9de0c94 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-controllerManager-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/value.mdx new file mode 100755 index 000000000..0c6d319e6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +####### `value` required string {#controlPlane-distro-k8s-controllerManager-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom.mdx new file mode 100755 index 000000000..fdc52a3bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..153b736c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..3d71d5c41 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..6b86b71b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..6efd62782 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-controllerManager-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..90ac22a03 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..71e2937a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `apiVersion` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..8969783a9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `fieldPath` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..d34c34e58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..dbb98ed50 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `containerName` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..208a64e37 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..04dbb94dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Format` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..f638ce48a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `resource` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..4d43709ec --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..59bae9669 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..f47004150 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..d28c309e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-controllerManager-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..07c35b828 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-controllerManager-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom_reference.mdx new file mode 100755 index 000000000..0d2c697db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom.mdx new file mode 100755 index 000000000..f37ddd7b6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-controllerManager-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef.mdx new file mode 100755 index 000000000..171266801 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-controllerManager-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..43c87ba34 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-controllerManager-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..81064b0c2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-controllerManager-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/prefix.mdx new file mode 100755 index 000000000..a8d6e4c28 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `prefix` required string {#controlPlane-distro-k8s-controllerManager-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef.mdx new file mode 100755 index 000000000..002b018e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-controllerManager-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..012d4de24 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-controllerManager-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..bddd191dd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-controllerManager-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom_reference.mdx new file mode 100755 index 000000000..47e4d306f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-controllerManager-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-controllerManager-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env_reference.mdx new file mode 100755 index 000000000..2d50a8501 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-controllerManager-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/image.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/image.mdx new file mode 100755 index 000000000..5c2fe924c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/image.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `image` required string {#controlPlane-distro-k8s-controllerManager-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/imagePullPolicy.mdx new file mode 100755 index 000000000..20cdf1138 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `imagePullPolicy` required string {#controlPlane-distro-k8s-controllerManager-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle.mdx new file mode 100755 index 000000000..ea2c59de3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-controllerManager-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart.mdx new file mode 100755 index 000000000..3d930dd7a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..177714f21 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..59aa2710f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..5c6a7e363 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..7e34cfb0c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..5cecaba58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..21f0d918f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..009d20439 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..36080753b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..e835df46f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..57848cd44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..aa617839e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..b75c7cc8c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..a93c2aff3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..da6bb99d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..3896da544 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..0b99865d8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..ea74d1d34 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..43fe9303f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..8e79d7697 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..f1735df4b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..1d5815898 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..e2717241d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..b540c884a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..f334ef857 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop.mdx new file mode 100755 index 000000000..ca4565854 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..4b301380f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..562c0fbb5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..a34e6e166 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..a7f85e3d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..4d86fd4c9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..9d42b752f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..a65f4ef88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..f99dff4a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..716f76e7b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..d6e20d1b3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..3727905a2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..505672178 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..79dcf574f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..2aa7a5f0a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..2e7b8915a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..a304ff017 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..317874869 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..d9e30c077 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..aed87ad64 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..6c3419b0d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..467efae0f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..d103f6561 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..7eed6e36a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..bf94b6f27 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle_reference.mdx new file mode 100755 index 000000000..c586ab704 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-controllerManager-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-controllerManager-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe.mdx new file mode 100755 index 000000000..437c79af7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-controllerManager-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec.mdx new file mode 100755 index 000000000..bbb4d0047 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..31588cf7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-controllerManager-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..b9152587e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc.mdx new file mode 100755 index 000000000..f2280a6f8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..8158f027a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..564b40fd8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..58db8910a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..34b2837c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..8f116d223 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..788ed1a38 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..c46202f39 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..044a2fbe0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..ff4a00f0d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..fb92f7084 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..6313d334d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..97e4af94d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..581c8307d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..e19a66768 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..6dc04de34 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..7a690f4f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..42009d682 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..fe2e4b653 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..f3cb10d1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..bdd48b811 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..5a1027d87 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..9a61866fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..971a9e24b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..ff3098cc1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..ce1f1d85f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..912cf7038 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-controllerManager-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe_reference.mdx new file mode 100755 index 000000000..86e92d141 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-controllerManager-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/name.mdx new file mode 100755 index 000000000..c7ece3dd3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/name.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k8s-controllerManager-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports.mdx new file mode 100755 index 000000000..4655c05d3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-controllerManager-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/containerPort.mdx new file mode 100755 index 000000000..fa4141729 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `containerPort` required integer {#controlPlane-distro-k8s-controllerManager-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/hostIP.mdx new file mode 100755 index 000000000..7e740a83d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `hostIP` required string {#controlPlane-distro-k8s-controllerManager-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/hostPort.mdx new file mode 100755 index 000000000..953ee94fc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `hostPort` required integer {#controlPlane-distro-k8s-controllerManager-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/name.mdx new file mode 100755 index 000000000..7ebc28466 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-controllerManager-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/protocol.mdx new file mode 100755 index 000000000..3a63efe5e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `protocol` required string {#controlPlane-distro-k8s-controllerManager-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe.mdx new file mode 100755 index 000000000..cd025b1d7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-controllerManager-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec.mdx new file mode 100755 index 000000000..a92790870 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..68e648443 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-controllerManager-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..1149570f6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc.mdx new file mode 100755 index 000000000..bc3c6f2b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..38b1beb3e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..fa90cb051 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..a34bd778f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..cd617db1b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..3b71e4406 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..936f9a80d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..c978c2518 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..5ecc983c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..109de6644 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..b8abd54d9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..3cb30c6b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..09013930c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..30633e598 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..ce841d714 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..fda5002fb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..f5922a030 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..f70552fcd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..5e1574626 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..53076c02f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..18a54e697 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..db897639b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..afa14df74 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..62f09c512 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..39926040f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..0f8adf5d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..8b6c26493 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-controllerManager-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe_reference.mdx new file mode 100755 index 000000000..f95a52b42 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-controllerManager-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy.mdx new file mode 100755 index 000000000..5732faecf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-controllerManager-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..8c99ca3d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `resourceName` required string {#controlPlane-distro-k8s-controllerManager-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..5cc50593c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `restartPolicy` required string {#controlPlane-distro-k8s-controllerManager-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources.mdx new file mode 100755 index 000000000..053cfc0d2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-controllerManager-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims.mdx new file mode 100755 index 000000000..5ac65dbad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-controllerManager-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims/name.mdx new file mode 100755 index 000000000..c051b3e2e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-controllerManager-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/limits.mdx new file mode 100755 index 000000000..eda3d66cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-controllerManager-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/requests.mdx new file mode 100755 index 000000000..bdd98a4f9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-controllerManager-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources_reference.mdx new file mode 100755 index 000000000..fa93f193f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-controllerManager-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-controllerManager-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-controllerManager-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/restartPolicy.mdx new file mode 100755 index 000000000..5aa8e817b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `restartPolicy` required string {#controlPlane-distro-k8s-controllerManager-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext.mdx new file mode 100755 index 000000000..84a8122b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-controllerManager-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..df934fc2f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +####### `allowPrivilegeEscalation` required boolean false {#controlPlane-distro-k8s-controllerManager-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities.mdx new file mode 100755 index 000000000..fa28c1c58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-controllerManager-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..ca27dbecd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `add` required string[] {#controlPlane-distro-k8s-controllerManager-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..3b64bce51 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `drop` required string[] {#controlPlane-distro-k8s-controllerManager-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/privileged.mdx new file mode 100755 index 000000000..6926b4682 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `privileged` required boolean false {#controlPlane-distro-k8s-controllerManager-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/procMount.mdx new file mode 100755 index 000000000..274e42bc3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `procMount` required string {#controlPlane-distro-k8s-controllerManager-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..8dfe829f1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `readOnlyRootFilesystem` required boolean false {#controlPlane-distro-k8s-controllerManager-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..6a1070fd1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsGroup` required integer {#controlPlane-distro-k8s-controllerManager-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..282703fc2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +####### `runAsNonRoot` required boolean false {#controlPlane-distro-k8s-controllerManager-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsUser.mdx new file mode 100755 index 000000000..514682f84 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsUser` required integer {#controlPlane-distro-k8s-controllerManager-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..9b6b5243c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-controllerManager-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..88c482b87 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `level` required string {#controlPlane-distro-k8s-controllerManager-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..82f10c008 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `role` required string {#controlPlane-distro-k8s-controllerManager-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..2fafd76e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-controllerManager-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..3146a5647 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `user` required string {#controlPlane-distro-k8s-controllerManager-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..686ad4bd5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-controllerManager-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..46c576595 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `localhostProfile` required string {#controlPlane-distro-k8s-controllerManager-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..545044a47 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-controllerManager-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..561dfb3d4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-controllerManager-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..1c43032bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `gmsaCredentialSpec` required string {#controlPlane-distro-k8s-controllerManager-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..bf87ccea5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `gmsaCredentialSpecName` required string {#controlPlane-distro-k8s-controllerManager-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..5b186049e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `hostProcess` required boolean false {#controlPlane-distro-k8s-controllerManager-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..08468a075 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `runAsUserName` required string {#controlPlane-distro-k8s-controllerManager-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext_reference.mdx new file mode 100755 index 000000000..59daf99c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-controllerManager-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-controllerManager-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-controllerManager-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-controllerManager-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe.mdx new file mode 100755 index 000000000..578c8c6d4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-controllerManager-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec.mdx new file mode 100755 index 000000000..d047bb7fa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-controllerManager-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec/command.mdx new file mode 100755 index 000000000..3930d5e1f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-controllerManager-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..ab0ded88a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc.mdx new file mode 100755 index 000000000..5d076df02 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-controllerManager-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..605b8a3b7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..0c3aac7de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet.mdx new file mode 100755 index 000000000..6c97f3fc9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..cb8003983 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..d9e70c235 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..f66745d98 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..e1798690e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..f15415780 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..2800f4517 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..1d8b82f05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..56eab02de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..6d9019f9b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..453601030 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..34ff60ee0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..7af607d88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..48741f1f9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..5e6d1ee47 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..c0bb14856 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..ffd0ea3ce --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..a1cce225d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..b1246c287 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..082455a3c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..1ffc7a8a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..e7f5c3232 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..6898a1e15 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..1d6a40be3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-controllerManager-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe_reference.mdx new file mode 100755 index 000000000..973f5b28f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-controllerManager-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-controllerManager-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-controllerManager-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-controllerManager-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/stdin.mdx new file mode 100755 index 000000000..2842a28c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `stdin` required boolean false {#controlPlane-distro-k8s-controllerManager-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/stdinOnce.mdx new file mode 100755 index 000000000..53ceecf67 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `stdinOnce` required boolean false {#controlPlane-distro-k8s-controllerManager-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/terminationMessagePath.mdx new file mode 100755 index 000000000..a76149ad3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePath` required string {#controlPlane-distro-k8s-controllerManager-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/terminationMessagePolicy.mdx new file mode 100755 index 000000000..5ef3dfb3e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePolicy` required string {#controlPlane-distro-k8s-controllerManager-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/tty.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/tty.mdx new file mode 100755 index 000000000..7761988f2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `tty` required boolean false {#controlPlane-distro-k8s-controllerManager-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices.mdx new file mode 100755 index 000000000..f707bcf0a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-controllerManager-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..5582d9a8b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `devicePath` required string {#controlPlane-distro-k8s-controllerManager-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices/name.mdx new file mode 100755 index 000000000..60bb47d0d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-controllerManager-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts.mdx new file mode 100755 index 000000000..0289100c0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-controllerManager-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..c1033d02e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `mountPath` required string {#controlPlane-distro-k8s-controllerManager-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..7e7b27983 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `mountPropagation` required string {#controlPlane-distro-k8s-controllerManager-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/name.mdx new file mode 100755 index 000000000..1e47ff99f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-controllerManager-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..19c5a87e3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `readOnly` required boolean false {#controlPlane-distro-k8s-controllerManager-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/subPath.mdx new file mode 100755 index 000000000..294842896 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `subPath` required string {#controlPlane-distro-k8s-controllerManager-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..e45078aa2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `subPathExpr` required string {#controlPlane-distro-k8s-controllerManager-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/workingDir.mdx new file mode 100755 index 000000000..a6a48d85f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `workingDir` required string {#controlPlane-distro-k8s-controllerManager-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager_reference.mdx new file mode 100755 index 000000000..0cf91603e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/controllerManager_reference.mdx @@ -0,0 +1,282 @@ + +import PartialName from "./controllerManager/name.mdx" +import PartialImage from "./controllerManager/image.mdx" +import PartialCommand from "./controllerManager/command.mdx" +import PartialArgs from "./controllerManager/args.mdx" +import PartialWorkingdir from "./controllerManager/workingDir.mdx" +import PartialPortsreference from "./controllerManager/ports_reference.mdx" +import PartialEnvfromreference from "./controllerManager/envFrom_reference.mdx" +import PartialEnvreference from "./controllerManager/env_reference.mdx" +import PartialResourcesreference from "./controllerManager/resources_reference.mdx" +import PartialResizepolicyreference from "./controllerManager/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./controllerManager/restartPolicy.mdx" +import PartialVolumemountsreference from "./controllerManager/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./controllerManager/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./controllerManager/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./controllerManager/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./controllerManager/startupProbe_reference.mdx" +import PartialLifecyclereference from "./controllerManager/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./controllerManager/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./controllerManager/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./controllerManager/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./controllerManager/securityContext_reference.mdx" +import PartialStdin from "./controllerManager/stdin.mdx" +import PartialStdinonce from "./controllerManager/stdinOnce.mdx" +import PartialTty from "./controllerManager/tty.mdx" + + + + + + + + + + + + + + + + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-controllerManager-ports} + +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. + + + + + + +
+ + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-controllerManager-envFrom} + +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. + + + + + + +
+ + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-controllerManager-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-controllerManager-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-controllerManager-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-controllerManager-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-controllerManager-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-controllerManager-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-controllerManager-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-controllerManager-startupProbe} + +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 + + + + + + +
+ + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-controllerManager-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-controllerManager-securityContext} + +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/ + + + + + + +
+ + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd.mdx new file mode 100755 index 000000000..e0d215aee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd.mdx @@ -0,0 +1,17 @@ + +import PartialEtcdreference from "./etcd_reference.mdx" + + +
+ + +##### `etcd` required {#controlPlane-distro-k8s-etcd} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/args.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/args.mdx new file mode 100755 index 000000000..c53133c63 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/args.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `args` required string[] {#controlPlane-distro-k8s-etcd-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/command.mdx new file mode 100755 index 000000000..e4f116dc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/command.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `command` required string[] {#controlPlane-distro-k8s-etcd-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env.mdx new file mode 100755 index 000000000..6ee3277d8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-etcd-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/name.mdx new file mode 100755 index 000000000..1767b7e51 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-etcd-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/value.mdx new file mode 100755 index 000000000..96da3ebe6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +####### `value` required string {#controlPlane-distro-k8s-etcd-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom.mdx new file mode 100755 index 000000000..f2855117c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-etcd-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..f8b488cee --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..585b2ee1b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..8b0ef622a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..80f99694f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-etcd-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..99105a568 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..5c35c59f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `apiVersion` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..b51406a0c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `fieldPath` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..3624bfb50 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..3fd2be2cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `containerName` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..7268bb35a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-etcd-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..711428fb7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Format` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..645e056f4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `resource` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..43dd7385e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-etcd-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..028a5756d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..96fb58d04 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..fd274c70f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-etcd-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..f5f99792e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-etcd-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom_reference.mdx new file mode 100755 index 000000000..5e55c25db --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-etcd-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom.mdx new file mode 100755 index 000000000..070f29217 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-etcd-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef.mdx new file mode 100755 index 000000000..3740f32d8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-etcd-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..7884deda8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-etcd-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..8dffe953a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-etcd-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/prefix.mdx new file mode 100755 index 000000000..b7e155eb6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `prefix` required string {#controlPlane-distro-k8s-etcd-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef.mdx new file mode 100755 index 000000000..bf862063b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-etcd-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..7d05735df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-etcd-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..26618f58e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-etcd-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom_reference.mdx new file mode 100755 index 000000000..1cfcc5b32 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-etcd-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-etcd-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env_reference.mdx new file mode 100755 index 000000000..eb518241f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-etcd-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/image.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/image.mdx new file mode 100755 index 000000000..c570b8554 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/image.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `image` required string {#controlPlane-distro-k8s-etcd-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/imagePullPolicy.mdx new file mode 100755 index 000000000..027a406e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `imagePullPolicy` required string {#controlPlane-distro-k8s-etcd-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle.mdx new file mode 100755 index 000000000..226abe508 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-etcd-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart.mdx new file mode 100755 index 000000000..a663bd336 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..64b19da95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..cb906a836 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-etcd-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..371592ae6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..abee1ad3e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..aeda4abd2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..968d58194 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..03534b0e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..1df2fd21e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..9984d7891 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..d178ecd2a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..cce64845a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..0fd7fb5cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..55383ab30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..fc5ebee60 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..ff8e57457 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..76f746696 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-etcd-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..a35aa78e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..3c6d968c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..3dcd5d6c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..10e9611cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..0a786d847 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..ccd80a56f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..2eab49ba3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..a7c21973a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop.mdx new file mode 100755 index 000000000..517a6118b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..a33deff43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..80d52305a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-etcd-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..f14bd7e1d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..06936b31e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..4b5c0c188 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..392fa6db2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..ea02a8ea8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..a925471ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..0b03e70c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..f8dab308b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..20c7d6c20 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..f4fd4ab47 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..101026152 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..c6b176c76 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..330ebcb09 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..48847fc05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-etcd-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..d51ad6dae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..acd8382ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..a234a6eef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..ece75b5f8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..867ac2024 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..36033d618 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..495ad707a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..f8fe0897e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle_reference.mdx new file mode 100755 index 000000000..5567af918 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-etcd-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-etcd-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe.mdx new file mode 100755 index 000000000..e0c6a8f00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-etcd-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec.mdx new file mode 100755 index 000000000..fc6940cb9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-etcd-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..ac7831e42 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-etcd-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..dccdc58ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc.mdx new file mode 100755 index 000000000..c782d7a3f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-etcd-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..4f52de864 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..b1524ee62 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-etcd-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..e006bc35f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..89354a677 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..3c9e91569 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..b77723ee6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..5975b0ae1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..1d699c2ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..e6ae01c07 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..00f9684ad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..1901ec74d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..de047777e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..e66c0a1d4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..6ccf87812 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..9bc7b0508 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..b6120c15e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..c2749d439 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..e1dd41ea1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..0cce60fb6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..063ecd909 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..94d3146b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..86012f2ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..eb83de5f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..393e41478 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..f8c307c53 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..8ffff136f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-etcd-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe_reference.mdx new file mode 100755 index 000000000..8f583106f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-etcd-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-etcd-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-etcd-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-etcd-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/name.mdx new file mode 100755 index 000000000..2883e53af --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/name.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k8s-etcd-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports.mdx new file mode 100755 index 000000000..202b5f610 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-etcd-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/containerPort.mdx new file mode 100755 index 000000000..670a0cb43 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `containerPort` required integer {#controlPlane-distro-k8s-etcd-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/hostIP.mdx new file mode 100755 index 000000000..1f730fe57 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `hostIP` required string {#controlPlane-distro-k8s-etcd-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/hostPort.mdx new file mode 100755 index 000000000..12ef0fd8f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `hostPort` required integer {#controlPlane-distro-k8s-etcd-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/name.mdx new file mode 100755 index 000000000..65e079b18 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-etcd-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/protocol.mdx new file mode 100755 index 000000000..4bc76c4e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `protocol` required string {#controlPlane-distro-k8s-etcd-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe.mdx new file mode 100755 index 000000000..32fea238f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-etcd-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec.mdx new file mode 100755 index 000000000..3da02b70c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-etcd-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..068e4323e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-etcd-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..190251be8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc.mdx new file mode 100755 index 000000000..33e85333f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-etcd-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..876758596 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..f6bcbe6a3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-etcd-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..83e6a0e93 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..068609101 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..76ee5dcdf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..2b24b7e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..cb8931f28 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..290484c5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..e31774bde --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..1bf6a7750 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..cefa4cfa9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..ac9bb8686 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..4632c31cf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..08ddec586 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..849bf47f0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..0ffa4285e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..920bcfce9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..4354501a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..0bf9f9036 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..6dc58f0cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..49b45cc6d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..7d534bcb1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..b91a55869 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..6fec26724 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..242d5a8cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..c1c30dcfd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-etcd-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe_reference.mdx new file mode 100755 index 000000000..313a53ccd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-etcd-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-etcd-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-etcd-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-etcd-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy.mdx new file mode 100755 index 000000000..970323101 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-etcd-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..bcd4a56fd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `resourceName` required string {#controlPlane-distro-k8s-etcd-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..c46fefe1d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `restartPolicy` required string {#controlPlane-distro-k8s-etcd-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources.mdx new file mode 100755 index 000000000..69ccded2f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-etcd-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims.mdx new file mode 100755 index 000000000..fc1d37f23 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-etcd-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims/name.mdx new file mode 100755 index 000000000..1857c7123 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-etcd-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/limits.mdx new file mode 100755 index 000000000..ba24d88f6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-etcd-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/requests.mdx new file mode 100755 index 000000000..f3efb5f12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-etcd-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources_reference.mdx new file mode 100755 index 000000000..dd20f4fb1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-etcd-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-etcd-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-etcd-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/restartPolicy.mdx new file mode 100755 index 000000000..fa3c8da45 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `restartPolicy` required string {#controlPlane-distro-k8s-etcd-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext.mdx new file mode 100755 index 000000000..a1890795c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-etcd-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..14c409a83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +####### `allowPrivilegeEscalation` required boolean false {#controlPlane-distro-k8s-etcd-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities.mdx new file mode 100755 index 000000000..eeb6e7efc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-etcd-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..f9c598d55 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `add` required string[] {#controlPlane-distro-k8s-etcd-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..396bcf1f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `drop` required string[] {#controlPlane-distro-k8s-etcd-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/privileged.mdx new file mode 100755 index 000000000..a6e250cd7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `privileged` required boolean false {#controlPlane-distro-k8s-etcd-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/procMount.mdx new file mode 100755 index 000000000..fa710e591 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `procMount` required string {#controlPlane-distro-k8s-etcd-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..9b5f4e57c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `readOnlyRootFilesystem` required boolean false {#controlPlane-distro-k8s-etcd-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..2d6224582 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsGroup` required integer {#controlPlane-distro-k8s-etcd-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..a6e5f25a9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +####### `runAsNonRoot` required boolean false {#controlPlane-distro-k8s-etcd-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsUser.mdx new file mode 100755 index 000000000..491795235 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsUser` required integer {#controlPlane-distro-k8s-etcd-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..d1b9f9367 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-etcd-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..127eee849 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `level` required string {#controlPlane-distro-k8s-etcd-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..b38b82a22 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `role` required string {#controlPlane-distro-k8s-etcd-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..db53070a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-etcd-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..1d748c718 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `user` required string {#controlPlane-distro-k8s-etcd-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..5c0191444 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-etcd-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..1b673afd0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `localhostProfile` required string {#controlPlane-distro-k8s-etcd-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..96cc949bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-etcd-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..2b1b12142 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-etcd-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..2958051a4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `gmsaCredentialSpec` required string {#controlPlane-distro-k8s-etcd-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..5cdddee66 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `gmsaCredentialSpecName` required string {#controlPlane-distro-k8s-etcd-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..206e1f796 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `hostProcess` required boolean false {#controlPlane-distro-k8s-etcd-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..39545bb55 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `runAsUserName` required string {#controlPlane-distro-k8s-etcd-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext_reference.mdx new file mode 100755 index 000000000..5bcd2409d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-etcd-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-etcd-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-etcd-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-etcd-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe.mdx new file mode 100755 index 000000000..660ca90d9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-etcd-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec.mdx new file mode 100755 index 000000000..6fe46d4c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-etcd-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec/command.mdx new file mode 100755 index 000000000..3b99bf2fb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-etcd-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..0083dae25 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-etcd-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc.mdx new file mode 100755 index 000000000..b84df73e3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-etcd-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..06b790111 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-etcd-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..c5121b695 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-etcd-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet.mdx new file mode 100755 index 000000000..3e856e956 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-etcd-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..0eb529ced --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..b43e64eb1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..0d5594da2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..f1f95a70e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..d893f6039 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..44e81f08c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..ae90cf4cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..f6d8df874 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..b28707956 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..555facd22 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..823f9c8e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-etcd-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..c07e40e83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-etcd-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..6968897d8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-etcd-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..ca5750087 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-etcd-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..166c221f3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..6908c7060 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..8b5573f8a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..8d4a2c289 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..73ba02a36 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..ff24eff53 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..5fe99b892 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..5fc623fe6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-etcd-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..b97a55bba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-etcd-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe_reference.mdx new file mode 100755 index 000000000..a128fcb35 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-etcd-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-etcd-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-etcd-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-etcd-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/stdin.mdx new file mode 100755 index 000000000..7ea5f928a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `stdin` required boolean false {#controlPlane-distro-k8s-etcd-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/stdinOnce.mdx new file mode 100755 index 000000000..49da711bc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `stdinOnce` required boolean false {#controlPlane-distro-k8s-etcd-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/terminationMessagePath.mdx new file mode 100755 index 000000000..27ad6665d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePath` required string {#controlPlane-distro-k8s-etcd-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/terminationMessagePolicy.mdx new file mode 100755 index 000000000..748944e58 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePolicy` required string {#controlPlane-distro-k8s-etcd-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/tty.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/tty.mdx new file mode 100755 index 000000000..03c267699 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `tty` required boolean false {#controlPlane-distro-k8s-etcd-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices.mdx new file mode 100755 index 000000000..29721d252 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-etcd-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..952ee9034 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `devicePath` required string {#controlPlane-distro-k8s-etcd-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices/name.mdx new file mode 100755 index 000000000..bb2080719 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-etcd-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts.mdx new file mode 100755 index 000000000..85224f399 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-etcd-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..487734630 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `mountPath` required string {#controlPlane-distro-k8s-etcd-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..ed24b8838 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `mountPropagation` required string {#controlPlane-distro-k8s-etcd-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/name.mdx new file mode 100755 index 000000000..ee3b53622 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-etcd-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..e73245898 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `readOnly` required boolean false {#controlPlane-distro-k8s-etcd-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/subPath.mdx new file mode 100755 index 000000000..593d088e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `subPath` required string {#controlPlane-distro-k8s-etcd-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..c366787c5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `subPathExpr` required string {#controlPlane-distro-k8s-etcd-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/workingDir.mdx new file mode 100755 index 000000000..273970c93 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `workingDir` required string {#controlPlane-distro-k8s-etcd-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd_reference.mdx new file mode 100755 index 000000000..7975b939a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/etcd_reference.mdx @@ -0,0 +1,282 @@ + +import PartialName from "./etcd/name.mdx" +import PartialImage from "./etcd/image.mdx" +import PartialCommand from "./etcd/command.mdx" +import PartialArgs from "./etcd/args.mdx" +import PartialWorkingdir from "./etcd/workingDir.mdx" +import PartialPortsreference from "./etcd/ports_reference.mdx" +import PartialEnvfromreference from "./etcd/envFrom_reference.mdx" +import PartialEnvreference from "./etcd/env_reference.mdx" +import PartialResourcesreference from "./etcd/resources_reference.mdx" +import PartialResizepolicyreference from "./etcd/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./etcd/restartPolicy.mdx" +import PartialVolumemountsreference from "./etcd/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./etcd/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./etcd/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./etcd/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./etcd/startupProbe_reference.mdx" +import PartialLifecyclereference from "./etcd/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./etcd/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./etcd/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./etcd/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./etcd/securityContext_reference.mdx" +import PartialStdin from "./etcd/stdin.mdx" +import PartialStdinonce from "./etcd/stdinOnce.mdx" +import PartialTty from "./etcd/tty.mdx" + + + + + + + + + + + + + + + + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-etcd-ports} + +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. + + + + + + +
+ + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-etcd-envFrom} + +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. + + + + + + +
+ + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-etcd-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-etcd-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-etcd-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-etcd-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-etcd-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-etcd-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-etcd-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-etcd-startupProbe} + +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 + + + + + + +
+ + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-etcd-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-etcd-securityContext} + +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/ + + + + + + +
+ + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler.mdx new file mode 100755 index 000000000..6d4a930b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler.mdx @@ -0,0 +1,17 @@ + +import PartialSchedulerreference from "./scheduler_reference.mdx" + + +
+ + +##### `scheduler` required {#controlPlane-distro-k8s-scheduler} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/args.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/args.mdx new file mode 100755 index 000000000..3b4e8412a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/args.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `args` required string[] {#controlPlane-distro-k8s-scheduler-args} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/command.mdx new file mode 100755 index 000000000..646bcd774 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/command.mdx @@ -0,0 +1,20 @@ + +
+ + +###### `command` required string[] {#controlPlane-distro-k8s-scheduler-command} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env.mdx new file mode 100755 index 000000000..37dca7ffe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env.mdx @@ -0,0 +1,18 @@ + +import PartialEnvreference from "./env_reference.mdx" + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-scheduler-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/name.mdx new file mode 100755 index 000000000..f76f3b736 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-scheduler-env-name} + +Name of the environment variable. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/value.mdx new file mode 100755 index 000000000..ca2de914d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/value.mdx @@ -0,0 +1,21 @@ + +
+ + +####### `value` required string {#controlPlane-distro-k8s-scheduler-env-value} + +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 "". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom.mdx new file mode 100755 index 000000000..82fd1fdf2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom.mdx @@ -0,0 +1,17 @@ + +import PartialValuefromreference from "./valueFrom_reference.mdx" + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-scheduler-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef.mdx new file mode 100755 index 000000000..f9954e17d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapkeyrefreference from "./configMapKeyRef_reference.mdx" + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/key.mdx new file mode 100755 index 000000000..4b7469fad --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-configMapKeyRef-key} + +The key to select. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/name.mdx new file mode 100755 index 000000000..828276637 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-configMapKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/optional.mdx new file mode 100755 index 000000000..b07ca1365 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-scheduler-env-valueFrom-configMapKeyRef-optional} + +Specify whether the ConfigMap or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef_reference.mdx new file mode 100755 index 000000000..be73d0462 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/configMapKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./configMapKeyRef/name.mdx" +import PartialKey from "./configMapKeyRef/key.mdx" +import PartialOptional from "./configMapKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef.mdx new file mode 100755 index 000000000..baa997c7f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialFieldrefreference from "./fieldRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef/apiVersion.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef/apiVersion.mdx new file mode 100755 index 000000000..04795205d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `apiVersion` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-fieldRef-apiVersion} + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef/fieldPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef/fieldPath.mdx new file mode 100755 index 000000000..d68295c5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef/fieldPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `fieldPath` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-fieldRef-fieldPath} + +Path of the field to select in the specified API version. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef_reference.mdx new file mode 100755 index 000000000..b733ed75e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/fieldRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialApiversion from "./fieldRef/apiVersion.mdx" +import PartialFieldpath from "./fieldRef/fieldPath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef.mdx new file mode 100755 index 000000000..2a025384b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef.mdx @@ -0,0 +1,18 @@ + +import PartialResourcefieldrefreference from "./resourceFieldRef_reference.mdx" + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/containerName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/containerName.mdx new file mode 100755 index 000000000..43d21e495 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/containerName.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `containerName` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-resourceFieldRef-containerName} + +Container name: required for volumes, optional for env vars + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor.mdx new file mode 100755 index 000000000..67aaa601d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor.mdx @@ -0,0 +1,17 @@ + +import PartialDivisorreference from "./divisor_reference.mdx" + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor/Format.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor/Format.mdx new file mode 100755 index 000000000..cd9cfd120 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Format` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-resourceFieldRef-divisor-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor_reference.mdx new file mode 100755 index 000000000..d9e48be00 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/divisor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./divisor/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/resource.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/resource.mdx new file mode 100755 index 000000000..655e390e0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef/resource.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `resource` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-resourceFieldRef-resource} + +Required: resource to select + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef_reference.mdx new file mode 100755 index 000000000..65dcb095b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/resourceFieldRef_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContainername from "./resourceFieldRef/containerName.mdx" +import PartialResource from "./resourceFieldRef/resource.mdx" +import PartialDivisorreference from "./resourceFieldRef/divisor_reference.mdx" + + + + + + + + +
+ + +######### `divisor` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-resourceFieldRef-divisor} + +Specifies the output format of the exposed resources, defaults to "1" + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef.mdx new file mode 100755 index 000000000..0fc91da15 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretkeyrefreference from "./secretKeyRef_reference.mdx" + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/key.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/key.mdx new file mode 100755 index 000000000..a1db06a64 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/key.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `key` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-secretKeyRef-key} + +The key of the secret to select from. Must be a valid secret key. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/name.mdx new file mode 100755 index 000000000..30d6b55c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-scheduler-env-valueFrom-secretKeyRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/optional.mdx new file mode 100755 index 000000000..1ed122450 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `optional` required boolean false {#controlPlane-distro-k8s-scheduler-env-valueFrom-secretKeyRef-optional} + +Specify whether the Secret or its key must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef_reference.mdx new file mode 100755 index 000000000..0ddb19c12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom/secretKeyRef_reference.mdx @@ -0,0 +1,12 @@ + +import PartialName from "./secretKeyRef/name.mdx" +import PartialKey from "./secretKeyRef/key.mdx" +import PartialOptional from "./secretKeyRef/optional.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom_reference.mdx new file mode 100755 index 000000000..640f3138e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env/valueFrom_reference.mdx @@ -0,0 +1,70 @@ + +import PartialFieldrefreference from "./valueFrom/fieldRef_reference.mdx" +import PartialResourcefieldrefreference from "./valueFrom/resourceFieldRef_reference.mdx" +import PartialConfigmapkeyrefreference from "./valueFrom/configMapKeyRef_reference.mdx" +import PartialSecretkeyrefreference from "./valueFrom/secretKeyRef_reference.mdx" + + +
+ + +######## `fieldRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-fieldRef} + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + +
+ + + +
+ + +######## `resourceFieldRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-resourceFieldRef} + +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. + + + + + + +
+ + + +
+ + +######## `configMapKeyRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-configMapKeyRef} + +Selects a key of a ConfigMap. + + + + + + +
+ + + +
+ + +######## `secretKeyRef` required {#controlPlane-distro-k8s-scheduler-env-valueFrom-secretKeyRef} + +Selects a key of a secret in the pod's namespace + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom.mdx new file mode 100755 index 000000000..a84faffcb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom.mdx @@ -0,0 +1,22 @@ + +import PartialEnvfromreference from "./envFrom_reference.mdx" + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-scheduler-envFrom} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef.mdx new file mode 100755 index 000000000..1431f745c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmaprefreference from "./configMapRef_reference.mdx" + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-scheduler-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef/name.mdx new file mode 100755 index 000000000..43e2fa2e5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-scheduler-envFrom-configMapRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef/optional.mdx new file mode 100755 index 000000000..29bc3761f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-scheduler-envFrom-configMapRef-optional} + +Specify whether the ConfigMap must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef_reference.mdx new file mode 100755 index 000000000..6c4322c05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/configMapRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./configMapRef/name.mdx" +import PartialOptional from "./configMapRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/prefix.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/prefix.mdx new file mode 100755 index 000000000..2651c7886 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/prefix.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `prefix` required string {#controlPlane-distro-k8s-scheduler-envFrom-prefix} + +An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef.mdx new file mode 100755 index 000000000..a30291eed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef.mdx @@ -0,0 +1,17 @@ + +import PartialSecretrefreference from "./secretRef_reference.mdx" + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-scheduler-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef/name.mdx new file mode 100755 index 000000000..c0f2429de --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-scheduler-envFrom-secretRef-name} + +Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid? + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef/optional.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef/optional.mdx new file mode 100755 index 000000000..78997ab7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `optional` required boolean false {#controlPlane-distro-k8s-scheduler-envFrom-secretRef-optional} + +Specify whether the Secret must be defined + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef_reference.mdx new file mode 100755 index 000000000..81e4345d5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom/secretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secretRef/name.mdx" +import PartialOptional from "./secretRef/optional.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom_reference.mdx new file mode 100755 index 000000000..a460f4506 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/envFrom_reference.mdx @@ -0,0 +1,38 @@ + +import PartialPrefix from "./envFrom/prefix.mdx" +import PartialConfigmaprefreference from "./envFrom/configMapRef_reference.mdx" +import PartialSecretrefreference from "./envFrom/secretRef_reference.mdx" + + + + + +
+ + +####### `configMapRef` required {#controlPlane-distro-k8s-scheduler-envFrom-configMapRef} + +The ConfigMap to select from + + + + + + +
+ + + +
+ + +####### `secretRef` required {#controlPlane-distro-k8s-scheduler-envFrom-secretRef} + +The Secret to select from + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env_reference.mdx new file mode 100755 index 000000000..f54da8eb8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/env_reference.mdx @@ -0,0 +1,25 @@ + +import PartialName from "./env/name.mdx" +import PartialValue from "./env/value.mdx" +import PartialValuefromreference from "./env/valueFrom_reference.mdx" + + + + + + + + +
+ + +####### `valueFrom` required {#controlPlane-distro-k8s-scheduler-env-valueFrom} + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/image.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/image.mdx new file mode 100755 index 000000000..6529c5550 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/image.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `image` required string {#controlPlane-distro-k8s-scheduler-image} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/imagePullPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/imagePullPolicy.mdx new file mode 100755 index 000000000..31ea6f015 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/imagePullPolicy.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `imagePullPolicy` required string {#controlPlane-distro-k8s-scheduler-imagePullPolicy} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle.mdx new file mode 100755 index 000000000..ed5eb3a05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle.mdx @@ -0,0 +1,18 @@ + +import PartialLifecyclereference from "./lifecycle_reference.mdx" + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-scheduler-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart.mdx new file mode 100755 index 000000000..697e58e7a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart.mdx @@ -0,0 +1,20 @@ + +import PartialPoststartreference from "./postStart_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec.mdx new file mode 100755 index 000000000..1090fbf7e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec/command.mdx new file mode 100755 index 000000000..d5fed7e98 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet.mdx new file mode 100755 index 000000000..cc694e944 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/host.mdx new file mode 100755 index 000000000..96ebd45ef --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..7174a205f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..cad961fdb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..a4ff58946 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/path.mdx new file mode 100755 index 000000000..0a1038209 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port.mdx new file mode 100755 index 000000000..b7dee5810 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..036d45320 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..c7e416e6a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/Type.mdx new file mode 100755 index 000000000..37b98f5f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/scheme.mdx new file mode 100755 index 000000000..9ea3d22b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet_reference.mdx new file mode 100755 index 000000000..c6e99cd92 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep.mdx new file mode 100755 index 000000000..b7641e929 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep/seconds.mdx new file mode 100755 index 000000000..844b5cc1a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket.mdx new file mode 100755 index 000000000..3180abe64 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/host.mdx new file mode 100755 index 000000000..e3a287281 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port.mdx new file mode 100755 index 000000000..e526bb43b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..7fec78b79 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..f821161be --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..5dbb28575 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket_reference.mdx new file mode 100755 index 000000000..2b41b9913 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart_reference.mdx new file mode 100755 index 000000000..04d90d062 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/postStart_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./postStart/exec_reference.mdx" +import PartialHttpgetreference from "./postStart/httpGet_reference.mdx" +import PartialTcpsocketreference from "./postStart/tcpSocket_reference.mdx" +import PartialSleepreference from "./postStart/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop.mdx new file mode 100755 index 000000000..9bb8af9e2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop.mdx @@ -0,0 +1,25 @@ + +import PartialPrestopreference from "./preStop_reference.mdx" + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec.mdx new file mode 100755 index 000000000..55b30d363 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec/command.mdx new file mode 100755 index 000000000..d31c94a75 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######### `command` required string[] {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet.mdx new file mode 100755 index 000000000..1a8c7c296 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/host.mdx new file mode 100755 index 000000000..9e1f72f74 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..286f46e17 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..f45efaac3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..6ee28bf7d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `value` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/path.mdx new file mode 100755 index 000000000..c5329ed61 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `path` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port.mdx new file mode 100755 index 000000000..8affde54b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..4364ede48 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..f9d60f10f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/Type.mdx new file mode 100755 index 000000000..91e95d160 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/scheme.mdx new file mode 100755 index 000000000..3807fec5b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `scheme` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet_reference.mdx new file mode 100755 index 000000000..ee335a73c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######### `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep.mdx new file mode 100755 index 000000000..eaf863c9a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep/seconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep/seconds.mdx new file mode 100755 index 000000000..64c58e04d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep/seconds.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `seconds` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-sleep-seconds} + +Seconds is the number of seconds to sleep. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep_reference.mdx new file mode 100755 index 000000000..29a893068 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/sleep_reference.mdx @@ -0,0 +1,4 @@ + +import PartialSeconds from "./sleep/seconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket.mdx new file mode 100755 index 000000000..54b3b0f1e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket.mdx @@ -0,0 +1,19 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/host.mdx new file mode 100755 index 000000000..c7631715a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `host` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port.mdx new file mode 100755 index 000000000..d60cb5549 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..61c5b8952 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `IntVal` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..5f98866c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `StrVal` required string {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..e865590cc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `Type` required integer {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket_reference.mdx new file mode 100755 index 000000000..77c906cd6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######### `port` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop_reference.mdx new file mode 100755 index 000000000..1b6e6e179 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle/preStop_reference.mdx @@ -0,0 +1,70 @@ + +import PartialExecreference from "./preStop/exec_reference.mdx" +import PartialHttpgetreference from "./preStop/httpGet_reference.mdx" +import PartialTcpsocketreference from "./preStop/tcpSocket_reference.mdx" +import PartialSleepreference from "./preStop/sleep_reference.mdx" + + +
+ + +######## `exec` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +######## `httpGet` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +######## `tcpSocket` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-tcpSocket} + +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. + + + + + + +
+ + + +
+ + +######## `sleep` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop-sleep} + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle_reference.mdx new file mode 100755 index 000000000..19b869e79 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/lifecycle_reference.mdx @@ -0,0 +1,45 @@ + +import PartialPoststartreference from "./lifecycle/postStart_reference.mdx" +import PartialPrestopreference from "./lifecycle/preStop_reference.mdx" + + +
+ + +####### `postStart` required {#controlPlane-distro-k8s-scheduler-lifecycle-postStart} + +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 + + + + + + +
+ + + +
+ + +####### `preStop` required {#controlPlane-distro-k8s-scheduler-lifecycle-preStop} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe.mdx new file mode 100755 index 000000000..5a75eb79c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialLivenessprobereference from "./livenessProbe_reference.mdx" + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-scheduler-livenessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec.mdx new file mode 100755 index 000000000..a2a5094f9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-scheduler-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec/command.mdx new file mode 100755 index 000000000..cb04e2a14 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-scheduler-livenessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/failureThreshold.mdx new file mode 100755 index 000000000..56d26853d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc.mdx new file mode 100755 index 000000000..6779582cd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-scheduler-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc/port.mdx new file mode 100755 index 000000000..5d0ade2c1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc/service.mdx new file mode 100755 index 000000000..d2fe966e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet.mdx new file mode 100755 index 000000000..8369b4f3c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/host.mdx new file mode 100755 index 000000000..0c418ca5f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..e8337bdd5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..69a35c9df --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..34733fefa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/path.mdx new file mode 100755 index 000000000..cd0e96811 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port.mdx new file mode 100755 index 000000000..d0297835d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..c8c7acdcd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..dd21b759e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..dfb7ba6bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..e12a02846 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..61a94af9f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..23445b249 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/periodSeconds.mdx new file mode 100755 index 000000000..b6885dd83 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/successThreshold.mdx new file mode 100755 index 000000000..1fe660326 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket.mdx new file mode 100755 index 000000000..ddb0c18a8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..523e44aab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..eebb58e53 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..b1d9f02b9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..c85db9cc1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..be5b3b720 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..45a14b843 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..1cbc6e426 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..c271863a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-scheduler-livenessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe_reference.mdx new file mode 100755 index 000000000..ad63ea1ab --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/livenessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./livenessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./livenessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./livenessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./livenessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./livenessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./livenessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./livenessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./livenessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./livenessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./livenessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-scheduler-livenessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-scheduler-livenessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-scheduler-livenessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-scheduler-livenessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/name.mdx new file mode 100755 index 000000000..47856e16b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/name.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `name` required string {#controlPlane-distro-k8s-scheduler-name} + +Name of the container specified as a DNS_LABEL. +Each container in a pod must have a unique name (DNS_LABEL). +Cannot be updated. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports.mdx new file mode 100755 index 000000000..0d7cd5d13 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports.mdx @@ -0,0 +1,23 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-scheduler-ports} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/containerPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/containerPort.mdx new file mode 100755 index 000000000..f108059a4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/containerPort.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `containerPort` required integer {#controlPlane-distro-k8s-scheduler-ports-containerPort} + +Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/hostIP.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/hostIP.mdx new file mode 100755 index 000000000..0d683b518 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/hostIP.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `hostIP` required string {#controlPlane-distro-k8s-scheduler-ports-hostIP} + +What host IP to bind the external port to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/hostPort.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/hostPort.mdx new file mode 100755 index 000000000..1f45d39bd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/hostPort.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `hostPort` required integer {#controlPlane-distro-k8s-scheduler-ports-hostPort} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/name.mdx new file mode 100755 index 000000000..27c085c6f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/name.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-scheduler-ports-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/protocol.mdx new file mode 100755 index 000000000..bee8a26b2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `protocol` required string {#controlPlane-distro-k8s-scheduler-ports-protocol} + +Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports_reference.mdx new file mode 100755 index 000000000..d3e30b22c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/ports_reference.mdx @@ -0,0 +1,20 @@ + +import PartialName from "./ports/name.mdx" +import PartialHostport from "./ports/hostPort.mdx" +import PartialContainerport from "./ports/containerPort.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialHostip from "./ports/hostIP.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe.mdx new file mode 100755 index 000000000..0e15a58e8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe.mdx @@ -0,0 +1,20 @@ + +import PartialReadinessprobereference from "./readinessProbe_reference.mdx" + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-scheduler-readinessProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec.mdx new file mode 100755 index 000000000..ce2be8851 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-scheduler-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec/command.mdx new file mode 100755 index 000000000..b4df6b37a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-scheduler-readinessProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/failureThreshold.mdx new file mode 100755 index 000000000..260432173 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc.mdx new file mode 100755 index 000000000..e3c3360c4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-scheduler-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc/port.mdx new file mode 100755 index 000000000..5b00a43e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc/service.mdx new file mode 100755 index 000000000..33eda7090 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet.mdx new file mode 100755 index 000000000..f116b3547 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/host.mdx new file mode 100755 index 000000000..9c4e747a6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..86a3ae51b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..0583ff421 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..c10d1929d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/path.mdx new file mode 100755 index 000000000..dd2ae5242 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port.mdx new file mode 100755 index 000000000..0daa79c07 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..28d9eb4d0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..8a628b90f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..98c1ecf2f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..b5a70c5ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet_reference.mdx new file mode 100755 index 000000000..efa8a83c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..3b5592ac6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/periodSeconds.mdx new file mode 100755 index 000000000..7d62c4c70 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/successThreshold.mdx new file mode 100755 index 000000000..75069d85c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket.mdx new file mode 100755 index 000000000..f366c0b35 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..3d42d3f9e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..a7865bb06 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..54aa8906e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..4748e614f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..2f386cc20 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..7f68c15ae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..4b2ab5de2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..dbc442b9c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-scheduler-readinessProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe_reference.mdx new file mode 100755 index 000000000..4cc1ab482 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/readinessProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./readinessProbe/exec_reference.mdx" +import PartialHttpgetreference from "./readinessProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./readinessProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./readinessProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./readinessProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./readinessProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./readinessProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./readinessProbe/successThreshold.mdx" +import PartialFailurethreshold from "./readinessProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./readinessProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-scheduler-readinessProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-scheduler-readinessProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-scheduler-readinessProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-scheduler-readinessProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy.mdx new file mode 100755 index 000000000..328f5adf6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy.mdx @@ -0,0 +1,17 @@ + +import PartialResizepolicyreference from "./resizePolicy_reference.mdx" + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-scheduler-resizePolicy} + +Resources resize policy for the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy/resourceName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy/resourceName.mdx new file mode 100755 index 000000000..5cb23587e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy/resourceName.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `resourceName` required string {#controlPlane-distro-k8s-scheduler-resizePolicy-resourceName} + +Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy/restartPolicy.mdx new file mode 100755 index 000000000..d00a04326 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy/restartPolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `restartPolicy` required string {#controlPlane-distro-k8s-scheduler-resizePolicy-restartPolicy} + +Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy_reference.mdx new file mode 100755 index 000000000..64b6ffdf8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resizePolicy_reference.mdx @@ -0,0 +1,8 @@ + +import PartialResourcename from "./resizePolicy/resourceName.mdx" +import PartialRestartpolicy from "./resizePolicy/restartPolicy.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources.mdx new file mode 100755 index 000000000..77fda0a31 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources.mdx @@ -0,0 +1,19 @@ + +import PartialResourcesreference from "./resources_reference.mdx" + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-scheduler-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims.mdx new file mode 100755 index 000000000..315eefe0d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims.mdx @@ -0,0 +1,24 @@ + +import PartialClaimsreference from "./claims_reference.mdx" + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-scheduler-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims/name.mdx new file mode 100755 index 000000000..50da92d96 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims/name.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `name` required string {#controlPlane-distro-k8s-scheduler-resources-claims-name} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims_reference.mdx new file mode 100755 index 000000000..8701882e4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/claims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialName from "./claims/name.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/limits.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/limits.mdx new file mode 100755 index 000000000..9f91492e3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/limits.mdx @@ -0,0 +1,18 @@ + +import PartialLimitsreference from "./limits_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-scheduler-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/limits_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/limits_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/requests.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/requests.mdx new file mode 100755 index 000000000..8744a2271 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/requests.mdx @@ -0,0 +1,20 @@ + +import PartialRequestsreference from "./requests_reference.mdx" + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-scheduler-resources-requests} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/requests_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources/requests_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources_reference.mdx new file mode 100755 index 000000000..1303fb4c2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/resources_reference.mdx @@ -0,0 +1,62 @@ + +import PartialLimitsreference from "./resources/limits_reference.mdx" +import PartialRequestsreference from "./resources/requests_reference.mdx" +import PartialClaimsreference from "./resources/claims_reference.mdx" + + +
+ + +####### `limits` required {#controlPlane-distro-k8s-scheduler-resources-limits} + +Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +####### `requests` required {#controlPlane-distro-k8s-scheduler-resources-requests} + +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/ + + + + + + +
+ + + +
+ + +####### `claims` required object[] {#controlPlane-distro-k8s-scheduler-resources-claims} + +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. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/restartPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/restartPolicy.mdx new file mode 100755 index 000000000..1e808b528 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/restartPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `restartPolicy` required string {#controlPlane-distro-k8s-scheduler-restartPolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext.mdx new file mode 100755 index 000000000..fc03cbb12 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext.mdx @@ -0,0 +1,19 @@ + +import PartialSecuritycontextreference from "./securityContext_reference.mdx" + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-scheduler-securityContext} + +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/ + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/allowPrivilegeEscalation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/allowPrivilegeEscalation.mdx new file mode 100755 index 000000000..248a3e689 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/allowPrivilegeEscalation.mdx @@ -0,0 +1,19 @@ + +
+ + +####### `allowPrivilegeEscalation` required boolean false {#controlPlane-distro-k8s-scheduler-securityContext-allowPrivilegeEscalation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities.mdx new file mode 100755 index 000000000..326e17c81 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities.mdx @@ -0,0 +1,19 @@ + +import PartialCapabilitiesreference from "./capabilities_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-scheduler-securityContext-capabilities} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities/add.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities/add.mdx new file mode 100755 index 000000000..6ea36b67a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities/add.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `add` required string[] {#controlPlane-distro-k8s-scheduler-securityContext-capabilities-add} + +Added capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities/drop.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities/drop.mdx new file mode 100755 index 000000000..41f282fc3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities/drop.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `drop` required string[] {#controlPlane-distro-k8s-scheduler-securityContext-capabilities-drop} + +Removed capabilities + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities_reference.mdx new file mode 100755 index 000000000..b33950e30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/capabilities_reference.mdx @@ -0,0 +1,8 @@ + +import PartialAdd from "./capabilities/add.mdx" +import PartialDrop from "./capabilities/drop.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/privileged.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/privileged.mdx new file mode 100755 index 000000000..8ae85788a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/privileged.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `privileged` required boolean false {#controlPlane-distro-k8s-scheduler-securityContext-privileged} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/procMount.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/procMount.mdx new file mode 100755 index 000000000..c9e1c526c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/procMount.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `procMount` required string {#controlPlane-distro-k8s-scheduler-securityContext-procMount} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/readOnlyRootFilesystem.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/readOnlyRootFilesystem.mdx new file mode 100755 index 000000000..771540947 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/readOnlyRootFilesystem.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `readOnlyRootFilesystem` required boolean false {#controlPlane-distro-k8s-scheduler-securityContext-readOnlyRootFilesystem} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsGroup.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsGroup.mdx new file mode 100755 index 000000000..804a17964 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsGroup.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsGroup` required integer {#controlPlane-distro-k8s-scheduler-securityContext-runAsGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsNonRoot.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsNonRoot.mdx new file mode 100755 index 000000000..f8458c7ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsNonRoot.mdx @@ -0,0 +1,18 @@ + +
+ + +####### `runAsNonRoot` required boolean false {#controlPlane-distro-k8s-scheduler-securityContext-runAsNonRoot} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsUser.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsUser.mdx new file mode 100755 index 000000000..a091c547f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/runAsUser.mdx @@ -0,0 +1,17 @@ + +
+ + +####### `runAsUser` required integer {#controlPlane-distro-k8s-scheduler-securityContext-runAsUser} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions.mdx new file mode 100755 index 000000000..8a7873911 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions.mdx @@ -0,0 +1,21 @@ + +import PartialSelinuxoptionsreference from "./seLinuxOptions_reference.mdx" + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-scheduler-securityContext-seLinuxOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/level.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/level.mdx new file mode 100755 index 000000000..81cc51922 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/level.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `level` required string {#controlPlane-distro-k8s-scheduler-securityContext-seLinuxOptions-level} + +Level is SELinux level label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/role.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/role.mdx new file mode 100755 index 000000000..0c672f0c0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/role.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `role` required string {#controlPlane-distro-k8s-scheduler-securityContext-seLinuxOptions-role} + +Role is a SELinux role label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/type.mdx new file mode 100755 index 000000000..cf48fc286 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/type.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-scheduler-securityContext-seLinuxOptions-type} + +Type is a SELinux type label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/user.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/user.mdx new file mode 100755 index 000000000..130f5250c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions/user.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `user` required string {#controlPlane-distro-k8s-scheduler-securityContext-seLinuxOptions-user} + +User is a SELinux user label that applies to the container. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions_reference.mdx new file mode 100755 index 000000000..61ec5c562 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seLinuxOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialUser from "./seLinuxOptions/user.mdx" +import PartialRole from "./seLinuxOptions/role.mdx" +import PartialType from "./seLinuxOptions/type.mdx" +import PartialLevel from "./seLinuxOptions/level.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile.mdx new file mode 100755 index 000000000..bc527bf9b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile.mdx @@ -0,0 +1,20 @@ + +import PartialSeccompprofilereference from "./seccompProfile_reference.mdx" + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-scheduler-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile/localhostProfile.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile/localhostProfile.mdx new file mode 100755 index 000000000..43ad57720 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile/localhostProfile.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `localhostProfile` required string {#controlPlane-distro-k8s-scheduler-securityContext-seccompProfile-localhostProfile} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile/type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile/type.mdx new file mode 100755 index 000000000..29314ce24 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile/type.mdx @@ -0,0 +1,18 @@ + +
+ + +######## `type` required string {#controlPlane-distro-k8s-scheduler-securityContext-seccompProfile-type} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile_reference.mdx new file mode 100755 index 000000000..5721a9c30 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/seccompProfile_reference.mdx @@ -0,0 +1,8 @@ + +import PartialType from "./seccompProfile/type.mdx" +import PartialLocalhostprofile from "./seccompProfile/localhostProfile.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions.mdx new file mode 100755 index 000000000..2b956fdbe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions.mdx @@ -0,0 +1,20 @@ + +import PartialWindowsoptionsreference from "./windowsOptions_reference.mdx" + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-scheduler-securityContext-windowsOptions} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/gmsaCredentialSpec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/gmsaCredentialSpec.mdx new file mode 100755 index 000000000..ddae1ef16 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/gmsaCredentialSpec.mdx @@ -0,0 +1,15 @@ + +
+ + +######## `gmsaCredentialSpec` required string {#controlPlane-distro-k8s-scheduler-securityContext-windowsOptions-gmsaCredentialSpec} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/gmsaCredentialSpecName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/gmsaCredentialSpecName.mdx new file mode 100755 index 000000000..25c90a98c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/gmsaCredentialSpecName.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `gmsaCredentialSpecName` required string {#controlPlane-distro-k8s-scheduler-securityContext-windowsOptions-gmsaCredentialSpecName} + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/hostProcess.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/hostProcess.mdx new file mode 100755 index 000000000..1b5a4fa1d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/hostProcess.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `hostProcess` required boolean false {#controlPlane-distro-k8s-scheduler-securityContext-windowsOptions-hostProcess} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/runAsUserName.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/runAsUserName.mdx new file mode 100755 index 000000000..7ffba9164 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions/runAsUserName.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `runAsUserName` required string {#controlPlane-distro-k8s-scheduler-securityContext-windowsOptions-runAsUserName} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions_reference.mdx new file mode 100755 index 000000000..cdb0254eb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext/windowsOptions_reference.mdx @@ -0,0 +1,16 @@ + +import PartialGmsacredentialspecname from "./windowsOptions/gmsaCredentialSpecName.mdx" +import PartialGmsacredentialspec from "./windowsOptions/gmsaCredentialSpec.mdx" +import PartialRunasusername from "./windowsOptions/runAsUserName.mdx" +import PartialHostprocess from "./windowsOptions/hostProcess.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext_reference.mdx new file mode 100755 index 000000000..aa9d9d2ed --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/securityContext_reference.mdx @@ -0,0 +1,108 @@ + +import PartialCapabilitiesreference from "./securityContext/capabilities_reference.mdx" +import PartialPrivileged from "./securityContext/privileged.mdx" +import PartialSelinuxoptionsreference from "./securityContext/seLinuxOptions_reference.mdx" +import PartialWindowsoptionsreference from "./securityContext/windowsOptions_reference.mdx" +import PartialRunasuser from "./securityContext/runAsUser.mdx" +import PartialRunasgroup from "./securityContext/runAsGroup.mdx" +import PartialRunasnonroot from "./securityContext/runAsNonRoot.mdx" +import PartialReadonlyrootfilesystem from "./securityContext/readOnlyRootFilesystem.mdx" +import PartialAllowprivilegeescalation from "./securityContext/allowPrivilegeEscalation.mdx" +import PartialProcmount from "./securityContext/procMount.mdx" +import PartialSeccompprofilereference from "./securityContext/seccompProfile_reference.mdx" + + +
+ + +####### `capabilities` required {#controlPlane-distro-k8s-scheduler-securityContext-capabilities} + +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. + + + + + + +
+ + + + + + +
+ + +####### `seLinuxOptions` required {#controlPlane-distro-k8s-scheduler-securityContext-seLinuxOptions} + +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. + + + + + + +
+ + + +
+ + +####### `windowsOptions` required {#controlPlane-distro-k8s-scheduler-securityContext-windowsOptions} + +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. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + +####### `seccompProfile` required {#controlPlane-distro-k8s-scheduler-securityContext-seccompProfile} + +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. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe.mdx new file mode 100755 index 000000000..2ed6128a2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe.mdx @@ -0,0 +1,23 @@ + +import PartialStartupprobereference from "./startupProbe_reference.mdx" + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-scheduler-startupProbe} + +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 + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec.mdx new file mode 100755 index 000000000..2184f41c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec.mdx @@ -0,0 +1,17 @@ + +import PartialExecreference from "./exec_reference.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-scheduler-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec/command.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec/command.mdx new file mode 100755 index 000000000..a5c3a529e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec/command.mdx @@ -0,0 +1,17 @@ + +
+ + +######## `command` required string[] {#controlPlane-distro-k8s-scheduler-startupProbe-exec-command} + +Command is the command line to execute inside the container, the working directory for the +command is root ('/') in the container's filesystem. The command is simply exec'd, it is +not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use +a shell, you need to explicitly call out to that shell. +Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec_reference.mdx new file mode 100755 index 000000000..863c2a316 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/exec_reference.mdx @@ -0,0 +1,4 @@ + +import PartialCommand from "./exec/command.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/failureThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/failureThreshold.mdx new file mode 100755 index 000000000..cba5fb862 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/failureThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `failureThreshold` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-failureThreshold} + +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc.mdx new file mode 100755 index 000000000..834ba8541 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc.mdx @@ -0,0 +1,17 @@ + +import PartialGrpcreference from "./grpc_reference.mdx" + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-scheduler-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc/port.mdx new file mode 100755 index 000000000..ecc5aa718 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc/port.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `port` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-grpc-port} + +Port number of the gRPC service. Number must be in the range 1 to 65535. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc/service.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc/service.mdx new file mode 100755 index 000000000..97f15dbae --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc/service.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `service` required string {#controlPlane-distro-k8s-scheduler-startupProbe-grpc-service} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc_reference.mdx new file mode 100755 index 000000000..b456f45c3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/grpc_reference.mdx @@ -0,0 +1,8 @@ + +import PartialPort from "./grpc/port.mdx" +import PartialService from "./grpc/service.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet.mdx new file mode 100755 index 000000000..ac1a11ba6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet.mdx @@ -0,0 +1,17 @@ + +import PartialHttpgetreference from "./httpGet_reference.mdx" + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/host.mdx new file mode 100755 index 000000000..ee574b3dc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/host.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-host} + +Host name to connect to, defaults to the pod IP. You probably want to set +"Host" in httpHeaders instead. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders.mdx new file mode 100755 index 000000000..6be61573d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders.mdx @@ -0,0 +1,17 @@ + +import PartialHttpheadersreference from "./httpHeaders_reference.mdx" + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders/name.mdx new file mode 100755 index 000000000..a31a78dfc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######### `name` required string {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-httpHeaders-name} + +The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders/value.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders/value.mdx new file mode 100755 index 000000000..e98c14360 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders/value.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `value` required string {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-httpHeaders-value} + +The header field value + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders_reference.mdx new file mode 100755 index 000000000..1ef32c4c7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/httpHeaders_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./httpHeaders/name.mdx" +import PartialValue from "./httpHeaders/value.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/path.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/path.mdx new file mode 100755 index 000000000..27a26625e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-path} + +Path to access on the HTTP server. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port.mdx new file mode 100755 index 000000000..fdd68adb3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/IntVal.mdx new file mode 100755 index 000000000..49d4e5a2f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/StrVal.mdx new file mode 100755 index 000000000..711271cb8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/Type.mdx new file mode 100755 index 000000000..503b5befe --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/scheme.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/scheme.mdx new file mode 100755 index 000000000..6f3b3204d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet/scheme.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `scheme` required string {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-scheme} + +Scheme to use for connecting to the host. +Defaults to HTTP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet_reference.mdx new file mode 100755 index 000000000..6a611730a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/httpGet_reference.mdx @@ -0,0 +1,48 @@ + +import PartialPath from "./httpGet/path.mdx" +import PartialPortreference from "./httpGet/port_reference.mdx" +import PartialHost from "./httpGet/host.mdx" +import PartialScheme from "./httpGet/scheme.mdx" +import PartialHttpheadersreference from "./httpGet/httpHeaders_reference.mdx" + + + + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-port} + +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + + + + + + + +
+ + +######## `httpHeaders` required object[] {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet-httpHeaders} + +Custom headers to set in the request. HTTP allows repeated headers. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/initialDelaySeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/initialDelaySeconds.mdx new file mode 100755 index 000000000..b5113dace --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/initialDelaySeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `initialDelaySeconds` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-initialDelaySeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/periodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/periodSeconds.mdx new file mode 100755 index 000000000..da90c5d44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/periodSeconds.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `periodSeconds` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-periodSeconds} + +How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/successThreshold.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/successThreshold.mdx new file mode 100755 index 000000000..9c72f6249 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/successThreshold.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `successThreshold` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-successThreshold} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket.mdx new file mode 100755 index 000000000..325759713 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket.mdx @@ -0,0 +1,17 @@ + +import PartialTcpsocketreference from "./tcpSocket_reference.mdx" + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/host.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/host.mdx new file mode 100755 index 000000000..0d254e436 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/host.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `host` required string {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket-host} + +Optional: Host name to connect to, defaults to the pod IP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port.mdx new file mode 100755 index 000000000..967b199a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port.mdx @@ -0,0 +1,19 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/IntVal.mdx new file mode 100755 index 000000000..3f98907a5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `IntVal` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket-port-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/StrVal.mdx new file mode 100755 index 000000000..68b4e2b21 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `StrVal` required string {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket-port-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/Type.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/Type.mdx new file mode 100755 index 000000000..ff471698c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +######### `Type` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket-port-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port_reference.mdx new file mode 100755 index 000000000..2d84e4fc5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket/port_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./port/Type.mdx" +import PartialIntval from "./port/IntVal.mdx" +import PartialStrval from "./port/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket_reference.mdx new file mode 100755 index 000000000..b365f8c1a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/tcpSocket_reference.mdx @@ -0,0 +1,23 @@ + +import PartialPortreference from "./tcpSocket/port_reference.mdx" +import PartialHost from "./tcpSocket/host.mdx" + + +
+ + +######## `port` required {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket-port} + +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/terminationGracePeriodSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/terminationGracePeriodSeconds.mdx new file mode 100755 index 000000000..211e2c86f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/terminationGracePeriodSeconds.mdx @@ -0,0 +1,22 @@ + +
+ + +####### `terminationGracePeriodSeconds` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-terminationGracePeriodSeconds} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/timeoutSeconds.mdx new file mode 100755 index 000000000..56b314961 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-distro-k8s-scheduler-startupProbe-timeoutSeconds} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe_reference.mdx new file mode 100755 index 000000000..cb08d79e6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/startupProbe_reference.mdx @@ -0,0 +1,92 @@ + +import PartialExecreference from "./startupProbe/exec_reference.mdx" +import PartialHttpgetreference from "./startupProbe/httpGet_reference.mdx" +import PartialTcpsocketreference from "./startupProbe/tcpSocket_reference.mdx" +import PartialGrpcreference from "./startupProbe/grpc_reference.mdx" +import PartialInitialdelayseconds from "./startupProbe/initialDelaySeconds.mdx" +import PartialTimeoutseconds from "./startupProbe/timeoutSeconds.mdx" +import PartialPeriodseconds from "./startupProbe/periodSeconds.mdx" +import PartialSuccessthreshold from "./startupProbe/successThreshold.mdx" +import PartialFailurethreshold from "./startupProbe/failureThreshold.mdx" +import PartialTerminationgraceperiodseconds from "./startupProbe/terminationGracePeriodSeconds.mdx" + + +
+ + +####### `exec` required {#controlPlane-distro-k8s-scheduler-startupProbe-exec} + +Exec specifies the action to take. + + + + + + +
+ + + +
+ + +####### `httpGet` required {#controlPlane-distro-k8s-scheduler-startupProbe-httpGet} + +HTTPGet specifies the http request to perform. + + + + + + +
+ + + +
+ + +####### `tcpSocket` required {#controlPlane-distro-k8s-scheduler-startupProbe-tcpSocket} + +TCPSocket specifies an action involving a TCP port. + + + + + + +
+ + + +
+ + +####### `grpc` required {#controlPlane-distro-k8s-scheduler-startupProbe-grpc} + +GRPC specifies an action involving a GRPC port. + + + + + + +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/stdin.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/stdin.mdx new file mode 100755 index 000000000..55cb2f742 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/stdin.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `stdin` required boolean false {#controlPlane-distro-k8s-scheduler-stdin} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/stdinOnce.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/stdinOnce.mdx new file mode 100755 index 000000000..9d2f97321 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/stdinOnce.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `stdinOnce` required boolean false {#controlPlane-distro-k8s-scheduler-stdinOnce} + +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 + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/terminationMessagePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/terminationMessagePath.mdx new file mode 100755 index 000000000..81034478a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/terminationMessagePath.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePath` required string {#controlPlane-distro-k8s-scheduler-terminationMessagePath} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/terminationMessagePolicy.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/terminationMessagePolicy.mdx new file mode 100755 index 000000000..b96398bba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/terminationMessagePolicy.mdx @@ -0,0 +1,19 @@ + +
+ + +###### `terminationMessagePolicy` required string {#controlPlane-distro-k8s-scheduler-terminationMessagePolicy} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/tty.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/tty.mdx new file mode 100755 index 000000000..4c2b9aebd --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/tty.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `tty` required boolean false {#controlPlane-distro-k8s-scheduler-tty} + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. +Default is false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices.mdx new file mode 100755 index 000000000..6d319240e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices.mdx @@ -0,0 +1,17 @@ + +import PartialVolumedevicesreference from "./volumeDevices_reference.mdx" + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-scheduler-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices/devicePath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices/devicePath.mdx new file mode 100755 index 000000000..e03ccdabc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices/devicePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `devicePath` required string {#controlPlane-distro-k8s-scheduler-volumeDevices-devicePath} + +devicePath is the path inside of the container that the device will be mapped to. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices/name.mdx new file mode 100755 index 000000000..9da5e92ba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-scheduler-volumeDevices-name} + +name must match the name of a persistentVolumeClaim in the pod + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices_reference.mdx new file mode 100755 index 000000000..b7f91fe54 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeDevices_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./volumeDevices/name.mdx" +import PartialDevicepath from "./volumeDevices/devicePath.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts.mdx new file mode 100755 index 000000000..09a4d0e4f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts.mdx @@ -0,0 +1,18 @@ + +import PartialVolumemountsreference from "./volumeMounts_reference.mdx" + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-scheduler-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/mountPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/mountPath.mdx new file mode 100755 index 000000000..53a6fc913 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/mountPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `mountPath` required string {#controlPlane-distro-k8s-scheduler-volumeMounts-mountPath} + +Path within the container at which the volume should be mounted. Must +not contain ':'. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/mountPropagation.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/mountPropagation.mdx new file mode 100755 index 000000000..73339b33f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/mountPropagation.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `mountPropagation` required string {#controlPlane-distro-k8s-scheduler-volumeMounts-mountPropagation} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/name.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/name.mdx new file mode 100755 index 000000000..15ca8d487 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-distro-k8s-scheduler-volumeMounts-name} + +This must match the Name of a Volume. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/readOnly.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/readOnly.mdx new file mode 100755 index 000000000..e0c5ae2e3 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/readOnly.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `readOnly` required boolean false {#controlPlane-distro-k8s-scheduler-volumeMounts-readOnly} + +Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/subPath.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/subPath.mdx new file mode 100755 index 000000000..a68f7f03e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/subPath.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `subPath` required string {#controlPlane-distro-k8s-scheduler-volumeMounts-subPath} + +Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/subPathExpr.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/subPathExpr.mdx new file mode 100755 index 000000000..e63be9491 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts/subPathExpr.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `subPathExpr` required string {#controlPlane-distro-k8s-scheduler-volumeMounts-subPathExpr} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts_reference.mdx new file mode 100755 index 000000000..52ceca29c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/volumeMounts_reference.mdx @@ -0,0 +1,24 @@ + +import PartialName from "./volumeMounts/name.mdx" +import PartialReadonly from "./volumeMounts/readOnly.mdx" +import PartialMountpath from "./volumeMounts/mountPath.mdx" +import PartialSubpath from "./volumeMounts/subPath.mdx" +import PartialMountpropagation from "./volumeMounts/mountPropagation.mdx" +import PartialSubpathexpr from "./volumeMounts/subPathExpr.mdx" + + + + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/workingDir.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/workingDir.mdx new file mode 100755 index 000000000..e6ac6b758 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler/workingDir.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `workingDir` required string {#controlPlane-distro-k8s-scheduler-workingDir} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler_reference.mdx new file mode 100755 index 000000000..5286e5fba --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s/scheduler_reference.mdx @@ -0,0 +1,282 @@ + +import PartialName from "./scheduler/name.mdx" +import PartialImage from "./scheduler/image.mdx" +import PartialCommand from "./scheduler/command.mdx" +import PartialArgs from "./scheduler/args.mdx" +import PartialWorkingdir from "./scheduler/workingDir.mdx" +import PartialPortsreference from "./scheduler/ports_reference.mdx" +import PartialEnvfromreference from "./scheduler/envFrom_reference.mdx" +import PartialEnvreference from "./scheduler/env_reference.mdx" +import PartialResourcesreference from "./scheduler/resources_reference.mdx" +import PartialResizepolicyreference from "./scheduler/resizePolicy_reference.mdx" +import PartialRestartpolicy from "./scheduler/restartPolicy.mdx" +import PartialVolumemountsreference from "./scheduler/volumeMounts_reference.mdx" +import PartialVolumedevicesreference from "./scheduler/volumeDevices_reference.mdx" +import PartialLivenessprobereference from "./scheduler/livenessProbe_reference.mdx" +import PartialReadinessprobereference from "./scheduler/readinessProbe_reference.mdx" +import PartialStartupprobereference from "./scheduler/startupProbe_reference.mdx" +import PartialLifecyclereference from "./scheduler/lifecycle_reference.mdx" +import PartialTerminationmessagepath from "./scheduler/terminationMessagePath.mdx" +import PartialTerminationmessagepolicy from "./scheduler/terminationMessagePolicy.mdx" +import PartialImagepullpolicy from "./scheduler/imagePullPolicy.mdx" +import PartialSecuritycontextreference from "./scheduler/securityContext_reference.mdx" +import PartialStdin from "./scheduler/stdin.mdx" +import PartialStdinonce from "./scheduler/stdinOnce.mdx" +import PartialTty from "./scheduler/tty.mdx" + + + + + + + + + + + + + + + + + +
+ + +###### `ports` required object[] {#controlPlane-distro-k8s-scheduler-ports} + +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. + + + + + + +
+ + + +
+ + +###### `envFrom` required object[] {#controlPlane-distro-k8s-scheduler-envFrom} + +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. + + + + + + +
+ + + +
+ + +###### `env` required object[] {#controlPlane-distro-k8s-scheduler-env} + +List of environment variables to set in the container. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `resources` required {#controlPlane-distro-k8s-scheduler-resources} + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + +
+ + + +
+ + +###### `resizePolicy` required object[] {#controlPlane-distro-k8s-scheduler-resizePolicy} + +Resources resize policy for the container. + + + + + + +
+ + + + + + +
+ + +###### `volumeMounts` required object[] {#controlPlane-distro-k8s-scheduler-volumeMounts} + +Pod volumes to mount into the container's filesystem. +Cannot be updated. + + + + + + +
+ + + +
+ + +###### `volumeDevices` required object[] {#controlPlane-distro-k8s-scheduler-volumeDevices} + +volumeDevices is the list of block devices to be used by the container. + + + + + + +
+ + + +
+ + +###### `livenessProbe` required {#controlPlane-distro-k8s-scheduler-livenessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `readinessProbe` required {#controlPlane-distro-k8s-scheduler-readinessProbe} + +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 + + + + + + +
+ + + +
+ + +###### `startupProbe` required {#controlPlane-distro-k8s-scheduler-startupProbe} + +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 + + + + + + +
+ + + +
+ + +###### `lifecycle` required {#controlPlane-distro-k8s-scheduler-lifecycle} + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + +
+ + + + + + + + + + + + +
+ + +###### `securityContext` required {#controlPlane-distro-k8s-scheduler-securityContext} + +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/ + + + + + + +
+ + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/distro/k8s_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro/k8s_reference.mdx new file mode 100755 index 000000000..54d08a31c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro/k8s_reference.mdx @@ -0,0 +1,68 @@ + +import PartialApiserverreference from "./k8s/apiServer_reference.mdx" +import PartialControllermanagerreference from "./k8s/controllerManager_reference.mdx" +import PartialSchedulerreference from "./k8s/scheduler_reference.mdx" +import PartialEtcdreference from "./k8s/etcd_reference.mdx" + + +
+ + +##### `apiServer` required {#controlPlane-distro-k8s-apiServer} + + + + + + + + +
+ + + +
+ + +##### `controllerManager` required {#controlPlane-distro-k8s-controllerManager} + + + + + + + + +
+ + + +
+ + +##### `scheduler` required {#controlPlane-distro-k8s-scheduler} + + + + + + + + +
+ + + +
+ + +##### `etcd` required {#controlPlane-distro-k8s-etcd} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/distro_reference.mdx b/docs/pages/configuration/_partials/controlPlane/distro_reference.mdx new file mode 100755 index 000000000..9b3bfe9a0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/distro_reference.mdx @@ -0,0 +1,68 @@ + +import PartialK3sreference from "./distro/k3s_reference.mdx" +import PartialK8sreference from "./distro/k8s_reference.mdx" +import PartialK0sreference from "./distro/k0s_reference.mdx" +import PartialAdvancedreference from "./distro/advanced_reference.mdx" + + +
+ + +#### `k3s` required {#controlPlane-distro-k3s} + + + + + + + + +
+ + + +
+ + +#### `k8s` required {#controlPlane-distro-k8s} + + + + + + + + +
+ + + +
+ + +#### `k0s` required {#controlPlane-distro-k0s} + + + + + + + + +
+ + + +
+ + +#### `advanced` required {#controlPlane-distro-advanced} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/highAvailability.mdx b/docs/pages/configuration/_partials/controlPlane/highAvailability.mdx new file mode 100755 index 000000000..061080b3f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/highAvailability.mdx @@ -0,0 +1,17 @@ + +import PartialHighavailabilityreference from "./highAvailability_reference.mdx" + + +
+ + +### `highAvailability` required {#controlPlane-highAvailability} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/highAvailability/leaseDuration.mdx b/docs/pages/configuration/_partials/controlPlane/highAvailability/leaseDuration.mdx new file mode 100755 index 000000000..8a46ada44 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/highAvailability/leaseDuration.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `leaseDuration` required integer {#controlPlane-highAvailability-leaseDuration} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/highAvailability/renewDeadline.mdx b/docs/pages/configuration/_partials/controlPlane/highAvailability/renewDeadline.mdx new file mode 100755 index 000000000..c1ec296aa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/highAvailability/renewDeadline.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `renewDeadline` required integer {#controlPlane-highAvailability-renewDeadline} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/highAvailability/replicas.mdx b/docs/pages/configuration/_partials/controlPlane/highAvailability/replicas.mdx new file mode 100755 index 000000000..248a6f135 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/highAvailability/replicas.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `replicas` required integer {#controlPlane-highAvailability-replicas} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/highAvailability/retryPeriod.mdx b/docs/pages/configuration/_partials/controlPlane/highAvailability/retryPeriod.mdx new file mode 100755 index 000000000..aed81ad8a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/highAvailability/retryPeriod.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `retryPeriod` required integer {#controlPlane-highAvailability-retryPeriod} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/highAvailability_reference.mdx b/docs/pages/configuration/_partials/controlPlane/highAvailability_reference.mdx new file mode 100755 index 000000000..e4c52056f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/highAvailability_reference.mdx @@ -0,0 +1,16 @@ + +import PartialReplicas from "./highAvailability/replicas.mdx" +import PartialLeaseduration from "./highAvailability/leaseDuration.mdx" +import PartialRenewdeadline from "./highAvailability/renewDeadline.mdx" +import PartialRetryperiod from "./highAvailability/retryPeriod.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/hostPathMapper.mdx b/docs/pages/configuration/_partials/controlPlane/hostPathMapper.mdx new file mode 100755 index 000000000..9637fecc8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/hostPathMapper.mdx @@ -0,0 +1,17 @@ + +import PartialHostpathmapperreference from "./hostPathMapper_reference.mdx" + + +
+ + +### `hostPathMapper` required {#controlPlane-hostPathMapper} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/hostPathMapper/central.mdx b/docs/pages/configuration/_partials/controlPlane/hostPathMapper/central.mdx new file mode 100755 index 000000000..c4ca0ab11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/hostPathMapper/central.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `central` required boolean false {#controlPlane-hostPathMapper-central} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/hostPathMapper/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/hostPathMapper/enabled.mdx new file mode 100755 index 000000000..43207fdb7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/hostPathMapper/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#controlPlane-hostPathMapper-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/hostPathMapper_reference.mdx b/docs/pages/configuration/_partials/controlPlane/hostPathMapper_reference.mdx new file mode 100755 index 000000000..8eca3a863 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/hostPathMapper_reference.mdx @@ -0,0 +1,8 @@ + +import PartialEnabled from "./hostPathMapper/enabled.mdx" +import PartialCentral from "./hostPathMapper/central.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/ingress.mdx b/docs/pages/configuration/_partials/controlPlane/ingress.mdx new file mode 100755 index 000000000..d3dd7f06f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress.mdx @@ -0,0 +1,17 @@ + +import PartialIngressreference from "./ingress_reference.mdx" + + +
+ + +### `ingress` required {#controlPlane-ingress} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/annotations.mdx new file mode 100755 index 000000000..bde8d5d67 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `annotations` required object {#controlPlane-ingress-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/enabled.mdx new file mode 100755 index 000000000..109bf7e95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#controlPlane-ingress-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/labels.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/labels.mdx new file mode 100755 index 000000000..cfe5a06bc --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `labels` required object {#controlPlane-ingress-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/name.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/name.mdx new file mode 100755 index 000000000..28bdc2624 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/name.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `name` required string {#controlPlane-ingress-name} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec.mdx new file mode 100755 index 000000000..13d49763f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec.mdx @@ -0,0 +1,17 @@ + +import PartialSpecreference from "./spec_reference.mdx" + + +
+ + +#### `spec` required {#controlPlane-ingress-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend.mdx new file mode 100755 index 000000000..8c0dbd9ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend.mdx @@ -0,0 +1,20 @@ + +import PartialDefaultbackendreference from "./defaultBackend_reference.mdx" + + +
+ + +##### `defaultBackend` required {#controlPlane-ingress-spec-defaultBackend} + +defaultBackend is the backend that should handle requests that don't +match any rule. If Rules are not specified, DefaultBackend must be specified. +If DefaultBackend is not set, the handling of requests that do not match any +of the rules will be up to the Ingress controller. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource.mdx new file mode 100755 index 000000000..502672a3b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource.mdx @@ -0,0 +1,20 @@ + +import PartialResourcereference from "./resource_reference.mdx" + + +
+ + +###### `resource` required {#controlPlane-ingress-spec-defaultBackend-resource} + +resource is an ObjectRef to another Kubernetes resource in the namespace +of the Ingress object. If resource is specified, a service.Name and +service.Port must not be specified. +This is a mutually exclusive setting with "Service". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/apiGroup.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/apiGroup.mdx new file mode 100755 index 000000000..c1ed03413 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/apiGroup.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `apiGroup` required string {#controlPlane-ingress-spec-defaultBackend-resource-apiGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/kind.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/kind.mdx new file mode 100755 index 000000000..f35933d2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `kind` required string {#controlPlane-ingress-spec-defaultBackend-resource-kind} + +Kind is the type of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/name.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/name.mdx new file mode 100755 index 000000000..a97ef982e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource/name.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `name` required string {#controlPlane-ingress-spec-defaultBackend-resource-name} + +Name is the name of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource_reference.mdx new file mode 100755 index 000000000..cd5b30231 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/resource_reference.mdx @@ -0,0 +1,12 @@ + +import PartialApigroup from "./resource/apiGroup.mdx" +import PartialKind from "./resource/kind.mdx" +import PartialName from "./resource/name.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service.mdx new file mode 100755 index 000000000..00996d1aa --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service.mdx @@ -0,0 +1,18 @@ + +import PartialServicereference from "./service_reference.mdx" + + +
+ + +###### `service` required {#controlPlane-ingress-spec-defaultBackend-service} + +service references a service as a backend. +This is a mutually exclusive setting with "Resource". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/name.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/name.mdx new file mode 100755 index 000000000..b206547fb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/name.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `name` required string {#controlPlane-ingress-spec-defaultBackend-service-name} + +name is the referenced service. The service must exist in +the same namespace as the Ingress object. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port.mdx new file mode 100755 index 000000000..e99bf8cc8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port.mdx @@ -0,0 +1,18 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +####### `port` required {#controlPlane-ingress-spec-defaultBackend-service-port} + +port of the referenced service. A port name or port number +is required for a IngressServiceBackend. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port/name.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port/name.mdx new file mode 100755 index 000000000..10dedae35 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port/name.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `name` required string {#controlPlane-ingress-spec-defaultBackend-service-port-name} + +name is the name of the port on the Service. +This is a mutually exclusive setting with "Number". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port/number.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port/number.mdx new file mode 100755 index 000000000..b27b0942c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port/number.mdx @@ -0,0 +1,14 @@ + +
+ + +######## `number` required integer {#controlPlane-ingress-spec-defaultBackend-service-port-number} + +number is the numerical port number (e.g. 80) on the Service. +This is a mutually exclusive setting with "Name". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port_reference.mdx new file mode 100755 index 000000000..89f2923b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service/port_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./port/name.mdx" +import PartialNumber from "./port/number.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service_reference.mdx new file mode 100755 index 000000000..355f757ff --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend/service_reference.mdx @@ -0,0 +1,22 @@ + +import PartialName from "./service/name.mdx" +import PartialPortreference from "./service/port_reference.mdx" + + + + + +
+ + +####### `port` required {#controlPlane-ingress-spec-defaultBackend-service-port} + +port of the referenced service. A port name or port number +is required for a IngressServiceBackend. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend_reference.mdx new file mode 100755 index 000000000..c3724992d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/defaultBackend_reference.mdx @@ -0,0 +1,38 @@ + +import PartialServicereference from "./defaultBackend/service_reference.mdx" +import PartialResourcereference from "./defaultBackend/resource_reference.mdx" + + +
+ + +###### `service` required {#controlPlane-ingress-spec-defaultBackend-service} + +service references a service as a backend. +This is a mutually exclusive setting with "Resource". + + + + + + +
+ + + +
+ + +###### `resource` required {#controlPlane-ingress-spec-defaultBackend-resource} + +resource is an ObjectRef to another Kubernetes resource in the namespace +of the Ingress object. If resource is specified, a service.Name and +service.Port must not be specified. +This is a mutually exclusive setting with "Service". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/ingressClassName.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/ingressClassName.mdx new file mode 100755 index 000000000..cb9288344 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/ingressClassName.mdx @@ -0,0 +1,22 @@ + +
+ + +##### `ingressClassName` required string {#controlPlane-ingress-spec-ingressClassName} + +ingressClassName is the name of an IngressClass cluster resource. Ingress +controller implementations use this field to know whether they should be +serving this Ingress resource, by a transitive connection +(controller -> IngressClass -> Ingress resource). Although the +`kubernetes.io/ingress.class` annotation (simple constant name) was never +formally defined, it was widely supported by Ingress controllers to create +a direct binding between Ingress controller and Ingress resources. Newly +created Ingress resources should prefer using the field. However, even +though the annotation is officially deprecated, for backwards compatibility +reasons, ingress controllers should still honor that annotation if present. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules.mdx new file mode 100755 index 000000000..673ff5e22 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules.mdx @@ -0,0 +1,18 @@ + +import PartialRulesreference from "./rules_reference.mdx" + + +
+ + +##### `rules` required object[] {#controlPlane-ingress-spec-rules} + +rules is a list of host rules used to configure the Ingress. If unspecified, +or no rule matches, all traffic is sent to the default backend. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/host.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/host.mdx new file mode 100755 index 000000000..fba2089f1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/host.mdx @@ -0,0 +1,34 @@ + +
+ + +###### `host` required string {#controlPlane-ingress-spec-rules-host} + +host is the fully qualified domain name of a network host, as defined by RFC 3986. +Note the following deviations from the "host" part of the +URI as defined in RFC 3986: +1. IPs are not allowed. Currently an IngressRuleValue can only apply to + the IP in the Spec of the parent Ingress. +2. The `:` delimiter is not respected because ports are not allowed. + Currently the port of an Ingress is implicitly :80 for http and + :443 for https. +Both these may change in the future. +Incoming requests are matched against the host before the +IngressRuleValue. If the host is unspecified, the Ingress routes all +traffic based on the specified IngressRuleValue. + +host can be "precise" which is a domain name without the terminating dot of +a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name +prefixed with a single wildcard label (e.g. "*.foo.com"). +The wildcard character '*' must appear by itself as the first DNS label and +matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). +Requests will be matched against the Host field in the following way: +1. If host is precise, the request matches this rule if the http host header is equal to Host. +2. If host is a wildcard, then the request matches this rule if the http host header +is to equal to the suffix (removing the first label) of the wildcard rule. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http.mdx new file mode 100755 index 000000000..a930ed1c4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http.mdx @@ -0,0 +1,17 @@ + +import PartialHttpreference from "./http_reference.mdx" + + +
+ + +###### `http` required {#controlPlane-ingress-spec-rules-http} + ++optional + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths.mdx new file mode 100755 index 000000000..879d05b53 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths.mdx @@ -0,0 +1,17 @@ + +import PartialPathsreference from "./paths_reference.mdx" + + +
+ + +####### `paths` required object[] {#controlPlane-ingress-spec-rules-http-paths} + +paths is a collection of paths that map requests to backends. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend.mdx new file mode 100755 index 000000000..388475966 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend.mdx @@ -0,0 +1,18 @@ + +import PartialBackendreference from "./backend_reference.mdx" + + +
+ + +######## `backend` required {#controlPlane-ingress-spec-rules-http-paths-backend} + +backend defines the referenced service endpoint to which the traffic +will be forwarded to. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource.mdx new file mode 100755 index 000000000..3631d7e3d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource.mdx @@ -0,0 +1,20 @@ + +import PartialResourcereference from "./resource_reference.mdx" + + +
+ + +######### `resource` required {#controlPlane-ingress-spec-rules-http-paths-backend-resource} + +resource is an ObjectRef to another Kubernetes resource in the namespace +of the Ingress object. If resource is specified, a service.Name and +service.Port must not be specified. +This is a mutually exclusive setting with "Service". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/apiGroup.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/apiGroup.mdx new file mode 100755 index 000000000..eb1d56c2b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/apiGroup.mdx @@ -0,0 +1,15 @@ + +
+ + +########## `apiGroup` required string {#controlPlane-ingress-spec-rules-http-paths-backend-resource-apiGroup} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/kind.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/kind.mdx new file mode 100755 index 000000000..9effd5525 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `kind` required string {#controlPlane-ingress-spec-rules-http-paths-backend-resource-kind} + +Kind is the type of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/name.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/name.mdx new file mode 100755 index 000000000..24076cb6d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource/name.mdx @@ -0,0 +1,13 @@ + +
+ + +########## `name` required string {#controlPlane-ingress-spec-rules-http-paths-backend-resource-name} + +Name is the name of resource being referenced + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource_reference.mdx new file mode 100755 index 000000000..cd5b30231 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/resource_reference.mdx @@ -0,0 +1,12 @@ + +import PartialApigroup from "./resource/apiGroup.mdx" +import PartialKind from "./resource/kind.mdx" +import PartialName from "./resource/name.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service.mdx new file mode 100755 index 000000000..ed67150ac --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service.mdx @@ -0,0 +1,18 @@ + +import PartialServicereference from "./service_reference.mdx" + + +
+ + +######### `service` required {#controlPlane-ingress-spec-rules-http-paths-backend-service} + +service references a service as a backend. +This is a mutually exclusive setting with "Resource". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/name.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/name.mdx new file mode 100755 index 000000000..dadaa7a88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########## `name` required string {#controlPlane-ingress-spec-rules-http-paths-backend-service-name} + +name is the referenced service. The service must exist in +the same namespace as the Ingress object. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port.mdx new file mode 100755 index 000000000..98bba15b0 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port.mdx @@ -0,0 +1,18 @@ + +import PartialPortreference from "./port_reference.mdx" + + +
+ + +########## `port` required {#controlPlane-ingress-spec-rules-http-paths-backend-service-port} + +port of the referenced service. A port name or port number +is required for a IngressServiceBackend. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port/name.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port/name.mdx new file mode 100755 index 000000000..2dda0028e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port/name.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `name` required string {#controlPlane-ingress-spec-rules-http-paths-backend-service-port-name} + +name is the name of the port on the Service. +This is a mutually exclusive setting with "Number". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port/number.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port/number.mdx new file mode 100755 index 000000000..4687b43c6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port/number.mdx @@ -0,0 +1,14 @@ + +
+ + +########### `number` required integer {#controlPlane-ingress-spec-rules-http-paths-backend-service-port-number} + +number is the numerical port number (e.g. 80) on the Service. +This is a mutually exclusive setting with "Name". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port_reference.mdx new file mode 100755 index 000000000..89f2923b8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service/port_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./port/name.mdx" +import PartialNumber from "./port/number.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service_reference.mdx new file mode 100755 index 000000000..fa23f62f5 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend/service_reference.mdx @@ -0,0 +1,22 @@ + +import PartialName from "./service/name.mdx" +import PartialPortreference from "./service/port_reference.mdx" + + + + + +
+ + +########## `port` required {#controlPlane-ingress-spec-rules-http-paths-backend-service-port} + +port of the referenced service. A port name or port number +is required for a IngressServiceBackend. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend_reference.mdx new file mode 100755 index 000000000..b54ea6c95 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/backend_reference.mdx @@ -0,0 +1,38 @@ + +import PartialServicereference from "./backend/service_reference.mdx" +import PartialResourcereference from "./backend/resource_reference.mdx" + + +
+ + +######### `service` required {#controlPlane-ingress-spec-rules-http-paths-backend-service} + +service references a service as a backend. +This is a mutually exclusive setting with "Resource". + + + + + + +
+ + + +
+ + +######### `resource` required {#controlPlane-ingress-spec-rules-http-paths-backend-resource} + +resource is an ObjectRef to another Kubernetes resource in the namespace +of the Ingress object. If resource is specified, a service.Name and +service.Port must not be specified. +This is a mutually exclusive setting with "Service". + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/path.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/path.mdx new file mode 100755 index 000000000..29698c917 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/path.mdx @@ -0,0 +1,16 @@ + +
+ + +######## `path` required string {#controlPlane-ingress-spec-rules-http-paths-path} + +path is matched against the path of an incoming request. Currently it can +contain characters disallowed from the conventional "path" part of a URL +as defined by RFC 3986. Paths must begin with a '/' and must be present +when using PathType with value "Exact" or "Prefix". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/pathType.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/pathType.mdx new file mode 100755 index 000000000..2eeae626d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths/pathType.mdx @@ -0,0 +1,26 @@ + +
+ + +######## `pathType` required string {#controlPlane-ingress-spec-rules-http-paths-pathType} + +pathType determines the interpretation of the path matching. PathType can +be one of the following values: +* Exact: Matches the URL path exactly. +* Prefix: Matches based on a URL path prefix split by '/'. Matching is + done on a path element by element basis. A path element refers is the + list of labels in the path split by the '/' separator. A request is a + match for path p if every p is an element-wise prefix of p of the + request path. Note that if the last element of the path is a substring + of the last element in request path, it is not a match (e.g. /foo/bar + matches /foo/bar/baz, but does not match /foo/barbaz). +* ImplementationSpecific: Interpretation of the Path matching is up to + the IngressClass. Implementations can treat this as a separate PathType + or treat it identically to Prefix or Exact path types. +Implementations are required to support all path types. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths_reference.mdx new file mode 100755 index 000000000..4968751a2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http/paths_reference.mdx @@ -0,0 +1,26 @@ + +import PartialPath from "./paths/path.mdx" +import PartialPathtype from "./paths/pathType.mdx" +import PartialBackendreference from "./paths/backend_reference.mdx" + + + + + + + + +
+ + +######## `backend` required {#controlPlane-ingress-spec-rules-http-paths-backend} + +backend defines the referenced service endpoint to which the traffic +will be forwarded to. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http_reference.mdx new file mode 100755 index 000000000..f4ee2fc3c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules/http_reference.mdx @@ -0,0 +1,17 @@ + +import PartialPathsreference from "./http/paths_reference.mdx" + + +
+ + +####### `paths` required object[] {#controlPlane-ingress-spec-rules-http-paths} + +paths is a collection of paths that map requests to backends. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules_reference.mdx new file mode 100755 index 000000000..258ff6645 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/rules_reference.mdx @@ -0,0 +1,21 @@ + +import PartialHost from "./rules/host.mdx" +import PartialHttpreference from "./rules/http_reference.mdx" + + + + + +
+ + +###### `http` required {#controlPlane-ingress-spec-rules-http} + ++optional + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls.mdx new file mode 100755 index 000000000..21818a1e7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls.mdx @@ -0,0 +1,21 @@ + +import PartialTlsreference from "./tls_reference.mdx" + + +
+ + +##### `tls` required object[] {#controlPlane-ingress-spec-tls} + +tls represents the TLS configuration. Currently the Ingress only supports a +single TLS port, 443. If multiple members of this list specify different hosts, +they will be multiplexed on the same port according to the hostname specified +through the SNI TLS extension, if the ingress controller fulfilling the +ingress supports SNI. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls/hosts.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls/hosts.mdx new file mode 100755 index 000000000..8c5004db4 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls/hosts.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `hosts` required string[] {#controlPlane-ingress-spec-tls-hosts} + +hosts is a list of hosts included in the TLS certificate. The values in +this list must match the name/s used in the tlsSecret. Defaults to the +wildcard host setting for the loadbalancer controller fulfilling this +Ingress, if left unspecified. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls/secretName.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls/secretName.mdx new file mode 100755 index 000000000..8c6618e11 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls/secretName.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `secretName` required string {#controlPlane-ingress-spec-tls-secretName} + +secretName is the name of the secret used to terminate TLS traffic on +port 443. Field is left optional to allow TLS routing based on SNI +hostname alone. If the SNI host in a listener conflicts with the "Host" +header field used by an IngressRule, the SNI host is used for termination +and value of the "Host" header is used for routing. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls_reference.mdx new file mode 100755 index 000000000..78a41318e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec/tls_reference.mdx @@ -0,0 +1,8 @@ + +import PartialHosts from "./tls/hosts.mdx" +import PartialSecretname from "./tls/secretName.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/ingress/spec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress/spec_reference.mdx new file mode 100755 index 000000000..f468d470a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress/spec_reference.mdx @@ -0,0 +1,63 @@ + +import PartialIngressclassname from "./spec/ingressClassName.mdx" +import PartialDefaultbackendreference from "./spec/defaultBackend_reference.mdx" +import PartialTlsreference from "./spec/tls_reference.mdx" +import PartialRulesreference from "./spec/rules_reference.mdx" + + + + + +
+ + +##### `defaultBackend` required {#controlPlane-ingress-spec-defaultBackend} + +defaultBackend is the backend that should handle requests that don't +match any rule. If Rules are not specified, DefaultBackend must be specified. +If DefaultBackend is not set, the handling of requests that do not match any +of the rules will be up to the Ingress controller. + + + + + + +
+ + + +
+ + +##### `tls` required object[] {#controlPlane-ingress-spec-tls} + +tls represents the TLS configuration. Currently the Ingress only supports a +single TLS port, 443. If multiple members of this list specify different hosts, +they will be multiplexed on the same port according to the hostname specified +through the SNI TLS extension, if the ingress controller fulfilling the +ingress supports SNI. + + + + + + +
+ + + +
+ + +##### `rules` required object[] {#controlPlane-ingress-spec-rules} + +rules is a list of host rules used to configure the Ingress. If unspecified, +or no rule matches, all traffic is sent to the default backend. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/ingress_reference.mdx b/docs/pages/configuration/_partials/controlPlane/ingress_reference.mdx new file mode 100755 index 000000000..ba2fea2bf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/ingress_reference.mdx @@ -0,0 +1,33 @@ + +import PartialEnabled from "./ingress/enabled.mdx" +import PartialLabels from "./ingress/labels.mdx" +import PartialAnnotations from "./ingress/annotations.mdx" +import PartialName from "./ingress/name.mdx" +import PartialSpecreference from "./ingress/spec_reference.mdx" + + + + + + + + + + + + + + +
+ + +#### `spec` required {#controlPlane-ingress-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/proxy.mdx b/docs/pages/configuration/_partials/controlPlane/proxy.mdx new file mode 100755 index 000000000..b4d981437 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/proxy.mdx @@ -0,0 +1,17 @@ + +import PartialProxyreference from "./proxy_reference.mdx" + + +
+ + +### `proxy` required {#controlPlane-proxy} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/proxy/bindAddress.mdx b/docs/pages/configuration/_partials/controlPlane/proxy/bindAddress.mdx new file mode 100755 index 000000000..71094e8d6 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/proxy/bindAddress.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `bindAddress` required string {#controlPlane-proxy-bindAddress} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/proxy/port.mdx b/docs/pages/configuration/_partials/controlPlane/proxy/port.mdx new file mode 100755 index 000000000..412626384 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/proxy/port.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `port` required integer {#controlPlane-proxy-port} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/proxy/tls.mdx b/docs/pages/configuration/_partials/controlPlane/proxy/tls.mdx new file mode 100755 index 000000000..344a2064c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/proxy/tls.mdx @@ -0,0 +1,17 @@ + +import PartialTlsreference from "./tls_reference.mdx" + + +
+ + +#### `tls` required {#controlPlane-proxy-tls} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/proxy/tls/extraSANs.mdx b/docs/pages/configuration/_partials/controlPlane/proxy/tls/extraSANs.mdx new file mode 100755 index 000000000..6e02d7e4e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/proxy/tls/extraSANs.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `extraSANs` required string[] {#controlPlane-proxy-tls-extraSANs} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/proxy/tls_reference.mdx b/docs/pages/configuration/_partials/controlPlane/proxy/tls_reference.mdx new file mode 100755 index 000000000..df2786c4c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/proxy/tls_reference.mdx @@ -0,0 +1,4 @@ + +import PartialExtrasans from "./tls/extraSANs.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/proxy_reference.mdx b/docs/pages/configuration/_partials/controlPlane/proxy_reference.mdx new file mode 100755 index 000000000..c8edc11cb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/proxy_reference.mdx @@ -0,0 +1,25 @@ + +import PartialBindaddress from "./proxy/bindAddress.mdx" +import PartialPort from "./proxy/port.mdx" +import PartialTlsreference from "./proxy/tls_reference.mdx" + + + + + + + + +
+ + +#### `tls` required {#controlPlane-proxy-tls} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service.mdx b/docs/pages/configuration/_partials/controlPlane/service.mdx new file mode 100755 index 000000000..0da84568b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service.mdx @@ -0,0 +1,17 @@ + +import PartialServicereference from "./service_reference.mdx" + + +
+ + +### `service` required {#controlPlane-service} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/annotations.mdx b/docs/pages/configuration/_partials/controlPlane/service/annotations.mdx new file mode 100755 index 000000000..919265508 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/annotations.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `annotations` required object {#controlPlane-service-annotations} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/labels.mdx b/docs/pages/configuration/_partials/controlPlane/service/labels.mdx new file mode 100755 index 000000000..67723a88b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/labels.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `labels` required object {#controlPlane-service-labels} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/name.mdx b/docs/pages/configuration/_partials/controlPlane/service/name.mdx new file mode 100755 index 000000000..6bc030d05 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/name.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `name` required string {#controlPlane-service-name} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec.mdx new file mode 100755 index 000000000..bb6d390c8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec.mdx @@ -0,0 +1,17 @@ + +import PartialSpecreference from "./spec_reference.mdx" + + +
+ + +#### `spec` required {#controlPlane-service-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/allocateLoadBalancerNodePorts.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/allocateLoadBalancerNodePorts.mdx new file mode 100755 index 000000000..18b8c6e49 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/allocateLoadBalancerNodePorts.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `allocateLoadBalancerNodePorts` required boolean false {#controlPlane-service-spec-allocateLoadBalancerNodePorts} + +allocateLoadBalancerNodePorts defines if NodePorts will be automatically +allocated for services with type LoadBalancer. Default is "true". It +may be set to "false" if the cluster load-balancer does not rely on +NodePorts. If the caller requests specific NodePorts (by specifying a +value), those requests will be respected, regardless of this field. +This field may only be set for services with type LoadBalancer and will +be cleared if the type is changed to any other type. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/clusterIP.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/clusterIP.mdx new file mode 100755 index 000000000..7ca8c1697 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/clusterIP.mdx @@ -0,0 +1,27 @@ + +
+ + +##### `clusterIP` required string {#controlPlane-service-spec-clusterIP} + +clusterIP is the IP address of the service and is usually assigned +randomly. If an address is specified manually, is in-range (as per +system configuration), and is not in use, it will be allocated to the +service; otherwise creation of the service will fail. This field may not +be changed through updates unless the type field is also being changed +to ExternalName (which requires this field to be blank) or the type +field is being changed from ExternalName (in which case this field may +optionally be specified, as describe above). Valid values are "None", +empty string (""), or a valid IP address. Setting this to "None" makes a +"headless service" (no virtual IP), which is useful when direct endpoint +connections are preferred and proxying is not required. Only applies to +types ClusterIP, NodePort, and LoadBalancer. If this field is specified +when creating a Service of type ExternalName, creation will fail. This +field will be wiped when updating a Service to type ExternalName. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/clusterIPs.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/clusterIPs.mdx new file mode 100755 index 000000000..68363d83b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/clusterIPs.mdx @@ -0,0 +1,35 @@ + +
+ + +##### `clusterIPs` required string[] {#controlPlane-service-spec-clusterIPs} + +ClusterIPs is a list of IP addresses assigned to this service, and are +usually assigned randomly. If an address is specified manually, is +in-range (as per system configuration), and is not in use, it will be +allocated to the service; otherwise creation of the service will fail. +This field may not be changed through updates unless the type field is +also being changed to ExternalName (which requires this field to be +empty) or the type field is being changed from ExternalName (in which +case this field may optionally be specified, as describe above). Valid +values are "None", empty string (""), or a valid IP address. Setting +this to "None" makes a "headless service" (no virtual IP), which is +useful when direct endpoint connections are preferred and proxying is +not required. Only applies to types ClusterIP, NodePort, and +LoadBalancer. If this field is specified when creating a Service of type +ExternalName, creation will fail. This field will be wiped when updating +a Service to type ExternalName. If this field is not specified, it will +be initialized from the clusterIP field. If this field is specified, +clients must ensure that clusterIPs[0] and clusterIP have the same +value. + +This field may hold a maximum of two entries (dual-stack IPs, in either order). +These IPs must correspond to the values of the ipFamilies field. Both +clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/externalIPs.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/externalIPs.mdx new file mode 100755 index 000000000..df6f3864e --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/externalIPs.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `externalIPs` required string[] {#controlPlane-service-spec-externalIPs} + +externalIPs is a list of IP addresses for which nodes in the cluster +will also accept traffic for this service. These IPs are not managed by +Kubernetes. The user is responsible for ensuring that traffic arrives +at a node with this IP. A common example is external load-balancers +that are not part of the Kubernetes system. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/externalName.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/externalName.mdx new file mode 100755 index 000000000..fd349e0f1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/externalName.mdx @@ -0,0 +1,16 @@ + +
+ + +##### `externalName` required string {#controlPlane-service-spec-externalName} + +externalName is the external reference that discovery mechanisms will +return as an alias for this service (e.g. a DNS CNAME record). No +proxying will be involved. Must be a lowercase RFC-1123 hostname +(https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/externalTrafficPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/externalTrafficPolicy.mdx new file mode 100755 index 000000000..50d419cca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/externalTrafficPolicy.mdx @@ -0,0 +1,25 @@ + +
+ + +##### `externalTrafficPolicy` required string {#controlPlane-service-spec-externalTrafficPolicy} + +externalTrafficPolicy describes how nodes distribute service traffic they +receive on one of the Service's "externally-facing" addresses (NodePorts, +ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure +the service in a way that assumes that external load balancers will take care +of balancing the service traffic between nodes, and so each node will deliver +traffic only to the node-local endpoints of the service, without masquerading +the client source IP. (Traffic mistakenly sent to a node with no endpoints will +be dropped.) The default value, "Cluster", uses the standard behavior of +routing to all endpoints evenly (possibly modified by topology and other +features). Note that traffic sent to an External IP or LoadBalancer IP from +within the cluster will always get "Cluster" semantics, but clients sending to +a NodePort from within the cluster may need to take traffic policy into account +when picking a node. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/healthCheckNodePort.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/healthCheckNodePort.mdx new file mode 100755 index 000000000..c6930088b --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/healthCheckNodePort.mdx @@ -0,0 +1,22 @@ + +
+ + +##### `healthCheckNodePort` required integer {#controlPlane-service-spec-healthCheckNodePort} + +healthCheckNodePort specifies the healthcheck nodePort for the service. +This only applies when type is set to LoadBalancer and +externalTrafficPolicy is set to Local. If a value is specified, is +in-range, and is not in use, it will be used. If not specified, a value +will be automatically allocated. External systems (e.g. load-balancers) +can use this port to determine if a given node holds endpoints for this +service or not. If this field is specified when creating a Service +which does not need it, creation will fail. This field will be wiped +when updating a Service to no longer need it (e.g. changing type). +This field cannot be updated once set. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/internalTrafficPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/internalTrafficPolicy.mdx new file mode 100755 index 000000000..8491bbf09 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/internalTrafficPolicy.mdx @@ -0,0 +1,18 @@ + +
+ + +##### `internalTrafficPolicy` required string {#controlPlane-service-spec-internalTrafficPolicy} + +InternalTrafficPolicy describes how nodes distribute service traffic they +receive on the ClusterIP. If set to "Local", the proxy will assume that pods +only want to talk to endpoints of the service on the same node as the pod, +dropping the traffic if there are no local endpoints. The default value, +"Cluster", uses the standard behavior of routing to all endpoints evenly +(possibly modified by topology and other features). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ipFamilies.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ipFamilies.mdx new file mode 100755 index 000000000..cde0d5141 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ipFamilies.mdx @@ -0,0 +1,28 @@ + +
+ + +##### `ipFamilies` required string[] {#controlPlane-service-spec-ipFamilies} + +IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this +service. This field is usually assigned automatically based on cluster +configuration and the ipFamilyPolicy field. If this field is specified +manually, the requested family is available in the cluster, +and ipFamilyPolicy allows it, it will be used; otherwise creation of +the service will fail. This field is conditionally mutable: it allows +for adding or removing a secondary IP family, but it does not allow +changing the primary IP family of the Service. Valid values are "IPv4" +and "IPv6". This field only applies to Services of types ClusterIP, +NodePort, and LoadBalancer, and does apply to "headless" services. +This field will be wiped when updating a Service to type ExternalName. + +This field may hold a maximum of two entries (dual-stack families, in +either order). These families must correspond to the values of the +clusterIPs field, if specified. Both clusterIPs and ipFamilies are +governed by the ipFamilyPolicy field. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ipFamilyPolicy.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ipFamilyPolicy.mdx new file mode 100755 index 000000000..5504b287a --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ipFamilyPolicy.mdx @@ -0,0 +1,20 @@ + +
+ + +##### `ipFamilyPolicy` required string {#controlPlane-service-spec-ipFamilyPolicy} + +IPFamilyPolicy represents the dual-stack-ness requested or required by +this Service. If there is no value provided, then this field will be set +to SingleStack. Services can be "SingleStack" (a single IP family), +"PreferDualStack" (two IP families on dual-stack configured clusters or +a single IP family on single-stack clusters), or "RequireDualStack" +(two IP families on dual-stack configured clusters, otherwise fail). The +ipFamilies and clusterIPs fields depend on the value of this field. This +field will be wiped when updating a service to type ExternalName. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerClass.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerClass.mdx new file mode 100755 index 000000000..43bc6eca8 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerClass.mdx @@ -0,0 +1,22 @@ + +
+ + +##### `loadBalancerClass` required string {#controlPlane-service-spec-loadBalancerClass} + +loadBalancerClass is the class of the load balancer implementation this Service belongs to. +If specified, the value of this field must be a label-style identifier, with an optional prefix, +e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. +This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load +balancer implementation is used, today this is typically done through the cloud provider integration, +but should apply for any default implementation. If set, it is assumed that a load balancer +implementation is watching for Services with a matching class. Any default load balancer +implementation (e.g. cloud providers) should ignore Services that set this field. +This field can only be set when creating or updating a Service to type 'LoadBalancer'. +Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerIP.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerIP.mdx new file mode 100755 index 000000000..776052a60 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerIP.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `loadBalancerIP` required string {#controlPlane-service-spec-loadBalancerIP} + +Only applies to Service Type: LoadBalancer. +This feature depends on whether the underlying cloud-provider supports specifying +the loadBalancerIP when a load balancer is created. +This field will be ignored if the cloud-provider does not support the feature. +Deprecated: This field was under-specified and its meaning varies across implementations. +Using it is non-portable and it may not support dual-stack. +Users are encouraged to use implementation-specific annotations when available. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerSourceRanges.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerSourceRanges.mdx new file mode 100755 index 000000000..115ce1f73 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/loadBalancerSourceRanges.mdx @@ -0,0 +1,16 @@ + +
+ + +##### `loadBalancerSourceRanges` required string[] {#controlPlane-service-spec-loadBalancerSourceRanges} + +If specified and supported by the platform, this will restrict traffic through the cloud-provider +load-balancer will be restricted to the specified client IPs. This field will be ignored if the +cloud-provider does not support the feature." +More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports.mdx new file mode 100755 index 000000000..cc27eb9e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports.mdx @@ -0,0 +1,18 @@ + +import PartialPortsreference from "./ports_reference.mdx" + + +
+ + +##### `ports` required object[] {#controlPlane-service-spec-ports} + +The list of ports that are exposed by this service. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/appProtocol.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/appProtocol.mdx new file mode 100755 index 000000000..e48fe4ecf --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/appProtocol.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `appProtocol` required string {#controlPlane-service-spec-ports-appProtocol} + +The application protocol for this port. +This is used as a hint for implementations to offer richer behavior for protocols that they understand. +This field follows standard Kubernetes label syntax. +Valid values are either: + +* Un-prefixed protocol names - reserved for IANA standard service names (as per +RFC-6335 and https://www.iana.org/assignments/service-names). + +* Kubernetes-defined prefixed names: + * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- + * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 + * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 + +* Other protocols should use implementation-defined prefixed names such as +mycompany.com/my-custom-protocol. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/name.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/name.mdx new file mode 100755 index 000000000..f5dda9e9f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/name.mdx @@ -0,0 +1,17 @@ + +
+ + +###### `name` required string {#controlPlane-service-spec-ports-name} + +The name of this port within the service. This must be a DNS_LABEL. +All ports within a ServiceSpec must have unique names. When considering +the endpoints for a Service, this must match the 'name' field in the +EndpointPort. +Optional if only one ServicePort is defined on this service. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/nodePort.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/nodePort.mdx new file mode 100755 index 000000000..134f9b6e1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/nodePort.mdx @@ -0,0 +1,21 @@ + +
+ + +###### `nodePort` required integer {#controlPlane-service-spec-ports-nodePort} + +The port on each node on which this service is exposed when type is +NodePort or LoadBalancer. Usually assigned by the system. If a value is +specified, in-range, and not in use it will be used, otherwise the +operation will fail. If not specified, a port will be allocated if this +Service requires one. If this field is specified when creating a +Service which does not need it, creation will fail. This field will be +wiped when updating a Service to no longer need it (e.g. changing type +from NodePort to ClusterIP). +More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/port.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/port.mdx new file mode 100755 index 000000000..732df14ca --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/port.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `port` required integer {#controlPlane-service-spec-ports-port} + +The port that will be exposed by this service. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/protocol.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/protocol.mdx new file mode 100755 index 000000000..927322454 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/protocol.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `protocol` required string {#controlPlane-service-spec-ports-protocol} + +The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". +Default is TCP. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort.mdx new file mode 100755 index 000000000..d667fc99c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort.mdx @@ -0,0 +1,24 @@ + +import PartialTargetportreference from "./targetPort_reference.mdx" + + +
+ + +###### `targetPort` required {#controlPlane-service-spec-ports-targetPort} + +Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/IntVal.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/IntVal.mdx new file mode 100755 index 000000000..dbfa4d6f1 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/IntVal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `IntVal` required integer {#controlPlane-service-spec-ports-targetPort-IntVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/StrVal.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/StrVal.mdx new file mode 100755 index 000000000..3364c5d73 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/StrVal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `StrVal` required string {#controlPlane-service-spec-ports-targetPort-StrVal} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/Type.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/Type.mdx new file mode 100755 index 000000000..6ba791760 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort/Type.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `Type` required integer {#controlPlane-service-spec-ports-targetPort-Type} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort_reference.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort_reference.mdx new file mode 100755 index 000000000..287c53142 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports/targetPort_reference.mdx @@ -0,0 +1,12 @@ + +import PartialType from "./targetPort/Type.mdx" +import PartialIntval from "./targetPort/IntVal.mdx" +import PartialStrval from "./targetPort/StrVal.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/ports_reference.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/ports_reference.mdx new file mode 100755 index 000000000..d227ffecb --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/ports_reference.mdx @@ -0,0 +1,44 @@ + +import PartialName from "./ports/name.mdx" +import PartialProtocol from "./ports/protocol.mdx" +import PartialAppprotocol from "./ports/appProtocol.mdx" +import PartialPort from "./ports/port.mdx" +import PartialTargetportreference from "./ports/targetPort_reference.mdx" +import PartialNodeport from "./ports/nodePort.mdx" + + + + + + + + + + + + + + +
+ + +###### `targetPort` required {#controlPlane-service-spec-ports-targetPort} + +Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/publishNotReadyAddresses.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/publishNotReadyAddresses.mdx new file mode 100755 index 000000000..563086743 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/publishNotReadyAddresses.mdx @@ -0,0 +1,20 @@ + +
+ + +##### `publishNotReadyAddresses` required boolean false {#controlPlane-service-spec-publishNotReadyAddresses} + +publishNotReadyAddresses indicates that any agent which deals with endpoints for this +Service should disregard any indications of ready/not-ready. +The primary use case for setting this field is for a StatefulSet's Headless Service to +propagate SRV DNS records for its Pods for the purpose of peer discovery. +The Kubernetes controllers that generate Endpoints and EndpointSlice resources for +Services interpret this to mean that all endpoints are considered "ready" even if the +Pods themselves are not. Agents which consume only Kubernetes generated endpoints +through the Endpoints or EndpointSlice resources can safely assume this behavior. + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/selector.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/selector.mdx new file mode 100755 index 000000000..d2dfd1b9d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/selector.mdx @@ -0,0 +1,18 @@ + +
+ + +##### `selector` required object {#controlPlane-service-spec-selector} + +Route service traffic to pods with label keys and values matching this +selector. If empty or not present, the service is assumed to have an +external process managing its endpoints, which Kubernetes will not +modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. +Ignored if type is ExternalName. +More info: https://kubernetes.io/docs/concepts/services-networking/service/ + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinity.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinity.mdx new file mode 100755 index 000000000..3e13a330c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinity.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `sessionAffinity` required string {#controlPlane-service-spec-sessionAffinity} + +Supports "ClientIP" and "None". Used to maintain session affinity. +Enable client IP based session affinity. +Must be ClientIP or None. +Defaults to None. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig.mdx new file mode 100755 index 000000000..6ac4cfaa9 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig.mdx @@ -0,0 +1,17 @@ + +import PartialSessionaffinityconfigreference from "./sessionAffinityConfig_reference.mdx" + + +
+ + +##### `sessionAffinityConfig` required {#controlPlane-service-spec-sessionAffinityConfig} + +sessionAffinityConfig contains the configurations of session affinity. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP.mdx new file mode 100755 index 000000000..d8ccc741f --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP.mdx @@ -0,0 +1,17 @@ + +import PartialClientipreference from "./clientIP_reference.mdx" + + +
+ + +###### `clientIP` required {#controlPlane-service-spec-sessionAffinityConfig-clientIP} + +clientIP contains the configurations of Client IP based session affinity. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP/timeoutSeconds.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP/timeoutSeconds.mdx new file mode 100755 index 000000000..3d056ee96 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP/timeoutSeconds.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `timeoutSeconds` required integer {#controlPlane-service-spec-sessionAffinityConfig-clientIP-timeoutSeconds} + +timeoutSeconds specifies the seconds of ClientIP type session sticky time. +The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". +Default value is 10800(for 3 hours). + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP_reference.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP_reference.mdx new file mode 100755 index 000000000..fb3d0ec04 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig/clientIP_reference.mdx @@ -0,0 +1,4 @@ + +import PartialTimeoutseconds from "./clientIP/timeoutSeconds.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig_reference.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig_reference.mdx new file mode 100755 index 000000000..3f42f8a88 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/sessionAffinityConfig_reference.mdx @@ -0,0 +1,17 @@ + +import PartialClientipreference from "./sessionAffinityConfig/clientIP_reference.mdx" + + +
+ + +###### `clientIP` required {#controlPlane-service-spec-sessionAffinityConfig-clientIP} + +clientIP contains the configurations of Client IP based session affinity. + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec/type.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec/type.mdx new file mode 100755 index 000000000..94da80c59 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec/type.mdx @@ -0,0 +1,28 @@ + +
+ + +##### `type` required string {#controlPlane-service-spec-type} + +type determines how the Service is exposed. Defaults to ClusterIP. Valid +options are ExternalName, ClusterIP, NodePort, and LoadBalancer. +"ClusterIP" allocates a cluster-internal IP address for load-balancing +to endpoints. Endpoints are determined by the selector or if that is not +specified, by manual construction of an Endpoints object or +EndpointSlice objects. If clusterIP is "None", no virtual IP is +allocated and the endpoints are published as a set of endpoints rather +than a virtual IP. +"NodePort" builds on ClusterIP and allocates a port on every node which +routes to the same endpoints as the clusterIP. +"LoadBalancer" builds on NodePort and creates an external load-balancer +(if supported in the current cloud) which routes to the same endpoints +as the clusterIP. +"ExternalName" aliases this service to the specified externalName. +Several other fields do not apply to ExternalName services. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/service/spec_reference.mdx b/docs/pages/configuration/_partials/controlPlane/service/spec_reference.mdx new file mode 100755 index 000000000..48cbf0778 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service/spec_reference.mdx @@ -0,0 +1,103 @@ + +import PartialPortsreference from "./spec/ports_reference.mdx" +import PartialSelector from "./spec/selector.mdx" +import PartialClusterip from "./spec/clusterIP.mdx" +import PartialClusterips from "./spec/clusterIPs.mdx" +import PartialType from "./spec/type.mdx" +import PartialExternalips from "./spec/externalIPs.mdx" +import PartialSessionaffinity from "./spec/sessionAffinity.mdx" +import PartialLoadbalancerip from "./spec/loadBalancerIP.mdx" +import PartialLoadbalancersourceranges from "./spec/loadBalancerSourceRanges.mdx" +import PartialExternalname from "./spec/externalName.mdx" +import PartialExternaltrafficpolicy from "./spec/externalTrafficPolicy.mdx" +import PartialHealthchecknodeport from "./spec/healthCheckNodePort.mdx" +import PartialPublishnotreadyaddresses from "./spec/publishNotReadyAddresses.mdx" +import PartialSessionaffinityconfigreference from "./spec/sessionAffinityConfig_reference.mdx" +import PartialIpfamilies from "./spec/ipFamilies.mdx" +import PartialIpfamilypolicy from "./spec/ipFamilyPolicy.mdx" +import PartialAllocateloadbalancernodeports from "./spec/allocateLoadBalancerNodePorts.mdx" +import PartialLoadbalancerclass from "./spec/loadBalancerClass.mdx" +import PartialInternaltrafficpolicy from "./spec/internalTrafficPolicy.mdx" + + +
+ + +##### `ports` required object[] {#controlPlane-service-spec-ports} + +The list of ports that are exposed by this service. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +##### `sessionAffinityConfig` required {#controlPlane-service-spec-sessionAffinityConfig} + +sessionAffinityConfig contains the configurations of session affinity. + + + + + + +
+ + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/controlPlane/service_reference.mdx b/docs/pages/configuration/_partials/controlPlane/service_reference.mdx new file mode 100755 index 000000000..6043b04f7 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/service_reference.mdx @@ -0,0 +1,29 @@ + +import PartialLabels from "./service/labels.mdx" +import PartialAnnotations from "./service/annotations.mdx" +import PartialName from "./service/name.mdx" +import PartialSpecreference from "./service/spec_reference.mdx" + + + + + + + + + + + +
+ + +#### `spec` required {#controlPlane-service-spec} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/virtualScheduler.mdx b/docs/pages/configuration/_partials/controlPlane/virtualScheduler.mdx new file mode 100755 index 000000000..d0068810c --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/virtualScheduler.mdx @@ -0,0 +1,17 @@ + +import PartialVirtualschedulerreference from "./virtualScheduler_reference.mdx" + + +
+ + +### `virtualScheduler` required {#controlPlane-virtualScheduler} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/virtualScheduler/enabled.mdx b/docs/pages/configuration/_partials/controlPlane/virtualScheduler/enabled.mdx new file mode 100755 index 000000000..1d3516c8d --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/virtualScheduler/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#controlPlane-virtualScheduler-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/controlPlane/virtualScheduler_reference.mdx b/docs/pages/configuration/_partials/controlPlane/virtualScheduler_reference.mdx new file mode 100755 index 000000000..77066aba2 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane/virtualScheduler_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./virtualScheduler/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/controlPlane_reference.mdx b/docs/pages/configuration/_partials/controlPlane_reference.mdx new file mode 100755 index 000000000..f22b2c927 --- /dev/null +++ b/docs/pages/configuration/_partials/controlPlane_reference.mdx @@ -0,0 +1,170 @@ + +import PartialDistroreference from "./controlPlane/distro_reference.mdx" +import PartialBackingstorereference from "./controlPlane/backingStore_reference.mdx" +import PartialHostpathmapperreference from "./controlPlane/hostPathMapper_reference.mdx" +import PartialCorednsreference from "./controlPlane/coredns_reference.mdx" +import PartialVirtualschedulerreference from "./controlPlane/virtualScheduler_reference.mdx" +import PartialProxyreference from "./controlPlane/proxy_reference.mdx" +import PartialServicereference from "./controlPlane/service_reference.mdx" +import PartialIngressreference from "./controlPlane/ingress_reference.mdx" +import PartialHighavailabilityreference from "./controlPlane/highAvailability_reference.mdx" +import PartialAdvancedreference from "./controlPlane/advanced_reference.mdx" + + +
+ + +### `distro` required {#controlPlane-distro} + + + + + + + + +
+ + + +
+ + +### `backingStore` required {#controlPlane-backingStore} + + + + + + + + +
+ + + +
+ + +### `hostPathMapper` required {#controlPlane-hostPathMapper} + + + + + + + + +
+ + + +
+ + +### `coredns` required {#controlPlane-coredns} + + + + + + + + +
+ + + +
+ + +### `virtualScheduler` required {#controlPlane-virtualScheduler} + + + + + + + + +
+ + + +
+ + +### `proxy` required {#controlPlane-proxy} + + + + + + + + +
+ + + +
+ + +### `service` required {#controlPlane-service} + + + + + + + + +
+ + + +
+ + +### `ingress` required {#controlPlane-ingress} + + + + + + + + +
+ + + +
+ + +### `highAvailability` required {#controlPlane-highAvailability} + + + + + + + + +
+ + + +
+ + +### `advanced` required {#controlPlane-advanced} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental.mdx b/docs/pages/configuration/_partials/experimental.mdx new file mode 100755 index 000000000..8e07050e3 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental.mdx @@ -0,0 +1,17 @@ + +import PartialExperimentalreference from "./experimental_reference.mdx" + + +
+ + +## `experimental` required {#experimental} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/Extended.mdx b/docs/pages/configuration/_partials/experimental/Extended.mdx new file mode 100755 index 000000000..e8d268822 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/Extended.mdx @@ -0,0 +1,13 @@ + +
+ + +### `Extended` required object {#experimental-Extended} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync.mdx b/docs/pages/configuration/_partials/experimental/genericSync.mdx new file mode 100755 index 000000000..ff3762965 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync.mdx @@ -0,0 +1,17 @@ + +import PartialGenericsyncreference from "./genericSync_reference.mdx" + + +
+ + +### `genericSync` required {#experimental-genericSync} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export.mdx new file mode 100755 index 000000000..3a17b428d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export.mdx @@ -0,0 +1,17 @@ + +import PartialExportreference from "./export_reference.mdx" + + +
+ + +#### `export` required object[] {#experimental-genericSync-export} + +Exports syncs a resource from the virtual cluster to the host + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/apiVersion.mdx new file mode 100755 index 000000000..fbdf1ec9c --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `apiVersion` required string {#experimental-genericSync-export-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/kind.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/kind.mdx new file mode 100755 index 000000000..ee0201678 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `kind` required string {#experimental-genericSync-export-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/optional.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/optional.mdx new file mode 100755 index 000000000..819d9e96c --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `optional` required boolean false {#experimental-genericSync-export-optional} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches.mdx new file mode 100755 index 000000000..72bd9f8ce --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches.mdx @@ -0,0 +1,18 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +##### `patches` required object[] {#experimental-genericSync-export-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions.mdx new file mode 100755 index 000000000..8a1ef1a29 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-export-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/empty.mdx new file mode 100755 index 000000000..d0b5b83fc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-genericSync-export-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/equal.mdx new file mode 100755 index 000000000..f516a1567 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-genericSync-export-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..7d0582d23 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-genericSync-export-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/path.mdx new file mode 100755 index 000000000..d781d4f13 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-genericSync-export-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/subPath.mdx new file mode 100755 index 000000000..d30b84da6 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-genericSync-export-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/fromPath.mdx new file mode 100755 index 000000000..5bc4d740e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-genericSync-export-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/ignore.mdx new file mode 100755 index 000000000..e6236c0e1 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-genericSync-export-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/namePath.mdx new file mode 100755 index 000000000..690b7415f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-genericSync-export-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/namespacePath.mdx new file mode 100755 index 000000000..211caff11 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-genericSync-export-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/op.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/op.mdx new file mode 100755 index 000000000..b24367012 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-genericSync-export-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/path.mdx new file mode 100755 index 000000000..133932a19 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-genericSync-export-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/regex.mdx new file mode 100755 index 000000000..a00238109 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-genericSync-export-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync.mdx new file mode 100755 index 000000000..c7d3c748d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-genericSync-export-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync/configmap.mdx new file mode 100755 index 000000000..1b226ca99 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-genericSync-export-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync/secret.mdx new file mode 100755 index 000000000..9bba07b77 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-genericSync-export-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches/value.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/value.mdx new file mode 100755 index 000000000..e5e874509 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-genericSync-export-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/patches_reference.mdx new file mode 100755 index 000000000..6f93e1f55 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-export-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-genericSync-export-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/replaceOnConflict.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/replaceOnConflict.mdx new file mode 100755 index 000000000..01cfa457d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/replaceOnConflict.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `replaceOnConflict` required boolean false {#experimental-genericSync-export-replaceOnConflict} + +ReplaceWhenInvalid determines if the controller should try to recreate the object +if there is a problem applying + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches.mdx new file mode 100755 index 000000000..6efeb67c2 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches.mdx @@ -0,0 +1,18 @@ + +import PartialReversepatchesreference from "./reversePatches_reference.mdx" + + +
+ + +##### `reversePatches` required object[] {#experimental-genericSync-export-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions.mdx new file mode 100755 index 000000000..0a07586b8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-export-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/empty.mdx new file mode 100755 index 000000000..d479d771e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-genericSync-export-reversePatches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/equal.mdx new file mode 100755 index 000000000..a4ef370fd --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-genericSync-export-reversePatches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/notEqual.mdx new file mode 100755 index 000000000..ae7d20a16 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-genericSync-export-reversePatches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/path.mdx new file mode 100755 index 000000000..5e9843ebc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-genericSync-export-reversePatches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/subPath.mdx new file mode 100755 index 000000000..450bbcfd3 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-genericSync-export-reversePatches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/fromPath.mdx new file mode 100755 index 000000000..a8a98fb30 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-genericSync-export-reversePatches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/ignore.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/ignore.mdx new file mode 100755 index 000000000..0d771ed58 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-genericSync-export-reversePatches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/namePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/namePath.mdx new file mode 100755 index 000000000..9ca3dfa3a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-genericSync-export-reversePatches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/namespacePath.mdx new file mode 100755 index 000000000..8e30dad04 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-genericSync-export-reversePatches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/op.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/op.mdx new file mode 100755 index 000000000..d611c2f80 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-genericSync-export-reversePatches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/path.mdx new file mode 100755 index 000000000..5a039f789 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-genericSync-export-reversePatches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/regex.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/regex.mdx new file mode 100755 index 000000000..f4f7f4c33 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-genericSync-export-reversePatches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync.mdx new file mode 100755 index 000000000..4b35ebb97 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-genericSync-export-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync/configmap.mdx new file mode 100755 index 000000000..6662b9b94 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-genericSync-export-reversePatches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync/secret.mdx new file mode 100755 index 000000000..d55208108 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-genericSync-export-reversePatches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/value.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/value.mdx new file mode 100755 index 000000000..e1b4bec87 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-genericSync-export-reversePatches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches_reference.mdx new file mode 100755 index 000000000..5f9545515 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/reversePatches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./reversePatches/op.mdx" +import PartialFrompath from "./reversePatches/fromPath.mdx" +import PartialPath from "./reversePatches/path.mdx" +import PartialNamepath from "./reversePatches/namePath.mdx" +import PartialNamespacepath from "./reversePatches/namespacePath.mdx" +import PartialValue from "./reversePatches/value.mdx" +import PartialRegex from "./reversePatches/regex.mdx" +import PartialConditionsreference from "./reversePatches/conditions_reference.mdx" +import PartialIgnore from "./reversePatches/ignore.mdx" +import PartialSyncreference from "./reversePatches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-export-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-genericSync-export-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/selector.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/selector.mdx new file mode 100755 index 000000000..50754dc5f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/selector.mdx @@ -0,0 +1,18 @@ + +import PartialSelectorreference from "./selector_reference.mdx" + + +
+ + +##### `selector` required {#experimental-genericSync-export-selector} + +Selector is a label selector to select the synced objects in the virtual cluster. +If empty, all objects will be synced. + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/selector/labelSelector.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/selector/labelSelector.mdx new file mode 100755 index 000000000..000b324d7 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/selector/labelSelector.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `labelSelector` required object {#experimental-genericSync-export-selector-labelSelector} + +LabelSelector are the labels to select the object from + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export/selector_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export/selector_reference.mdx new file mode 100755 index 000000000..0adfa8260 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export/selector_reference.mdx @@ -0,0 +1,4 @@ + +import PartialLabelselector from "./selector/labelSelector.mdx" + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/export_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/export_reference.mdx new file mode 100755 index 000000000..3021bfb3d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/export_reference.mdx @@ -0,0 +1,70 @@ + +import PartialApiversion from "./export/apiVersion.mdx" +import PartialKind from "./export/kind.mdx" +import PartialOptional from "./export/optional.mdx" +import PartialReplaceonconflict from "./export/replaceOnConflict.mdx" +import PartialPatchesreference from "./export/patches_reference.mdx" +import PartialReversepatchesreference from "./export/reversePatches_reference.mdx" +import PartialSelectorreference from "./export/selector_reference.mdx" + + + + + + + + + + + + + + +
+ + +##### `patches` required object[] {#experimental-genericSync-export-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
+ + + +
+ + +##### `reversePatches` required object[] {#experimental-genericSync-export-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
+ + + +
+ + +##### `selector` required {#experimental-genericSync-export-selector} + +Selector is a label selector to select the synced objects in the virtual cluster. +If empty, all objects will be synced. + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks.mdx new file mode 100755 index 000000000..6dd873329 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks.mdx @@ -0,0 +1,17 @@ + +import PartialHooksreference from "./hooks_reference.mdx" + + +
+ + +#### `hooks` required {#experimental-genericSync-hooks} + +Hooks are hooks that can be used to inject custom patches before syncing + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual.mdx new file mode 100755 index 000000000..52db6f023 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual.mdx @@ -0,0 +1,17 @@ + +import PartialHosttovirtualreference from "./hostToVirtual_reference.mdx" + + +
+ + +##### `hostToVirtual` required object[] {#experimental-genericSync-hooks-hostToVirtual} + +HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/apiVersion.mdx new file mode 100755 index 000000000..4b6f80ffd --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `apiVersion` required string {#experimental-genericSync-hooks-hostToVirtual-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/kind.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/kind.mdx new file mode 100755 index 000000000..69ebcd7b4 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `kind` required string {#experimental-genericSync-hooks-hostToVirtual-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches.mdx new file mode 100755 index 000000000..390706980 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches.mdx @@ -0,0 +1,17 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +###### `patches` required object[] {#experimental-genericSync-hooks-hostToVirtual-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions.mdx new file mode 100755 index 000000000..519fad739 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +####### `conditions` required object[] {#experimental-genericSync-hooks-hostToVirtual-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/empty.mdx new file mode 100755 index 000000000..080c51ec6 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `empty` required boolean false {#experimental-genericSync-hooks-hostToVirtual-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/equal.mdx new file mode 100755 index 000000000..d6a77fc02 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `equal` required {#experimental-genericSync-hooks-hostToVirtual-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..66c47dc65 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `notEqual` required {#experimental-genericSync-hooks-hostToVirtual-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/path.mdx new file mode 100755 index 000000000..c9b4a9834 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#experimental-genericSync-hooks-hostToVirtual-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/subPath.mdx new file mode 100755 index 000000000..745729581 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `subPath` required string {#experimental-genericSync-hooks-hostToVirtual-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/fromPath.mdx new file mode 100755 index 000000000..48a7deb4b --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `fromPath` required string {#experimental-genericSync-hooks-hostToVirtual-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/ignore.mdx new file mode 100755 index 000000000..df66b10ba --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `ignore` required boolean false {#experimental-genericSync-hooks-hostToVirtual-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/namePath.mdx new file mode 100755 index 000000000..5e2b264c3 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namePath` required string {#experimental-genericSync-hooks-hostToVirtual-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/namespacePath.mdx new file mode 100755 index 000000000..04169fd26 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namespacePath` required string {#experimental-genericSync-hooks-hostToVirtual-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/op.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/op.mdx new file mode 100755 index 000000000..76ecee1dc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `op` required string {#experimental-genericSync-hooks-hostToVirtual-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/path.mdx new file mode 100755 index 000000000..43603e8b4 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-genericSync-hooks-hostToVirtual-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/regex.mdx new file mode 100755 index 000000000..a09491ca8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `regex` required string {#experimental-genericSync-hooks-hostToVirtual-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync.mdx new file mode 100755 index 000000000..f6174a6a4 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +####### `sync` required {#experimental-genericSync-hooks-hostToVirtual-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync/configmap.mdx new file mode 100755 index 000000000..0cd36ef1d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `configmap` required boolean false {#experimental-genericSync-hooks-hostToVirtual-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync/secret.mdx new file mode 100755 index 000000000..d714b5916 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `secret` required boolean false {#experimental-genericSync-hooks-hostToVirtual-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/value.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/value.mdx new file mode 100755 index 000000000..15529bc83 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `value` required {#experimental-genericSync-hooks-hostToVirtual-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches_reference.mdx new file mode 100755 index 000000000..b9191de3e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +####### `conditions` required object[] {#experimental-genericSync-hooks-hostToVirtual-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +####### `sync` required {#experimental-genericSync-hooks-hostToVirtual-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/verbs.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/verbs.mdx new file mode 100755 index 000000000..f628353df --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual/verbs.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `verbs` required string[] {#experimental-genericSync-hooks-hostToVirtual-verbs} + +Verbs are the verbs that the hook should mutate + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual_reference.mdx new file mode 100755 index 000000000..bb5444b3c --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/hostToVirtual_reference.mdx @@ -0,0 +1,29 @@ + +import PartialApiversion from "./hostToVirtual/apiVersion.mdx" +import PartialKind from "./hostToVirtual/kind.mdx" +import PartialVerbs from "./hostToVirtual/verbs.mdx" +import PartialPatchesreference from "./hostToVirtual/patches_reference.mdx" + + + + + + + + + + + +
+ + +###### `patches` required object[] {#experimental-genericSync-hooks-hostToVirtual-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost.mdx new file mode 100755 index 000000000..0c708bb7a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost.mdx @@ -0,0 +1,17 @@ + +import PartialVirtualtohostreference from "./virtualToHost_reference.mdx" + + +
+ + +##### `virtualToHost` required object[] {#experimental-genericSync-hooks-virtualToHost} + +VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/apiVersion.mdx new file mode 100755 index 000000000..94f742546 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `apiVersion` required string {#experimental-genericSync-hooks-virtualToHost-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/kind.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/kind.mdx new file mode 100755 index 000000000..c948645a4 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `kind` required string {#experimental-genericSync-hooks-virtualToHost-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches.mdx new file mode 100755 index 000000000..a7e548205 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches.mdx @@ -0,0 +1,17 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +###### `patches` required object[] {#experimental-genericSync-hooks-virtualToHost-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions.mdx new file mode 100755 index 000000000..80aed1ada --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +####### `conditions` required object[] {#experimental-genericSync-hooks-virtualToHost-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/empty.mdx new file mode 100755 index 000000000..1ba795ed8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `empty` required boolean false {#experimental-genericSync-hooks-virtualToHost-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/equal.mdx new file mode 100755 index 000000000..3364e4dc8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `equal` required {#experimental-genericSync-hooks-virtualToHost-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..9f0e0b715 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `notEqual` required {#experimental-genericSync-hooks-virtualToHost-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/path.mdx new file mode 100755 index 000000000..667c7e618 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#experimental-genericSync-hooks-virtualToHost-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/subPath.mdx new file mode 100755 index 000000000..0dbf6cbb2 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `subPath` required string {#experimental-genericSync-hooks-virtualToHost-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/fromPath.mdx new file mode 100755 index 000000000..06b3e6621 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `fromPath` required string {#experimental-genericSync-hooks-virtualToHost-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/ignore.mdx new file mode 100755 index 000000000..1045751af --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `ignore` required boolean false {#experimental-genericSync-hooks-virtualToHost-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/namePath.mdx new file mode 100755 index 000000000..59f8ff14e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namePath` required string {#experimental-genericSync-hooks-virtualToHost-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/namespacePath.mdx new file mode 100755 index 000000000..6db04ffdc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namespacePath` required string {#experimental-genericSync-hooks-virtualToHost-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/op.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/op.mdx new file mode 100755 index 000000000..5660ff853 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `op` required string {#experimental-genericSync-hooks-virtualToHost-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/path.mdx new file mode 100755 index 000000000..9cff9d4b2 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-genericSync-hooks-virtualToHost-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/regex.mdx new file mode 100755 index 000000000..5a60d8d3b --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `regex` required string {#experimental-genericSync-hooks-virtualToHost-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync.mdx new file mode 100755 index 000000000..a3c845d36 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +####### `sync` required {#experimental-genericSync-hooks-virtualToHost-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync/configmap.mdx new file mode 100755 index 000000000..513d9c305 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `configmap` required boolean false {#experimental-genericSync-hooks-virtualToHost-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync/secret.mdx new file mode 100755 index 000000000..fb9515a45 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `secret` required boolean false {#experimental-genericSync-hooks-virtualToHost-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/value.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/value.mdx new file mode 100755 index 000000000..3b7fa66fb --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `value` required {#experimental-genericSync-hooks-virtualToHost-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches_reference.mdx new file mode 100755 index 000000000..09841cc69 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +####### `conditions` required object[] {#experimental-genericSync-hooks-virtualToHost-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +####### `sync` required {#experimental-genericSync-hooks-virtualToHost-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/verbs.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/verbs.mdx new file mode 100755 index 000000000..e79a2ab0d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost/verbs.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `verbs` required string[] {#experimental-genericSync-hooks-virtualToHost-verbs} + +Verbs are the verbs that the hook should mutate + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost_reference.mdx new file mode 100755 index 000000000..bc0d98846 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks/virtualToHost_reference.mdx @@ -0,0 +1,29 @@ + +import PartialApiversion from "./virtualToHost/apiVersion.mdx" +import PartialKind from "./virtualToHost/kind.mdx" +import PartialVerbs from "./virtualToHost/verbs.mdx" +import PartialPatchesreference from "./virtualToHost/patches_reference.mdx" + + + + + + + + + + + +
+ + +###### `patches` required object[] {#experimental-genericSync-hooks-virtualToHost-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/hooks_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/hooks_reference.mdx new file mode 100755 index 000000000..ffded8cf1 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/hooks_reference.mdx @@ -0,0 +1,34 @@ + +import PartialHosttovirtualreference from "./hooks/hostToVirtual_reference.mdx" +import PartialVirtualtohostreference from "./hooks/virtualToHost_reference.mdx" + + +
+ + +##### `hostToVirtual` required object[] {#experimental-genericSync-hooks-hostToVirtual} + +HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster + + + + + + +
+ + + +
+ + +##### `virtualToHost` required object[] {#experimental-genericSync-hooks-virtualToHost} + +VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import.mdx new file mode 100755 index 000000000..75c71f0fd --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import.mdx @@ -0,0 +1,17 @@ + +import PartialImportreference from "./import_reference.mdx" + + +
+ + +#### `import` required object[] {#experimental-genericSync-import} + +Imports syncs a resource from the host cluster to virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/apiVersion.mdx new file mode 100755 index 000000000..f3dbda50a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `apiVersion` required string {#experimental-genericSync-import-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/kind.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/kind.mdx new file mode 100755 index 000000000..8f9625016 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `kind` required string {#experimental-genericSync-import-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/optional.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/optional.mdx new file mode 100755 index 000000000..49f77145e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `optional` required boolean false {#experimental-genericSync-import-optional} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches.mdx new file mode 100755 index 000000000..43f426e38 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches.mdx @@ -0,0 +1,18 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +##### `patches` required object[] {#experimental-genericSync-import-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions.mdx new file mode 100755 index 000000000..c72ba9cc2 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-import-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/empty.mdx new file mode 100755 index 000000000..da18610a6 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-genericSync-import-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/equal.mdx new file mode 100755 index 000000000..346cc0856 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-genericSync-import-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..7365c186d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-genericSync-import-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/path.mdx new file mode 100755 index 000000000..3d5f6dd13 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-genericSync-import-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/subPath.mdx new file mode 100755 index 000000000..f67dad21b --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-genericSync-import-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/fromPath.mdx new file mode 100755 index 000000000..f2bd88edb --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-genericSync-import-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/ignore.mdx new file mode 100755 index 000000000..c2ab2905a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-genericSync-import-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/namePath.mdx new file mode 100755 index 000000000..4e1224f98 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-genericSync-import-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/namespacePath.mdx new file mode 100755 index 000000000..335111616 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-genericSync-import-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/op.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/op.mdx new file mode 100755 index 000000000..0bd4fc69d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-genericSync-import-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/path.mdx new file mode 100755 index 000000000..5be7b6140 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-genericSync-import-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/regex.mdx new file mode 100755 index 000000000..d5bfc5a59 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-genericSync-import-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync.mdx new file mode 100755 index 000000000..ec6565023 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-genericSync-import-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync/configmap.mdx new file mode 100755 index 000000000..8a21febc5 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-genericSync-import-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync/secret.mdx new file mode 100755 index 000000000..3ea9cde3e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-genericSync-import-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches/value.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/value.mdx new file mode 100755 index 000000000..dbcef8ed1 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-genericSync-import-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/patches_reference.mdx new file mode 100755 index 000000000..32aa96e57 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-import-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-genericSync-import-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/replaceOnConflict.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/replaceOnConflict.mdx new file mode 100755 index 000000000..056b29497 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/replaceOnConflict.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `replaceOnConflict` required boolean false {#experimental-genericSync-import-replaceOnConflict} + +ReplaceWhenInvalid determines if the controller should try to recreate the object +if there is a problem applying + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches.mdx new file mode 100755 index 000000000..73dbaa2ab --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches.mdx @@ -0,0 +1,18 @@ + +import PartialReversepatchesreference from "./reversePatches_reference.mdx" + + +
+ + +##### `reversePatches` required object[] {#experimental-genericSync-import-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions.mdx new file mode 100755 index 000000000..437c676ff --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-import-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/empty.mdx new file mode 100755 index 000000000..cddeeb73e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-genericSync-import-reversePatches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/equal.mdx new file mode 100755 index 000000000..51383eb36 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-genericSync-import-reversePatches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/notEqual.mdx new file mode 100755 index 000000000..e61fa8794 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-genericSync-import-reversePatches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/path.mdx new file mode 100755 index 000000000..d591ad7ec --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-genericSync-import-reversePatches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/subPath.mdx new file mode 100755 index 000000000..91a0e8420 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-genericSync-import-reversePatches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/fromPath.mdx new file mode 100755 index 000000000..f5ba31102 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-genericSync-import-reversePatches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/ignore.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/ignore.mdx new file mode 100755 index 000000000..3ca084137 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-genericSync-import-reversePatches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/namePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/namePath.mdx new file mode 100755 index 000000000..84508af8b --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-genericSync-import-reversePatches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/namespacePath.mdx new file mode 100755 index 000000000..6bc02c461 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-genericSync-import-reversePatches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/op.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/op.mdx new file mode 100755 index 000000000..220f21a68 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-genericSync-import-reversePatches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/path.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/path.mdx new file mode 100755 index 000000000..b3bef6adf --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-genericSync-import-reversePatches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/regex.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/regex.mdx new file mode 100755 index 000000000..dc8d7e36e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-genericSync-import-reversePatches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync.mdx new file mode 100755 index 000000000..41c30f08e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-genericSync-import-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync/configmap.mdx new file mode 100755 index 000000000..f7b2f53ce --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-genericSync-import-reversePatches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync/secret.mdx new file mode 100755 index 000000000..0a9cc33b1 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-genericSync-import-reversePatches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/value.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/value.mdx new file mode 100755 index 000000000..ac16f81ee --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-genericSync-import-reversePatches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches_reference.mdx new file mode 100755 index 000000000..14e0a8162 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import/reversePatches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./reversePatches/op.mdx" +import PartialFrompath from "./reversePatches/fromPath.mdx" +import PartialPath from "./reversePatches/path.mdx" +import PartialNamepath from "./reversePatches/namePath.mdx" +import PartialNamespacepath from "./reversePatches/namespacePath.mdx" +import PartialValue from "./reversePatches/value.mdx" +import PartialRegex from "./reversePatches/regex.mdx" +import PartialConditionsreference from "./reversePatches/conditions_reference.mdx" +import PartialIgnore from "./reversePatches/ignore.mdx" +import PartialSyncreference from "./reversePatches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-genericSync-import-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-genericSync-import-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/import_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync/import_reference.mdx new file mode 100755 index 000000000..28fadc05f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/import_reference.mdx @@ -0,0 +1,52 @@ + +import PartialApiversion from "./import/apiVersion.mdx" +import PartialKind from "./import/kind.mdx" +import PartialOptional from "./import/optional.mdx" +import PartialReplaceonconflict from "./import/replaceOnConflict.mdx" +import PartialPatchesreference from "./import/patches_reference.mdx" +import PartialReversepatchesreference from "./import/reversePatches_reference.mdx" + + + + + + + + + + + + + + +
+ + +##### `patches` required object[] {#experimental-genericSync-import-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
+ + + +
+ + +##### `reversePatches` required object[] {#experimental-genericSync-import-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync/version.mdx b/docs/pages/configuration/_partials/experimental/genericSync/version.mdx new file mode 100755 index 000000000..4d04bbf5f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync/version.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `version` required string {#experimental-genericSync-version} + +Version is the config version + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/genericSync_reference.mdx b/docs/pages/configuration/_partials/experimental/genericSync_reference.mdx new file mode 100755 index 000000000..f936960e2 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/genericSync_reference.mdx @@ -0,0 +1,55 @@ + +import PartialVersion from "./genericSync/version.mdx" +import PartialExportreference from "./genericSync/export_reference.mdx" +import PartialImportreference from "./genericSync/import_reference.mdx" +import PartialHooksreference from "./genericSync/hooks_reference.mdx" + + + + + +
+ + +#### `export` required object[] {#experimental-genericSync-export} + +Exports syncs a resource from the virtual cluster to the host + + + + + + +
+ + + +
+ + +#### `import` required object[] {#experimental-genericSync-import} + +Imports syncs a resource from the host cluster to virtual cluster + + + + + + +
+ + + +
+ + +#### `hooks` required {#experimental-genericSync-hooks} + +Hooks are hooks that can be used to inject custom patches before syncing + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/init.mdx b/docs/pages/configuration/_partials/experimental/init.mdx new file mode 100755 index 000000000..6ebd6d866 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/init.mdx @@ -0,0 +1,17 @@ + +import PartialInitreference from "./init_reference.mdx" + + +
+ + +### `init` required {#experimental-init} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/init/helm.mdx b/docs/pages/configuration/_partials/experimental/init/helm.mdx new file mode 100755 index 000000000..1bbf02914 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/init/helm.mdx @@ -0,0 +1,17 @@ + +import PartialHelmreference from "./helm_reference.mdx" + + +
+ + +#### `helm` required object[] {#experimental-init-helm} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/init/helm_reference.mdx b/docs/pages/configuration/_partials/experimental/init/helm_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/experimental/init/manifests.mdx b/docs/pages/configuration/_partials/experimental/init/manifests.mdx new file mode 100755 index 000000000..0ab2368ac --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/init/manifests.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `manifests` required string {#experimental-init-manifests} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/init/manifestsTemplate.mdx b/docs/pages/configuration/_partials/experimental/init/manifestsTemplate.mdx new file mode 100755 index 000000000..06c3f7385 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/init/manifestsTemplate.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `manifestsTemplate` required string {#experimental-init-manifestsTemplate} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/init_reference.mdx b/docs/pages/configuration/_partials/experimental/init_reference.mdx new file mode 100755 index 000000000..fc04ca30e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/init_reference.mdx @@ -0,0 +1,25 @@ + +import PartialManifests from "./init/manifests.mdx" +import PartialManifeststemplate from "./init/manifestsTemplate.mdx" +import PartialHelmreference from "./init/helm_reference.mdx" + + + + + + + + +
+ + +#### `helm` required object[] {#experimental-init-helm} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches.mdx b/docs/pages/configuration/_partials/experimental/syncPatches.mdx new file mode 100755 index 000000000..252b7ab74 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches.mdx @@ -0,0 +1,17 @@ + +import PartialSyncpatchesreference from "./syncPatches_reference.mdx" + + +
+ + +### `syncPatches` required {#experimental-syncPatches} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export.mdx new file mode 100755 index 000000000..2adc34e18 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export.mdx @@ -0,0 +1,17 @@ + +import PartialExportreference from "./export_reference.mdx" + + +
+ + +#### `export` required object[] {#experimental-syncPatches-export} + +Exports syncs a resource from the virtual cluster to the host + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/apiVersion.mdx new file mode 100755 index 000000000..781eccfdf --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `apiVersion` required string {#experimental-syncPatches-export-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/kind.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/kind.mdx new file mode 100755 index 000000000..4c4f1036e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `kind` required string {#experimental-syncPatches-export-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/optional.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/optional.mdx new file mode 100755 index 000000000..2097a2cdf --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `optional` required boolean false {#experimental-syncPatches-export-optional} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches.mdx new file mode 100755 index 000000000..a06c04920 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches.mdx @@ -0,0 +1,18 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +##### `patches` required object[] {#experimental-syncPatches-export-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions.mdx new file mode 100755 index 000000000..2c7b13bc4 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-export-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/empty.mdx new file mode 100755 index 000000000..3b8da1c2a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-syncPatches-export-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/equal.mdx new file mode 100755 index 000000000..5d21feca7 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-syncPatches-export-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..3589dc2a6 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-syncPatches-export-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/path.mdx new file mode 100755 index 000000000..5ddfe3475 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-syncPatches-export-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/subPath.mdx new file mode 100755 index 000000000..ae24513c4 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-syncPatches-export-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/fromPath.mdx new file mode 100755 index 000000000..88b08eb64 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-syncPatches-export-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/ignore.mdx new file mode 100755 index 000000000..4055c708d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-syncPatches-export-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/namePath.mdx new file mode 100755 index 000000000..ed0d951fd --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-syncPatches-export-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/namespacePath.mdx new file mode 100755 index 000000000..8d692bbac --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-syncPatches-export-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/op.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/op.mdx new file mode 100755 index 000000000..2142c2bb7 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-syncPatches-export-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/path.mdx new file mode 100755 index 000000000..c443f1618 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-syncPatches-export-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/regex.mdx new file mode 100755 index 000000000..d9f1e258d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-syncPatches-export-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync.mdx new file mode 100755 index 000000000..b67e7c2da --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-syncPatches-export-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync/configmap.mdx new file mode 100755 index 000000000..30c05de6f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-syncPatches-export-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync/secret.mdx new file mode 100755 index 000000000..37d8c394b --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-syncPatches-export-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/value.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/value.mdx new file mode 100755 index 000000000..c3d04de57 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-syncPatches-export-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches_reference.mdx new file mode 100755 index 000000000..37718d576 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-export-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-syncPatches-export-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/replaceOnConflict.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/replaceOnConflict.mdx new file mode 100755 index 000000000..54f50a3a5 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/replaceOnConflict.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `replaceOnConflict` required boolean false {#experimental-syncPatches-export-replaceOnConflict} + +ReplaceWhenInvalid determines if the controller should try to recreate the object +if there is a problem applying + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches.mdx new file mode 100755 index 000000000..d1ba14c99 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches.mdx @@ -0,0 +1,18 @@ + +import PartialReversepatchesreference from "./reversePatches_reference.mdx" + + +
+ + +##### `reversePatches` required object[] {#experimental-syncPatches-export-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions.mdx new file mode 100755 index 000000000..8890c454a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-export-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/empty.mdx new file mode 100755 index 000000000..84c84cefd --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-syncPatches-export-reversePatches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/equal.mdx new file mode 100755 index 000000000..c9cb9d606 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-syncPatches-export-reversePatches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/notEqual.mdx new file mode 100755 index 000000000..4ea70e367 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-syncPatches-export-reversePatches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/path.mdx new file mode 100755 index 000000000..41678ca86 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-syncPatches-export-reversePatches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/subPath.mdx new file mode 100755 index 000000000..d030662d5 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-syncPatches-export-reversePatches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/fromPath.mdx new file mode 100755 index 000000000..8493f20bb --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-syncPatches-export-reversePatches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/ignore.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/ignore.mdx new file mode 100755 index 000000000..c503d5d7f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-syncPatches-export-reversePatches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/namePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/namePath.mdx new file mode 100755 index 000000000..8ebcc5625 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-syncPatches-export-reversePatches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/namespacePath.mdx new file mode 100755 index 000000000..ecbb9f259 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-syncPatches-export-reversePatches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/op.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/op.mdx new file mode 100755 index 000000000..2e85743fe --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-syncPatches-export-reversePatches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/path.mdx new file mode 100755 index 000000000..a501e2dbb --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-syncPatches-export-reversePatches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/regex.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/regex.mdx new file mode 100755 index 000000000..8dd238a17 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-syncPatches-export-reversePatches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync.mdx new file mode 100755 index 000000000..dab285a72 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-syncPatches-export-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync/configmap.mdx new file mode 100755 index 000000000..d1f629956 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-syncPatches-export-reversePatches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync/secret.mdx new file mode 100755 index 000000000..d2b14b162 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-syncPatches-export-reversePatches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/value.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/value.mdx new file mode 100755 index 000000000..421033ac7 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-syncPatches-export-reversePatches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches_reference.mdx new file mode 100755 index 000000000..726462887 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/reversePatches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./reversePatches/op.mdx" +import PartialFrompath from "./reversePatches/fromPath.mdx" +import PartialPath from "./reversePatches/path.mdx" +import PartialNamepath from "./reversePatches/namePath.mdx" +import PartialNamespacepath from "./reversePatches/namespacePath.mdx" +import PartialValue from "./reversePatches/value.mdx" +import PartialRegex from "./reversePatches/regex.mdx" +import PartialConditionsreference from "./reversePatches/conditions_reference.mdx" +import PartialIgnore from "./reversePatches/ignore.mdx" +import PartialSyncreference from "./reversePatches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-export-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-syncPatches-export-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/selector.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/selector.mdx new file mode 100755 index 000000000..c0e8b99ea --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/selector.mdx @@ -0,0 +1,18 @@ + +import PartialSelectorreference from "./selector_reference.mdx" + + +
+ + +##### `selector` required {#experimental-syncPatches-export-selector} + +Selector is a label selector to select the synced objects in the virtual cluster. +If empty, all objects will be synced. + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/selector/labelSelector.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/selector/labelSelector.mdx new file mode 100755 index 000000000..383e5da0b --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/selector/labelSelector.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `labelSelector` required object {#experimental-syncPatches-export-selector-labelSelector} + +LabelSelector are the labels to select the object from + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export/selector_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export/selector_reference.mdx new file mode 100755 index 000000000..0adfa8260 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export/selector_reference.mdx @@ -0,0 +1,4 @@ + +import PartialLabelselector from "./selector/labelSelector.mdx" + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/export_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/export_reference.mdx new file mode 100755 index 000000000..224d46409 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/export_reference.mdx @@ -0,0 +1,70 @@ + +import PartialApiversion from "./export/apiVersion.mdx" +import PartialKind from "./export/kind.mdx" +import PartialOptional from "./export/optional.mdx" +import PartialReplaceonconflict from "./export/replaceOnConflict.mdx" +import PartialPatchesreference from "./export/patches_reference.mdx" +import PartialReversepatchesreference from "./export/reversePatches_reference.mdx" +import PartialSelectorreference from "./export/selector_reference.mdx" + + + + + + + + + + + + + + +
+ + +##### `patches` required object[] {#experimental-syncPatches-export-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
+ + + +
+ + +##### `reversePatches` required object[] {#experimental-syncPatches-export-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
+ + + +
+ + +##### `selector` required {#experimental-syncPatches-export-selector} + +Selector is a label selector to select the synced objects in the virtual cluster. +If empty, all objects will be synced. + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks.mdx new file mode 100755 index 000000000..c9a16c896 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks.mdx @@ -0,0 +1,17 @@ + +import PartialHooksreference from "./hooks_reference.mdx" + + +
+ + +#### `hooks` required {#experimental-syncPatches-hooks} + +Hooks are hooks that can be used to inject custom patches before syncing + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual.mdx new file mode 100755 index 000000000..50340e3b1 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual.mdx @@ -0,0 +1,17 @@ + +import PartialHosttovirtualreference from "./hostToVirtual_reference.mdx" + + +
+ + +##### `hostToVirtual` required object[] {#experimental-syncPatches-hooks-hostToVirtual} + +HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/apiVersion.mdx new file mode 100755 index 000000000..ac6811730 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `apiVersion` required string {#experimental-syncPatches-hooks-hostToVirtual-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/kind.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/kind.mdx new file mode 100755 index 000000000..cfa6aa1dc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `kind` required string {#experimental-syncPatches-hooks-hostToVirtual-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches.mdx new file mode 100755 index 000000000..04acaf9d3 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches.mdx @@ -0,0 +1,17 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +###### `patches` required object[] {#experimental-syncPatches-hooks-hostToVirtual-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions.mdx new file mode 100755 index 000000000..e84e43374 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +####### `conditions` required object[] {#experimental-syncPatches-hooks-hostToVirtual-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/empty.mdx new file mode 100755 index 000000000..d96518eca --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `empty` required boolean false {#experimental-syncPatches-hooks-hostToVirtual-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/equal.mdx new file mode 100755 index 000000000..3d267e8f8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `equal` required {#experimental-syncPatches-hooks-hostToVirtual-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..bdc95fb84 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `notEqual` required {#experimental-syncPatches-hooks-hostToVirtual-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/path.mdx new file mode 100755 index 000000000..e8025cee0 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/subPath.mdx new file mode 100755 index 000000000..04c0adf7d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `subPath` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/fromPath.mdx new file mode 100755 index 000000000..0f717161f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `fromPath` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/ignore.mdx new file mode 100755 index 000000000..b81e3a363 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `ignore` required boolean false {#experimental-syncPatches-hooks-hostToVirtual-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/namePath.mdx new file mode 100755 index 000000000..5ab262b6f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namePath` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/namespacePath.mdx new file mode 100755 index 000000000..aefa48746 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namespacePath` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/op.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/op.mdx new file mode 100755 index 000000000..3a914dcf1 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `op` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/path.mdx new file mode 100755 index 000000000..af1e05278 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/regex.mdx new file mode 100755 index 000000000..c7eb8e3d5 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `regex` required string {#experimental-syncPatches-hooks-hostToVirtual-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync.mdx new file mode 100755 index 000000000..eab7c2a9f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +####### `sync` required {#experimental-syncPatches-hooks-hostToVirtual-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync/configmap.mdx new file mode 100755 index 000000000..62c19bd17 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `configmap` required boolean false {#experimental-syncPatches-hooks-hostToVirtual-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync/secret.mdx new file mode 100755 index 000000000..14b25cbdb --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `secret` required boolean false {#experimental-syncPatches-hooks-hostToVirtual-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/value.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/value.mdx new file mode 100755 index 000000000..cd0c09c44 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `value` required {#experimental-syncPatches-hooks-hostToVirtual-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches_reference.mdx new file mode 100755 index 000000000..f1d009767 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +####### `conditions` required object[] {#experimental-syncPatches-hooks-hostToVirtual-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +####### `sync` required {#experimental-syncPatches-hooks-hostToVirtual-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/verbs.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/verbs.mdx new file mode 100755 index 000000000..fe6940c81 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual/verbs.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `verbs` required string[] {#experimental-syncPatches-hooks-hostToVirtual-verbs} + +Verbs are the verbs that the hook should mutate + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual_reference.mdx new file mode 100755 index 000000000..f521a01bc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/hostToVirtual_reference.mdx @@ -0,0 +1,29 @@ + +import PartialApiversion from "./hostToVirtual/apiVersion.mdx" +import PartialKind from "./hostToVirtual/kind.mdx" +import PartialVerbs from "./hostToVirtual/verbs.mdx" +import PartialPatchesreference from "./hostToVirtual/patches_reference.mdx" + + + + + + + + + + + +
+ + +###### `patches` required object[] {#experimental-syncPatches-hooks-hostToVirtual-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost.mdx new file mode 100755 index 000000000..196fc4129 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost.mdx @@ -0,0 +1,17 @@ + +import PartialVirtualtohostreference from "./virtualToHost_reference.mdx" + + +
+ + +##### `virtualToHost` required object[] {#experimental-syncPatches-hooks-virtualToHost} + +VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/apiVersion.mdx new file mode 100755 index 000000000..a303cb48d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `apiVersion` required string {#experimental-syncPatches-hooks-virtualToHost-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/kind.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/kind.mdx new file mode 100755 index 000000000..cacee2d8a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `kind` required string {#experimental-syncPatches-hooks-virtualToHost-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches.mdx new file mode 100755 index 000000000..1273896d8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches.mdx @@ -0,0 +1,17 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +###### `patches` required object[] {#experimental-syncPatches-hooks-virtualToHost-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions.mdx new file mode 100755 index 000000000..f76891a84 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +####### `conditions` required object[] {#experimental-syncPatches-hooks-virtualToHost-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/empty.mdx new file mode 100755 index 000000000..2eeb377db --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `empty` required boolean false {#experimental-syncPatches-hooks-virtualToHost-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/equal.mdx new file mode 100755 index 000000000..074125af7 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `equal` required {#experimental-syncPatches-hooks-virtualToHost-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..7cbc9bba3 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `notEqual` required {#experimental-syncPatches-hooks-virtualToHost-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/path.mdx new file mode 100755 index 000000000..ec83711b7 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `path` required string {#experimental-syncPatches-hooks-virtualToHost-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/subPath.mdx new file mode 100755 index 000000000..8d15a0a4c --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `subPath` required string {#experimental-syncPatches-hooks-virtualToHost-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/fromPath.mdx new file mode 100755 index 000000000..c35845e5f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `fromPath` required string {#experimental-syncPatches-hooks-virtualToHost-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/ignore.mdx new file mode 100755 index 000000000..e521b696f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `ignore` required boolean false {#experimental-syncPatches-hooks-virtualToHost-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/namePath.mdx new file mode 100755 index 000000000..eb2478174 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namePath` required string {#experimental-syncPatches-hooks-virtualToHost-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/namespacePath.mdx new file mode 100755 index 000000000..4a5b084b5 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `namespacePath` required string {#experimental-syncPatches-hooks-virtualToHost-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/op.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/op.mdx new file mode 100755 index 000000000..af4c693df --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `op` required string {#experimental-syncPatches-hooks-virtualToHost-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/path.mdx new file mode 100755 index 000000000..4a13f026c --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-syncPatches-hooks-virtualToHost-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/regex.mdx new file mode 100755 index 000000000..b80b482d7 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `regex` required string {#experimental-syncPatches-hooks-virtualToHost-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync.mdx new file mode 100755 index 000000000..a9d90da86 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +####### `sync` required {#experimental-syncPatches-hooks-virtualToHost-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync/configmap.mdx new file mode 100755 index 000000000..de1575cfc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `configmap` required boolean false {#experimental-syncPatches-hooks-virtualToHost-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync/secret.mdx new file mode 100755 index 000000000..72b77f7c4 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +######## `secret` required boolean false {#experimental-syncPatches-hooks-virtualToHost-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/value.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/value.mdx new file mode 100755 index 000000000..1913cbe3d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `value` required {#experimental-syncPatches-hooks-virtualToHost-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches_reference.mdx new file mode 100755 index 000000000..43248164d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +####### `conditions` required object[] {#experimental-syncPatches-hooks-virtualToHost-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +####### `sync` required {#experimental-syncPatches-hooks-virtualToHost-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/verbs.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/verbs.mdx new file mode 100755 index 000000000..a466a4c6e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost/verbs.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `verbs` required string[] {#experimental-syncPatches-hooks-virtualToHost-verbs} + +Verbs are the verbs that the hook should mutate + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost_reference.mdx new file mode 100755 index 000000000..198c4c800 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks/virtualToHost_reference.mdx @@ -0,0 +1,29 @@ + +import PartialApiversion from "./virtualToHost/apiVersion.mdx" +import PartialKind from "./virtualToHost/kind.mdx" +import PartialVerbs from "./virtualToHost/verbs.mdx" +import PartialPatchesreference from "./virtualToHost/patches_reference.mdx" + + + + + + + + + + + +
+ + +###### `patches` required object[] {#experimental-syncPatches-hooks-virtualToHost-patches} + +Patches are the patches to apply on the object to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/hooks_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/hooks_reference.mdx new file mode 100755 index 000000000..42943bdec --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/hooks_reference.mdx @@ -0,0 +1,34 @@ + +import PartialHosttovirtualreference from "./hooks/hostToVirtual_reference.mdx" +import PartialVirtualtohostreference from "./hooks/virtualToHost_reference.mdx" + + +
+ + +##### `hostToVirtual` required object[] {#experimental-syncPatches-hooks-hostToVirtual} + +HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster + + + + + + +
+ + + +
+ + +##### `virtualToHost` required object[] {#experimental-syncPatches-hooks-virtualToHost} + +VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import.mdx new file mode 100755 index 000000000..55fd28db5 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import.mdx @@ -0,0 +1,17 @@ + +import PartialImportreference from "./import_reference.mdx" + + +
+ + +#### `import` required object[] {#experimental-syncPatches-import} + +Imports syncs a resource from the host cluster to virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/apiVersion.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/apiVersion.mdx new file mode 100755 index 000000000..71c65ec0e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/apiVersion.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `apiVersion` required string {#experimental-syncPatches-import-apiVersion} + +APIVersion of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/kind.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/kind.mdx new file mode 100755 index 000000000..fea31657e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/kind.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `kind` required string {#experimental-syncPatches-import-kind} + +Kind of the object to sync + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/optional.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/optional.mdx new file mode 100755 index 000000000..abcf4145d --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/optional.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `optional` required boolean false {#experimental-syncPatches-import-optional} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches.mdx new file mode 100755 index 000000000..38a2d4494 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches.mdx @@ -0,0 +1,18 @@ + +import PartialPatchesreference from "./patches_reference.mdx" + + +
+ + +##### `patches` required object[] {#experimental-syncPatches-import-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions.mdx new file mode 100755 index 000000000..f5754fc19 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-import-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/empty.mdx new file mode 100755 index 000000000..798ce80ee --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-syncPatches-import-patches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/equal.mdx new file mode 100755 index 000000000..68ff64926 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-syncPatches-import-patches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/notEqual.mdx new file mode 100755 index 000000000..e9a394108 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-syncPatches-import-patches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/path.mdx new file mode 100755 index 000000000..c53372c79 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-syncPatches-import-patches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/subPath.mdx new file mode 100755 index 000000000..d3ab38b3b --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-syncPatches-import-patches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/fromPath.mdx new file mode 100755 index 000000000..8b6bd664f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-syncPatches-import-patches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/ignore.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/ignore.mdx new file mode 100755 index 000000000..ca9fc6a16 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-syncPatches-import-patches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/namePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/namePath.mdx new file mode 100755 index 000000000..c4bb959dc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-syncPatches-import-patches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/namespacePath.mdx new file mode 100755 index 000000000..07cd67361 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-syncPatches-import-patches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/op.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/op.mdx new file mode 100755 index 000000000..6bf135b60 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-syncPatches-import-patches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/path.mdx new file mode 100755 index 000000000..c0aa3db3f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-syncPatches-import-patches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/regex.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/regex.mdx new file mode 100755 index 000000000..33d5906dc --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-syncPatches-import-patches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync.mdx new file mode 100755 index 000000000..42c1fd18e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-syncPatches-import-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync/configmap.mdx new file mode 100755 index 000000000..28a14f305 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-syncPatches-import-patches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync/secret.mdx new file mode 100755 index 000000000..b6e486348 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-syncPatches-import-patches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/value.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/value.mdx new file mode 100755 index 000000000..2960bc40e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-syncPatches-import-patches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/patches_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches_reference.mdx new file mode 100755 index 000000000..42214a7f8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/patches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./patches/op.mdx" +import PartialFrompath from "./patches/fromPath.mdx" +import PartialPath from "./patches/path.mdx" +import PartialNamepath from "./patches/namePath.mdx" +import PartialNamespacepath from "./patches/namespacePath.mdx" +import PartialValue from "./patches/value.mdx" +import PartialRegex from "./patches/regex.mdx" +import PartialConditionsreference from "./patches/conditions_reference.mdx" +import PartialIgnore from "./patches/ignore.mdx" +import PartialSyncreference from "./patches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-import-patches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-syncPatches-import-patches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/replaceOnConflict.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/replaceOnConflict.mdx new file mode 100755 index 000000000..2441d5909 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/replaceOnConflict.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `replaceOnConflict` required boolean false {#experimental-syncPatches-import-replaceOnConflict} + +ReplaceWhenInvalid determines if the controller should try to recreate the object +if there is a problem applying + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches.mdx new file mode 100755 index 000000000..7cb6c810a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches.mdx @@ -0,0 +1,18 @@ + +import PartialReversepatchesreference from "./reversePatches_reference.mdx" + + +
+ + +##### `reversePatches` required object[] {#experimental-syncPatches-import-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions.mdx new file mode 100755 index 000000000..0fed33a4a --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions.mdx @@ -0,0 +1,18 @@ + +import PartialConditionsreference from "./conditions_reference.mdx" + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-import-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/empty.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/empty.mdx new file mode 100755 index 000000000..8c4a93388 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/empty.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `empty` required boolean false {#experimental-syncPatches-import-reversePatches-conditions-empty} + +Empty means that the path value should be empty or unset + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/equal.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/equal.mdx new file mode 100755 index 000000000..eacac1e78 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/equal.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `equal` required {#experimental-syncPatches-import-reversePatches-conditions-equal} + +Equal is the value the path should be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/notEqual.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/notEqual.mdx new file mode 100755 index 000000000..5ca249194 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/notEqual.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `notEqual` required {#experimental-syncPatches-import-reversePatches-conditions-notEqual} + +NotEqual is the value the path should not be equal to + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/path.mdx new file mode 100755 index 000000000..e31af8822 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/path.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `path` required string {#experimental-syncPatches-import-reversePatches-conditions-path} + +Path is the path within the object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/subPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/subPath.mdx new file mode 100755 index 000000000..8cb699335 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions/subPath.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `subPath` required string {#experimental-syncPatches-import-reversePatches-conditions-subPath} + +SubPath is the path below the selected object to select + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions_reference.mdx new file mode 100755 index 000000000..f5509ba8e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/conditions_reference.mdx @@ -0,0 +1,20 @@ + +import PartialPath from "./conditions/path.mdx" +import PartialSubpath from "./conditions/subPath.mdx" +import PartialEqual from "./conditions/equal.mdx" +import PartialNotequal from "./conditions/notEqual.mdx" +import PartialEmpty from "./conditions/empty.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/fromPath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/fromPath.mdx new file mode 100755 index 000000000..07f22195e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/fromPath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `fromPath` required string {#experimental-syncPatches-import-reversePatches-fromPath} + +FromPath is the path from the other object + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/ignore.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/ignore.mdx new file mode 100755 index 000000000..eda9992b0 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/ignore.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `ignore` required boolean false {#experimental-syncPatches-import-reversePatches-ignore} + +Ignore determines if the path should be ignored if handled as a reverse patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/namePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/namePath.mdx new file mode 100755 index 000000000..a3e15a0f9 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/namePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namePath` required string {#experimental-syncPatches-import-reversePatches-namePath} + +NamePath is the path to the name of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/namespacePath.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/namespacePath.mdx new file mode 100755 index 000000000..f22aea0e6 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/namespacePath.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `namespacePath` required string {#experimental-syncPatches-import-reversePatches-namespacePath} + +NamespacePath is path to the namespace of a child resource within Path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/op.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/op.mdx new file mode 100755 index 000000000..6e7e6a63f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/op.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `op` required string {#experimental-syncPatches-import-reversePatches-op} + +Operation is the type of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/path.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/path.mdx new file mode 100755 index 000000000..7588dc754 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/path.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `path` required string {#experimental-syncPatches-import-reversePatches-path} + +Path is the path of the patch + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/regex.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/regex.mdx new file mode 100755 index 000000000..36c1b8501 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/regex.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `regex` required string {#experimental-syncPatches-import-reversePatches-regex} + +Regex - is regular expresion used to identify the Name, +and optionally Namespace, parts of the field value that +will be replaced with the rewritten Name and/or Namespace + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync.mdx new file mode 100755 index 000000000..ac06d0473 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync.mdx @@ -0,0 +1,18 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +###### `sync` required {#experimental-syncPatches-import-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync/configmap.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync/configmap.mdx new file mode 100755 index 000000000..5b76a093c --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync/configmap.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `configmap` required boolean false {#experimental-syncPatches-import-reversePatches-sync-configmap} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync/secret.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync/secret.mdx new file mode 100755 index 000000000..848c3f997 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync/secret.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `secret` required boolean false {#experimental-syncPatches-import-reversePatches-sync-secret} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync_reference.mdx new file mode 100755 index 000000000..45c6cf11e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/sync_reference.mdx @@ -0,0 +1,8 @@ + +import PartialSecret from "./sync/secret.mdx" +import PartialConfigmap from "./sync/configmap.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/value.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/value.mdx new file mode 100755 index 000000000..7ae13a916 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches/value.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `value` required {#experimental-syncPatches-import-reversePatches-value} + +Value is the new value to be set to the path + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches_reference.mdx new file mode 100755 index 000000000..9e626dfac --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import/reversePatches_reference.mdx @@ -0,0 +1,68 @@ + +import PartialOp from "./reversePatches/op.mdx" +import PartialFrompath from "./reversePatches/fromPath.mdx" +import PartialPath from "./reversePatches/path.mdx" +import PartialNamepath from "./reversePatches/namePath.mdx" +import PartialNamespacepath from "./reversePatches/namespacePath.mdx" +import PartialValue from "./reversePatches/value.mdx" +import PartialRegex from "./reversePatches/regex.mdx" +import PartialConditionsreference from "./reversePatches/conditions_reference.mdx" +import PartialIgnore from "./reversePatches/ignore.mdx" +import PartialSyncreference from "./reversePatches/sync_reference.mdx" + + + + + + + + + + + + + + + + + + + + + + + +
+ + +###### `conditions` required object[] {#experimental-syncPatches-import-reversePatches-conditions} + +Conditions are conditions that must be true for +the patch to get executed + + + + + + +
+ + + + + + +
+ + +###### `sync` required {#experimental-syncPatches-import-reversePatches-sync} + +Sync defines if a specialized syncer should be initialized using values +from the rewriteName operation as Secret/Configmap names to be synced + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/import_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/import_reference.mdx new file mode 100755 index 000000000..b96e9d03f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/import_reference.mdx @@ -0,0 +1,52 @@ + +import PartialApiversion from "./import/apiVersion.mdx" +import PartialKind from "./import/kind.mdx" +import PartialOptional from "./import/optional.mdx" +import PartialReplaceonconflict from "./import/replaceOnConflict.mdx" +import PartialPatchesreference from "./import/patches_reference.mdx" +import PartialReversepatchesreference from "./import/reversePatches_reference.mdx" + + + + + + + + + + + + + + +
+ + +##### `patches` required object[] {#experimental-syncPatches-import-patches} + +Patches are the patches to apply on the virtual cluster objects +when syncing them from the host cluster + + + + + + +
+ + + +
+ + +##### `reversePatches` required object[] {#experimental-syncPatches-import-reversePatches} + +ReversePatches are the patches to apply to host cluster objects +after it has been synced to the virtual cluster + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches/version.mdx b/docs/pages/configuration/_partials/experimental/syncPatches/version.mdx new file mode 100755 index 000000000..f1eca9e4c --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches/version.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `version` required string {#experimental-syncPatches-version} + +Version is the config version + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncPatches_reference.mdx b/docs/pages/configuration/_partials/experimental/syncPatches_reference.mdx new file mode 100755 index 000000000..baf5a2ed6 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncPatches_reference.mdx @@ -0,0 +1,55 @@ + +import PartialVersion from "./syncPatches/version.mdx" +import PartialExportreference from "./syncPatches/export_reference.mdx" +import PartialImportreference from "./syncPatches/import_reference.mdx" +import PartialHooksreference from "./syncPatches/hooks_reference.mdx" + + + + + +
+ + +#### `export` required object[] {#experimental-syncPatches-export} + +Exports syncs a resource from the virtual cluster to the host + + + + + + +
+ + + +
+ + +#### `import` required object[] {#experimental-syncPatches-import} + +Imports syncs a resource from the host cluster to virtual cluster + + + + + + +
+ + + +
+ + +#### `hooks` required {#experimental-syncPatches-hooks} + +Hooks are hooks that can be used to inject custom patches before syncing + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncSettings.mdx b/docs/pages/configuration/_partials/experimental/syncSettings.mdx new file mode 100755 index 000000000..f0b24456f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncSettings.mdx @@ -0,0 +1,17 @@ + +import PartialSyncsettingsreference from "./syncSettings_reference.mdx" + + +
+ + +### `syncSettings` required {#experimental-syncSettings} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncSettings/disableSync.mdx b/docs/pages/configuration/_partials/experimental/syncSettings/disableSync.mdx new file mode 100755 index 000000000..46eaadbf8 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncSettings/disableSync.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `disableSync` required boolean false {#experimental-syncSettings-disableSync} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncSettings/target.mdx b/docs/pages/configuration/_partials/experimental/syncSettings/target.mdx new file mode 100755 index 000000000..3c718e597 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncSettings/target.mdx @@ -0,0 +1,17 @@ + +import PartialTargetreference from "./target_reference.mdx" + + +
+ + +#### `target` required {#experimental-syncSettings-target} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncSettings/target/namespace.mdx b/docs/pages/configuration/_partials/experimental/syncSettings/target/namespace.mdx new file mode 100755 index 000000000..718c75523 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncSettings/target/namespace.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `namespace` required string {#experimental-syncSettings-target-namespace} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental/syncSettings/target_reference.mdx b/docs/pages/configuration/_partials/experimental/syncSettings/target_reference.mdx new file mode 100755 index 000000000..69f04679f --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncSettings/target_reference.mdx @@ -0,0 +1,4 @@ + +import PartialNamespace from "./target/namespace.mdx" + + diff --git a/docs/pages/configuration/_partials/experimental/syncSettings_reference.mdx b/docs/pages/configuration/_partials/experimental/syncSettings_reference.mdx new file mode 100755 index 000000000..b7fdf107e --- /dev/null +++ b/docs/pages/configuration/_partials/experimental/syncSettings_reference.mdx @@ -0,0 +1,21 @@ + +import PartialDisablesync from "./syncSettings/disableSync.mdx" +import PartialTargetreference from "./syncSettings/target_reference.mdx" + + + + + +
+ + +#### `target` required {#experimental-syncSettings-target} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/experimental_reference.mdx b/docs/pages/configuration/_partials/experimental_reference.mdx new file mode 100755 index 000000000..fd75fc422 --- /dev/null +++ b/docs/pages/configuration/_partials/experimental_reference.mdx @@ -0,0 +1,72 @@ + +import PartialExtended from "./experimental/Extended.mdx" +import PartialSyncsettingsreference from "./experimental/syncSettings_reference.mdx" +import PartialSyncpatchesreference from "./experimental/syncPatches_reference.mdx" +import PartialGenericsyncreference from "./experimental/genericSync_reference.mdx" +import PartialInitreference from "./experimental/init_reference.mdx" + + + + + +
+ + +### `syncSettings` required {#experimental-syncSettings} + + + + + + + + +
+ + + +
+ + +### `syncPatches` required {#experimental-syncPatches} + + + + + + + + +
+ + + +
+ + +### `genericSync` required {#experimental-genericSync} + + + + + + + + +
+ + + +
+ + +### `init` required {#experimental-init} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/exportKubeConfig.mdx b/docs/pages/configuration/_partials/exportKubeConfig.mdx new file mode 100755 index 000000000..f2e7d8ec5 --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig.mdx @@ -0,0 +1,17 @@ + +import PartialExportkubeconfigreference from "./exportKubeConfig_reference.mdx" + + +
+ + +## `exportKubeConfig` required {#exportKubeConfig} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/exportKubeConfig/context.mdx b/docs/pages/configuration/_partials/exportKubeConfig/context.mdx new file mode 100755 index 000000000..0f0334cc1 --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig/context.mdx @@ -0,0 +1,13 @@ + +
+ + +### `context` required string {#exportKubeConfig-context} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/exportKubeConfig/secret.mdx b/docs/pages/configuration/_partials/exportKubeConfig/secret.mdx new file mode 100755 index 000000000..a0c88664b --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig/secret.mdx @@ -0,0 +1,17 @@ + +import PartialSecretreference from "./secret_reference.mdx" + + +
+ + +### `secret` required {#exportKubeConfig-secret} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/exportKubeConfig/secret/name.mdx b/docs/pages/configuration/_partials/exportKubeConfig/secret/name.mdx new file mode 100755 index 000000000..f8e200ea0 --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig/secret/name.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `name` required string {#exportKubeConfig-secret-name} + +name is unique within a namespace to reference a secret resource. + + + + + +
diff --git a/docs/pages/configuration/_partials/exportKubeConfig/secret/namespace.mdx b/docs/pages/configuration/_partials/exportKubeConfig/secret/namespace.mdx new file mode 100755 index 000000000..a46e4b80a --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig/secret/namespace.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `namespace` required string {#exportKubeConfig-secret-namespace} + +namespace defines the space within which the secret name must be unique. + + + + + +
diff --git a/docs/pages/configuration/_partials/exportKubeConfig/secret_reference.mdx b/docs/pages/configuration/_partials/exportKubeConfig/secret_reference.mdx new file mode 100755 index 000000000..9e5ee949c --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig/secret_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./secret/name.mdx" +import PartialNamespace from "./secret/namespace.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/exportKubeConfig/server.mdx b/docs/pages/configuration/_partials/exportKubeConfig/server.mdx new file mode 100755 index 000000000..4a7d3c6ef --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig/server.mdx @@ -0,0 +1,13 @@ + +
+ + +### `server` required string {#exportKubeConfig-server} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/exportKubeConfig_reference.mdx b/docs/pages/configuration/_partials/exportKubeConfig_reference.mdx new file mode 100755 index 000000000..d7d48b75c --- /dev/null +++ b/docs/pages/configuration/_partials/exportKubeConfig_reference.mdx @@ -0,0 +1,25 @@ + +import PartialContext from "./exportKubeConfig/context.mdx" +import PartialServer from "./exportKubeConfig/server.mdx" +import PartialSecretreference from "./exportKubeConfig/secret_reference.mdx" + + + + + + + + +
+ + +### `secret` required {#exportKubeConfig-secret} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/license.mdx b/docs/pages/configuration/_partials/license.mdx new file mode 100755 index 000000000..ecfff3858 --- /dev/null +++ b/docs/pages/configuration/_partials/license.mdx @@ -0,0 +1,17 @@ + +import PartialLicensereference from "./license_reference.mdx" + + +
+ + +## `license` required {#license} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/license/key.mdx b/docs/pages/configuration/_partials/license/key.mdx new file mode 100755 index 000000000..424515056 --- /dev/null +++ b/docs/pages/configuration/_partials/license/key.mdx @@ -0,0 +1,13 @@ + +
+ + +### `key` required string {#license-key} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/license/keySecretRef.mdx b/docs/pages/configuration/_partials/license/keySecretRef.mdx new file mode 100755 index 000000000..2317f1cf2 --- /dev/null +++ b/docs/pages/configuration/_partials/license/keySecretRef.mdx @@ -0,0 +1,17 @@ + +import PartialKeysecretrefreference from "./keySecretRef_reference.mdx" + + +
+ + +### `keySecretRef` required {#license-keySecretRef} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/license/keySecretRef/name.mdx b/docs/pages/configuration/_partials/license/keySecretRef/name.mdx new file mode 100755 index 000000000..24b6ff32b --- /dev/null +++ b/docs/pages/configuration/_partials/license/keySecretRef/name.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `name` required string {#license-keySecretRef-name} + +name is unique within a namespace to reference a secret resource. + + + + + +
diff --git a/docs/pages/configuration/_partials/license/keySecretRef/namespace.mdx b/docs/pages/configuration/_partials/license/keySecretRef/namespace.mdx new file mode 100755 index 000000000..35e836036 --- /dev/null +++ b/docs/pages/configuration/_partials/license/keySecretRef/namespace.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `namespace` required string {#license-keySecretRef-namespace} + +namespace defines the space within which the secret name must be unique. + + + + + +
diff --git a/docs/pages/configuration/_partials/license/keySecretRef_reference.mdx b/docs/pages/configuration/_partials/license/keySecretRef_reference.mdx new file mode 100755 index 000000000..657389a22 --- /dev/null +++ b/docs/pages/configuration/_partials/license/keySecretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./keySecretRef/name.mdx" +import PartialNamespace from "./keySecretRef/namespace.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/license_reference.mdx b/docs/pages/configuration/_partials/license_reference.mdx new file mode 100755 index 000000000..7d5892cf9 --- /dev/null +++ b/docs/pages/configuration/_partials/license_reference.mdx @@ -0,0 +1,21 @@ + +import PartialKey from "./license/key.mdx" +import PartialKeysecretrefreference from "./license/keySecretRef_reference.mdx" + + + + + +
+ + +### `keySecretRef` required {#license-keySecretRef} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking.mdx b/docs/pages/configuration/_partials/networking.mdx new file mode 100755 index 000000000..bd512036e --- /dev/null +++ b/docs/pages/configuration/_partials/networking.mdx @@ -0,0 +1,17 @@ + +import PartialNetworkingreference from "./networking_reference.mdx" + + +
+ + +## `networking` required {#networking} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced.mdx b/docs/pages/configuration/_partials/networking/advanced.mdx new file mode 100755 index 000000000..9c71b7ec8 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced.mdx @@ -0,0 +1,17 @@ + +import PartialAdvancedreference from "./advanced_reference.mdx" + + +
+ + +### `advanced` required {#networking-advanced} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/clusterDomain.mdx b/docs/pages/configuration/_partials/networking/advanced/clusterDomain.mdx new file mode 100755 index 000000000..4dcf7dfa3 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/clusterDomain.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `clusterDomain` required string {#networking-advanced-clusterDomain} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/fallback.mdx b/docs/pages/configuration/_partials/networking/advanced/fallback.mdx new file mode 100755 index 000000000..c2e9780f0 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/fallback.mdx @@ -0,0 +1,17 @@ + +import PartialFallbackreference from "./fallback_reference.mdx" + + +
+ + +#### `fallback` required object[] {#networking-advanced-fallback} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/fallback/hostCluster.mdx b/docs/pages/configuration/_partials/networking/advanced/fallback/hostCluster.mdx new file mode 100755 index 000000000..b6382ef2e --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/fallback/hostCluster.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `hostCluster` required boolean false {#networking-advanced-fallback-hostCluster} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/fallback/ip.mdx b/docs/pages/configuration/_partials/networking/advanced/fallback/ip.mdx new file mode 100755 index 000000000..94eb7b428 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/fallback/ip.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `ip` required string {#networking-advanced-fallback-ip} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/fallback_reference.mdx b/docs/pages/configuration/_partials/networking/advanced/fallback_reference.mdx new file mode 100755 index 000000000..f714a080b --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/fallback_reference.mdx @@ -0,0 +1,8 @@ + +import PartialIp from "./fallback/ip.mdx" +import PartialHostcluster from "./fallback/hostCluster.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/networking/advanced/proxyKubelets.mdx b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets.mdx new file mode 100755 index 000000000..358bc3e02 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets.mdx @@ -0,0 +1,17 @@ + +import PartialProxykubeletsreference from "./proxyKubelets_reference.mdx" + + +
+ + +#### `proxyKubelets` required {#networking-advanced-proxyKubelets} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/proxyKubelets/byHostname.mdx b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets/byHostname.mdx new file mode 100755 index 000000000..d7fda65e8 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets/byHostname.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `byHostname` required boolean false {#networking-advanced-proxyKubelets-byHostname} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/proxyKubelets/byIP.mdx b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets/byIP.mdx new file mode 100755 index 000000000..678e0bfd5 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets/byIP.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `byIP` required boolean false {#networking-advanced-proxyKubelets-byIP} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/advanced/proxyKubelets_reference.mdx b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets_reference.mdx new file mode 100755 index 000000000..08b371f05 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced/proxyKubelets_reference.mdx @@ -0,0 +1,8 @@ + +import PartialByhostname from "./proxyKubelets/byHostname.mdx" +import PartialByip from "./proxyKubelets/byIP.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/networking/advanced_reference.mdx b/docs/pages/configuration/_partials/networking/advanced_reference.mdx new file mode 100755 index 000000000..b48f778f3 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/advanced_reference.mdx @@ -0,0 +1,38 @@ + +import PartialClusterdomain from "./advanced/clusterDomain.mdx" +import PartialFallbackreference from "./advanced/fallback_reference.mdx" +import PartialProxykubeletsreference from "./advanced/proxyKubelets_reference.mdx" + + + + + +
+ + +#### `fallback` required object[] {#networking-advanced-fallback} + + + + + + + + +
+ + + +
+ + +#### `proxyKubelets` required {#networking-advanced-proxyKubelets} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices.mdx b/docs/pages/configuration/_partials/networking/replicateServices.mdx new file mode 100755 index 000000000..d5e85e7b4 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices.mdx @@ -0,0 +1,17 @@ + +import PartialReplicateservicesreference from "./replicateServices_reference.mdx" + + +
+ + +### `replicateServices` required {#networking-replicateServices} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices/fromHost.mdx b/docs/pages/configuration/_partials/networking/replicateServices/fromHost.mdx new file mode 100755 index 000000000..13da3096d --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/fromHost.mdx @@ -0,0 +1,17 @@ + +import PartialFromhostreference from "./fromHost_reference.mdx" + + +
+ + +#### `fromHost` required {#networking-replicateServices-fromHost} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices/fromHost/from.mdx b/docs/pages/configuration/_partials/networking/replicateServices/fromHost/from.mdx new file mode 100755 index 000000000..d1d73d668 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/fromHost/from.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `from` required string {#networking-replicateServices-fromHost-from} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices/fromHost/to.mdx b/docs/pages/configuration/_partials/networking/replicateServices/fromHost/to.mdx new file mode 100755 index 000000000..a4c9c8343 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/fromHost/to.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `to` required string {#networking-replicateServices-fromHost-to} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices/fromHost_reference.mdx b/docs/pages/configuration/_partials/networking/replicateServices/fromHost_reference.mdx new file mode 100755 index 000000000..d9806f59d --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/fromHost_reference.mdx @@ -0,0 +1,8 @@ + +import PartialFrom from "./fromHost/from.mdx" +import PartialTo from "./fromHost/to.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/networking/replicateServices/toHost.mdx b/docs/pages/configuration/_partials/networking/replicateServices/toHost.mdx new file mode 100755 index 000000000..6cfbe7b59 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/toHost.mdx @@ -0,0 +1,17 @@ + +import PartialTohostreference from "./toHost_reference.mdx" + + +
+ + +#### `toHost` required {#networking-replicateServices-toHost} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices/toHost/from.mdx b/docs/pages/configuration/_partials/networking/replicateServices/toHost/from.mdx new file mode 100755 index 000000000..dbd91daef --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/toHost/from.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `from` required string {#networking-replicateServices-toHost-from} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices/toHost/to.mdx b/docs/pages/configuration/_partials/networking/replicateServices/toHost/to.mdx new file mode 100755 index 000000000..cf5061479 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/toHost/to.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `to` required string {#networking-replicateServices-toHost-to} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/replicateServices/toHost_reference.mdx b/docs/pages/configuration/_partials/networking/replicateServices/toHost_reference.mdx new file mode 100755 index 000000000..b52142917 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices/toHost_reference.mdx @@ -0,0 +1,8 @@ + +import PartialFrom from "./toHost/from.mdx" +import PartialTo from "./toHost/to.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/networking/replicateServices_reference.mdx b/docs/pages/configuration/_partials/networking/replicateServices_reference.mdx new file mode 100755 index 000000000..bdf31364f --- /dev/null +++ b/docs/pages/configuration/_partials/networking/replicateServices_reference.mdx @@ -0,0 +1,34 @@ + +import PartialTohostreference from "./replicateServices/toHost_reference.mdx" +import PartialFromhostreference from "./replicateServices/fromHost_reference.mdx" + + +
+ + +#### `toHost` required {#networking-replicateServices-toHost} + + + + + + + + +
+ + + +
+ + +#### `fromHost` required {#networking-replicateServices-fromHost} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices.mdx b/docs/pages/configuration/_partials/networking/resolveServices.mdx new file mode 100755 index 000000000..054e8682b --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices.mdx @@ -0,0 +1,17 @@ + +import PartialResolveservicesreference from "./resolveServices_reference.mdx" + + +
+ + +### `resolveServices` required {#networking-resolveServices} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/service.mdx b/docs/pages/configuration/_partials/networking/resolveServices/service.mdx new file mode 100755 index 000000000..c7cee1d38 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/service.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `service` required string {#networking-resolveServices-service} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target.mdx new file mode 100755 index 000000000..0ddc89849 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target.mdx @@ -0,0 +1,17 @@ + +import PartialTargetreference from "./target_reference.mdx" + + +
+ + +#### `target` required {#networking-resolveServices-target} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/external.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/external.mdx new file mode 100755 index 000000000..9cc428622 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/external.mdx @@ -0,0 +1,17 @@ + +import PartialExternalreference from "./external_reference.mdx" + + +
+ + +##### `external` required {#networking-resolveServices-target-external} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/external/hostname.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/external/hostname.mdx new file mode 100755 index 000000000..b1ac2833d --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/external/hostname.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `hostname` required string {#networking-resolveServices-target-external-hostname} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/external_reference.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/external_reference.mdx new file mode 100755 index 000000000..b85f3dcf0 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/external_reference.mdx @@ -0,0 +1,4 @@ + +import PartialHostname from "./external/hostname.mdx" + + diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/host.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/host.mdx new file mode 100755 index 000000000..bb560484c --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/host.mdx @@ -0,0 +1,17 @@ + +import PartialHostreference from "./host_reference.mdx" + + +
+ + +##### `host` required {#networking-resolveServices-target-host} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/host/service.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/host/service.mdx new file mode 100755 index 000000000..b5ccaf879 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/host/service.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `service` required string {#networking-resolveServices-target-host-service} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/host_reference.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/host_reference.mdx new file mode 100755 index 000000000..81b91eb9a --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/host_reference.mdx @@ -0,0 +1,4 @@ + +import PartialService from "./host/service.mdx" + + diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster.mdx new file mode 100755 index 000000000..b1fd6f5cd --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster.mdx @@ -0,0 +1,17 @@ + +import PartialVclusterreference from "./vcluster_reference.mdx" + + +
+ + +##### `vcluster` required {#networking-resolveServices-target-vcluster} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster/service.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster/service.mdx new file mode 100755 index 000000000..6a1410aea --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster/service.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `service` required string {#networking-resolveServices-target-vcluster-service} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster_reference.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster_reference.mdx new file mode 100755 index 000000000..fd6b0f090 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target/vcluster_reference.mdx @@ -0,0 +1,4 @@ + +import PartialService from "./vcluster/service.mdx" + + diff --git a/docs/pages/configuration/_partials/networking/resolveServices/target_reference.mdx b/docs/pages/configuration/_partials/networking/resolveServices/target_reference.mdx new file mode 100755 index 000000000..a5ac2023a --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices/target_reference.mdx @@ -0,0 +1,51 @@ + +import PartialVclusterreference from "./target/vcluster_reference.mdx" +import PartialHostreference from "./target/host_reference.mdx" +import PartialExternalreference from "./target/external_reference.mdx" + + +
+ + +##### `vcluster` required {#networking-resolveServices-target-vcluster} + + + + + + + + +
+ + + +
+ + +##### `host` required {#networking-resolveServices-target-host} + + + + + + + + +
+ + + +
+ + +##### `external` required {#networking-resolveServices-target-external} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking/resolveServices_reference.mdx b/docs/pages/configuration/_partials/networking/resolveServices_reference.mdx new file mode 100755 index 000000000..cc93365a5 --- /dev/null +++ b/docs/pages/configuration/_partials/networking/resolveServices_reference.mdx @@ -0,0 +1,21 @@ + +import PartialService from "./resolveServices/service.mdx" +import PartialTargetreference from "./resolveServices/target_reference.mdx" + + + + + +
+ + +#### `target` required {#networking-resolveServices-target} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/networking_reference.mdx b/docs/pages/configuration/_partials/networking_reference.mdx new file mode 100755 index 000000000..0fc2313b5 --- /dev/null +++ b/docs/pages/configuration/_partials/networking_reference.mdx @@ -0,0 +1,51 @@ + +import PartialReplicateservicesreference from "./networking/replicateServices_reference.mdx" +import PartialResolveservicesreference from "./networking/resolveServices_reference.mdx" +import PartialAdvancedreference from "./networking/advanced_reference.mdx" + + +
+ + +### `replicateServices` required {#networking-replicateServices} + + + + + + + + +
+ + + +
+ + +### `resolveServices` required {#networking-resolveServices} + + + + + + + + +
+ + + +
+ + +### `advanced` required {#networking-advanced} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability.mdx b/docs/pages/configuration/_partials/observability.mdx new file mode 100755 index 000000000..e9591ea45 --- /dev/null +++ b/docs/pages/configuration/_partials/observability.mdx @@ -0,0 +1,17 @@ + +import PartialObservabilityreference from "./observability_reference.mdx" + + +
+ + +## `observability` required {#observability} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics.mdx b/docs/pages/configuration/_partials/observability/metrics.mdx new file mode 100755 index 000000000..127bc239c --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics.mdx @@ -0,0 +1,17 @@ + +import PartialMetricsreference from "./metrics_reference.mdx" + + +
+ + +### `metrics` required {#observability-metrics} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy.mdx new file mode 100755 index 000000000..09e8829b4 --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy.mdx @@ -0,0 +1,17 @@ + +import PartialProxyreference from "./proxy_reference.mdx" + + +
+ + +#### `proxy` required {#observability-metrics-proxy} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy/nodes.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy/nodes.mdx new file mode 100755 index 000000000..d0f5afe53 --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy/nodes.mdx @@ -0,0 +1,17 @@ + +import PartialNodesreference from "./nodes_reference.mdx" + + +
+ + +##### `nodes` required {#observability-metrics-proxy-nodes} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy/nodes/enabled.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy/nodes/enabled.mdx new file mode 100755 index 000000000..2fbfbeb4e --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy/nodes/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `enabled` required boolean false {#observability-metrics-proxy-nodes-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy/nodes_reference.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy/nodes_reference.mdx new file mode 100755 index 000000000..2c50ea052 --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy/nodes_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./nodes/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy/pods.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy/pods.mdx new file mode 100755 index 000000000..f321cc49e --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy/pods.mdx @@ -0,0 +1,17 @@ + +import PartialPodsreference from "./pods_reference.mdx" + + +
+ + +##### `pods` required {#observability-metrics-proxy-pods} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy/pods/enabled.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy/pods/enabled.mdx new file mode 100755 index 000000000..ed58fcbf3 --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy/pods/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `enabled` required boolean false {#observability-metrics-proxy-pods-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy/pods_reference.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy/pods_reference.mdx new file mode 100755 index 000000000..91099bada --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy/pods_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./pods/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/observability/metrics/proxy_reference.mdx b/docs/pages/configuration/_partials/observability/metrics/proxy_reference.mdx new file mode 100755 index 000000000..0e2c18418 --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics/proxy_reference.mdx @@ -0,0 +1,34 @@ + +import PartialNodesreference from "./proxy/nodes_reference.mdx" +import PartialPodsreference from "./proxy/pods_reference.mdx" + + +
+ + +##### `nodes` required {#observability-metrics-proxy-nodes} + + + + + + + + +
+ + + +
+ + +##### `pods` required {#observability-metrics-proxy-pods} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/metrics_reference.mdx b/docs/pages/configuration/_partials/observability/metrics_reference.mdx new file mode 100755 index 000000000..8f763b926 --- /dev/null +++ b/docs/pages/configuration/_partials/observability/metrics_reference.mdx @@ -0,0 +1,17 @@ + +import PartialProxyreference from "./metrics/proxy_reference.mdx" + + +
+ + +#### `proxy` required {#observability-metrics-proxy} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/serviceMonitor.mdx b/docs/pages/configuration/_partials/observability/serviceMonitor.mdx new file mode 100755 index 000000000..1201b2023 --- /dev/null +++ b/docs/pages/configuration/_partials/observability/serviceMonitor.mdx @@ -0,0 +1,17 @@ + +import PartialServicemonitorreference from "./serviceMonitor_reference.mdx" + + +
+ + +### `serviceMonitor` required {#observability-serviceMonitor} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/serviceMonitor/enabled.mdx b/docs/pages/configuration/_partials/observability/serviceMonitor/enabled.mdx new file mode 100755 index 000000000..0bff82bae --- /dev/null +++ b/docs/pages/configuration/_partials/observability/serviceMonitor/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#observability-serviceMonitor-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/observability/serviceMonitor_reference.mdx b/docs/pages/configuration/_partials/observability/serviceMonitor_reference.mdx new file mode 100755 index 000000000..4b3c20f7e --- /dev/null +++ b/docs/pages/configuration/_partials/observability/serviceMonitor_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./serviceMonitor/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/observability_reference.mdx b/docs/pages/configuration/_partials/observability_reference.mdx new file mode 100755 index 000000000..253b251ad --- /dev/null +++ b/docs/pages/configuration/_partials/observability_reference.mdx @@ -0,0 +1,34 @@ + +import PartialServicemonitorreference from "./observability/serviceMonitor_reference.mdx" +import PartialMetricsreference from "./observability/metrics_reference.mdx" + + +
+ + +### `serviceMonitor` required {#observability-serviceMonitor} + + + + + + + + +
+ + + +
+ + +### `metrics` required {#observability-metrics} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform.mdx b/docs/pages/configuration/_partials/platform.mdx new file mode 100755 index 000000000..265be0c48 --- /dev/null +++ b/docs/pages/configuration/_partials/platform.mdx @@ -0,0 +1,17 @@ + +import PartialPlatformreference from "./platform_reference.mdx" + + +
+ + +## `platform` required {#platform} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/apiKey.mdx b/docs/pages/configuration/_partials/platform/apiKey.mdx new file mode 100755 index 000000000..8eaae4af0 --- /dev/null +++ b/docs/pages/configuration/_partials/platform/apiKey.mdx @@ -0,0 +1,17 @@ + +import PartialApikeyreference from "./apiKey_reference.mdx" + + +
+ + +### `apiKey` required {#platform-apiKey} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/apiKey/key.mdx b/docs/pages/configuration/_partials/platform/apiKey/key.mdx new file mode 100755 index 000000000..21ebf45d4 --- /dev/null +++ b/docs/pages/configuration/_partials/platform/apiKey/key.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `key` required string {#platform-apiKey-key} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/apiKey/keySecretRef.mdx b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef.mdx new file mode 100755 index 000000000..4d03427dd --- /dev/null +++ b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef.mdx @@ -0,0 +1,17 @@ + +import PartialKeysecretrefreference from "./keySecretRef_reference.mdx" + + +
+ + +#### `keySecretRef` required {#platform-apiKey-keySecretRef} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/apiKey/keySecretRef/name.mdx b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef/name.mdx new file mode 100755 index 000000000..0ef9fc00c --- /dev/null +++ b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef/name.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `name` required string {#platform-apiKey-keySecretRef-name} + +name is unique within a namespace to reference a secret resource. + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/apiKey/keySecretRef/namespace.mdx b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef/namespace.mdx new file mode 100755 index 000000000..7e256805f --- /dev/null +++ b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef/namespace.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `namespace` required string {#platform-apiKey-keySecretRef-namespace} + +namespace defines the space within which the secret name must be unique. + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/apiKey/keySecretRef_reference.mdx b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef_reference.mdx new file mode 100755 index 000000000..657389a22 --- /dev/null +++ b/docs/pages/configuration/_partials/platform/apiKey/keySecretRef_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./keySecretRef/name.mdx" +import PartialNamespace from "./keySecretRef/namespace.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/platform/apiKey_reference.mdx b/docs/pages/configuration/_partials/platform/apiKey_reference.mdx new file mode 100755 index 000000000..12a60606a --- /dev/null +++ b/docs/pages/configuration/_partials/platform/apiKey_reference.mdx @@ -0,0 +1,21 @@ + +import PartialKey from "./apiKey/key.mdx" +import PartialKeysecretrefreference from "./apiKey/keySecretRef_reference.mdx" + + + + + +
+ + +#### `keySecretRef` required {#platform-apiKey-keySecretRef} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/name.mdx b/docs/pages/configuration/_partials/platform/name.mdx new file mode 100755 index 000000000..a866f7134 --- /dev/null +++ b/docs/pages/configuration/_partials/platform/name.mdx @@ -0,0 +1,13 @@ + +
+ + +### `name` required string {#platform-name} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/owner.mdx b/docs/pages/configuration/_partials/platform/owner.mdx new file mode 100755 index 000000000..0aaeecd65 --- /dev/null +++ b/docs/pages/configuration/_partials/platform/owner.mdx @@ -0,0 +1,13 @@ + +
+ + +### `owner` required string {#platform-owner} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform/project.mdx b/docs/pages/configuration/_partials/platform/project.mdx new file mode 100755 index 000000000..296499dcf --- /dev/null +++ b/docs/pages/configuration/_partials/platform/project.mdx @@ -0,0 +1,13 @@ + +
+ + +### `project` required string {#platform-project} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/platform_reference.mdx b/docs/pages/configuration/_partials/platform_reference.mdx new file mode 100755 index 000000000..3b49ff31f --- /dev/null +++ b/docs/pages/configuration/_partials/platform_reference.mdx @@ -0,0 +1,29 @@ + +import PartialName from "./platform/name.mdx" +import PartialOwner from "./platform/owner.mdx" +import PartialProject from "./platform/project.mdx" +import PartialApikeyreference from "./platform/apiKey_reference.mdx" + + + + + + + + + + + +
+ + +### `apiKey` required {#platform-apiKey} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/plugin.mdx b/docs/pages/configuration/_partials/plugin.mdx new file mode 100755 index 000000000..15d1706d6 --- /dev/null +++ b/docs/pages/configuration/_partials/plugin.mdx @@ -0,0 +1,13 @@ + +
+ + +## `plugin` required object {#plugin} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/plugins.mdx b/docs/pages/configuration/_partials/plugins.mdx new file mode 100755 index 000000000..ed46dea55 --- /dev/null +++ b/docs/pages/configuration/_partials/plugins.mdx @@ -0,0 +1,13 @@ + +
+ + +## `plugins` required object {#plugins} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies.mdx b/docs/pages/configuration/_partials/policies.mdx new file mode 100755 index 000000000..a7be5d9bc --- /dev/null +++ b/docs/pages/configuration/_partials/policies.mdx @@ -0,0 +1,17 @@ + +import PartialPoliciesreference from "./policies_reference.mdx" + + +
+ + +## `policies` required {#policies} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl.mdx b/docs/pages/configuration/_partials/policies/admissionControl.mdx new file mode 100755 index 000000000..b1cc5e82d --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl.mdx @@ -0,0 +1,17 @@ + +import PartialAdmissioncontrolreference from "./admissionControl_reference.mdx" + + +
+ + +### `admissionControl` required {#policies-admissionControl} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks.mdx new file mode 100755 index 000000000..573978714 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks.mdx @@ -0,0 +1,17 @@ + +import PartialMutatingwebhooksreference from "./mutatingWebhooks_reference.mdx" + + +
+ + +#### `mutatingWebhooks` required object[] {#policies-admissionControl-mutatingWebhooks} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/admissionReviewVersions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/admissionReviewVersions.mdx new file mode 100755 index 000000000..15812cfef --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/admissionReviewVersions.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `admissionReviewVersions` required string[] {#policies-admissionControl-mutatingWebhooks-admissionReviewVersions} + +AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` +versions the Webhook expects. API server will try to use first version in +the list which it supports. If none of the versions specified in this list +supported by API server, validation will fail for this object. +If a persisted webhook configuration specifies allowed versions and does not +include any versions known to the API Server, calls to the webhook will fail +and be subject to the failure policy. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig.mdx new file mode 100755 index 000000000..f4d20b818 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig.mdx @@ -0,0 +1,18 @@ + +import PartialClientconfigreference from "./clientConfig_reference.mdx" + + +
+ + +##### `clientConfig` required {#policies-admissionControl-mutatingWebhooks-clientConfig} + +ClientConfig defines how to communicate with the hook. +Required + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/caBundle.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/caBundle.mdx new file mode 100755 index 000000000..4bfdb4237 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/caBundle.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `caBundle` required string {#policies-admissionControl-mutatingWebhooks-clientConfig-caBundle} + +`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. +If unspecified, system trust roots on the apiserver are used. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service.mdx new file mode 100755 index 000000000..197d179b9 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service.mdx @@ -0,0 +1,21 @@ + +import PartialServicereference from "./service_reference.mdx" + + +
+ + +###### `service` required {#policies-admissionControl-mutatingWebhooks-clientConfig-service} + +`service` is a reference to the service for this webhook. Either +`service` or `url` must be specified. + +If the webhook is running within the cluster, then you should use `service`. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/name.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/name.mdx new file mode 100755 index 000000000..2d20b50e5 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/name.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `name` required string {#policies-admissionControl-mutatingWebhooks-clientConfig-service-name} + +`name` is the name of the service. +Required + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/namespace.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/namespace.mdx new file mode 100755 index 000000000..85bd6a8aa --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/namespace.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `namespace` required string {#policies-admissionControl-mutatingWebhooks-clientConfig-service-namespace} + +`namespace` is the namespace of the service. +Required + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/path.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/path.mdx new file mode 100755 index 000000000..d58051c65 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/path.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `path` required string {#policies-admissionControl-mutatingWebhooks-clientConfig-service-path} + +`path` is an optional URL path which will be sent in any request to +this service. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/port.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/port.mdx new file mode 100755 index 000000000..03157b92a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service/port.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `port` required integer {#policies-admissionControl-mutatingWebhooks-clientConfig-service-port} + +If specified, the port on the service that hosting webhook. +Default to 443 for backward compatibility. +`port` should be a valid port number (1-65535, inclusive). + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service_reference.mdx new file mode 100755 index 000000000..0236214af --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/service_reference.mdx @@ -0,0 +1,16 @@ + +import PartialNamespace from "./service/namespace.mdx" +import PartialName from "./service/name.mdx" +import PartialPath from "./service/path.mdx" +import PartialPort from "./service/port.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/url.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/url.mdx new file mode 100755 index 000000000..227824d8c --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig/url.mdx @@ -0,0 +1,38 @@ + +
+ + +###### `url` required string {#policies-admissionControl-mutatingWebhooks-clientConfig-url} + +`url` gives the location of the webhook, in standard URL form +(`scheme://host:port/path`). Exactly one of `url` or `service` +must be specified. + +The `host` should not refer to a service running in the cluster; use +the `service` field instead. The host might be resolved via external +DNS in some apiservers (e.g., `kube-apiserver` cannot resolve +in-cluster DNS as that would be a layering violation). `host` may +also be an IP address. + +Please note that using `localhost` or `127.0.0.1` as a `host` is +risky unless you take great care to run this webhook on all hosts +which run an apiserver which might need to make calls to this +webhook. Such installs are likely to be non-portable, i.e., not easy +to turn up in a new cluster. + +The scheme must be "https"; the URL must begin with "https://". + +A path is optional, and if present may be any string permissible in +a URL. You may use the path to pass an arbitrary string to the +webhook, for example, a cluster identifier. + +Attempting to use a user or basic auth e.g. "user:password@" is not +allowed. Fragments ("#...") and query parameters ("?...") are not +allowed, either. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig_reference.mdx new file mode 100755 index 000000000..e431f5492 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/clientConfig_reference.mdx @@ -0,0 +1,29 @@ + +import PartialUrl from "./clientConfig/url.mdx" +import PartialServicereference from "./clientConfig/service_reference.mdx" +import PartialCabundle from "./clientConfig/caBundle.mdx" + + + + + +
+ + +###### `service` required {#policies-admissionControl-mutatingWebhooks-clientConfig-service} + +`service` is a reference to the service for this webhook. Either +`service` or `url` must be specified. + +If the webhook is running within the cluster, then you should use `service`. + + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/failurePolicy.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/failurePolicy.mdx new file mode 100755 index 000000000..b2759a731 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/failurePolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `failurePolicy` required string {#policies-admissionControl-mutatingWebhooks-failurePolicy} + +FailurePolicy defines how unrecognized errors from the admission endpoint are handled - +allowed values are Ignore or Fail. Defaults to Fail. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions.mdx new file mode 100755 index 000000000..8f67f78e3 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions.mdx @@ -0,0 +1,30 @@ + +import PartialMatchconditionsreference from "./matchConditions_reference.mdx" + + +
+ + +##### `matchConditions` required object[] {#policies-admissionControl-mutatingWebhooks-matchConditions} + +MatchConditions is a list of conditions that must be met for a request to be sent to this +webhook. Match conditions filter requests that have already been matched by the rules, +namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. +There are a maximum of 64 match conditions allowed. + +The exact matching logic is (in order): + 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. + 2. If ALL matchConditions evaluate to TRUE, the webhook is called. + 3. If any matchCondition evaluates to an error (but none are FALSE): + - If failurePolicy=Fail, reject the request + - If failurePolicy=Ignore, the error is ignored and the webhook is skipped + +This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions/expression.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions/expression.mdx new file mode 100755 index 000000000..af0de8c75 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions/expression.mdx @@ -0,0 +1,25 @@ + +
+ + +###### `expression` required string {#policies-admissionControl-mutatingWebhooks-matchConditions-expression} + +Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. +CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: + +'object' - The object from the incoming request. The value is null for DELETE requests. +'oldObject' - The existing object. The value is null for CREATE requests. +'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). +'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. + See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz +'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the + request resource. +Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ + +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions/name.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions/name.mdx new file mode 100755 index 000000000..79fce8649 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions/name.mdx @@ -0,0 +1,21 @@ + +
+ + +###### `name` required string {#policies-admissionControl-mutatingWebhooks-matchConditions-name} + +Name is an identifier for this match condition, used for strategic merging of MatchConditions, +as well as providing an identifier for logging purposes. A good name should be descriptive of +the associated expression. +Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and +must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or +'123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an +optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') + +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions_reference.mdx new file mode 100755 index 000000000..45e8ad735 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchConditions_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./matchConditions/name.mdx" +import PartialExpression from "./matchConditions/expression.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchPolicy.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchPolicy.mdx new file mode 100755 index 000000000..f70c3e27c --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/matchPolicy.mdx @@ -0,0 +1,26 @@ + +
+ + +##### `matchPolicy` required string {#policies-admissionControl-mutatingWebhooks-matchPolicy} + +matchPolicy defines how the "rules" list is used to match incoming requests. +Allowed values are "Exact" or "Equivalent". + +- Exact: match a request only if it exactly matches a specified rule. +For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, +but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, +a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. +For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, +and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, +a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Equivalent" + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/name.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/name.mdx new file mode 100755 index 000000000..0feceec3b --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/name.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `name` required string {#policies-admissionControl-mutatingWebhooks-name} + +The name of the admission webhook. +Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where +"imagepolicy" is the name of the webhook, and kubernetes.io is the name +of the organization. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector.mdx new file mode 100755 index 000000000..76ac1b2a9 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector.mdx @@ -0,0 +1,59 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +##### `namespaceSelector` required {#policies-admissionControl-mutatingWebhooks-namespaceSelector} + +NamespaceSelector decides whether to run the webhook on an object based +on whether the namespace for that object matches the selector. If the +object itself is a namespace, the matching is performed on +object.metadata.labels. If the object is another cluster scoped resource, +it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not +associated with "runlevel" of "0" or "1"; you will set the selector as +follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "runlevel", + "operator": "NotIn", + "values": [ + "0", + "1" + ] + } + ] +} + +If instead you want to only run the webhook on any objects whose +namespace is associated with the "environment" of "prod" or "staging"; +you will set the selector as follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "environment", + "operator": "In", + "values": [ + "prod", + "staging" + ] + } + ] +} + +See +https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..6a33a92ed --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-mutatingWebhooks-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..775e67dc2 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `key` required string {#policies-admissionControl-mutatingWebhooks-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..6e99bc44a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `operator` required string {#policies-admissionControl-mutatingWebhooks-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..f3b082588 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `values` required string[] {#policies-admissionControl-mutatingWebhooks-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..14a33f5d5 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `matchLabels` required object {#policies-admissionControl-mutatingWebhooks-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector_reference.mdx new file mode 100755 index 000000000..9be9c5a85 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-mutatingWebhooks-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector.mdx new file mode 100755 index 000000000..ad99b80f9 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector.mdx @@ -0,0 +1,27 @@ + +import PartialObjectselectorreference from "./objectSelector_reference.mdx" + + +
+ + +##### `objectSelector` required {#policies-admissionControl-mutatingWebhooks-objectSelector} + +ObjectSelector decides whether to run the webhook based on if the +object has matching labels. objectSelector is evaluated against both +the oldObject and newObject that would be sent to the webhook, and +is considered to match if either object matches the selector. A null +object (oldObject in the case of create, or newObject in the case of +delete) or an object that cannot have labels (like a +DeploymentRollback or a PodProxyOptions object) is not considered to +match. +Use the object selector only if the webhook is opt-in, because end +users may skip the admission webhook by setting the labels. +Default to the empty LabelSelector, which matches everything. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions.mdx new file mode 100755 index 000000000..9f9701832 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-mutatingWebhooks-objectSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..082f99853 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `key` required string {#policies-admissionControl-mutatingWebhooks-objectSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..e8ae8dc9d --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `operator` required string {#policies-admissionControl-mutatingWebhooks-objectSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..8710c5354 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `values` required string[] {#policies-admissionControl-mutatingWebhooks-objectSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchLabels.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchLabels.mdx new file mode 100755 index 000000000..3650147fd --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `matchLabels` required object {#policies-admissionControl-mutatingWebhooks-objectSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector_reference.mdx new file mode 100755 index 000000000..0f7bdd9e6 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/objectSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./objectSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./objectSelector/matchExpressions_reference.mdx" + + + + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-mutatingWebhooks-objectSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/reinvocationPolicy.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/reinvocationPolicy.mdx new file mode 100755 index 000000000..859f9c23f --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/reinvocationPolicy.mdx @@ -0,0 +1,27 @@ + +
+ + +##### `reinvocationPolicy` required string {#policies-admissionControl-mutatingWebhooks-reinvocationPolicy} + +reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. +Allowed values are "Never" and "IfNeeded". + +Never: the webhook will not be called more than once in a single admission evaluation. + +IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation +if the object being admitted is modified by other admission plugins after the initial webhook call. +Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. +Note: +* the number of additional invocations is not guaranteed to be exactly one. +* if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. +* webhooks that use this option may be reordered to minimize the number of additional invocations. +* to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. + +Defaults to "Never". + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules.mdx new file mode 100755 index 000000000..1b572d50a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules.mdx @@ -0,0 +1,22 @@ + +import PartialRulesreference from "./rules_reference.mdx" + + +
+ + +##### `rules` required object[] {#policies-admissionControl-mutatingWebhooks-rules} + +Rules describes what operations on what resources/subresources the webhook cares about. +The webhook cares about an operation if it matches _any_ Rule. +However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks +from putting the cluster in a state which cannot be recovered from without completely +disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called +on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/apiGroups.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/apiGroups.mdx new file mode 100755 index 000000000..9e19fa88d --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/apiGroups.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `apiGroups` required string[] {#policies-admissionControl-mutatingWebhooks-rules-apiGroups} + +APIGroups is the API groups the resources belong to. '*' is all groups. +If '*' is present, the length of the slice must be one. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/apiVersions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/apiVersions.mdx new file mode 100755 index 000000000..abe0f6e1d --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/apiVersions.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `apiVersions` required string[] {#policies-admissionControl-mutatingWebhooks-rules-apiVersions} + +APIVersions is the API versions the resources belong to. '*' is all versions. +If '*' is present, the length of the slice must be one. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/operations.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/operations.mdx new file mode 100755 index 000000000..2a8b3b834 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/operations.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `operations` required string[] {#policies-admissionControl-mutatingWebhooks-rules-operations} + +Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * +for all of those operations and any future admission operations that are added. +If '*' is present, the length of the slice must be one. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/resources.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/resources.mdx new file mode 100755 index 000000000..785bde54e --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/resources.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `resources` required string[] {#policies-admissionControl-mutatingWebhooks-rules-resources} + +Resources is a list of resources this rule applies to. + +For example: +'pods' means pods. +'pods/log' means the log subresource of pods. +'*' means all resources, but not subresources. +'pods/*' means all subresources of pods. +'*/scale' means all scale subresources. +'*/*' means all resources and their subresources. + +If wildcard is present, the validation rule will ensure resources do not +overlap with each other. + +Depending on the enclosing object, subresources might not be allowed. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/scope.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/scope.mdx new file mode 100755 index 000000000..944772425 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules/scope.mdx @@ -0,0 +1,21 @@ + +
+ + +###### `scope` required string {#policies-admissionControl-mutatingWebhooks-rules-scope} + +scope specifies the scope of this rule. +Valid values are "Cluster", "Namespaced", and "*" +"Cluster" means that only cluster-scoped resources will match this rule. +Namespace API objects are cluster-scoped. +"Namespaced" means that only namespaced resources will match this rule. +"*" means that there are no scope restrictions. +Subresources match the scope of their parent resource. +Default is "*". + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules_reference.mdx new file mode 100755 index 000000000..5bada53a1 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/rules_reference.mdx @@ -0,0 +1,20 @@ + +import PartialOperations from "./rules/operations.mdx" +import PartialApigroups from "./rules/apiGroups.mdx" +import PartialApiversions from "./rules/apiVersions.mdx" +import PartialResources from "./rules/resources.mdx" +import PartialScope from "./rules/scope.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/sideEffects.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/sideEffects.mdx new file mode 100755 index 000000000..aa600a3ec --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/sideEffects.mdx @@ -0,0 +1,18 @@ + +
+ + +##### `sideEffects` required string {#policies-admissionControl-mutatingWebhooks-sideEffects} + +SideEffects states whether this webhook has side effects. +Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). +Webhooks with side effects MUST implement a reconciliation system, since a request may be +rejected by a future step in the admission chain and the side effects therefore need to be undone. +Requests with the dryRun attribute will be auto-rejected if they match a webhook with +sideEffects == Unknown or Some. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/timeoutSeconds.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/timeoutSeconds.mdx new file mode 100755 index 000000000..7132737d3 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks/timeoutSeconds.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `timeoutSeconds` required integer {#policies-admissionControl-mutatingWebhooks-timeoutSeconds} + +TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, +the webhook call will be ignored or the API call will fail based on the +failure policy. +The timeout value must be between 1 and 30 seconds. +Default to 10 seconds. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks_reference.mdx new file mode 100755 index 000000000..6966ca940 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/mutatingWebhooks_reference.mdx @@ -0,0 +1,184 @@ + +import PartialName from "./mutatingWebhooks/name.mdx" +import PartialClientconfigreference from "./mutatingWebhooks/clientConfig_reference.mdx" +import PartialRulesreference from "./mutatingWebhooks/rules_reference.mdx" +import PartialFailurepolicy from "./mutatingWebhooks/failurePolicy.mdx" +import PartialMatchpolicy from "./mutatingWebhooks/matchPolicy.mdx" +import PartialNamespaceselectorreference from "./mutatingWebhooks/namespaceSelector_reference.mdx" +import PartialObjectselectorreference from "./mutatingWebhooks/objectSelector_reference.mdx" +import PartialSideeffects from "./mutatingWebhooks/sideEffects.mdx" +import PartialTimeoutseconds from "./mutatingWebhooks/timeoutSeconds.mdx" +import PartialAdmissionreviewversions from "./mutatingWebhooks/admissionReviewVersions.mdx" +import PartialReinvocationpolicy from "./mutatingWebhooks/reinvocationPolicy.mdx" +import PartialMatchconditionsreference from "./mutatingWebhooks/matchConditions_reference.mdx" + + + + + +
+ + +##### `clientConfig` required {#policies-admissionControl-mutatingWebhooks-clientConfig} + +ClientConfig defines how to communicate with the hook. +Required + + + + + + +
+ + + +
+ + +##### `rules` required object[] {#policies-admissionControl-mutatingWebhooks-rules} + +Rules describes what operations on what resources/subresources the webhook cares about. +The webhook cares about an operation if it matches _any_ Rule. +However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks +from putting the cluster in a state which cannot be recovered from without completely +disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called +on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + + + + + + +
+ + + + + + + + + +
+ + +##### `namespaceSelector` required {#policies-admissionControl-mutatingWebhooks-namespaceSelector} + +NamespaceSelector decides whether to run the webhook on an object based +on whether the namespace for that object matches the selector. If the +object itself is a namespace, the matching is performed on +object.metadata.labels. If the object is another cluster scoped resource, +it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not +associated with "runlevel" of "0" or "1"; you will set the selector as +follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "runlevel", + "operator": "NotIn", + "values": [ + "0", + "1" + ] + } + ] +} + +If instead you want to only run the webhook on any objects whose +namespace is associated with the "environment" of "prod" or "staging"; +you will set the selector as follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "environment", + "operator": "In", + "values": [ + "prod", + "staging" + ] + } + ] +} + +See +https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + + + + + + +
+ + + +
+ + +##### `objectSelector` required {#policies-admissionControl-mutatingWebhooks-objectSelector} + +ObjectSelector decides whether to run the webhook based on if the +object has matching labels. objectSelector is evaluated against both +the oldObject and newObject that would be sent to the webhook, and +is considered to match if either object matches the selector. A null +object (oldObject in the case of create, or newObject in the case of +delete) or an object that cannot have labels (like a +DeploymentRollback or a PodProxyOptions object) is not considered to +match. +Use the object selector only if the webhook is opt-in, because end +users may skip the admission webhook by setting the labels. +Default to the empty LabelSelector, which matches everything. + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +##### `matchConditions` required object[] {#policies-admissionControl-mutatingWebhooks-matchConditions} + +MatchConditions is a list of conditions that must be met for a request to be sent to this +webhook. Match conditions filter requests that have already been matched by the rules, +namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. +There are a maximum of 64 match conditions allowed. + +The exact matching logic is (in order): + 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. + 2. If ALL matchConditions evaluate to TRUE, the webhook is called. + 3. If any matchCondition evaluates to an error (but none are FALSE): + - If failurePolicy=Fail, reject the request + - If failurePolicy=Ignore, the error is ignored and the webhook is skipped + +This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks.mdx new file mode 100755 index 000000000..2e82191ae --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks.mdx @@ -0,0 +1,17 @@ + +import PartialValidatingwebhooksreference from "./validatingWebhooks_reference.mdx" + + +
+ + +#### `validatingWebhooks` required object[] {#policies-admissionControl-validatingWebhooks} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/admissionReviewVersions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/admissionReviewVersions.mdx new file mode 100755 index 000000000..b64c54ca4 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/admissionReviewVersions.mdx @@ -0,0 +1,19 @@ + +
+ + +##### `admissionReviewVersions` required string[] {#policies-admissionControl-validatingWebhooks-admissionReviewVersions} + +AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` +versions the Webhook expects. API server will try to use first version in +the list which it supports. If none of the versions specified in this list +supported by API server, validation will fail for this object. +If a persisted webhook configuration specifies allowed versions and does not +include any versions known to the API Server, calls to the webhook will fail +and be subject to the failure policy. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig.mdx new file mode 100755 index 000000000..ed7eca830 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig.mdx @@ -0,0 +1,18 @@ + +import PartialClientconfigreference from "./clientConfig_reference.mdx" + + +
+ + +##### `clientConfig` required {#policies-admissionControl-validatingWebhooks-clientConfig} + +ClientConfig defines how to communicate with the hook. +Required + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/caBundle.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/caBundle.mdx new file mode 100755 index 000000000..72d75845a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/caBundle.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `caBundle` required string {#policies-admissionControl-validatingWebhooks-clientConfig-caBundle} + +`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. +If unspecified, system trust roots on the apiserver are used. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service.mdx new file mode 100755 index 000000000..1e234aa4a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service.mdx @@ -0,0 +1,21 @@ + +import PartialServicereference from "./service_reference.mdx" + + +
+ + +###### `service` required {#policies-admissionControl-validatingWebhooks-clientConfig-service} + +`service` is a reference to the service for this webhook. Either +`service` or `url` must be specified. + +If the webhook is running within the cluster, then you should use `service`. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/name.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/name.mdx new file mode 100755 index 000000000..c046c28f9 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/name.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `name` required string {#policies-admissionControl-validatingWebhooks-clientConfig-service-name} + +`name` is the name of the service. +Required + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/namespace.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/namespace.mdx new file mode 100755 index 000000000..47e4ebd6c --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/namespace.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `namespace` required string {#policies-admissionControl-validatingWebhooks-clientConfig-service-namespace} + +`namespace` is the namespace of the service. +Required + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/path.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/path.mdx new file mode 100755 index 000000000..cee42e125 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/path.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `path` required string {#policies-admissionControl-validatingWebhooks-clientConfig-service-path} + +`path` is an optional URL path which will be sent in any request to +this service. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/port.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/port.mdx new file mode 100755 index 000000000..45f418677 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service/port.mdx @@ -0,0 +1,15 @@ + +
+ + +####### `port` required integer {#policies-admissionControl-validatingWebhooks-clientConfig-service-port} + +If specified, the port on the service that hosting webhook. +Default to 443 for backward compatibility. +`port` should be a valid port number (1-65535, inclusive). + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service_reference.mdx new file mode 100755 index 000000000..0236214af --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/service_reference.mdx @@ -0,0 +1,16 @@ + +import PartialNamespace from "./service/namespace.mdx" +import PartialName from "./service/name.mdx" +import PartialPath from "./service/path.mdx" +import PartialPort from "./service/port.mdx" + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/url.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/url.mdx new file mode 100755 index 000000000..b6b2db243 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig/url.mdx @@ -0,0 +1,38 @@ + +
+ + +###### `url` required string {#policies-admissionControl-validatingWebhooks-clientConfig-url} + +`url` gives the location of the webhook, in standard URL form +(`scheme://host:port/path`). Exactly one of `url` or `service` +must be specified. + +The `host` should not refer to a service running in the cluster; use +the `service` field instead. The host might be resolved via external +DNS in some apiservers (e.g., `kube-apiserver` cannot resolve +in-cluster DNS as that would be a layering violation). `host` may +also be an IP address. + +Please note that using `localhost` or `127.0.0.1` as a `host` is +risky unless you take great care to run this webhook on all hosts +which run an apiserver which might need to make calls to this +webhook. Such installs are likely to be non-portable, i.e., not easy +to turn up in a new cluster. + +The scheme must be "https"; the URL must begin with "https://". + +A path is optional, and if present may be any string permissible in +a URL. You may use the path to pass an arbitrary string to the +webhook, for example, a cluster identifier. + +Attempting to use a user or basic auth e.g. "user:password@" is not +allowed. Fragments ("#...") and query parameters ("?...") are not +allowed, either. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig_reference.mdx new file mode 100755 index 000000000..e1866d804 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/clientConfig_reference.mdx @@ -0,0 +1,29 @@ + +import PartialUrl from "./clientConfig/url.mdx" +import PartialServicereference from "./clientConfig/service_reference.mdx" +import PartialCabundle from "./clientConfig/caBundle.mdx" + + + + + +
+ + +###### `service` required {#policies-admissionControl-validatingWebhooks-clientConfig-service} + +`service` is a reference to the service for this webhook. Either +`service` or `url` must be specified. + +If the webhook is running within the cluster, then you should use `service`. + + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/failurePolicy.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/failurePolicy.mdx new file mode 100755 index 000000000..493dd1225 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/failurePolicy.mdx @@ -0,0 +1,14 @@ + +
+ + +##### `failurePolicy` required string {#policies-admissionControl-validatingWebhooks-failurePolicy} + +FailurePolicy defines how unrecognized errors from the admission endpoint are handled - +allowed values are Ignore or Fail. Defaults to Fail. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions.mdx new file mode 100755 index 000000000..c9768c030 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions.mdx @@ -0,0 +1,30 @@ + +import PartialMatchconditionsreference from "./matchConditions_reference.mdx" + + +
+ + +##### `matchConditions` required object[] {#policies-admissionControl-validatingWebhooks-matchConditions} + +MatchConditions is a list of conditions that must be met for a request to be sent to this +webhook. Match conditions filter requests that have already been matched by the rules, +namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. +There are a maximum of 64 match conditions allowed. + +The exact matching logic is (in order): + 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. + 2. If ALL matchConditions evaluate to TRUE, the webhook is called. + 3. If any matchCondition evaluates to an error (but none are FALSE): + - If failurePolicy=Fail, reject the request + - If failurePolicy=Ignore, the error is ignored and the webhook is skipped + +This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions/expression.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions/expression.mdx new file mode 100755 index 000000000..f58944819 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions/expression.mdx @@ -0,0 +1,25 @@ + +
+ + +###### `expression` required string {#policies-admissionControl-validatingWebhooks-matchConditions-expression} + +Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. +CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: + +'object' - The object from the incoming request. The value is null for DELETE requests. +'oldObject' - The existing object. The value is null for CREATE requests. +'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). +'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. + See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz +'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the + request resource. +Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ + +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions/name.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions/name.mdx new file mode 100755 index 000000000..26b3cd031 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions/name.mdx @@ -0,0 +1,21 @@ + +
+ + +###### `name` required string {#policies-admissionControl-validatingWebhooks-matchConditions-name} + +Name is an identifier for this match condition, used for strategic merging of MatchConditions, +as well as providing an identifier for logging purposes. A good name should be descriptive of +the associated expression. +Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and +must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or +'123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an +optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') + +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions_reference.mdx new file mode 100755 index 000000000..45e8ad735 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchConditions_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./matchConditions/name.mdx" +import PartialExpression from "./matchConditions/expression.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchPolicy.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchPolicy.mdx new file mode 100755 index 000000000..433857180 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/matchPolicy.mdx @@ -0,0 +1,26 @@ + +
+ + +##### `matchPolicy` required string {#policies-admissionControl-validatingWebhooks-matchPolicy} + +matchPolicy defines how the "rules" list is used to match incoming requests. +Allowed values are "Exact" or "Equivalent". + +- Exact: match a request only if it exactly matches a specified rule. +For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, +but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, +a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. +For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, +and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, +a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Equivalent" + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/name.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/name.mdx new file mode 100755 index 000000000..6ae0c6990 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/name.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `name` required string {#policies-admissionControl-validatingWebhooks-name} + +The name of the admission webhook. +Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where +"imagepolicy" is the name of the webhook, and kubernetes.io is the name +of the organization. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector.mdx new file mode 100755 index 000000000..50b00f22b --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector.mdx @@ -0,0 +1,59 @@ + +import PartialNamespaceselectorreference from "./namespaceSelector_reference.mdx" + + +
+ + +##### `namespaceSelector` required {#policies-admissionControl-validatingWebhooks-namespaceSelector} + +NamespaceSelector decides whether to run the webhook on an object based +on whether the namespace for that object matches the selector. If the +object itself is a namespace, the matching is performed on +object.metadata.labels. If the object is another cluster scoped resource, +it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not +associated with "runlevel" of "0" or "1"; you will set the selector as +follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "runlevel", + "operator": "NotIn", + "values": [ + "0", + "1" + ] + } + ] +} + +If instead you want to only run the webhook on any objects whose +namespace is associated with the "environment" of "prod" or "staging"; +you will set the selector as follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "environment", + "operator": "In", + "values": [ + "prod", + "staging" + ] + } + ] +} + +See +https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions.mdx new file mode 100755 index 000000000..0a61ece4a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-validatingWebhooks-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..1c9add99b --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `key` required string {#policies-admissionControl-validatingWebhooks-namespaceSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..a415c5105 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `operator` required string {#policies-admissionControl-validatingWebhooks-namespaceSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..23de85040 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `values` required string[] {#policies-admissionControl-validatingWebhooks-namespaceSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchLabels.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchLabels.mdx new file mode 100755 index 000000000..a59d639d5 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `matchLabels` required object {#policies-admissionControl-validatingWebhooks-namespaceSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector_reference.mdx new file mode 100755 index 000000000..bb88b87cb --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/namespaceSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./namespaceSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./namespaceSelector/matchExpressions_reference.mdx" + + + + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-validatingWebhooks-namespaceSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector.mdx new file mode 100755 index 000000000..127418aca --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector.mdx @@ -0,0 +1,27 @@ + +import PartialObjectselectorreference from "./objectSelector_reference.mdx" + + +
+ + +##### `objectSelector` required {#policies-admissionControl-validatingWebhooks-objectSelector} + +ObjectSelector decides whether to run the webhook based on if the +object has matching labels. objectSelector is evaluated against both +the oldObject and newObject that would be sent to the webhook, and +is considered to match if either object matches the selector. A null +object (oldObject in the case of create, or newObject in the case of +delete) or an object that cannot have labels (like a +DeploymentRollback or a PodProxyOptions object) is not considered to +match. +Use the object selector only if the webhook is opt-in, because end +users may skip the admission webhook by setting the labels. +Default to the empty LabelSelector, which matches everything. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions.mdx new file mode 100755 index 000000000..878c1e7ee --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-validatingWebhooks-objectSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..4307c4f40 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +####### `key` required string {#policies-admissionControl-validatingWebhooks-objectSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..4820d4ea5 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +####### `operator` required string {#policies-admissionControl-validatingWebhooks-objectSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..c85710a1e --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +####### `values` required string[] {#policies-admissionControl-validatingWebhooks-objectSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchLabels.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchLabels.mdx new file mode 100755 index 000000000..e5b07db13 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector/matchLabels.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `matchLabels` required object {#policies-admissionControl-validatingWebhooks-objectSelector-matchLabels} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector_reference.mdx new file mode 100755 index 000000000..b98acfbad --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/objectSelector_reference.mdx @@ -0,0 +1,21 @@ + +import PartialMatchlabels from "./objectSelector/matchLabels.mdx" +import PartialMatchexpressionsreference from "./objectSelector/matchExpressions_reference.mdx" + + + + + +
+ + +###### `matchExpressions` required object[] {#policies-admissionControl-validatingWebhooks-objectSelector-matchExpressions} + +matchExpressions is a list of label selector requirements. The requirements are ANDed. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules.mdx new file mode 100755 index 000000000..32506a930 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules.mdx @@ -0,0 +1,22 @@ + +import PartialRulesreference from "./rules_reference.mdx" + + +
+ + +##### `rules` required object[] {#policies-admissionControl-validatingWebhooks-rules} + +Rules describes what operations on what resources/subresources the webhook cares about. +The webhook cares about an operation if it matches _any_ Rule. +However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks +from putting the cluster in a state which cannot be recovered from without completely +disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called +on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/apiGroups.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/apiGroups.mdx new file mode 100755 index 000000000..a5718bba4 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/apiGroups.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `apiGroups` required string[] {#policies-admissionControl-validatingWebhooks-rules-apiGroups} + +APIGroups is the API groups the resources belong to. '*' is all groups. +If '*' is present, the length of the slice must be one. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/apiVersions.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/apiVersions.mdx new file mode 100755 index 000000000..143acc6d3 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/apiVersions.mdx @@ -0,0 +1,15 @@ + +
+ + +###### `apiVersions` required string[] {#policies-admissionControl-validatingWebhooks-rules-apiVersions} + +APIVersions is the API versions the resources belong to. '*' is all versions. +If '*' is present, the length of the slice must be one. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/operations.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/operations.mdx new file mode 100755 index 000000000..87bccf4c1 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/operations.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `operations` required string[] {#policies-admissionControl-validatingWebhooks-rules-operations} + +Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * +for all of those operations and any future admission operations that are added. +If '*' is present, the length of the slice must be one. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/resources.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/resources.mdx new file mode 100755 index 000000000..6a8ed5cc5 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/resources.mdx @@ -0,0 +1,27 @@ + +
+ + +###### `resources` required string[] {#policies-admissionControl-validatingWebhooks-rules-resources} + +Resources is a list of resources this rule applies to. + +For example: +'pods' means pods. +'pods/log' means the log subresource of pods. +'*' means all resources, but not subresources. +'pods/*' means all subresources of pods. +'*/scale' means all scale subresources. +'*/*' means all resources and their subresources. + +If wildcard is present, the validation rule will ensure resources do not +overlap with each other. + +Depending on the enclosing object, subresources might not be allowed. +Required. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/scope.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/scope.mdx new file mode 100755 index 000000000..d41da8a6a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules/scope.mdx @@ -0,0 +1,21 @@ + +
+ + +###### `scope` required string {#policies-admissionControl-validatingWebhooks-rules-scope} + +scope specifies the scope of this rule. +Valid values are "Cluster", "Namespaced", and "*" +"Cluster" means that only cluster-scoped resources will match this rule. +Namespace API objects are cluster-scoped. +"Namespaced" means that only namespaced resources will match this rule. +"*" means that there are no scope restrictions. +Subresources match the scope of their parent resource. +Default is "*". + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules_reference.mdx new file mode 100755 index 000000000..5bada53a1 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/rules_reference.mdx @@ -0,0 +1,20 @@ + +import PartialOperations from "./rules/operations.mdx" +import PartialApigroups from "./rules/apiGroups.mdx" +import PartialApiversions from "./rules/apiVersions.mdx" +import PartialResources from "./rules/resources.mdx" +import PartialScope from "./rules/scope.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/sideEffects.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/sideEffects.mdx new file mode 100755 index 000000000..1994a64e6 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/sideEffects.mdx @@ -0,0 +1,18 @@ + +
+ + +##### `sideEffects` required string {#policies-admissionControl-validatingWebhooks-sideEffects} + +SideEffects states whether this webhook has side effects. +Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). +Webhooks with side effects MUST implement a reconciliation system, since a request may be +rejected by a future step in the admission chain and the side effects therefore need to be undone. +Requests with the dryRun attribute will be auto-rejected if they match a webhook with +sideEffects == Unknown or Some. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/timeoutSeconds.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/timeoutSeconds.mdx new file mode 100755 index 000000000..5e2ffdff0 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks/timeoutSeconds.mdx @@ -0,0 +1,17 @@ + +
+ + +##### `timeoutSeconds` required integer {#policies-admissionControl-validatingWebhooks-timeoutSeconds} + +TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, +the webhook call will be ignored or the API call will fail based on the +failure policy. +The timeout value must be between 1 and 30 seconds. +Default to 10 seconds. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks_reference.mdx new file mode 100755 index 000000000..9a45308d3 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl/validatingWebhooks_reference.mdx @@ -0,0 +1,180 @@ + +import PartialName from "./validatingWebhooks/name.mdx" +import PartialClientconfigreference from "./validatingWebhooks/clientConfig_reference.mdx" +import PartialRulesreference from "./validatingWebhooks/rules_reference.mdx" +import PartialFailurepolicy from "./validatingWebhooks/failurePolicy.mdx" +import PartialMatchpolicy from "./validatingWebhooks/matchPolicy.mdx" +import PartialNamespaceselectorreference from "./validatingWebhooks/namespaceSelector_reference.mdx" +import PartialObjectselectorreference from "./validatingWebhooks/objectSelector_reference.mdx" +import PartialSideeffects from "./validatingWebhooks/sideEffects.mdx" +import PartialTimeoutseconds from "./validatingWebhooks/timeoutSeconds.mdx" +import PartialAdmissionreviewversions from "./validatingWebhooks/admissionReviewVersions.mdx" +import PartialMatchconditionsreference from "./validatingWebhooks/matchConditions_reference.mdx" + + + + + +
+ + +##### `clientConfig` required {#policies-admissionControl-validatingWebhooks-clientConfig} + +ClientConfig defines how to communicate with the hook. +Required + + + + + + +
+ + + +
+ + +##### `rules` required object[] {#policies-admissionControl-validatingWebhooks-rules} + +Rules describes what operations on what resources/subresources the webhook cares about. +The webhook cares about an operation if it matches _any_ Rule. +However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks +from putting the cluster in a state which cannot be recovered from without completely +disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called +on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + + + + + + +
+ + + + + + + + + +
+ + +##### `namespaceSelector` required {#policies-admissionControl-validatingWebhooks-namespaceSelector} + +NamespaceSelector decides whether to run the webhook on an object based +on whether the namespace for that object matches the selector. If the +object itself is a namespace, the matching is performed on +object.metadata.labels. If the object is another cluster scoped resource, +it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not +associated with "runlevel" of "0" or "1"; you will set the selector as +follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "runlevel", + "operator": "NotIn", + "values": [ + "0", + "1" + ] + } + ] +} + +If instead you want to only run the webhook on any objects whose +namespace is associated with the "environment" of "prod" or "staging"; +you will set the selector as follows: +"namespaceSelector": { + "matchExpressions": [ + { + "key": "environment", + "operator": "In", + "values": [ + "prod", + "staging" + ] + } + ] +} + +See +https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + + + + + + +
+ + + +
+ + +##### `objectSelector` required {#policies-admissionControl-validatingWebhooks-objectSelector} + +ObjectSelector decides whether to run the webhook based on if the +object has matching labels. objectSelector is evaluated against both +the oldObject and newObject that would be sent to the webhook, and +is considered to match if either object matches the selector. A null +object (oldObject in the case of create, or newObject in the case of +delete) or an object that cannot have labels (like a +DeploymentRollback or a PodProxyOptions object) is not considered to +match. +Use the object selector only if the webhook is opt-in, because end +users may skip the admission webhook by setting the labels. +Default to the empty LabelSelector, which matches everything. + + + + + + +
+ + + + + + + + + + + + +
+ + +##### `matchConditions` required object[] {#policies-admissionControl-validatingWebhooks-matchConditions} + +MatchConditions is a list of conditions that must be met for a request to be sent to this +webhook. Match conditions filter requests that have already been matched by the rules, +namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. +There are a maximum of 64 match conditions allowed. + +The exact matching logic is (in order): + 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. + 2. If ALL matchConditions evaluate to TRUE, the webhook is called. + 3. If any matchCondition evaluates to an error (but none are FALSE): + - If failurePolicy=Fail, reject the request + - If failurePolicy=Ignore, the error is ignored and the webhook is skipped + +This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate. + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/admissionControl_reference.mdx b/docs/pages/configuration/_partials/policies/admissionControl_reference.mdx new file mode 100755 index 000000000..b15c5caf1 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/admissionControl_reference.mdx @@ -0,0 +1,34 @@ + +import PartialValidatingwebhooksreference from "./admissionControl/validatingWebhooks_reference.mdx" +import PartialMutatingwebhooksreference from "./admissionControl/mutatingWebhooks_reference.mdx" + + +
+ + +#### `validatingWebhooks` required object[] {#policies-admissionControl-validatingWebhooks} + + + + + + + + +
+ + + +
+ + +#### `mutatingWebhooks` required object[] {#policies-admissionControl-mutatingWebhooks} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange.mdx b/docs/pages/configuration/_partials/policies/limitRange.mdx new file mode 100755 index 000000000..6e942c8cc --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange.mdx @@ -0,0 +1,17 @@ + +import PartialLimitrangereference from "./limitRange_reference.mdx" + + +
+ + +### `limitRange` required {#policies-limitRange} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default.mdx b/docs/pages/configuration/_partials/policies/limitRange/default.mdx new file mode 100755 index 000000000..e127e0ecd --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default.mdx @@ -0,0 +1,17 @@ + +import PartialDefaultreference from "./default_reference.mdx" + + +
+ + +#### `default` required {#policies-limitRange-default} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/cpu.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/cpu.mdx new file mode 100755 index 000000000..ac38be53d --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/cpu.mdx @@ -0,0 +1,17 @@ + +import PartialCpureference from "./cpu_reference.mdx" + + +
+ + +##### `cpu` required {#policies-limitRange-default-cpu} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/cpu/Format.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/cpu/Format.mdx new file mode 100755 index 000000000..f7b9bd008 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/cpu/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `Format` required string {#policies-limitRange-default-cpu-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/cpu_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/cpu_reference.mdx new file mode 100755 index 000000000..4c2d64471 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/cpu_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./cpu/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage.mdx new file mode 100755 index 000000000..d8b69151f --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage.mdx @@ -0,0 +1,17 @@ + +import PartialEphemeralstoragereference from "./ephemeral-storage_reference.mdx" + + +
+ + +##### `ephemeral-storage` required {#policies-limitRange-default-ephemeral-storage} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage/Format.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage/Format.mdx new file mode 100755 index 000000000..bb98d762d --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `Format` required string {#policies-limitRange-default-ephemeral-storage-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage_reference.mdx new file mode 100755 index 000000000..a3f1c58e8 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/ephemeral-storage_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./ephemeral-storage/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/memory.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/memory.mdx new file mode 100755 index 000000000..3eafece77 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/memory.mdx @@ -0,0 +1,17 @@ + +import PartialMemoryreference from "./memory_reference.mdx" + + +
+ + +##### `memory` required {#policies-limitRange-default-memory} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/memory/Format.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/memory/Format.mdx new file mode 100755 index 000000000..34ab64398 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/memory/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `Format` required string {#policies-limitRange-default-memory-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default/memory_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/default/memory_reference.mdx new file mode 100755 index 000000000..0e796a210 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default/memory_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./memory/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest.mdx new file mode 100755 index 000000000..152b1c586 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest.mdx @@ -0,0 +1,17 @@ + +import PartialDefaultrequestreference from "./defaultRequest_reference.mdx" + + +
+ + +#### `defaultRequest` required {#policies-limitRange-defaultRequest} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu.mdx new file mode 100755 index 000000000..cfbf0b6f9 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu.mdx @@ -0,0 +1,17 @@ + +import PartialCpureference from "./cpu_reference.mdx" + + +
+ + +##### `cpu` required {#policies-limitRange-defaultRequest-cpu} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu/Format.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu/Format.mdx new file mode 100755 index 000000000..1df905c22 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `Format` required string {#policies-limitRange-defaultRequest-cpu-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu_reference.mdx new file mode 100755 index 000000000..4c2d64471 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/cpu_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./cpu/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage.mdx new file mode 100755 index 000000000..b69a76ecf --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage.mdx @@ -0,0 +1,17 @@ + +import PartialEphemeralstoragereference from "./ephemeral-storage_reference.mdx" + + +
+ + +##### `ephemeral-storage` required {#policies-limitRange-defaultRequest-ephemeral-storage} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage/Format.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage/Format.mdx new file mode 100755 index 000000000..494533314 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `Format` required string {#policies-limitRange-defaultRequest-ephemeral-storage-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage_reference.mdx new file mode 100755 index 000000000..a3f1c58e8 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/ephemeral-storage_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./ephemeral-storage/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory.mdx new file mode 100755 index 000000000..0ad6d275f --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory.mdx @@ -0,0 +1,17 @@ + +import PartialMemoryreference from "./memory_reference.mdx" + + +
+ + +##### `memory` required {#policies-limitRange-defaultRequest-memory} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory/Format.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory/Format.mdx new file mode 100755 index 000000000..014633562 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory/Format.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `Format` required string {#policies-limitRange-defaultRequest-memory-Format} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory_reference.mdx new file mode 100755 index 000000000..0e796a210 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest/memory_reference.mdx @@ -0,0 +1,4 @@ + +import PartialFormat from "./memory/Format.mdx" + + diff --git a/docs/pages/configuration/_partials/policies/limitRange/defaultRequest_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest_reference.mdx new file mode 100755 index 000000000..e91051f3a --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/defaultRequest_reference.mdx @@ -0,0 +1,51 @@ + +import PartialEphemeralstoragereference from "./defaultRequest/ephemeral-storage_reference.mdx" +import PartialMemoryreference from "./defaultRequest/memory_reference.mdx" +import PartialCpureference from "./defaultRequest/cpu_reference.mdx" + + +
+ + +##### `ephemeral-storage` required {#policies-limitRange-defaultRequest-ephemeral-storage} + + + + + + + + +
+ + + +
+ + +##### `memory` required {#policies-limitRange-defaultRequest-memory} + + + + + + + + +
+ + + +
+ + +##### `cpu` required {#policies-limitRange-defaultRequest-cpu} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/default_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange/default_reference.mdx new file mode 100755 index 000000000..ee0913c8f --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/default_reference.mdx @@ -0,0 +1,51 @@ + +import PartialEphemeralstoragereference from "./default/ephemeral-storage_reference.mdx" +import PartialMemoryreference from "./default/memory_reference.mdx" +import PartialCpureference from "./default/cpu_reference.mdx" + + +
+ + +##### `ephemeral-storage` required {#policies-limitRange-default-ephemeral-storage} + + + + + + + + +
+ + + +
+ + +##### `memory` required {#policies-limitRange-default-memory} + + + + + + + + +
+ + + +
+ + +##### `cpu` required {#policies-limitRange-default-cpu} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange/enabled.mdx b/docs/pages/configuration/_partials/policies/limitRange/enabled.mdx new file mode 100755 index 000000000..9c3645f7b --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#policies-limitRange-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/limitRange_reference.mdx b/docs/pages/configuration/_partials/policies/limitRange_reference.mdx new file mode 100755 index 000000000..6a764265b --- /dev/null +++ b/docs/pages/configuration/_partials/policies/limitRange_reference.mdx @@ -0,0 +1,38 @@ + +import PartialEnabled from "./limitRange/enabled.mdx" +import PartialDefaultreference from "./limitRange/default_reference.mdx" +import PartialDefaultrequestreference from "./limitRange/defaultRequest_reference.mdx" + + + + + +
+ + +#### `default` required {#policies-limitRange-default} + + + + + + + + +
+ + + +
+ + +#### `defaultRequest` required {#policies-limitRange-defaultRequest} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/networkPolicy.mdx b/docs/pages/configuration/_partials/policies/networkPolicy.mdx new file mode 100755 index 000000000..31318245b --- /dev/null +++ b/docs/pages/configuration/_partials/policies/networkPolicy.mdx @@ -0,0 +1,17 @@ + +import PartialNetworkpolicyreference from "./networkPolicy_reference.mdx" + + +
+ + +### `networkPolicy` required {#policies-networkPolicy} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/networkPolicy/enabled.mdx b/docs/pages/configuration/_partials/policies/networkPolicy/enabled.mdx new file mode 100755 index 000000000..143d0ead7 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/networkPolicy/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#policies-networkPolicy-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/networkPolicy_reference.mdx b/docs/pages/configuration/_partials/policies/networkPolicy_reference.mdx new file mode 100755 index 000000000..7ba197cf3 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/networkPolicy_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./networkPolicy/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/policies/podSecurityStandard.mdx b/docs/pages/configuration/_partials/policies/podSecurityStandard.mdx new file mode 100755 index 000000000..04cd0c0e0 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/podSecurityStandard.mdx @@ -0,0 +1,13 @@ + +
+ + +### `podSecurityStandard` required string {#policies-podSecurityStandard} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota.mdx b/docs/pages/configuration/_partials/policies/resourceQuota.mdx new file mode 100755 index 000000000..485b07d38 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota.mdx @@ -0,0 +1,17 @@ + +import PartialResourcequotareference from "./resourceQuota_reference.mdx" + + +
+ + +### `resourceQuota` required {#policies-resourceQuota} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/enabled.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/enabled.mdx new file mode 100755 index 000000000..a4a8373a3 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `enabled` required boolean false {#policies-resourceQuota-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/quota.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/quota.mdx new file mode 100755 index 000000000..3cb6bcd9c --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/quota.mdx @@ -0,0 +1,17 @@ + +import PartialQuotareference from "./quota_reference.mdx" + + +
+ + +#### `quota` required {#policies-resourceQuota-quota} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/quota_reference.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/quota_reference.mdx new file mode 100755 index 000000000..e69de29bb diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector.mdx new file mode 100755 index 000000000..3f3fd1b4f --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector.mdx @@ -0,0 +1,17 @@ + +import PartialScopeselectorreference from "./scopeSelector_reference.mdx" + + +
+ + +#### `scopeSelector` required {#policies-resourceQuota-scopeSelector} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions.mdx new file mode 100755 index 000000000..8fe50b6f9 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./matchExpressions_reference.mdx" + + +
+ + +##### `matchExpressions` required object[] {#policies-resourceQuota-scopeSelector-matchExpressions} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/key.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/key.mdx new file mode 100755 index 000000000..de5ca0bd0 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/key.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `key` required string {#policies-resourceQuota-scopeSelector-matchExpressions-key} + +key is the label key that the selector applies to. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/operator.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/operator.mdx new file mode 100755 index 000000000..00a2aab03 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/operator.mdx @@ -0,0 +1,14 @@ + +
+ + +###### `operator` required string {#policies-resourceQuota-scopeSelector-matchExpressions-operator} + +operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/values.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/values.mdx new file mode 100755 index 000000000..187b74d64 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions/values.mdx @@ -0,0 +1,16 @@ + +
+ + +###### `values` required string[] {#policies-resourceQuota-scopeSelector-matchExpressions-values} + +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. + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions_reference.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions_reference.mdx new file mode 100755 index 000000000..a07e45e83 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector/matchExpressions_reference.mdx @@ -0,0 +1,12 @@ + +import PartialKey from "./matchExpressions/key.mdx" +import PartialOperator from "./matchExpressions/operator.mdx" +import PartialValues from "./matchExpressions/values.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector_reference.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector_reference.mdx new file mode 100755 index 000000000..52c1dc75e --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopeSelector_reference.mdx @@ -0,0 +1,17 @@ + +import PartialMatchexpressionsreference from "./scopeSelector/matchExpressions_reference.mdx" + + +
+ + +##### `matchExpressions` required object[] {#policies-resourceQuota-scopeSelector-matchExpressions} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota/scopes.mdx b/docs/pages/configuration/_partials/policies/resourceQuota/scopes.mdx new file mode 100755 index 000000000..f0c6d6421 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota/scopes.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `scopes` required string[] {#policies-resourceQuota-scopes} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/policies/resourceQuota_reference.mdx b/docs/pages/configuration/_partials/policies/resourceQuota_reference.mdx new file mode 100755 index 000000000..2a5b20e61 --- /dev/null +++ b/docs/pages/configuration/_partials/policies/resourceQuota_reference.mdx @@ -0,0 +1,42 @@ + +import PartialEnabled from "./resourceQuota/enabled.mdx" +import PartialQuotareference from "./resourceQuota/quota_reference.mdx" +import PartialScopeselectorreference from "./resourceQuota/scopeSelector_reference.mdx" +import PartialScopes from "./resourceQuota/scopes.mdx" + + + + + +
+ + +#### `quota` required {#policies-resourceQuota-quota} + + + + + + + + +
+ + + +
+ + +#### `scopeSelector` required {#policies-resourceQuota-scopeSelector} + + + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/policies_reference.mdx b/docs/pages/configuration/_partials/policies_reference.mdx new file mode 100755 index 000000000..434a36846 --- /dev/null +++ b/docs/pages/configuration/_partials/policies_reference.mdx @@ -0,0 +1,72 @@ + +import PartialPodsecuritystandard from "./policies/podSecurityStandard.mdx" +import PartialResourcequotareference from "./policies/resourceQuota_reference.mdx" +import PartialLimitrangereference from "./policies/limitRange_reference.mdx" +import PartialNetworkpolicyreference from "./policies/networkPolicy_reference.mdx" +import PartialAdmissioncontrolreference from "./policies/admissionControl_reference.mdx" + + + + + +
+ + +### `resourceQuota` required {#policies-resourceQuota} + + + + + + + + +
+ + + +
+ + +### `limitRange` required {#policies-limitRange} + + + + + + + + +
+ + + +
+ + +### `networkPolicy` required {#policies-networkPolicy} + + + + + + + + +
+ + + +
+ + +### `admissionControl` required {#policies-admissionControl} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac.mdx b/docs/pages/configuration/_partials/rbac.mdx new file mode 100755 index 000000000..e6bde611d --- /dev/null +++ b/docs/pages/configuration/_partials/rbac.mdx @@ -0,0 +1,17 @@ + +import PartialRbacreference from "./rbac_reference.mdx" + + +
+ + +## `rbac` required {#rbac} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/clusterRole.mdx b/docs/pages/configuration/_partials/rbac/clusterRole.mdx new file mode 100755 index 000000000..a029aec93 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/clusterRole.mdx @@ -0,0 +1,17 @@ + +import PartialClusterrolereference from "./clusterRole_reference.mdx" + + +
+ + +### `clusterRole` required {#rbac-clusterRole} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/clusterRole/create.mdx b/docs/pages/configuration/_partials/rbac/clusterRole/create.mdx new file mode 100755 index 000000000..6aa46f669 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/clusterRole/create.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `create` required boolean false {#rbac-clusterRole-create} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/clusterRole/extraRules.mdx b/docs/pages/configuration/_partials/rbac/clusterRole/extraRules.mdx new file mode 100755 index 000000000..bd6b24ff4 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/clusterRole/extraRules.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `extraRules` required {#rbac-clusterRole-extraRules} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/clusterRole_reference.mdx b/docs/pages/configuration/_partials/rbac/clusterRole_reference.mdx new file mode 100755 index 000000000..b2f7e3041 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/clusterRole_reference.mdx @@ -0,0 +1,8 @@ + +import PartialCreate from "./clusterRole/create.mdx" +import PartialExtrarules from "./clusterRole/extraRules.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/rbac/role.mdx b/docs/pages/configuration/_partials/rbac/role.mdx new file mode 100755 index 000000000..3e170c3b0 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/role.mdx @@ -0,0 +1,17 @@ + +import PartialRolereference from "./role_reference.mdx" + + +
+ + +### `role` required {#rbac-role} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/role/create.mdx b/docs/pages/configuration/_partials/rbac/role/create.mdx new file mode 100755 index 000000000..6c862e2f1 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/role/create.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `create` required boolean false {#rbac-role-create} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/role/excludedApiResources.mdx b/docs/pages/configuration/_partials/rbac/role/excludedApiResources.mdx new file mode 100755 index 000000000..7952bfe36 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/role/excludedApiResources.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `excludedApiResources` required string[] {#rbac-role-excludedApiResources} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/role/extraRules.mdx b/docs/pages/configuration/_partials/rbac/role/extraRules.mdx new file mode 100755 index 000000000..097eb0020 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/role/extraRules.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `extraRules` required {#rbac-role-extraRules} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/rbac/role_reference.mdx b/docs/pages/configuration/_partials/rbac/role_reference.mdx new file mode 100755 index 000000000..236566ecf --- /dev/null +++ b/docs/pages/configuration/_partials/rbac/role_reference.mdx @@ -0,0 +1,12 @@ + +import PartialCreate from "./role/create.mdx" +import PartialExtrarules from "./role/extraRules.mdx" +import PartialExcludedapiresources from "./role/excludedApiResources.mdx" + + + + + + + + diff --git a/docs/pages/configuration/_partials/rbac_reference.mdx b/docs/pages/configuration/_partials/rbac_reference.mdx new file mode 100755 index 000000000..7e006cdc1 --- /dev/null +++ b/docs/pages/configuration/_partials/rbac_reference.mdx @@ -0,0 +1,34 @@ + +import PartialClusterrolereference from "./rbac/clusterRole_reference.mdx" +import PartialRolereference from "./rbac/role_reference.mdx" + + +
+ + +### `clusterRole` required {#rbac-clusterRole} + + + + + + + + +
+ + + +
+ + +### `role` required {#rbac-role} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/reference.mdx b/docs/pages/configuration/_partials/reference.mdx new file mode 100755 index 000000000..7fd114826 --- /dev/null +++ b/docs/pages/configuration/_partials/reference.mdx @@ -0,0 +1,246 @@ + +import PartialExportkubeconfigreference from "./exportKubeConfig_reference.mdx" +import PartialSyncreference from "./sync_reference.mdx" +import PartialObservabilityreference from "./observability_reference.mdx" +import PartialNetworkingreference from "./networking_reference.mdx" +import PartialPlugin from "./plugin.mdx" +import PartialPlugins from "./plugins.mdx" +import PartialControlplanereference from "./controlPlane_reference.mdx" +import PartialPoliciesreference from "./policies_reference.mdx" +import PartialRbacreference from "./rbac_reference.mdx" +import PartialTelemetryreference from "./telemetry_reference.mdx" +import PartialExperimentalreference from "./experimental_reference.mdx" +import PartialLicensereference from "./license_reference.mdx" +import PartialPlatformreference from "./platform_reference.mdx" +import PartialSleepreference from "./sleep_reference.mdx" +import PartialTemplatereference from "./template_reference.mdx" +import PartialAccessreference from "./access_reference.mdx" + + +
+ + +## `exportKubeConfig` required {#exportKubeConfig} + + + + + + + + +
+ + + +
+ + +## `sync` required {#sync} + + + + + + + + +
+ + + +
+ + +## `observability` required {#observability} + + + + + + + + +
+ + + +
+ + +## `networking` required {#networking} + + + + + + + + +
+ + + + + + + + + +
+ + +## `controlPlane` required {#controlPlane} + + + + + + + + +
+ + + +
+ + +## `policies` required {#policies} + + + + + + + + +
+ + + +
+ + +## `rbac` required {#rbac} + + + + + + + + +
+ + + +
+ + +## `telemetry` required {#telemetry} + +Telemetry is the configuration related to telemetry gathered about vcluster usage. + + + + + + +
+ + + +
+ + +## `experimental` required {#experimental} + + + + + + + + +
+ + + +
+ + +## `license` required {#license} + + + + + + + + +
+ + + +
+ + +## `platform` required {#platform} + + + + + + + + +
+ + + +
+ + +## `sleep` required {#sleep} + + + + + + + + +
+ + + +
+ + +## `template` required {#template} + + + + + + + + +
+ + + +
+ + +## `access` required {#access} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep.mdx b/docs/pages/configuration/_partials/sleep.mdx new file mode 100755 index 000000000..7bf65fe96 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep.mdx @@ -0,0 +1,17 @@ + +import PartialSleepreference from "./sleep_reference.mdx" + + +
+ + +## `sleep` required {#sleep} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/after.mdx b/docs/pages/configuration/_partials/sleep/after.mdx new file mode 100755 index 000000000..b09f0dafb --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/after.mdx @@ -0,0 +1,13 @@ + +
+ + +### `after` required integer {#sleep-after} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/autoDelete.mdx b/docs/pages/configuration/_partials/sleep/autoDelete.mdx new file mode 100755 index 000000000..47ab6ee5f --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/autoDelete.mdx @@ -0,0 +1,17 @@ + +import PartialAutodeletereference from "./autoDelete_reference.mdx" + + +
+ + +### `autoDelete` required {#sleep-autoDelete} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/autoDelete/after.mdx b/docs/pages/configuration/_partials/sleep/autoDelete/after.mdx new file mode 100755 index 000000000..7ac5bbb5c --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/autoDelete/after.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `after` required integer {#sleep-autoDelete-after} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/autoDelete_reference.mdx b/docs/pages/configuration/_partials/sleep/autoDelete_reference.mdx new file mode 100755 index 000000000..3cc0b69e2 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/autoDelete_reference.mdx @@ -0,0 +1,4 @@ + +import PartialAfter from "./autoDelete/after.mdx" + + diff --git a/docs/pages/configuration/_partials/sleep/ignore.mdx b/docs/pages/configuration/_partials/sleep/ignore.mdx new file mode 100755 index 000000000..dec4603f3 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/ignore.mdx @@ -0,0 +1,17 @@ + +import PartialIgnorereference from "./ignore_reference.mdx" + + +
+ + +### `ignore` required {#sleep-ignore} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/ignore/connections.mdx b/docs/pages/configuration/_partials/sleep/ignore/connections.mdx new file mode 100755 index 000000000..bfb18a4e3 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/ignore/connections.mdx @@ -0,0 +1,17 @@ + +import PartialConnectionsreference from "./connections_reference.mdx" + + +
+ + +#### `connections` required {#sleep-ignore-connections} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/ignore/connections/after.mdx b/docs/pages/configuration/_partials/sleep/ignore/connections/after.mdx new file mode 100755 index 000000000..0775d7846 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/ignore/connections/after.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `after` required integer {#sleep-ignore-connections-after} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/ignore/connections_reference.mdx b/docs/pages/configuration/_partials/sleep/ignore/connections_reference.mdx new file mode 100755 index 000000000..278562bc7 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/ignore/connections_reference.mdx @@ -0,0 +1,4 @@ + +import PartialAfter from "./connections/after.mdx" + + diff --git a/docs/pages/configuration/_partials/sleep/ignore/resourcesWith.mdx b/docs/pages/configuration/_partials/sleep/ignore/resourcesWith.mdx new file mode 100755 index 000000000..5136655d2 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/ignore/resourcesWith.mdx @@ -0,0 +1,13 @@ + +
+ + +#### `resourcesWith` required object {#sleep-ignore-resourcesWith} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/ignore_reference.mdx b/docs/pages/configuration/_partials/sleep/ignore_reference.mdx new file mode 100755 index 000000000..7885ee203 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/ignore_reference.mdx @@ -0,0 +1,21 @@ + +import PartialConnectionsreference from "./ignore/connections_reference.mdx" +import PartialResourceswith from "./ignore/resourcesWith.mdx" + + +
+ + +#### `connections` required {#sleep-ignore-connections} + + + + + + + + +
+ + + diff --git a/docs/pages/configuration/_partials/sleep/schedule.mdx b/docs/pages/configuration/_partials/sleep/schedule.mdx new file mode 100755 index 000000000..e0f25deba --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/schedule.mdx @@ -0,0 +1,13 @@ + +
+ + +### `schedule` required string {#sleep-schedule} + +TODO validate crontab + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep/timezone.mdx b/docs/pages/configuration/_partials/sleep/timezone.mdx new file mode 100755 index 000000000..775342f3d --- /dev/null +++ b/docs/pages/configuration/_partials/sleep/timezone.mdx @@ -0,0 +1,13 @@ + +
+ + +### `timezone` required string {#sleep-timezone} + +TODO set default + + + + + +
diff --git a/docs/pages/configuration/_partials/sleep_reference.mdx b/docs/pages/configuration/_partials/sleep_reference.mdx new file mode 100755 index 000000000..1640ba058 --- /dev/null +++ b/docs/pages/configuration/_partials/sleep_reference.mdx @@ -0,0 +1,46 @@ + +import PartialAfter from "./sleep/after.mdx" +import PartialSchedule from "./sleep/schedule.mdx" +import PartialTimezone from "./sleep/timezone.mdx" +import PartialIgnorereference from "./sleep/ignore_reference.mdx" +import PartialAutodeletereference from "./sleep/autoDelete_reference.mdx" + + + + + + + + + + + +
+ + +### `ignore` required {#sleep-ignore} + + + + + + + + +
+ + + +
+ + +### `autoDelete` required {#sleep-autoDelete} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync.mdx b/docs/pages/configuration/_partials/sync.mdx new file mode 100755 index 000000000..46ea0bb01 --- /dev/null +++ b/docs/pages/configuration/_partials/sync.mdx @@ -0,0 +1,17 @@ + +import PartialSyncreference from "./sync_reference.mdx" + + +
+ + +## `sync` required {#sync} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost.mdx b/docs/pages/configuration/_partials/sync/FromHost.mdx new file mode 100755 index 000000000..3e96f7377 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost.mdx @@ -0,0 +1,17 @@ + +import PartialFromhostreference from "./FromHost_reference.mdx" + + +
+ + +### `FromHost` required {#sync-FromHost} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiDrivers.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiDrivers.mdx new file mode 100755 index 000000000..2ecd4c0a1 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiDrivers.mdx @@ -0,0 +1,17 @@ + +import PartialCsidriversreference from "./csiDrivers_reference.mdx" + + +
+ + +#### `csiDrivers` required {#sync-FromHost-csiDrivers} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiDrivers/enabled.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiDrivers/enabled.mdx new file mode 100755 index 000000000..67ef059a8 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiDrivers/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-FromHost-csiDrivers-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiDrivers_reference.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiDrivers_reference.mdx new file mode 100755 index 000000000..e9edb70fe --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiDrivers_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./csiDrivers/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiNodes.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiNodes.mdx new file mode 100755 index 000000000..a03b4a1f5 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiNodes.mdx @@ -0,0 +1,17 @@ + +import PartialCsinodesreference from "./csiNodes_reference.mdx" + + +
+ + +#### `csiNodes` required {#sync-FromHost-csiNodes} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiNodes/enabled.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiNodes/enabled.mdx new file mode 100755 index 000000000..376921546 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiNodes/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-FromHost-csiNodes-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiNodes_reference.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiNodes_reference.mdx new file mode 100755 index 000000000..57da787c2 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiNodes_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./csiNodes/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities.mdx new file mode 100755 index 000000000..07003cff9 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities.mdx @@ -0,0 +1,17 @@ + +import PartialCsistoragecapacitiesreference from "./csiStorageCapacities_reference.mdx" + + +
+ + +#### `csiStorageCapacities` required {#sync-FromHost-csiStorageCapacities} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities/enabled.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities/enabled.mdx new file mode 100755 index 000000000..f8b513cb5 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-FromHost-csiStorageCapacities-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities_reference.mdx b/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities_reference.mdx new file mode 100755 index 000000000..f3ee33f82 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/csiStorageCapacities_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./csiStorageCapacities/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/FromHost/events.mdx b/docs/pages/configuration/_partials/sync/FromHost/events.mdx new file mode 100755 index 000000000..7c03f1adf --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/events.mdx @@ -0,0 +1,17 @@ + +import PartialEventsreference from "./events_reference.mdx" + + +
+ + +#### `events` required {#sync-FromHost-events} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/events/enabled.mdx b/docs/pages/configuration/_partials/sync/FromHost/events/enabled.mdx new file mode 100755 index 000000000..a20d79bc4 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/events/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-FromHost-events-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/events_reference.mdx b/docs/pages/configuration/_partials/sync/FromHost/events_reference.mdx new file mode 100755 index 000000000..5ffe34779 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/events_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./events/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/FromHost/ingressClasses.mdx b/docs/pages/configuration/_partials/sync/FromHost/ingressClasses.mdx new file mode 100755 index 000000000..bb30024a5 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/ingressClasses.mdx @@ -0,0 +1,17 @@ + +import PartialIngressclassesreference from "./ingressClasses_reference.mdx" + + +
+ + +#### `ingressClasses` required {#sync-FromHost-ingressClasses} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/ingressClasses/enabled.mdx b/docs/pages/configuration/_partials/sync/FromHost/ingressClasses/enabled.mdx new file mode 100755 index 000000000..91fc7f911 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/ingressClasses/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-FromHost-ingressClasses-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/ingressClasses_reference.mdx b/docs/pages/configuration/_partials/sync/FromHost/ingressClasses_reference.mdx new file mode 100755 index 000000000..694be105e --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/ingressClasses_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./ingressClasses/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/FromHost/storageClasses.mdx b/docs/pages/configuration/_partials/sync/FromHost/storageClasses.mdx new file mode 100755 index 000000000..ad1c20292 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/storageClasses.mdx @@ -0,0 +1,17 @@ + +import PartialStorageclassesreference from "./storageClasses_reference.mdx" + + +
+ + +#### `storageClasses` required {#sync-FromHost-storageClasses} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/storageClasses/enabled.mdx b/docs/pages/configuration/_partials/sync/FromHost/storageClasses/enabled.mdx new file mode 100755 index 000000000..c3fdba9cc --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/storageClasses/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-FromHost-storageClasses-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/FromHost/storageClasses_reference.mdx b/docs/pages/configuration/_partials/sync/FromHost/storageClasses_reference.mdx new file mode 100755 index 000000000..2a5bf9d85 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost/storageClasses_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./storageClasses/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/FromHost_reference.mdx b/docs/pages/configuration/_partials/sync/FromHost_reference.mdx new file mode 100755 index 000000000..80d038f5c --- /dev/null +++ b/docs/pages/configuration/_partials/sync/FromHost_reference.mdx @@ -0,0 +1,102 @@ + +import PartialCsidriversreference from "./FromHost/csiDrivers_reference.mdx" +import PartialCsinodesreference from "./FromHost/csiNodes_reference.mdx" +import PartialCsistoragecapacitiesreference from "./FromHost/csiStorageCapacities_reference.mdx" +import PartialIngressclassesreference from "./FromHost/ingressClasses_reference.mdx" +import PartialEventsreference from "./FromHost/events_reference.mdx" +import PartialStorageclassesreference from "./FromHost/storageClasses_reference.mdx" + + +
+ + +#### `csiDrivers` required {#sync-FromHost-csiDrivers} + + + + + + + + +
+ + + +
+ + +#### `csiNodes` required {#sync-FromHost-csiNodes} + + + + + + + + +
+ + + +
+ + +#### `csiStorageCapacities` required {#sync-FromHost-csiStorageCapacities} + + + + + + + + +
+ + + +
+ + +#### `ingressClasses` required {#sync-FromHost-ingressClasses} + + + + + + + + +
+ + + +
+ + +#### `events` required {#sync-FromHost-events} + + + + + + + + +
+ + + +
+ + +#### `storageClasses` required {#sync-FromHost-storageClasses} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost.mdx b/docs/pages/configuration/_partials/sync/ToHost.mdx new file mode 100755 index 000000000..ef38cac7a --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost.mdx @@ -0,0 +1,17 @@ + +import PartialTohostreference from "./ToHost_reference.mdx" + + +
+ + +### `ToHost` required {#sync-ToHost} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/configMaps.mdx b/docs/pages/configuration/_partials/sync/ToHost/configMaps.mdx new file mode 100755 index 000000000..b26a7fe00 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/configMaps.mdx @@ -0,0 +1,17 @@ + +import PartialConfigmapsreference from "./configMaps_reference.mdx" + + +
+ + +#### `configMaps` required {#sync-ToHost-configMaps} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/configMaps/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/configMaps/enabled.mdx new file mode 100755 index 000000000..f3b4e8d21 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/configMaps/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-configMaps-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/configMaps_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/configMaps_reference.mdx new file mode 100755 index 000000000..a52bb814e --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/configMaps_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./configMaps/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/endpoints.mdx b/docs/pages/configuration/_partials/sync/ToHost/endpoints.mdx new file mode 100755 index 000000000..8c9c91f4d --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/endpoints.mdx @@ -0,0 +1,17 @@ + +import PartialEndpointsreference from "./endpoints_reference.mdx" + + +
+ + +#### `endpoints` required {#sync-ToHost-endpoints} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/endpoints/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/endpoints/enabled.mdx new file mode 100755 index 000000000..2575b92f7 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/endpoints/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-endpoints-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/endpoints_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/endpoints_reference.mdx new file mode 100755 index 000000000..ec6ebc98b --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/endpoints_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./endpoints/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/ingresses.mdx b/docs/pages/configuration/_partials/sync/ToHost/ingresses.mdx new file mode 100755 index 000000000..fbc2e8326 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/ingresses.mdx @@ -0,0 +1,17 @@ + +import PartialIngressesreference from "./ingresses_reference.mdx" + + +
+ + +#### `ingresses` required {#sync-ToHost-ingresses} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/ingresses/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/ingresses/enabled.mdx new file mode 100755 index 000000000..b0c85b24c --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/ingresses/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-ingresses-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/ingresses_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/ingresses_reference.mdx new file mode 100755 index 000000000..71930091e --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/ingresses_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./ingresses/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/networkPolicies.mdx b/docs/pages/configuration/_partials/sync/ToHost/networkPolicies.mdx new file mode 100755 index 000000000..e6ae6aa97 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/networkPolicies.mdx @@ -0,0 +1,17 @@ + +import PartialNetworkpoliciesreference from "./networkPolicies_reference.mdx" + + +
+ + +#### `networkPolicies` required {#sync-ToHost-networkPolicies} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/networkPolicies/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/networkPolicies/enabled.mdx new file mode 100755 index 000000000..e8555b666 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/networkPolicies/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-networkPolicies-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/networkPolicies_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/networkPolicies_reference.mdx new file mode 100755 index 000000000..836d32d95 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/networkPolicies_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./networkPolicies/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims.mdx b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims.mdx new file mode 100755 index 000000000..7d0e91126 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims.mdx @@ -0,0 +1,17 @@ + +import PartialPersistentvolumeclaimsreference from "./persistentVolumeClaims_reference.mdx" + + +
+ + +#### `persistentVolumeClaims` required {#sync-ToHost-persistentVolumeClaims} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims/enabled.mdx new file mode 100755 index 000000000..d845ae5d4 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-persistentVolumeClaims-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims_reference.mdx new file mode 100755 index 000000000..d687bbc2f --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumeClaims_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./persistentVolumeClaims/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes.mdx b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes.mdx new file mode 100755 index 000000000..09f156ac3 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes.mdx @@ -0,0 +1,17 @@ + +import PartialPersistentvolumesreference from "./persistentVolumes_reference.mdx" + + +
+ + +#### `persistentVolumes` required {#sync-ToHost-persistentVolumes} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes/enabled.mdx new file mode 100755 index 000000000..262fb14ec --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-persistentVolumes-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes_reference.mdx new file mode 100755 index 000000000..b2022f49e --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/persistentVolumes_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./persistentVolumes/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets.mdx b/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets.mdx new file mode 100755 index 000000000..243c63ab5 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets.mdx @@ -0,0 +1,17 @@ + +import PartialPoddisruptionbudgetsreference from "./podDisruptionBudgets_reference.mdx" + + +
+ + +#### `podDisruptionBudgets` required {#sync-ToHost-podDisruptionBudgets} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets/enabled.mdx new file mode 100755 index 000000000..66a0e69e0 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-podDisruptionBudgets-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets_reference.mdx new file mode 100755 index 000000000..1dc58c3bc --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/podDisruptionBudgets_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./podDisruptionBudgets/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods.mdx new file mode 100755 index 000000000..cb32b6387 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods.mdx @@ -0,0 +1,17 @@ + +import PartialPodsreference from "./pods_reference.mdx" + + +
+ + +#### `pods` required {#sync-ToHost-pods} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/enabled.mdx new file mode 100755 index 000000000..c15e4b8bc --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-pods-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/enforceTolerations.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/enforceTolerations.mdx new file mode 100755 index 000000000..13851a61e --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/enforceTolerations.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enforceTolerations` required string[] {#sync-ToHost-pods-enforceTolerations} + +validate format + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts.mdx new file mode 100755 index 000000000..f533d68d7 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts.mdx @@ -0,0 +1,17 @@ + +import PartialRewritehostsreference from "./rewriteHosts_reference.mdx" + + +
+ + +##### `rewriteHosts` required {#sync-ToHost-pods-rewriteHosts} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts/enabled.mdx new file mode 100755 index 000000000..3e3656d7a --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `enabled` required boolean false {#sync-ToHost-pods-rewriteHosts-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts/initContainerImage.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts/initContainerImage.mdx new file mode 100755 index 000000000..cc1e5035f --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts/initContainerImage.mdx @@ -0,0 +1,13 @@ + +
+ + +###### `initContainerImage` required boolean false {#sync-ToHost-pods-rewriteHosts-initContainerImage} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts_reference.mdx new file mode 100755 index 000000000..7e27af661 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/rewriteHosts_reference.mdx @@ -0,0 +1,8 @@ + +import PartialEnabled from "./rewriteHosts/enabled.mdx" +import PartialInitcontainerimage from "./rewriteHosts/initContainerImage.mdx" + + + + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/translateImage.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/translateImage.mdx new file mode 100755 index 000000000..da8c79a09 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/translateImage.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `translateImage` required object {#sync-ToHost-pods-translateImage} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/useSecretsForSATokens.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/useSecretsForSATokens.mdx new file mode 100755 index 000000000..e24c0705a --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/useSecretsForSATokens.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `useSecretsForSATokens` required boolean false {#sync-ToHost-pods-useSecretsForSATokens} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods/workloadServiceAccount.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods/workloadServiceAccount.mdx new file mode 100755 index 000000000..632516dea --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods/workloadServiceAccount.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `workloadServiceAccount` required string {#sync-ToHost-pods-workloadServiceAccount} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/pods_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/pods_reference.mdx new file mode 100755 index 000000000..682ce8b0d --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/pods_reference.mdx @@ -0,0 +1,37 @@ + +import PartialEnabled from "./pods/enabled.mdx" +import PartialWorkloadserviceaccount from "./pods/workloadServiceAccount.mdx" +import PartialTranslateimage from "./pods/translateImage.mdx" +import PartialEnforcetolerations from "./pods/enforceTolerations.mdx" +import PartialUsesecretsforsatokens from "./pods/useSecretsForSATokens.mdx" +import PartialRewritehostsreference from "./pods/rewriteHosts_reference.mdx" + + + + + + + + + + + + + + + + + +
+ + +##### `rewriteHosts` required {#sync-ToHost-pods-rewriteHosts} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/priorityClasses.mdx b/docs/pages/configuration/_partials/sync/ToHost/priorityClasses.mdx new file mode 100755 index 000000000..f1f4e76a3 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/priorityClasses.mdx @@ -0,0 +1,17 @@ + +import PartialPriorityclassesreference from "./priorityClasses_reference.mdx" + + +
+ + +#### `priorityClasses` required {#sync-ToHost-priorityClasses} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/priorityClasses/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/priorityClasses/enabled.mdx new file mode 100755 index 000000000..101134bc1 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/priorityClasses/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-priorityClasses-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/priorityClasses_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/priorityClasses_reference.mdx new file mode 100755 index 000000000..6d01a7122 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/priorityClasses_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./priorityClasses/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/secrets.mdx b/docs/pages/configuration/_partials/sync/ToHost/secrets.mdx new file mode 100755 index 000000000..221cade50 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/secrets.mdx @@ -0,0 +1,17 @@ + +import PartialSecretsreference from "./secrets_reference.mdx" + + +
+ + +#### `secrets` required {#sync-ToHost-secrets} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/secrets/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/secrets/enabled.mdx new file mode 100755 index 000000000..fa8764c38 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/secrets/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-secrets-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/secrets_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/secrets_reference.mdx new file mode 100755 index 000000000..8dbf2a670 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/secrets_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./secrets/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts.mdx b/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts.mdx new file mode 100755 index 000000000..b25ce7efd --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts.mdx @@ -0,0 +1,17 @@ + +import PartialServiceaccountsreference from "./serviceAccounts_reference.mdx" + + +
+ + +#### `serviceAccounts` required {#sync-ToHost-serviceAccounts} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts/enabled.mdx new file mode 100755 index 000000000..5e424ab0d --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-serviceAccounts-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts_reference.mdx new file mode 100755 index 000000000..287d0829e --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/serviceAccounts_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./serviceAccounts/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/services.mdx b/docs/pages/configuration/_partials/sync/ToHost/services.mdx new file mode 100755 index 000000000..14f725d1b --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/services.mdx @@ -0,0 +1,17 @@ + +import PartialServicesreference from "./services_reference.mdx" + + +
+ + +#### `services` required {#sync-ToHost-services} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/services/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/services/enabled.mdx new file mode 100755 index 000000000..40f0270b3 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/services/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-services-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/services_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/services_reference.mdx new file mode 100755 index 000000000..09db6c5c6 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/services_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./services/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/storageClasses.mdx b/docs/pages/configuration/_partials/sync/ToHost/storageClasses.mdx new file mode 100755 index 000000000..77e4c6b91 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/storageClasses.mdx @@ -0,0 +1,17 @@ + +import PartialStorageclassesreference from "./storageClasses_reference.mdx" + + +
+ + +#### `storageClasses` required {#sync-ToHost-storageClasses} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/storageClasses/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/storageClasses/enabled.mdx new file mode 100755 index 000000000..fcd9e39a7 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/storageClasses/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-storageClasses-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/storageClasses_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/storageClasses_reference.mdx new file mode 100755 index 000000000..2a5bf9d85 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/storageClasses_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./storageClasses/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots.mdx b/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots.mdx new file mode 100755 index 000000000..72b88b960 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots.mdx @@ -0,0 +1,17 @@ + +import PartialVolumesnapshotsreference from "./volumeSnapshots_reference.mdx" + + +
+ + +#### `volumeSnapshots` required {#sync-ToHost-volumeSnapshots} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots/enabled.mdx b/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots/enabled.mdx new file mode 100755 index 000000000..72454a600 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots/enabled.mdx @@ -0,0 +1,13 @@ + +
+ + +##### `enabled` required boolean false {#sync-ToHost-volumeSnapshots-enabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots_reference.mdx new file mode 100755 index 000000000..220610794 --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost/volumeSnapshots_reference.mdx @@ -0,0 +1,4 @@ + +import PartialEnabled from "./volumeSnapshots/enabled.mdx" + + diff --git a/docs/pages/configuration/_partials/sync/ToHost_reference.mdx b/docs/pages/configuration/_partials/sync/ToHost_reference.mdx new file mode 100755 index 000000000..6023cdbdb --- /dev/null +++ b/docs/pages/configuration/_partials/sync/ToHost_reference.mdx @@ -0,0 +1,238 @@ + +import PartialServicesreference from "./ToHost/services_reference.mdx" +import PartialEndpointsreference from "./ToHost/endpoints_reference.mdx" +import PartialIngressesreference from "./ToHost/ingresses_reference.mdx" +import PartialPriorityclassesreference from "./ToHost/priorityClasses_reference.mdx" +import PartialNetworkpoliciesreference from "./ToHost/networkPolicies_reference.mdx" +import PartialVolumesnapshotsreference from "./ToHost/volumeSnapshots_reference.mdx" +import PartialPoddisruptionbudgetsreference from "./ToHost/podDisruptionBudgets_reference.mdx" +import PartialServiceaccountsreference from "./ToHost/serviceAccounts_reference.mdx" +import PartialStorageclassesreference from "./ToHost/storageClasses_reference.mdx" +import PartialPersistentvolumesreference from "./ToHost/persistentVolumes_reference.mdx" +import PartialPersistentvolumeclaimsreference from "./ToHost/persistentVolumeClaims_reference.mdx" +import PartialConfigmapsreference from "./ToHost/configMaps_reference.mdx" +import PartialSecretsreference from "./ToHost/secrets_reference.mdx" +import PartialPodsreference from "./ToHost/pods_reference.mdx" + + +
+ + +#### `services` required {#sync-ToHost-services} + + + + + + + + +
+ + + +
+ + +#### `endpoints` required {#sync-ToHost-endpoints} + + + + + + + + +
+ + + +
+ + +#### `ingresses` required {#sync-ToHost-ingresses} + + + + + + + + +
+ + + +
+ + +#### `priorityClasses` required {#sync-ToHost-priorityClasses} + + + + + + + + +
+ + + +
+ + +#### `networkPolicies` required {#sync-ToHost-networkPolicies} + + + + + + + + +
+ + + +
+ + +#### `volumeSnapshots` required {#sync-ToHost-volumeSnapshots} + + + + + + + + +
+ + + +
+ + +#### `podDisruptionBudgets` required {#sync-ToHost-podDisruptionBudgets} + + + + + + + + +
+ + + +
+ + +#### `serviceAccounts` required {#sync-ToHost-serviceAccounts} + + + + + + + + +
+ + + +
+ + +#### `storageClasses` required {#sync-ToHost-storageClasses} + + + + + + + + +
+ + + +
+ + +#### `persistentVolumes` required {#sync-ToHost-persistentVolumes} + + + + + + + + +
+ + + +
+ + +#### `persistentVolumeClaims` required {#sync-ToHost-persistentVolumeClaims} + + + + + + + + +
+ + + +
+ + +#### `configMaps` required {#sync-ToHost-configMaps} + + + + + + + + +
+ + + +
+ + +#### `secrets` required {#sync-ToHost-secrets} + + + + + + + + +
+ + + +
+ + +#### `pods` required {#sync-ToHost-pods} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/sync_reference.mdx b/docs/pages/configuration/_partials/sync_reference.mdx new file mode 100755 index 000000000..e11be50de --- /dev/null +++ b/docs/pages/configuration/_partials/sync_reference.mdx @@ -0,0 +1,34 @@ + +import PartialTohostreference from "./sync/ToHost_reference.mdx" +import PartialFromhostreference from "./sync/FromHost_reference.mdx" + + +
+ + +### `ToHost` required {#sync-ToHost} + + + + + + + + +
+ + + +
+ + +### `FromHost` required {#sync-FromHost} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/telemetry.mdx b/docs/pages/configuration/_partials/telemetry.mdx new file mode 100755 index 000000000..04ea9575a --- /dev/null +++ b/docs/pages/configuration/_partials/telemetry.mdx @@ -0,0 +1,17 @@ + +import PartialTelemetryreference from "./telemetry_reference.mdx" + + +
+ + +## `telemetry` required {#telemetry} + +Telemetry is the configuration related to telemetry gathered about vcluster usage. + + + + + + +
diff --git a/docs/pages/configuration/_partials/telemetry/disabled.mdx b/docs/pages/configuration/_partials/telemetry/disabled.mdx new file mode 100755 index 000000000..3f5be557c --- /dev/null +++ b/docs/pages/configuration/_partials/telemetry/disabled.mdx @@ -0,0 +1,13 @@ + +
+ + +### `disabled` required boolean false {#telemetry-disabled} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/telemetry/instanceCreators.mdx b/docs/pages/configuration/_partials/telemetry/instanceCreators.mdx new file mode 100755 index 000000000..5b86ccde6 --- /dev/null +++ b/docs/pages/configuration/_partials/telemetry/instanceCreators.mdx @@ -0,0 +1,13 @@ + +
+ + +### `instanceCreators` required string {#telemetry-instanceCreators} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/telemetry/machineID.mdx b/docs/pages/configuration/_partials/telemetry/machineID.mdx new file mode 100755 index 000000000..f62bc8457 --- /dev/null +++ b/docs/pages/configuration/_partials/telemetry/machineID.mdx @@ -0,0 +1,13 @@ + +
+ + +### `machineID` required string {#telemetry-machineID} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/telemetry/platformInstanceID.mdx b/docs/pages/configuration/_partials/telemetry/platformInstanceID.mdx new file mode 100755 index 000000000..6a8f31b94 --- /dev/null +++ b/docs/pages/configuration/_partials/telemetry/platformInstanceID.mdx @@ -0,0 +1,13 @@ + +
+ + +### `platformInstanceID` required string {#telemetry-platformInstanceID} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/telemetry/platformUserID.mdx b/docs/pages/configuration/_partials/telemetry/platformUserID.mdx new file mode 100755 index 000000000..bdb505fcd --- /dev/null +++ b/docs/pages/configuration/_partials/telemetry/platformUserID.mdx @@ -0,0 +1,13 @@ + +
+ + +### `platformUserID` required string {#telemetry-platformUserID} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/telemetry_reference.mdx b/docs/pages/configuration/_partials/telemetry_reference.mdx new file mode 100755 index 000000000..95a19a1bf --- /dev/null +++ b/docs/pages/configuration/_partials/telemetry_reference.mdx @@ -0,0 +1,20 @@ + +import PartialDisabled from "./telemetry/disabled.mdx" +import PartialInstancecreators from "./telemetry/instanceCreators.mdx" +import PartialPlatformuserid from "./telemetry/platformUserID.mdx" +import PartialPlatforminstanceid from "./telemetry/platformInstanceID.mdx" +import PartialMachineid from "./telemetry/machineID.mdx" + + + + + + + + + + + + + + diff --git a/docs/pages/configuration/_partials/template.mdx b/docs/pages/configuration/_partials/template.mdx new file mode 100755 index 000000000..ec2bd5787 --- /dev/null +++ b/docs/pages/configuration/_partials/template.mdx @@ -0,0 +1,17 @@ + +import PartialTemplatereference from "./template_reference.mdx" + + +
+ + +## `template` required {#template} + + + + + + + + +
diff --git a/docs/pages/configuration/_partials/template/name.mdx b/docs/pages/configuration/_partials/template/name.mdx new file mode 100755 index 000000000..ecddf5620 --- /dev/null +++ b/docs/pages/configuration/_partials/template/name.mdx @@ -0,0 +1,13 @@ + +
+ + +### `name` required string {#template-name} + +Name is the name of the template used to populate the virtual cluster + + + + + +
diff --git a/docs/pages/configuration/_partials/template/version.mdx b/docs/pages/configuration/_partials/template/version.mdx new file mode 100755 index 000000000..31f6ca44a --- /dev/null +++ b/docs/pages/configuration/_partials/template/version.mdx @@ -0,0 +1,13 @@ + +
+ + +### `version` required string {#template-version} + + + + + + + +
diff --git a/docs/pages/configuration/_partials/template_reference.mdx b/docs/pages/configuration/_partials/template_reference.mdx new file mode 100755 index 000000000..b69d167d3 --- /dev/null +++ b/docs/pages/configuration/_partials/template_reference.mdx @@ -0,0 +1,8 @@ + +import PartialName from "./template/name.mdx" +import PartialVersion from "./template/version.mdx" + + + + + diff --git a/docs/pages/configuration/reference.mdx b/docs/pages/configuration/reference.mdx new file mode 100644 index 000000000..d6ce32b67 --- /dev/null +++ b/docs/pages/configuration/reference.mdx @@ -0,0 +1,12 @@ +--- +title: Config Reference +sidebar_label: Config Reference +--- + +import PartialConfig from "./_partials/reference.mdx" + +Every virtual cluster requires a values.yaml + +The `values.yaml` file supports the following fields: + + diff --git a/docs/schemas/config-openapi.json b/docs/schemas/config-openapi.json new file mode 100755 index 000000000..c811f74a0 --- /dev/null +++ b/docs/schemas/config-openapi.json @@ -0,0 +1,5360 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1", + "title": "vcluster.yaml" + }, + "paths": {}, + "definitions": { + "Config": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/loft-sh/vcluster/pkg/config/config", + "$defs": { + "AWSElasticBlockStoreVolumeSource": { + "properties": { + "volumeID": { + "type": "string", + "description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "partition": { + "type": "integer", + "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional" + } + }, + "type": "object", + "required": [ + "volumeID" + ], + "description": "Represents a Persistent Disk resource in AWS." + }, + "Access": { + "properties": { + "audit": { + "$ref": "#/definitions/Config/$defs/AccessAudit" + } + }, + "type": "object" + }, + "AccessAudit": { + "properties": { + "enabled": { + "type": "boolean" + }, + "level": { + "type": "integer", + "description": "TODO validate log levels" + }, + "policy": { + "$ref": "#/definitions/Config/$defs/AccessAuditPolicy" + } + }, + "type": "object" + }, + "AccessAuditPolicy": { + "properties": { + "rules": { + "items": { + "$ref": "#/definitions/Config/$defs/PolicyRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdmissionControl": { + "properties": { + "validatingWebhooks": { + "items": { + "$ref": "#/definitions/Config/$defs/ValidatingWebhook" + }, + "type": "array" + }, + "mutatingWebhooks": { + "items": { + "$ref": "#/definitions/Config/$defs/MutatingWebhook" + }, + "type": "array" + } + }, + "type": "object" + }, + "Affinity": { + "properties": { + "nodeAffinity": { + "$ref": "#/definitions/Config/$defs/NodeAffinity", + "description": "Describes node affinity scheduling rules for the pod.\n+optional" + }, + "podAffinity": { + "$ref": "#/definitions/Config/$defs/PodAffinity", + "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).\n+optional" + }, + "podAntiAffinity": { + "$ref": "#/definitions/Config/$defs/PodAntiAffinity", + "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).\n+optional" + } + }, + "type": "object", + "description": "Affinity is a group of affinity scheduling rules." + }, + "AzureDiskVolumeSource": { + "properties": { + "diskName": { + "type": "string", + "description": "diskName is the Name of the data disk in the blob storage" + }, + "diskURI": { + "type": "string", + "description": "diskURI is the URI of data disk in the blob storage" + }, + "cachingMode": { + "type": "string", + "description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "kind": { + "type": "string", + "description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared" + } + }, + "type": "object", + "required": [ + "diskName", + "diskURI" + ], + "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod." + }, + "AzureFileVolumeSource": { + "properties": { + "secretName": { + "type": "string", + "description": "secretName is the name of secret that contains Azure Storage Account Name and Key" + }, + "shareName": { + "type": "string", + "description": "shareName is the azure share Name" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "type": "object", + "required": [ + "secretName", + "shareName" + ], + "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod." + }, + "BackingStore": { + "properties": { + "sqlite": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "embeddedEtcd": { + "$ref": "#/definitions/Config/$defs/EmbeddedEtcd" + }, + "externalEtcd": { + "$ref": "#/definitions/Config/$defs/ExternalEtcd" + } + }, + "type": "object" + }, + "CSIVolumeSource": { + "properties": { + "driver": { + "type": "string", + "description": "driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster." + }, + "readOnly": { + "type": "boolean", + "description": "readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.\n+optional" + }, + "volumeAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.\n+optional" + }, + "nodePublishSecretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "nodePublishSecretRef is a reference to the secret object containing\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed.\n+optional" + } + }, + "type": "object", + "required": [ + "driver" + ], + "description": "Represents a source location of a volume to mount, managed by an external CSI driver" + }, + "Capabilities": { + "properties": { + "add": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Added capabilities\n+optional" + }, + "drop": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Removed capabilities\n+optional" + } + }, + "type": "object", + "description": "Adds and removes POSIX capabilities from running containers." + }, + "CephFSVolumeSource": { + "properties": { + "monitors": { + "items": { + "type": "string" + }, + "type": "array", + "description": "monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + }, + "path": { + "type": "string", + "description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional" + }, + "user": { + "type": "string", + "description": "user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "secretFile": { + "type": "string", + "description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + } + }, + "type": "object", + "required": [ + "monitors" + ], + "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling." + }, + "CinderVolumeSource": { + "properties": { + "volumeID": { + "type": "string", + "description": "volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack.\n+optional" + } + }, + "type": "object", + "required": [ + "volumeID" + ], + "description": "Represents a cinder volume resource in Openstack." + }, + "ClaimSource": { + "properties": { + "resourceClaimName": { + "type": "string", + "description": "ResourceClaimName is the name of a ResourceClaim object in the same\nnamespace as this pod." + }, + "resourceClaimTemplateName": { + "type": "string", + "description": "ResourceClaimTemplateName is the name of a ResourceClaimTemplate\nobject in the same namespace as this pod.\n\nThe template will be used to create a new ResourceClaim, which will\nbe bound to this pod. When this pod is deleted, the ResourceClaim\nwill also be deleted. The pod name and resource name, along with a\ngenerated component, will be used to form a unique name for the\nResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.\n\nThis field is immutable and no changes will be made to the\ncorresponding ResourceClaim by the control plane after creating the\nResourceClaim." + } + }, + "type": "object", + "description": "ClaimSource describes a reference to a ResourceClaim." + }, + "ClientIPConfig": { + "properties": { + "timeoutSeconds": { + "type": "integer", + "description": "timeoutSeconds specifies the seconds of ClientIP type session sticky time.\nThe value must be \u003e0 \u0026\u0026 \u003c=86400(for 1 day) if ServiceAffinity == \"ClientIP\".\nDefault value is 10800(for 3 hours).\n+optional" + } + }, + "type": "object", + "description": "ClientIPConfig represents the configurations of Client IP based session affinity." + }, + "ClusterTrustBundleProjection": { + "properties": { + "name": { + "type": "string", + "description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector.\n+optional" + }, + "signerName": { + "type": "string", + "description": "Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated.\n+optional" + }, + "labelSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\".\n+optional" + }, + "optional": { + "type": "boolean", + "description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles.\n+optional" + }, + "path": { + "type": "string", + "description": "Relative path from the volume root to write the bundle." + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem." + }, + "ConfigMapEnvSource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap must be defined\n+optional" + } + }, + "type": "object", + "description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with." + }, + "ConfigMapKeySelector": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "key": { + "type": "string", + "description": "The key to select." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap or its key must be defined\n+optional" + } + }, + "type": "object", + "required": [ + "key" + ], + "description": "Selects a key from a ConfigMap." + }, + "ConfigMapProjection": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "items": { + "items": { + "$ref": "#/definitions/Config/$defs/KeyToPath" + }, + "type": "array", + "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a ConfigMap into a projected volume." + }, + "ConfigMapVolumeSource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "items": { + "items": { + "$ref": "#/definitions/Config/$defs/KeyToPath" + }, + "type": "array", + "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a ConfigMap into a volume." + }, + "Container": { + "properties": { + "name": { + "type": "string", + "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + }, + "image": { + "type": "string", + "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional" + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "items": { + "$ref": "#/definitions/Config/$defs/ContainerPort" + }, + "type": "array", + "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol" + }, + "envFrom": { + "items": { + "$ref": "#/definitions/Config/$defs/EnvFromSource" + }, + "type": "array", + "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "items": { + "$ref": "#/definitions/Config/$defs/EnvVar" + }, + "type": "array", + "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/definitions/Config/$defs/ResourceRequirements", + "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "resizePolicy": { + "items": { + "$ref": "#/definitions/Config/$defs/ContainerResizePolicy" + }, + "type": "array", + "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic" + }, + "restartPolicy": { + "type": "string", + "description": "RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted.\n+featureGate=SidecarContainers\n+optional" + }, + "volumeMounts": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeMount" + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeDevice" + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "readinessProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "startupProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "lifecycle": { + "$ref": "#/definitions/Config/$defs/Lifecycle", + "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.\n+optional" + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/definitions/Config/$defs/SecurityContext", + "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/\n+optional" + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "A single application container that you want to run within a pod." + }, + "ContainerPort": { + "properties": { + "name": { + "type": "string", + "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional" + }, + "hostPort": { + "type": "integer", + "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 \u003c x \u003c 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional" + }, + "containerPort": { + "type": "integer", + "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 \u003c x \u003c 65536." + }, + "protocol": { + "type": "string", + "description": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".\n+optional\n+default=\"TCP\"" + }, + "hostIP": { + "type": "string", + "description": "What host IP to bind the external port to.\n+optional" + } + }, + "type": "object", + "required": [ + "containerPort" + ], + "description": "ContainerPort represents a network port in a single container." + }, + "ContainerResizePolicy": { + "properties": { + "resourceName": { + "type": "string", + "description": "Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + } + }, + "type": "object", + "required": [ + "resourceName", + "restartPolicy" + ], + "description": "ContainerResizePolicy represents resource resize policy for the container." + }, + "ControlPlane": { + "properties": { + "distro": { + "$ref": "#/definitions/Config/$defs/Distributions" + }, + "backingStore": { + "$ref": "#/definitions/Config/$defs/BackingStore" + }, + "hostPathMapper": { + "$ref": "#/definitions/Config/$defs/HostPathMapper" + }, + "coredns": { + "$ref": "#/definitions/Config/$defs/CoreDNS" + }, + "virtualScheduler": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "proxy": { + "$ref": "#/definitions/Config/$defs/ControlPlaneProxy" + }, + "service": { + "$ref": "#/definitions/Config/$defs/ControlPlaneService" + }, + "ingress": { + "$ref": "#/definitions/Config/$defs/ControlPlaneIngress" + }, + "highAvailability": { + "$ref": "#/definitions/Config/$defs/ControlPlaneHighAvailability" + }, + "advanced": { + "$ref": "#/definitions/Config/$defs/ControlPlaneAdvanced" + } + }, + "type": "object" + }, + "ControlPlaneAdvanced": { + "properties": { + "defaultImageRegistry": { + "type": "string" + }, + "headless": { + "type": "boolean" + }, + "persistence": { + "$ref": "#/definitions/Config/$defs/ControlPlanePersistence" + }, + "scheduling": { + "$ref": "#/definitions/Config/$defs/ControlPlaneScheduling" + }, + "serviceAccounts": { + "$ref": "#/definitions/Config/$defs/ControlPlaneServiceAccounts" + }, + "workloadServiceAccount": { + "$ref": "#/definitions/Config/$defs/ControlPlaneWorkloadServiceAccount" + }, + "probes": { + "$ref": "#/definitions/Config/$defs/ControlPlaneProbes" + }, + "security": { + "$ref": "#/definitions/Config/$defs/ControlPlaneSecurity" + }, + "metadata": { + "$ref": "#/definitions/Config/$defs/ControlPlaneMetadata" + } + }, + "type": "object" + }, + "ControlPlaneContainerSecurityContext": { + "properties": { + "allowPrivilegeEscalation": { + "type": "boolean" + }, + "capabilities": { + "$ref": "#/definitions/Config/$defs/Capabilities" + }, + "runAsUser": { + "type": "integer" + }, + "runAsGroup": { + "type": "integer" + } + }, + "type": "object" + }, + "ControlPlaneHighAvailability": { + "properties": { + "replicas": { + "type": "integer" + }, + "leaseDuration": { + "type": "integer" + }, + "renewDeadline": { + "type": "integer" + }, + "retryPeriod": { + "type": "integer" + } + }, + "type": "object" + }, + "ControlPlaneIngress": { + "properties": { + "enabled": { + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "name": { + "type": "string" + }, + "spec": { + "$ref": "#/definitions/Config/$defs/IngressSpec" + } + }, + "type": "object" + }, + "ControlPlaneMetadata": { + "properties": { + "statefulSet": { + "$ref": "#/definitions/Config/$defs/LabelsAndAnnotations" + }, + "pods": { + "$ref": "#/definitions/Config/$defs/LabelsAndAnnotations" + }, + "allResources": { + "$ref": "#/definitions/Config/$defs/LabelsAndAnnotations" + } + }, + "type": "object" + }, + "ControlPlanePersistence": { + "properties": { + "enabled": { + "type": "boolean" + }, + "retentionPolicy": { + "type": "string" + }, + "size": { + "$ref": "#/definitions/Config/$defs/Quantity" + }, + "storageClass": { + "type": "string" + }, + "addVolumeMounts": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeMount" + }, + "type": "array" + }, + "overwriteVolumeMounts": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeMount" + }, + "type": "array" + } + }, + "type": "object" + }, + "ControlPlaneProbes": { + "properties": { + "livenessProbe": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "readinessProbe": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + } + }, + "type": "object" + }, + "ControlPlaneProxy": { + "properties": { + "bindAddress": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "tls": { + "$ref": "#/definitions/Config/$defs/ControlPlaneProxyTLS" + } + }, + "type": "object" + }, + "ControlPlaneProxyTLS": { + "properties": { + "extraSANs": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ControlPlaneScheduling": { + "properties": { + "nodeSelector": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "affinity": { + "$ref": "#/definitions/Config/$defs/Affinity" + }, + "tolerations": { + "items": { + "$ref": "#/definitions/Config/$defs/Toleration" + }, + "type": "array" + }, + "priorityClassName": { + "type": "string" + } + }, + "type": "object" + }, + "ControlPlaneSecurity": { + "properties": { + "podSecurityContext": { + "$ref": "#/definitions/Config/$defs/PodSecurityContext" + }, + "containerSecurityContext": { + "$ref": "#/definitions/Config/$defs/ControlPlaneContainerSecurityContext" + } + }, + "type": "object" + }, + "ControlPlaneService": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "name": { + "type": "string" + }, + "spec": { + "$ref": "#/definitions/Config/$defs/ServiceSpec" + } + }, + "type": "object" + }, + "ControlPlaneServiceAccounts": { + "properties": { + "create": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "imagePullSecrets": { + "items": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference" + }, + "type": "array" + } + }, + "type": "object" + }, + "ControlPlaneWorkloadServiceAccount": { + "properties": { + "create": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "CoreDNS": { + "properties": { + "enabled": { + "type": "boolean" + }, + "embedded": { + "type": "boolean" + }, + "service": { + "$ref": "#/definitions/Config/$defs/CoreDNSService" + }, + "deployment": { + "$ref": "#/definitions/Config/$defs/CoreDNSDeployment" + } + }, + "type": "object" + }, + "CoreDNSDeployment": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "spec": { + "$ref": "#/definitions/Config/$defs/DeploymentSpec" + } + }, + "type": "object" + }, + "CoreDNSService": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "spec": { + "$ref": "#/definitions/Config/$defs/ServiceSpec" + } + }, + "type": "object" + }, + "DeploymentSpec": { + "properties": { + "replicas": { + "type": "integer", + "description": "Number of desired pods. This is a pointer to distinguish between explicit\nzero and not specified. Defaults to 1.\n+optional" + }, + "selector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "Label selector for pods. Existing ReplicaSets whose pods are\nselected by this will be the ones affected by this deployment.\nIt must match the pod template's labels." + }, + "template": { + "$ref": "#/definitions/Config/$defs/PodTemplateSpec", + "description": "Template describes the pods that will be created.\nThe only allowed template.spec.restartPolicy value is \"Always\"." + }, + "strategy": { + "$ref": "#/definitions/Config/$defs/DeploymentStrategy", + "description": "The deployment strategy to use to replace existing pods with new ones.\n+optional\n+patchStrategy=retainKeys" + }, + "minReadySeconds": { + "type": "integer", + "description": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing, for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n+optional" + }, + "revisionHistoryLimit": { + "type": "integer", + "description": "The number of old ReplicaSets to retain to allow rollback.\nThis is a pointer to distinguish between explicit zero and not specified.\nDefaults to 10.\n+optional" + }, + "paused": { + "type": "boolean", + "description": "Indicates that the deployment is paused.\n+optional" + }, + "progressDeadlineSeconds": { + "type": "integer", + "description": "The maximum time in seconds for a deployment to make progress before it\nis considered to be failed. The deployment controller will continue to\nprocess failed deployments and a condition with a ProgressDeadlineExceeded\nreason will be surfaced in the deployment status. Note that progress will\nnot be estimated during the time a deployment is paused. Defaults to 600s." + } + }, + "type": "object", + "required": [ + "selector", + "template" + ], + "description": "DeploymentSpec is the specification of the desired behavior of the Deployment." + }, + "DeploymentStrategy": { + "properties": { + "type": { + "type": "string", + "description": "Type of deployment. Can be \"Recreate\" or \"RollingUpdate\". Default is RollingUpdate.\n+optional" + }, + "rollingUpdate": { + "$ref": "#/definitions/Config/$defs/RollingUpdateDeployment", + "description": "Rolling update config params. Present only if DeploymentStrategyType =\nRollingUpdate.\n---\nTODO: Update this to follow our convention for oneOf, whatever we decide it\nto be.\n+optional" + } + }, + "type": "object", + "description": "DeploymentStrategy describes how to replace existing pods with new ones." + }, + "DistributionAdvanced": { + "properties": { + "paths": { + "$ref": "#/definitions/Config/$defs/DistributionPaths" + } + }, + "type": "object" + }, + "DistributionPaths": { + "properties": { + "kubeConfig": { + "type": "string" + }, + "serverCAKey": { + "type": "string" + }, + "serverCACert": { + "type": "string" + }, + "clientCACert": { + "type": "string" + }, + "requestHeaderCACert": { + "type": "string" + } + }, + "type": "object" + }, + "Distributions": { + "properties": { + "k3s": { + "$ref": "#/definitions/Config/$defs/DistributionsK3s" + }, + "k8s": { + "$ref": "#/definitions/Config/$defs/DistributionsK8s" + }, + "k0s": { + "$ref": "#/definitions/Config/$defs/Container" + }, + "advanced": { + "$ref": "#/definitions/Config/$defs/DistributionAdvanced" + } + }, + "type": "object" + }, + "DistributionsK3s": { + "properties": { + "name": { + "type": "string", + "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + }, + "image": { + "type": "string", + "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional" + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "items": { + "$ref": "#/definitions/Config/$defs/ContainerPort" + }, + "type": "array", + "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol" + }, + "envFrom": { + "items": { + "$ref": "#/definitions/Config/$defs/EnvFromSource" + }, + "type": "array", + "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "items": { + "$ref": "#/definitions/Config/$defs/EnvVar" + }, + "type": "array", + "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/definitions/Config/$defs/ResourceRequirements", + "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "resizePolicy": { + "items": { + "$ref": "#/definitions/Config/$defs/ContainerResizePolicy" + }, + "type": "array", + "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic" + }, + "restartPolicy": { + "type": "string", + "description": "RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted.\n+featureGate=SidecarContainers\n+optional" + }, + "volumeMounts": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeMount" + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeDevice" + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "readinessProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "startupProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "lifecycle": { + "$ref": "#/definitions/Config/$defs/Lifecycle", + "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.\n+optional" + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/definitions/Config/$defs/SecurityContext", + "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/\n+optional" + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + }, + "token": { + "type": "string" + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "DistributionsK8s": { + "properties": { + "apiServer": { + "$ref": "#/definitions/Config/$defs/Container" + }, + "controllerManager": { + "$ref": "#/definitions/Config/$defs/Container" + }, + "scheduler": { + "$ref": "#/definitions/Config/$defs/Container" + }, + "etcd": { + "$ref": "#/definitions/Config/$defs/Container" + } + }, + "type": "object" + }, + "DownwardAPIProjection": { + "properties": { + "items": { + "items": { + "$ref": "#/definitions/Config/$defs/DownwardAPIVolumeFile" + }, + "type": "array", + "description": "Items is a list of DownwardAPIVolume file\n+optional" + } + }, + "type": "object", + "description": "Represents downward API info for projecting into a projected volume." + }, + "DownwardAPIVolumeFile": { + "properties": { + "path": { + "type": "string", + "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'" + }, + "fieldRef": { + "$ref": "#/definitions/Config/$defs/ObjectFieldSelector", + "description": "Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.\n+optional" + }, + "resourceFieldRef": { + "$ref": "#/definitions/Config/$defs/ResourceFieldSelector", + "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.\n+optional" + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field" + }, + "DownwardAPIVolumeSource": { + "properties": { + "items": { + "items": { + "$ref": "#/definitions/Config/$defs/DownwardAPIVolumeFile" + }, + "type": "array", + "description": "Items is a list of downward API volume file\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "description": "DownwardAPIVolumeSource represents a volume containing downward API info." + }, + "EmbeddedEtcd": { + "properties": { + "enabled": { + "type": "boolean" + }, + "migrateFrom": { + "$ref": "#/definitions/Config/$defs/EmbeddedEtcdMigrateFrom" + } + }, + "type": "object" + }, + "EmbeddedEtcdMigrateFrom": { + "properties": { + "sqlite": { + "type": "boolean" + }, + "etcd": { + "type": "boolean" + } + }, + "type": "object" + }, + "EmptyDirVolumeSource": { + "properties": { + "medium": { + "type": "string", + "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional" + }, + "sizeLimit": { + "$ref": "#/definitions/Config/$defs/Quantity", + "description": "sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional" + } + }, + "type": "object", + "description": "Represents an empty directory for a pod." + }, + "EnableSwitch": { + "properties": { + "enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "EnvFromSource": { + "properties": { + "prefix": { + "type": "string", + "description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.\n+optional" + }, + "configMapRef": { + "$ref": "#/definitions/Config/$defs/ConfigMapEnvSource", + "description": "The ConfigMap to select from\n+optional" + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/SecretEnvSource", + "description": "The Secret to select from\n+optional" + } + }, + "type": "object", + "description": "EnvFromSource represents the source of a set of ConfigMaps" + }, + "EnvVar": { + "properties": { + "name": { + "type": "string", + "description": "Name of the environment variable. Must be a C_IDENTIFIER." + }, + "value": { + "type": "string", + "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional" + }, + "valueFrom": { + "$ref": "#/definitions/Config/$defs/EnvVarSource", + "description": "Source for the environment variable's value. Cannot be used if value is not empty.\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "EnvVar represents an environment variable present in a Container." + }, + "EnvVarSource": { + "properties": { + "fieldRef": { + "$ref": "#/definitions/Config/$defs/ObjectFieldSelector", + "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\n+optional" + }, + "resourceFieldRef": { + "$ref": "#/definitions/Config/$defs/ResourceFieldSelector", + "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.\n+optional" + }, + "configMapKeyRef": { + "$ref": "#/definitions/Config/$defs/ConfigMapKeySelector", + "description": "Selects a key of a ConfigMap.\n+optional" + }, + "secretKeyRef": { + "$ref": "#/definitions/Config/$defs/SecretKeySelector", + "description": "Selects a key of a secret in the pod's namespace\n+optional" + } + }, + "type": "object", + "description": "EnvVarSource represents a source for the value of an EnvVar." + }, + "EphemeralContainer": { + "properties": { + "name": { + "type": "string", + "description": "Name of the ephemeral container specified as a DNS_LABEL.\nThis name must be unique among all containers, init containers and ephemeral containers." + }, + "image": { + "type": "string", + "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images" + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell.\nThe image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint.\nThe image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "items": { + "$ref": "#/definitions/Config/$defs/ContainerPort" + }, + "type": "array", + "description": "Ports are not allowed for ephemeral containers.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol" + }, + "envFrom": { + "items": { + "$ref": "#/definitions/Config/$defs/EnvFromSource" + }, + "type": "array", + "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "items": { + "$ref": "#/definitions/Config/$defs/EnvVar" + }, + "type": "array", + "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/definitions/Config/$defs/ResourceRequirements", + "description": "Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources\nalready allocated to the pod.\n+optional" + }, + "resizePolicy": { + "items": { + "$ref": "#/definitions/Config/$defs/ContainerResizePolicy" + }, + "type": "array", + "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic" + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for the container to manage the restart behavior of each\ncontainer within a pod.\nThis may only be set for init containers. You cannot set this field on\nephemeral containers.\n+featureGate=SidecarContainers\n+optional" + }, + "volumeMounts": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeMount" + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeDevice" + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "Probes are not allowed for ephemeral containers.\n+optional" + }, + "readinessProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "Probes are not allowed for ephemeral containers.\n+optional" + }, + "startupProbe": { + "$ref": "#/definitions/Config/$defs/Probe", + "description": "Probes are not allowed for ephemeral containers.\n+optional" + }, + "lifecycle": { + "$ref": "#/definitions/Config/$defs/Lifecycle", + "description": "Lifecycle is not allowed for ephemeral containers.\n+optional" + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/definitions/Config/$defs/SecurityContext", + "description": "Optional: SecurityContext defines the security options the ephemeral container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\n+optional" + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + }, + "targetContainerName": { + "type": "string", + "description": "If set, the name of the container from PodSpec that this ephemeral container targets.\nThe ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.\nIf not set then the ephemeral container uses the namespaces configured in the Pod spec.\n\nThe container runtime must implement support for this feature. If the runtime does not\nsupport namespace targeting then the result of setting this field is undefined.\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging." + }, + "EphemeralVolumeSource": { + "properties": { + "volumeClaimTemplate": { + "$ref": "#/definitions/Config/$defs/PersistentVolumeClaimTemplate", + "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `\u003cpod name\u003e-\u003cvolume name\u003e` where\n`\u003cvolume name\u003e` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil." + } + }, + "type": "object", + "description": "Represents an ephemeral volume that is handled by a normal storage driver." + }, + "ExecAction": { + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional" + } + }, + "type": "object", + "description": "ExecAction describes a \"run in container\" action." + }, + "Experimental": { + "properties": { + "Extended": { + "type": "object" + }, + "syncSettings": { + "$ref": "#/definitions/Config/$defs/ExperimentalSyncSettings" + }, + "syncPatches": { + "$ref": "#/definitions/Config/$defs/SyncPatchesConfig" + }, + "genericSync": { + "$ref": "#/definitions/Config/$defs/SyncPatchesConfig" + }, + "init": { + "$ref": "#/definitions/Config/$defs/ExperimentalInit" + } + }, + "type": "object", + "required": [ + "Extended" + ] + }, + "ExperimentalInit": { + "properties": { + "manifests": { + "type": "string" + }, + "manifestsTemplate": { + "type": "string" + }, + "helm": { + "items": { + "$ref": "#/definitions/Config/$defs/ExperimentalInitHelm" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExperimentalInitHelm": { + "properties": {}, + "type": "object" + }, + "ExperimentalSyncSettings": { + "properties": { + "disableSync": { + "type": "boolean" + }, + "target": { + "$ref": "#/definitions/Config/$defs/ExperimentalSyncSettingsTarget" + } + }, + "type": "object" + }, + "ExperimentalSyncSettingsTarget": { + "properties": { + "namespace": { + "type": "string" + } + }, + "type": "object" + }, + "Export": { + "properties": { + "apiVersion": { + "type": "string", + "description": "APIVersion of the object to sync" + }, + "kind": { + "type": "string", + "description": "Kind of the object to sync" + }, + "optional": { + "type": "boolean" + }, + "replaceOnConflict": { + "type": "boolean", + "description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying" + }, + "patches": { + "items": { + "$ref": "#/definitions/Config/$defs/Patch" + }, + "type": "array", + "description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster" + }, + "reversePatches": { + "items": { + "$ref": "#/definitions/Config/$defs/Patch" + }, + "type": "array", + "description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster" + }, + "selector": { + "$ref": "#/definitions/Config/$defs/Selector", + "description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced." + } + }, + "type": "object" + }, + "ExportKubeConfig": { + "properties": { + "context": { + "type": "string" + }, + "server": { + "type": "string" + }, + "secret": { + "$ref": "#/definitions/Config/$defs/SecretReference" + } + }, + "type": "object", + "required": [ + "context", + "server" + ] + }, + "ExternalEtcd": { + "properties": { + "image": { + "type": "string" + }, + "replicas": { + "type": "integer" + }, + "metadata": { + "$ref": "#/definitions/Config/$defs/ExternalEtcdMetadata" + } + }, + "type": "object" + }, + "ExternalEtcdMetadata": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "podLabels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "podAnnotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "FCVolumeSource": { + "properties": { + "targetWWNs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "targetWWNs is Optional: FC target worldwide names (WWNs)\n+optional" + }, + "lun": { + "type": "integer", + "description": "lun is Optional: FC target lun number\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "wwids": { + "items": { + "type": "string" + }, + "type": "array", + "description": "wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.\n+optional" + } + }, + "type": "object", + "description": "Represents a Fibre Channel volume." + }, + "FieldsV1": { + "properties": {}, + "type": "object", + "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format." + }, + "FlexVolumeSource": { + "properties": { + "driver": { + "type": "string", + "description": "driver is the name of the driver to use for this volume." + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional" + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts.\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "options": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "options is Optional: this field holds extra command options if any.\n+optional" + } + }, + "type": "object", + "required": [ + "driver" + ], + "description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin." + }, + "FlockerVolumeSource": { + "properties": { + "datasetName": { + "type": "string", + "description": "datasetName is Name of the dataset stored as metadata -\u003e name on the dataset for Flocker\nshould be considered as deprecated\n+optional" + }, + "datasetUUID": { + "type": "string", + "description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset\n+optional" + } + }, + "type": "object", + "description": "Represents a Flocker volume mounted by the Flocker agent." + }, + "GCEPersistentDiskVolumeSource": { + "properties": { + "pdName": { + "type": "string", + "description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + }, + "fsType": { + "type": "string", + "description": "fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "partition": { + "type": "integer", + "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + } + }, + "type": "object", + "required": [ + "pdName" + ], + "description": "Represents a Persistent Disk resource in Google Compute Engine." + }, + "GRPCAction": { + "properties": { + "port": { + "type": "integer", + "description": "Port number of the gRPC service. Number must be in the range 1 to 65535." + }, + "service": { + "type": "string", + "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.\n+optional\n+default=\"\"" + } + }, + "type": "object", + "required": [ + "port", + "service" + ] + }, + "GitRepoVolumeSource": { + "properties": { + "repository": { + "type": "string", + "description": "repository is the URL" + }, + "revision": { + "type": "string", + "description": "revision is the commit hash for the specified revision.\n+optional" + }, + "directory": { + "type": "string", + "description": "directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.\n+optional" + } + }, + "type": "object", + "required": [ + "repository" + ], + "description": "Represents a volume that is populated with the contents of a git repository." + }, + "GlusterfsVolumeSource": { + "properties": { + "endpoints": { + "type": "string", + "description": "endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + }, + "path": { + "type": "string", + "description": "path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional" + } + }, + "type": "object", + "required": [ + "endpoints", + "path" + ], + "description": "Represents a Glusterfs mount that lasts the lifetime of a pod." + }, + "HTTPGetAction": { + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server.\n+optional" + }, + "port": { + "$ref": "#/definitions/Config/$defs/IntOrString", + "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional" + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional" + }, + "httpHeaders": { + "items": { + "$ref": "#/definitions/Config/$defs/HTTPHeader" + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional" + } + }, + "type": "object", + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests." + }, + "HTTPHeader": { + "properties": { + "name": { + "type": "string", + "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + }, + "value": { + "type": "string", + "description": "The header field value" + } + }, + "type": "object", + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes" + }, + "HTTPIngressPath": { + "properties": { + "path": { + "type": "string", + "description": "path is matched against the path of an incoming request. Currently it can\ncontain characters disallowed from the conventional \"path\" part of a URL\nas defined by RFC 3986. Paths must begin with a '/' and must be present\nwhen using PathType with value \"Exact\" or \"Prefix\".\n+optional" + }, + "pathType": { + "type": "string", + "description": "pathType determines the interpretation of the path matching. PathType can\nbe one of the following values:\n* Exact: Matches the URL path exactly.\n* Prefix: Matches based on a URL path prefix split by '/'. Matching is\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types." + }, + "backend": { + "$ref": "#/definitions/Config/$defs/IngressBackend", + "description": "backend defines the referenced service endpoint to which the traffic\nwill be forwarded to." + } + }, + "type": "object", + "required": [ + "pathType", + "backend" + ], + "description": "HTTPIngressPath associates a path with a backend." + }, + "HTTPIngressRuleValue": { + "properties": { + "paths": { + "items": { + "$ref": "#/definitions/Config/$defs/HTTPIngressPath" + }, + "type": "array", + "description": "paths is a collection of paths that map requests to backends.\n+listType=atomic" + } + }, + "type": "object", + "required": [ + "paths" + ], + "description": "HTTPIngressRuleValue is a list of http selectors pointing to backends." + }, + "Hook": { + "properties": { + "apiVersion": { + "type": "string", + "description": "APIVersion of the object to sync" + }, + "kind": { + "type": "string", + "description": "Kind of the object to sync" + }, + "verbs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Verbs are the verbs that the hook should mutate" + }, + "patches": { + "items": { + "$ref": "#/definitions/Config/$defs/Patch" + }, + "type": "array", + "description": "Patches are the patches to apply on the object to be synced" + } + }, + "type": "object" + }, + "Hooks": { + "properties": { + "hostToVirtual": { + "items": { + "$ref": "#/definitions/Config/$defs/Hook" + }, + "type": "array", + "description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster" + }, + "virtualToHost": { + "items": { + "$ref": "#/definitions/Config/$defs/Hook" + }, + "type": "array", + "description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster" + } + }, + "type": "object" + }, + "HostAlias": { + "properties": { + "ip": { + "type": "string", + "description": "IP address of the host file entry." + }, + "hostnames": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Hostnames for the above IP address." + } + }, + "type": "object", + "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file." + }, + "HostPathMapper": { + "properties": { + "enabled": { + "type": "boolean" + }, + "central": { + "type": "boolean" + } + }, + "type": "object" + }, + "HostPathVolumeSource": { + "properties": { + "path": { + "type": "string", + "description": "path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + }, + "type": { + "type": "string", + "description": "type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n+optional" + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "Represents a host path mapped into a pod." + }, + "ISCSIVolumeSource": { + "properties": { + "targetPortal": { + "type": "string", + "description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + }, + "iqn": { + "type": "string", + "description": "iqn is the target iSCSI Qualified Name." + }, + "lun": { + "type": "integer", + "description": "lun represents iSCSI Target Lun number." + }, + "iscsiInterface": { + "type": "string", + "description": "iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional" + }, + "portals": { + "items": { + "type": "string" + }, + "type": "array", + "description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).\n+optional" + }, + "chapAuthDiscovery": { + "type": "boolean", + "description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication\n+optional" + }, + "chapAuthSession": { + "type": "boolean", + "description": "chapAuthSession defines whether support iSCSI Session CHAP authentication\n+optional" + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "secretRef is the CHAP Secret for iSCSI target and initiator authentication\n+optional" + }, + "initiatorName": { + "type": "string", + "description": "initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n\u003ctarget portal\u003e:\u003cvolume name\u003e will be created for the connection.\n+optional" + } + }, + "type": "object", + "required": [ + "targetPortal", + "iqn", + "lun" + ], + "description": "Represents an ISCSI disk." + }, + "Import": { + "properties": { + "apiVersion": { + "type": "string", + "description": "APIVersion of the object to sync" + }, + "kind": { + "type": "string", + "description": "Kind of the object to sync" + }, + "optional": { + "type": "boolean" + }, + "replaceOnConflict": { + "type": "boolean", + "description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying" + }, + "patches": { + "items": { + "$ref": "#/definitions/Config/$defs/Patch" + }, + "type": "array", + "description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster" + }, + "reversePatches": { + "items": { + "$ref": "#/definitions/Config/$defs/Patch" + }, + "type": "array", + "description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster" + } + }, + "type": "object" + }, + "IngressBackend": { + "properties": { + "service": { + "$ref": "#/definitions/Config/$defs/IngressServiceBackend", + "description": "service references a service as a backend.\nThis is a mutually exclusive setting with \"Resource\".\n+optional" + }, + "resource": { + "$ref": "#/definitions/Config/$defs/TypedLocalObjectReference", + "description": "resource is an ObjectRef to another Kubernetes resource in the namespace\nof the Ingress object. If resource is specified, a service.Name and\nservice.Port must not be specified.\nThis is a mutually exclusive setting with \"Service\".\n+optional" + } + }, + "type": "object", + "description": "IngressBackend describes all endpoints for a given service and port." + }, + "IngressRule": { + "properties": { + "host": { + "type": "string", + "description": "host is the fully qualified domain name of a network host, as defined by RFC 3986.\nNote the following deviations from the \"host\" part of the\nURI as defined in RFC 3986:\n1. IPs are not allowed. Currently an IngressRuleValue can only apply to\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth these may change in the future.\nIncoming requests are matched against the host before the\nIngressRuleValue. If the host is unspecified, the Ingress routes all\ntraffic based on the specified IngressRuleValue.\n\nhost can be \"precise\" which is a domain name without the terminating dot of\na network host (e.g. \"foo.bar.com\") or \"wildcard\", which is a domain name\nprefixed with a single wildcard label (e.g. \"*.foo.com\").\nThe wildcard character '*' must appear by itself as the first DNS label and\nmatches only a single label. You cannot have a wildcard label by itself (e.g. Host == \"*\").\nRequests will be matched against the Host field in the following way:\n1. If host is precise, the request matches this rule if the http host header is equal to Host.\n2. If host is a wildcard, then the request matches this rule if the http host header\nis to equal to the suffix (removing the first label) of the wildcard rule.\n+optional" + }, + "http": { + "$ref": "#/definitions/Config/$defs/HTTPIngressRuleValue", + "description": "+optional" + } + }, + "type": "object", + "description": "IngressRule represents the rules mapping the paths under a specified host to the related backend services." + }, + "IngressServiceBackend": { + "properties": { + "name": { + "type": "string", + "description": "name is the referenced service. The service must exist in\nthe same namespace as the Ingress object." + }, + "port": { + "$ref": "#/definitions/Config/$defs/ServiceBackendPort", + "description": "port of the referenced service. A port name or port number\nis required for a IngressServiceBackend." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "IngressServiceBackend references a Kubernetes Service as a Backend." + }, + "IngressSpec": { + "properties": { + "ingressClassName": { + "type": "string", + "description": "ingressClassName is the name of an IngressClass cluster resource. Ingress\ncontroller implementations use this field to know whether they should be\nserving this Ingress resource, by a transitive connection\n(controller -\u003e IngressClass -\u003e Ingress resource). Although the\n`kubernetes.io/ingress.class` annotation (simple constant name) was never\nformally defined, it was widely supported by Ingress controllers to create\na direct binding between Ingress controller and Ingress resources. Newly\ncreated Ingress resources should prefer using the field. However, even\nthough the annotation is officially deprecated, for backwards compatibility\nreasons, ingress controllers should still honor that annotation if present.\n+optional" + }, + "defaultBackend": { + "$ref": "#/definitions/Config/$defs/IngressBackend", + "description": "defaultBackend is the backend that should handle requests that don't\nmatch any rule. If Rules are not specified, DefaultBackend must be specified.\nIf DefaultBackend is not set, the handling of requests that do not match any\nof the rules will be up to the Ingress controller.\n+optional" + }, + "tls": { + "items": { + "$ref": "#/definitions/Config/$defs/IngressTLS" + }, + "type": "array", + "description": "tls represents the TLS configuration. Currently the Ingress only supports a\nsingle TLS port, 443. If multiple members of this list specify different hosts,\nthey will be multiplexed on the same port according to the hostname specified\nthrough the SNI TLS extension, if the ingress controller fulfilling the\ningress supports SNI.\n+listType=atomic\n+optional" + }, + "rules": { + "items": { + "$ref": "#/definitions/Config/$defs/IngressRule" + }, + "type": "array", + "description": "rules is a list of host rules used to configure the Ingress. If unspecified,\nor no rule matches, all traffic is sent to the default backend.\n+listType=atomic\n+optional" + } + }, + "type": "object", + "description": "IngressSpec describes the Ingress the user wishes to exist." + }, + "IngressTLS": { + "properties": { + "hosts": { + "items": { + "type": "string" + }, + "type": "array", + "description": "hosts is a list of hosts included in the TLS certificate. The values in\nthis list must match the name/s used in the tlsSecret. Defaults to the\nwildcard host setting for the loadbalancer controller fulfilling this\nIngress, if left unspecified.\n+listType=atomic\n+optional" + }, + "secretName": { + "type": "string", + "description": "secretName is the name of the secret used to terminate TLS traffic on\nport 443. Field is left optional to allow TLS routing based on SNI\nhostname alone. If the SNI host in a listener conflicts with the \"Host\"\nheader field used by an IngressRule, the SNI host is used for termination\nand value of the \"Host\" header is used for routing.\n+optional" + } + }, + "type": "object", + "description": "IngressTLS describes the transport layer security associated with an ingress." + }, + "IntOrString": { + "properties": { + "Type": { + "type": "integer" + }, + "IntVal": { + "type": "integer" + }, + "StrVal": { + "type": "string" + } + }, + "type": "object", + "required": [ + "Type", + "IntVal", + "StrVal" + ] + }, + "KeyToPath": { + "properties": { + "key": { + "type": "string", + "description": "key is the key to project." + }, + "path": { + "type": "string", + "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + }, + "mode": { + "type": "integer", + "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "required": [ + "key", + "path" + ], + "description": "Maps a string key to a path within a volume." + }, + "LabelSelector": { + "properties": { + "matchLabels": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional" + }, + "matchExpressions": { + "items": { + "$ref": "#/definitions/Config/$defs/LabelSelectorRequirement" + }, + "type": "array", + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional" + } + }, + "type": "object", + "description": "A label selector is a label query over a set of resources." + }, + "LabelSelectorRequirement": { + "properties": { + "key": { + "type": "string", + "description": "key is the label key that the selector applies to." + }, + "operator": { + "type": "string", + "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.\n+optional" + } + }, + "type": "object", + "required": [ + "key", + "operator" + ], + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values." + }, + "LabelsAndAnnotations": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "License": { + "properties": { + "key": { + "type": "string" + }, + "keySecretRef": { + "$ref": "#/definitions/Config/$defs/SecretReference" + } + }, + "type": "object" + }, + "Lifecycle": { + "properties": { + "postStart": { + "$ref": "#/definitions/Config/$defs/LifecycleHandler", + "description": "PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional" + }, + "preStop": { + "$ref": "#/definitions/Config/$defs/LifecycleHandler", + "description": "PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional" + } + }, + "type": "object", + "description": "Lifecycle describes actions that the management system should take in response to container lifecycle events." + }, + "LifecycleHandler": { + "properties": { + "exec": { + "$ref": "#/definitions/Config/$defs/ExecAction", + "description": "Exec specifies the action to take.\n+optional" + }, + "httpGet": { + "$ref": "#/definitions/Config/$defs/HTTPGetAction", + "description": "HTTPGet specifies the http request to perform.\n+optional" + }, + "tcpSocket": { + "$ref": "#/definitions/Config/$defs/TCPSocketAction", + "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified.\n+optional" + }, + "sleep": { + "$ref": "#/definitions/Config/$defs/SleepAction", + "description": "Sleep represents the duration that the container should sleep before being terminated.\n+featureGate=PodLifecycleSleepAction\n+optional" + } + }, + "type": "object", + "description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook." + }, + "LimitRange": { + "properties": { + "enabled": { + "type": "boolean" + }, + "default": { + "$ref": "#/definitions/Config/$defs/LimitRangeLimits" + }, + "defaultRequest": { + "$ref": "#/definitions/Config/$defs/LimitRangeLimits" + } + }, + "type": "object" + }, + "LimitRangeLimits": { + "properties": { + "ephemeral-storage": { + "$ref": "#/definitions/Config/$defs/Quantity" + }, + "memory": { + "$ref": "#/definitions/Config/$defs/Quantity" + }, + "cpu": { + "$ref": "#/definitions/Config/$defs/Quantity" + } + }, + "type": "object" + }, + "LocalObjectReference": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + } + }, + "type": "object", + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace." + }, + "ManagedFieldsEntry": { + "properties": { + "manager": { + "type": "string", + "description": "Manager is an identifier of the workflow managing these fields." + }, + "operation": { + "type": "string", + "description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.\nThe only valid values for this field are 'Apply' and 'Update'." + }, + "apiVersion": { + "type": "string", + "description": "APIVersion defines the version of this resource that this field set\napplies to. The format is \"group/version\" just like the top-level\nAPIVersion field. It is necessary to track the version of a field\nset because it cannot be automatically converted." + }, + "time": { + "$ref": "#/definitions/Config/$defs/Time", + "description": "Time is the timestamp of when the ManagedFields entry was added. The\ntimestamp will also be updated if a field is added, the manager\nchanges any of the owned fields value or removes a field. The\ntimestamp does not update when a field is removed from the entry\nbecause another manager took it over.\n+optional" + }, + "fieldsType": { + "type": "string", + "description": "FieldsType is the discriminator for the different fields format and version.\nThere is currently only one possible value: \"FieldsV1\"" + }, + "fieldsV1": { + "$ref": "#/definitions/Config/$defs/FieldsV1", + "description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.\n+optional" + }, + "subresource": { + "type": "string", + "description": "Subresource is the name of the subresource used to update that object, or\nempty string if the object was updated through the main resource. The\nvalue of this field is used to distinguish between managers, even if they\nshare the same name. For example, a status update will be distinct from a\nregular update using the same manager name.\nNote that the APIVersion field is not related to the Subresource field and\nit always corresponds to the version of the main resource." + } + }, + "type": "object", + "description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to." + }, + "MatchCondition": { + "properties": { + "name": { + "type": "string", + "description": "Name is an identifier for this match condition, used for strategic merging of MatchConditions,\nas well as providing an identifier for logging purposes. A good name should be descriptive of\nthe associated expression.\nName must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and\nmust start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or\n'123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an\noptional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')\n\nRequired." + }, + "expression": { + "type": "string", + "description": "Expression represents the expression which will be evaluated by CEL. Must evaluate to bool.\nCEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:\n\n'object' - The object from the incoming request. The value is null for DELETE requests.\n'oldObject' - The existing object. The value is null for CREATE requests.\n'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest).\n'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.\n See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz\n'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the\n request resource.\nDocumentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/\n\nRequired." + } + }, + "type": "object", + "required": [ + "name", + "expression" + ], + "description": "MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook." + }, + "MutatingWebhook": { + "properties": { + "name": { + "type": "string", + "description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.\nRequired." + }, + "clientConfig": { + "$ref": "#/definitions/Config/$defs/WebhookClientConfig", + "description": "ClientConfig defines how to communicate with the hook.\nRequired" + }, + "rules": { + "items": { + "$ref": "#/definitions/Config/$defs/RuleWithOperations" + }, + "type": "array", + "description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.\nHowever, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks\nfrom putting the cluster in a state which cannot be recovered from without completely\ndisabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called\non admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects." + }, + "failurePolicy": { + "type": "string", + "description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.\n+optional" + }, + "matchPolicy": { + "type": "string", + "description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".\n\n- Exact: match a request only if it exactly matches a specified rule.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nbut \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.\n\n- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nand \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.\n\nDefaults to \"Equivalent\"\n+optional" + }, + "namespaceSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook.\n\nFor example, to run the webhook on any objects whose namespace is not\nassociated with \"runlevel\" of \"0\" or \"1\"; you will set the selector as\nfollows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"runlevel\",\n \"operator\": \"NotIn\",\n \"values\": [\n \"0\",\n \"1\"\n ]\n }\n ]\n}\n\nIf instead you want to only run the webhook on any objects whose\nnamespace is associated with the \"environment\" of \"prod\" or \"staging\";\nyou will set the selector as follows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"environment\",\n \"operator\": \"In\",\n \"values\": [\n \"prod\",\n \"staging\"\n ]\n }\n ]\n}\n\nSee\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/\nfor more examples of label selectors.\n\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "objectSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector. A null\nobject (oldObject in the case of create, or newObject in the case of\ndelete) or an object that cannot have labels (like a\nDeploymentRollback or a PodProxyOptions object) is not considered to\nmatch.\nUse the object selector only if the webhook is opt-in, because end\nusers may skip the admission webhook by setting the labels.\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "sideEffects": { + "type": "string", + "description": "SideEffects states whether this webhook has side effects.\nAcceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown).\nWebhooks with side effects MUST implement a reconciliation system, since a request may be\nrejected by a future step in the admission chain and the side effects therefore need to be undone.\nRequests with the dryRun attribute will be auto-rejected if they match a webhook with\nsideEffects == Unknown or Some." + }, + "timeoutSeconds": { + "type": "integer", + "description": "TimeoutSeconds specifies the timeout for this webhook. After the timeout passes,\nthe webhook call will be ignored or the API call will fail based on the\nfailure policy.\nThe timeout value must be between 1 and 30 seconds.\nDefault to 10 seconds.\n+optional" + }, + "admissionReviewVersions": { + "items": { + "type": "string" + }, + "type": "array", + "description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects. API server will try to use first version in\nthe list which it supports. If none of the versions specified in this list\nsupported by API server, validation will fail for this object.\nIf a persisted webhook configuration specifies allowed versions and does not\ninclude any versions known to the API Server, calls to the webhook will fail\nand be subject to the failure policy." + }, + "reinvocationPolicy": { + "type": "string", + "description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".\n\nNever: the webhook will not be called more than once in a single admission evaluation.\n\nIfNeeded: the webhook will be called at least one additional time as part of the admission evaluation\nif the object being admitted is modified by other admission plugins after the initial webhook call.\nWebhooks that specify this option *must* be idempotent, able to process objects they previously admitted.\nNote:\n* the number of additional invocations is not guaranteed to be exactly one.\n* if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again.\n* webhooks that use this option may be reordered to minimize the number of additional invocations.\n* to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead.\n\nDefaults to \"Never\".\n+optional" + }, + "matchConditions": { + "items": { + "$ref": "#/definitions/Config/$defs/MatchCondition" + }, + "type": "array", + "description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.\n\nThe exact matching logic is (in order):\n 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.\n 2. If ALL matchConditions evaluate to TRUE, the webhook is called.\n 3. If any matchCondition evaluates to an error (but none are FALSE):\n - If failurePolicy=Fail, reject the request\n - If failurePolicy=Ignore, the error is ignored and the webhook is skipped\n\nThis is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+featureGate=AdmissionWebhookMatchConditions\n+optional" + } + }, + "type": "object", + "required": [ + "name", + "clientConfig", + "sideEffects", + "admissionReviewVersions" + ], + "description": "MutatingWebhook describes an admission webhook and the resources and operations it applies to." + }, + "NFSVolumeSource": { + "properties": { + "server": { + "type": "string", + "description": "server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "path": { + "type": "string", + "description": "path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional" + } + }, + "type": "object", + "required": [ + "server", + "path" + ], + "description": "Represents an NFS mount that lasts the lifetime of a pod." + }, + "NetworkDNSFallback": { + "properties": { + "ip": { + "type": "string" + }, + "hostCluster": { + "type": "boolean" + } + }, + "type": "object" + }, + "NetworkPolicy": { + "properties": { + "enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "NetworkProxyKubelets": { + "properties": { + "byHostname": { + "type": "boolean" + }, + "byIP": { + "type": "boolean" + } + }, + "type": "object" + }, + "Networking": { + "properties": { + "replicateServices": { + "$ref": "#/definitions/Config/$defs/ReplicateServices" + }, + "resolveServices": { + "$ref": "#/definitions/Config/$defs/ResolveServices" + }, + "advanced": { + "$ref": "#/definitions/Config/$defs/NetworkingAdvanced" + } + }, + "type": "object" + }, + "NetworkingAdvanced": { + "properties": { + "clusterDomain": { + "type": "string" + }, + "fallback": { + "items": { + "$ref": "#/definitions/Config/$defs/NetworkDNSFallback" + }, + "type": "array" + }, + "proxyKubelets": { + "$ref": "#/definitions/Config/$defs/NetworkProxyKubelets" + } + }, + "type": "object" + }, + "NodeAffinity": { + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "$ref": "#/definitions/Config/$defs/NodeSelector", + "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/definitions/Config/$defs/PreferredSchedulingTerm" + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "type": "object", + "description": "Node affinity is a group of node affinity scheduling rules." + }, + "NodeSelector": { + "properties": { + "nodeSelectorTerms": { + "items": { + "$ref": "#/definitions/Config/$defs/NodeSelectorTerm" + }, + "type": "array", + "description": "Required. A list of node selector terms. The terms are ORed." + } + }, + "type": "object", + "required": [ + "nodeSelectorTerms" + ], + "description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms." + }, + "NodeSelectorRequirement": { + "properties": { + "key": { + "type": "string", + "description": "The label key that the selector applies to." + }, + "operator": { + "type": "string", + "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.\n+optional" + } + }, + "type": "object", + "required": [ + "key", + "operator" + ], + "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values." + }, + "NodeSelectorTerm": { + "properties": { + "matchExpressions": { + "items": { + "$ref": "#/definitions/Config/$defs/NodeSelectorRequirement" + }, + "type": "array", + "description": "A list of node selector requirements by node's labels.\n+optional" + }, + "matchFields": { + "items": { + "$ref": "#/definitions/Config/$defs/NodeSelectorRequirement" + }, + "type": "array", + "description": "A list of node selector requirements by node's fields.\n+optional" + } + }, + "type": "object", + "description": "A null or empty node selector term matches no objects." + }, + "ObjectFieldSelector": { + "properties": { + "apiVersion": { + "type": "string", + "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional" + }, + "fieldPath": { + "type": "string", + "description": "Path of the field to select in the specified API version." + } + }, + "type": "object", + "required": [ + "fieldPath" + ], + "description": "ObjectFieldSelector selects an APIVersioned field of an object." + }, + "ObjectMeta": { + "properties": { + "name": { + "type": "string", + "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional" + }, + "generateName": { + "type": "string", + "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional" + }, + "namespace": { + "type": "string", + "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional" + }, + "selfLink": { + "type": "string", + "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional" + }, + "uid": { + "type": "string", + "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids\n+optional" + }, + "resourceVersion": { + "type": "string", + "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional" + }, + "generation": { + "type": "integer", + "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional" + }, + "creationTimestamp": { + "$ref": "#/definitions/Config/$defs/Time", + "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional" + }, + "deletionTimestamp": { + "$ref": "#/definitions/Config/$defs/Time", + "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional" + }, + "deletionGracePeriodSeconds": { + "type": "integer", + "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional" + }, + "ownerReferences": { + "items": { + "$ref": "#/definitions/Config/$defs/OwnerReference" + }, + "type": "array", + "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge" + }, + "finalizers": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge" + }, + "managedFields": { + "items": { + "$ref": "#/definitions/Config/$defs/ManagedFieldsEntry" + }, + "type": "array", + "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional" + } + }, + "type": "object", + "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + }, + "Observability": { + "properties": { + "serviceMonitor": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "metrics": { + "$ref": "#/definitions/Config/$defs/ObservabilityMetrics" + } + }, + "type": "object" + }, + "ObservabilityMetrics": { + "properties": { + "proxy": { + "$ref": "#/definitions/Config/$defs/ObservabilityMetricsProxy" + } + }, + "type": "object" + }, + "ObservabilityMetricsProxy": { + "properties": { + "nodes": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "pods": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + } + }, + "type": "object" + }, + "OwnerReference": { + "properties": { + "apiVersion": { + "type": "string", + "description": "API version of the referent." + }, + "kind": { + "type": "string", + "description": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + }, + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names" + }, + "uid": { + "type": "string", + "description": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids" + }, + "controller": { + "type": "boolean", + "description": "If true, this reference points to the managing controller.\n+optional" + }, + "blockOwnerDeletion": { + "type": "boolean", + "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nSee https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion\nfor how the garbage collector interacts with this field and enforces the foreground deletion.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional" + } + }, + "type": "object", + "required": [ + "apiVersion", + "kind", + "name", + "uid" + ], + "description": "OwnerReference contains enough information to let you identify an owning object." + }, + "Patch": { + "properties": { + "op": { + "type": "string", + "description": "Operation is the type of the patch" + }, + "fromPath": { + "type": "string", + "description": "FromPath is the path from the other object" + }, + "path": { + "type": "string", + "description": "Path is the path of the patch" + }, + "namePath": { + "type": "string", + "description": "NamePath is the path to the name of a child resource within Path" + }, + "namespacePath": { + "type": "string", + "description": "NamespacePath is path to the namespace of a child resource within Path" + }, + "value": { + "description": "Value is the new value to be set to the path" + }, + "regex": { + "type": "string", + "description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace" + }, + "conditions": { + "items": { + "$ref": "#/definitions/Config/$defs/PatchCondition" + }, + "type": "array", + "description": "Conditions are conditions that must be true for\nthe patch to get executed" + }, + "ignore": { + "type": "boolean", + "description": "Ignore determines if the path should be ignored if handled as a reverse patch" + }, + "sync": { + "$ref": "#/definitions/Config/$defs/PatchSync", + "description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced" + } + }, + "type": "object" + }, + "PatchCondition": { + "properties": { + "path": { + "type": "string", + "description": "Path is the path within the object to select" + }, + "subPath": { + "type": "string", + "description": "SubPath is the path below the selected object to select" + }, + "equal": { + "description": "Equal is the value the path should be equal to" + }, + "notEqual": { + "description": "NotEqual is the value the path should not be equal to" + }, + "empty": { + "type": "boolean", + "description": "Empty means that the path value should be empty or unset" + } + }, + "type": "object" + }, + "PatchSync": { + "properties": { + "secret": { + "type": "boolean" + }, + "configmap": { + "type": "boolean" + } + }, + "type": "object" + }, + "PersistentVolumeClaimSpec": { + "properties": { + "accessModes": { + "items": { + "type": "string" + }, + "type": "array", + "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1\n+optional" + }, + "selector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "selector is a label query over volumes to consider for binding.\n+optional" + }, + "resources": { + "$ref": "#/definitions/Config/$defs/VolumeResourceRequirements", + "description": "resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources\n+optional" + }, + "volumeName": { + "type": "string", + "description": "volumeName is the binding reference to the PersistentVolume backing this claim.\n+optional" + }, + "storageClassName": { + "type": "string", + "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1\n+optional" + }, + "volumeMode": { + "type": "string", + "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.\n+optional" + }, + "dataSource": { + "$ref": "#/definitions/Config/$defs/TypedLocalObjectReference", + "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.\n+optional" + }, + "dataSourceRef": { + "$ref": "#/definitions/Config/$defs/TypedObjectReference", + "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+optional" + }, + "volumeAttributesClassName": { + "type": "string", + "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\n+featureGate=VolumeAttributesClass\n+optional" + } + }, + "type": "object", + "description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes" + }, + "PersistentVolumeClaimTemplate": { + "properties": { + "metadata": { + "$ref": "#/definitions/Config/$defs/ObjectMeta" + }, + "spec": { + "$ref": "#/definitions/Config/$defs/PersistentVolumeClaimSpec", + "description": "The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + } + }, + "type": "object", + "required": [ + "spec" + ], + "description": "PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource." + }, + "PersistentVolumeClaimVolumeSource": { + "properties": { + "claimName": { + "type": "string", + "description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false.\n+optional" + } + }, + "type": "object", + "required": [ + "claimName" + ], + "description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace." + }, + "PhotonPersistentDiskVolumeSource": { + "properties": { + "pdID": { + "type": "string", + "description": "pdID is the ID that identifies Photon Controller persistent disk" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + }, + "type": "object", + "required": [ + "pdID" + ], + "description": "Represents a Photon Controller persistent disk resource." + }, + "Platform": { + "properties": { + "name": { + "type": "string" + }, + "owner": { + "type": "string" + }, + "project": { + "type": "string" + }, + "apiKey": { + "$ref": "#/definitions/Config/$defs/License" + } + }, + "type": "object" + }, + "Plugin": { + "properties": { + "image": { + "type": "string" + }, + "config": { + "type": "object" + }, + "rbac": { + "$ref": "#/definitions/Config/$defs/PluginsRBAC" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "Plugins": { + "properties": { + "image": { + "type": "string" + }, + "config": { + "type": "object" + }, + "rbac": { + "$ref": "#/definitions/Config/$defs/PluginsRBAC" + } + }, + "type": "object" + }, + "PluginsRBAC": { + "properties": { + "role": { + "items": { + "$ref": "#/definitions/Config/$defs/PolicyRule" + }, + "type": "array" + }, + "clusterRole": { + "items": { + "$ref": "#/definitions/Config/$defs/PolicyRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "PodAffinity": { + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/definitions/Config/$defs/PodAffinityTerm" + }, + "type": "array", + "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/definitions/Config/$defs/WeightedPodAffinityTerm" + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "type": "object", + "description": "Pod affinity is a group of inter pod affinity scheduling rules." + }, + "PodAffinityTerm": { + "properties": { + "labelSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.\n+optional" + }, + "namespaces": { + "items": { + "type": "string" + }, + "type": "array", + "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".\n+optional" + }, + "topologyKey": { + "type": "string", + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + }, + "namespaceSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.\n+optional" + }, + "matchLabelKeys": { + "items": { + "type": "string" + }, + "type": "array", + "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nAlso, MatchLabelKeys cannot be set when LabelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\n+listType=atomic\n+optional" + }, + "mismatchLabelKeys": { + "items": { + "type": "string" + }, + "type": "array", + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both MismatchLabelKeys and LabelSelector.\nAlso, MismatchLabelKeys cannot be set when LabelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\n+listType=atomic\n+optional" + } + }, + "type": "object", + "required": [ + "topologyKey" + ], + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key \u003ctopologyKey\u003e matches that of any node on which a pod of the set of pods is running" + }, + "PodAntiAffinity": { + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/definitions/Config/$defs/PodAffinityTerm" + }, + "type": "array", + "description": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/definitions/Config/$defs/WeightedPodAffinityTerm" + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "type": "object", + "description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules." + }, + "PodDNSConfig": { + "properties": { + "nameservers": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed.\n+optional" + }, + "searches": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed.\n+optional" + }, + "options": { + "items": { + "$ref": "#/definitions/Config/$defs/PodDNSConfigOption" + }, + "type": "array", + "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy.\n+optional" + } + }, + "type": "object", + "description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy." + }, + "PodDNSConfigOption": { + "properties": { + "name": { + "type": "string", + "description": "Required." + }, + "value": { + "type": "string", + "description": "+optional" + } + }, + "type": "object", + "description": "PodDNSConfigOption defines DNS resolver options of a pod." + }, + "PodOS": { + "properties": { + "name": { + "type": "string", + "description": "Name is the name of the operating system. The currently supported values are linux and windows.\nAdditional value may be defined in future and can be one of:\nhttps://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration\nClients should expect to handle additional values and treat unrecognized values in this field as os: null" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "PodOS defines the OS parameters of a pod." + }, + "PodReadinessGate": { + "properties": { + "conditionType": { + "type": "string", + "description": "ConditionType refers to a condition in the pod's condition list with matching type." + } + }, + "type": "object", + "required": [ + "conditionType" + ], + "description": "PodReadinessGate contains the reference to a pod condition" + }, + "PodResourceClaim": { + "properties": { + "name": { + "type": "string", + "description": "Name uniquely identifies this resource claim inside the pod.\nThis must be a DNS_LABEL." + }, + "source": { + "$ref": "#/definitions/Config/$defs/ClaimSource", + "description": "Source describes where to find the ResourceClaim." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "PodResourceClaim references exactly one ResourceClaim through a ClaimSource." + }, + "PodSchedulingGate": { + "properties": { + "name": { + "type": "string", + "description": "Name of the scheduling gate.\nEach scheduling gate must have a unique name field." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "PodSchedulingGate is associated to a Pod to guard its scheduling." + }, + "PodSecurityContext": { + "properties": { + "seLinuxOptions": { + "$ref": "#/definitions/Config/$defs/SELinuxOptions", + "description": "The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "windowsOptions": { + "$ref": "#/definitions/Config/$defs/WindowsSecurityContextOptions", + "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional" + }, + "runAsUser": { + "type": "integer", + "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsGroup": { + "type": "integer", + "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsNonRoot": { + "type": "boolean", + "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "supplementalGroups": { + "items": { + "type": "integer" + }, + "type": "array", + "description": "A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "fsGroup": { + "type": "integer", + "description": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "sysctls": { + "items": { + "$ref": "#/definitions/Config/$defs/Sysctl" + }, + "type": "array", + "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "fsGroupChangePolicy": { + "type": "string", + "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "seccompProfile": { + "$ref": "#/definitions/Config/$defs/SeccompProfile", + "description": "The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + } + }, + "type": "object", + "description": "PodSecurityContext holds pod-level security attributes and common container settings." + }, + "PodSpec": { + "properties": { + "volumes": { + "items": { + "$ref": "#/definitions/Config/$defs/Volume" + }, + "type": "array", + "description": "List of volumes that can be mounted by containers belonging to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes\n+optional\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys" + }, + "initContainers": { + "items": { + "$ref": "#/definitions/Config/$defs/Container" + }, + "type": "array", + "description": "List of initialization containers belonging to the pod.\nInit containers are executed in order prior to containers being started. If any\ninit container fails, the pod is considered to have failed and is handled according\nto its restartPolicy. The name for an init container or normal container must be\nunique among all containers.\nInit containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.\nThe resourceRequirements of an init container are taken into account during scheduling\nby finding the highest request/limit for each resource type, and then using the max of\nof that value or the sum of the normal containers. Limits are applied to init containers\nin a similar fashion.\nInit containers cannot currently be added or removed.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "containers": { + "items": { + "$ref": "#/definitions/Config/$defs/Container" + }, + "type": "array", + "description": "List of containers belonging to the pod.\nContainers cannot currently be added or removed.\nThere must be at least one container in a Pod.\nCannot be updated.\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "ephemeralContainers": { + "items": { + "$ref": "#/definitions/Config/$defs/EphemeralContainer" + }, + "type": "array", + "description": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing\npod to perform user-initiated actions such as debugging. This list cannot be specified when\ncreating a pod, and it cannot be modified by updating the pod spec. In order to add an\nephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the pod.\nOne of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted.\nDefault to Always.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy\n+optional" + }, + "terminationGracePeriodSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional" + }, + "activeDeadlineSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod may be active on the node relative to\nStartTime before the system will actively try to mark it failed and kill associated containers.\nValue must be a positive integer.\n+optional" + }, + "dnsPolicy": { + "type": "string", + "description": "Set DNS policy for the pod.\nDefaults to \"ClusterFirst\".\nValid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.\nDNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.\nTo have DNS options set along with hostNetwork, you have to specify DNS policy\nexplicitly to 'ClusterFirstWithHostNet'.\n+optional" + }, + "nodeSelector": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "NodeSelector is a selector which must be true for the pod to fit on a node.\nSelector which must match a node's labels for the pod to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n+optional\n+mapType=atomic" + }, + "serviceAccountName": { + "type": "string", + "description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional" + }, + "serviceAccount": { + "type": "string", + "description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.\nDeprecated: Use serviceAccountName instead.\n+k8s:conversion-gen=false\n+optional" + }, + "automountServiceAccountToken": { + "type": "boolean", + "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.\n+optional" + }, + "nodeName": { + "type": "string", + "description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty,\nthe scheduler simply schedules this pod onto that node, assuming that it fits resource\nrequirements.\n+optional" + }, + "hostNetwork": { + "type": "boolean", + "description": "Host networking requested for this pod. Use the host's network namespace.\nIf this option is set, the ports that will be used must be specified.\nDefault to false.\n+k8s:conversion-gen=false\n+optional" + }, + "hostPID": { + "type": "boolean", + "description": "Use the host's pid namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "hostIPC": { + "type": "boolean", + "description": "Use the host's ipc namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "shareProcessNamespace": { + "type": "boolean", + "description": "Share a single process namespace between all of the containers in a pod.\nWhen this is set containers will be able to view and signal processes from other containers\nin the same pod, and the first process in each container will not be assigned PID 1.\nHostPID and ShareProcessNamespace cannot both be set.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "securityContext": { + "$ref": "#/definitions/Config/$defs/PodSecurityContext", + "description": "SecurityContext holds pod-level security attributes and common container settings.\nOptional: Defaults to empty. See type description for default values of each field.\n+optional" + }, + "imagePullSecrets": { + "items": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference" + }, + "type": "array", + "description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.\nIf specified, these secrets will be passed to individual puller implementations for them to use.\nMore info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "hostname": { + "type": "string", + "description": "Specifies the hostname of the Pod\nIf not specified, the pod's hostname will be set to a system-defined value.\n+optional" + }, + "subdomain": { + "type": "string", + "description": "If specified, the fully qualified Pod hostname will be \"\u003chostname\u003e.\u003csubdomain\u003e.\u003cpod namespace\u003e.svc.\u003ccluster domain\u003e\".\nIf not specified, the pod will not have a domainname at all.\n+optional" + }, + "affinity": { + "$ref": "#/definitions/Config/$defs/Affinity", + "description": "If specified, the pod's scheduling constraints\n+optional" + }, + "schedulerName": { + "type": "string", + "description": "If specified, the pod will be dispatched by specified scheduler.\nIf not specified, the pod will be dispatched by default scheduler.\n+optional" + }, + "tolerations": { + "items": { + "$ref": "#/definitions/Config/$defs/Toleration" + }, + "type": "array", + "description": "If specified, the pod's tolerations.\n+optional" + }, + "hostAliases": { + "items": { + "$ref": "#/definitions/Config/$defs/HostAlias" + }, + "type": "array", + "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts\nfile if specified. This is only valid for non-hostNetwork pods.\n+optional\n+patchMergeKey=ip\n+patchStrategy=merge" + }, + "priorityClassName": { + "type": "string", + "description": "If specified, indicates the pod's priority. \"system-node-critical\" and\n\"system-cluster-critical\" are two special keywords which indicate the\nhighest priorities with the former being the highest priority. Any other\nname must be defined by creating a PriorityClass object with that name.\nIf not specified, the pod priority will be default or zero if there is no\ndefault.\n+optional" + }, + "priority": { + "type": "integer", + "description": "The priority value. Various system components use this field to find the\npriority of the pod. When Priority Admission Controller is enabled, it\nprevents users from setting this field. The admission controller populates\nthis field from PriorityClassName.\nThe higher the value, the higher the priority.\n+optional" + }, + "dnsConfig": { + "$ref": "#/definitions/Config/$defs/PodDNSConfig", + "description": "Specifies the DNS parameters of a pod.\nParameters specified here will be merged to the generated DNS\nconfiguration based on DNSPolicy.\n+optional" + }, + "readinessGates": { + "items": { + "$ref": "#/definitions/Config/$defs/PodReadinessGate" + }, + "type": "array", + "description": "If specified, all readiness gates will be evaluated for pod readiness.\nA pod is ready when all its containers are ready AND\nall conditions specified in the readiness gates have status equal to \"True\"\nMore info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates\n+optional" + }, + "runtimeClassName": { + "type": "string", + "description": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used\nto run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.\nIf unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an\nempty definition that uses the default runtime handler.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class\n+optional" + }, + "enableServiceLinks": { + "type": "boolean", + "description": "EnableServiceLinks indicates whether information about services should be injected into pod's\nenvironment variables, matching the syntax of Docker links.\nOptional: Defaults to true.\n+optional" + }, + "preemptionPolicy": { + "type": "string", + "description": "PreemptionPolicy is the Policy for preempting pods with lower priority.\nOne of Never, PreemptLowerPriority.\nDefaults to PreemptLowerPriority if unset.\n+optional" + }, + "overhead": { + "$ref": "#/definitions/Config/$defs/ResourceList", + "description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.\nThis field will be autopopulated at admission time by the RuntimeClass admission controller. If\nthe RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.\nThe RuntimeClass admission controller will reject Pod create requests which have the overhead already\nset. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value\ndefined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md\n+optional" + }, + "topologySpreadConstraints": { + "items": { + "$ref": "#/definitions/Config/$defs/TopologySpreadConstraint" + }, + "type": "array", + "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nAll topologySpreadConstraints are ANDed.\n+optional\n+patchMergeKey=topologyKey\n+patchStrategy=merge\n+listType=map\n+listMapKey=topologyKey\n+listMapKey=whenUnsatisfiable" + }, + "setHostnameAsFQDN": { + "type": "boolean", + "description": "If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).\nIn Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).\nIn Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\\\SYSTEM\\\\CurrentControlSet\\\\Services\\\\Tcpip\\\\Parameters to FQDN.\nIf a pod does not have FQDN, this has no effect.\nDefault to false.\n+optional" + }, + "os": { + "$ref": "#/definitions/Config/$defs/PodOS", + "description": "Specifies the OS of the containers in the pod.\nSome pod and container fields are restricted if this is set.\n\nIf the OS field is set to linux, the following fields must be unset:\n-securityContext.windowsOptions\n\nIf the OS field is set to windows, following fields must be unset:\n- spec.hostPID\n- spec.hostIPC\n- spec.hostUsers\n- spec.securityContext.seLinuxOptions\n- spec.securityContext.seccompProfile\n- spec.securityContext.fsGroup\n- spec.securityContext.fsGroupChangePolicy\n- spec.securityContext.sysctls\n- spec.shareProcessNamespace\n- spec.securityContext.runAsUser\n- spec.securityContext.runAsGroup\n- spec.securityContext.supplementalGroups\n- spec.containers[*].securityContext.seLinuxOptions\n- spec.containers[*].securityContext.seccompProfile\n- spec.containers[*].securityContext.capabilities\n- spec.containers[*].securityContext.readOnlyRootFilesystem\n- spec.containers[*].securityContext.privileged\n- spec.containers[*].securityContext.allowPrivilegeEscalation\n- spec.containers[*].securityContext.procMount\n- spec.containers[*].securityContext.runAsUser\n- spec.containers[*].securityContext.runAsGroup\n+optional" + }, + "hostUsers": { + "type": "boolean", + "description": "Use the host's user namespace.\nOptional: Default to true.\nIf set to true or not present, the pod will be run in the host user namespace, useful\nfor when the pod needs a feature only available to the host user namespace, such as\nloading a kernel module with CAP_SYS_MODULE.\nWhen set to false, a new userns is created for the pod. Setting false is useful for\nmitigating container breakout vulnerabilities even allowing users to run their\ncontainers as root without actually having root privileges on the host.\nThis field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.\n+k8s:conversion-gen=false\n+optional" + }, + "schedulingGates": { + "items": { + "$ref": "#/definitions/Config/$defs/PodSchedulingGate" + }, + "type": "array", + "description": "SchedulingGates is an opaque list of values that if specified will block scheduling the pod.\nIf schedulingGates is not empty, the pod will stay in the SchedulingGated state and the\nscheduler will not attempt to schedule the pod.\n\nSchedulingGates can only be set at pod creation time, and be removed only afterwards.\n\nThis is a beta feature enabled by the PodSchedulingReadiness feature gate.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+featureGate=PodSchedulingReadiness\n+optional" + }, + "resourceClaims": { + "items": { + "$ref": "#/definitions/Config/$defs/PodResourceClaim" + }, + "type": "array", + "description": "ResourceClaims defines which ResourceClaims must be allocated\nand reserved before the Pod is allowed to start. The resources\nwill be made available to those containers which consume them\nby name.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable.\n\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional" + } + }, + "type": "object", + "required": [ + "containers" + ], + "description": "PodSpec is a description of a pod." + }, + "PodTemplateSpec": { + "properties": { + "metadata": { + "$ref": "#/definitions/Config/$defs/ObjectMeta" + }, + "spec": { + "$ref": "#/definitions/Config/$defs/PodSpec", + "description": "Specification of the desired behavior of the pod.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status\n+optional" + } + }, + "type": "object", + "description": "PodTemplateSpec describes the data a pod should have when created from a template" + }, + "Policies": { + "properties": { + "podSecurityStandard": { + "type": "string" + }, + "resourceQuota": { + "$ref": "#/definitions/Config/$defs/ResourceQuota" + }, + "limitRange": { + "$ref": "#/definitions/Config/$defs/LimitRange" + }, + "networkPolicy": { + "$ref": "#/definitions/Config/$defs/NetworkPolicy" + }, + "admissionControl": { + "$ref": "#/definitions/Config/$defs/AdmissionControl" + } + }, + "type": "object" + }, + "PolicyRule": { + "properties": { + "verbs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs." + }, + "apiGroups": { + "items": { + "type": "string" + }, + "type": "array", + "description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.\n+optional" + }, + "resources": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Resources is a list of resources this rule applies to. '*' represents all resources.\n+optional" + }, + "resourceNames": { + "items": { + "type": "string" + }, + "type": "array", + "description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.\n+optional" + }, + "nonResourceURLs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.\n+optional" + } + }, + "type": "object", + "required": [ + "verbs" + ], + "description": "PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to." + }, + "PortworxVolumeSource": { + "properties": { + "volumeID": { + "type": "string", + "description": "volumeID uniquely identifies a Portworx volume" + }, + "fsType": { + "type": "string", + "description": "fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "type": "object", + "required": [ + "volumeID" + ], + "description": "PortworxVolumeSource represents a Portworx volume resource." + }, + "PreferredSchedulingTerm": { + "properties": { + "weight": { + "type": "integer", + "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100." + }, + "preference": { + "$ref": "#/definitions/Config/$defs/NodeSelectorTerm", + "description": "A node selector term, associated with the corresponding weight." + } + }, + "type": "object", + "required": [ + "weight", + "preference" + ], + "description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e." + }, + "Probe": { + "properties": { + "exec": { + "$ref": "#/definitions/Config/$defs/ExecAction", + "description": "Exec specifies the action to take.\n+optional" + }, + "httpGet": { + "$ref": "#/definitions/Config/$defs/HTTPGetAction", + "description": "HTTPGet specifies the http request to perform.\n+optional" + }, + "tcpSocket": { + "$ref": "#/definitions/Config/$defs/TCPSocketAction", + "description": "TCPSocket specifies an action involving a TCP port.\n+optional" + }, + "grpc": { + "$ref": "#/definitions/Config/$defs/GRPCAction", + "description": "GRPC specifies an action involving a GRPC port.\n+optional" + }, + "initialDelaySeconds": { + "type": "integer", + "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "timeoutSeconds": { + "type": "integer", + "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "periodSeconds": { + "type": "integer", + "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional" + }, + "successThreshold": { + "type": "integer", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional" + }, + "failureThreshold": { + "type": "integer", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional" + }, + "terminationGracePeriodSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\n+optional" + } + }, + "type": "object", + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic." + }, + "ProjectedVolumeSource": { + "properties": { + "sources": { + "items": { + "$ref": "#/definitions/Config/$defs/VolumeProjection" + }, + "type": "array", + "description": "sources is the list of volume projections\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "required": [ + "sources" + ], + "description": "Represents a projected volume source" + }, + "Quantity": { + "properties": { + "Format": { + "type": "string" + } + }, + "type": "object", + "required": [ + "Format" + ], + "description": "Quantity is a fixed-point representation of a number." + }, + "QuobyteVolumeSource": { + "properties": { + "registry": { + "type": "string", + "description": "registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes" + }, + "volume": { + "type": "string", + "description": "volume is a string that references an already created Quobyte volume by name." + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.\n+optional" + }, + "user": { + "type": "string", + "description": "user to map volume access to\nDefaults to serivceaccount user\n+optional" + }, + "group": { + "type": "string", + "description": "group to map volume access to\nDefault is no group\n+optional" + }, + "tenant": { + "type": "string", + "description": "tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin\n+optional" + } + }, + "type": "object", + "required": [ + "registry", + "volume" + ], + "description": "Represents a Quobyte mount that lasts the lifetime of a pod." + }, + "RBAC": { + "properties": { + "clusterRole": { + "$ref": "#/definitions/Config/$defs/RBACClusterRole" + }, + "role": { + "$ref": "#/definitions/Config/$defs/RBACRole" + } + }, + "type": "object" + }, + "RBACClusterRole": { + "properties": { + "create": { + "type": "boolean" + }, + "extraRules": true + }, + "type": "object" + }, + "RBACRole": { + "properties": { + "create": { + "type": "boolean" + }, + "extraRules": true, + "excludedApiResources": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RBDVolumeSource": { + "properties": { + "monitors": { + "items": { + "type": "string" + }, + "type": "array", + "description": "monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + }, + "image": { + "type": "string", + "description": "image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "pool": { + "type": "string", + "description": "pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "user": { + "type": "string", + "description": "user is the rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "keyring": { + "type": "string", + "description": "keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "secretRef is name of the authentication secret for RBDUser. If provided\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + } + }, + "type": "object", + "required": [ + "monitors", + "image" + ], + "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod." + }, + "ReplicateServices": { + "properties": { + "toHost": { + "$ref": "#/definitions/Config/$defs/ServiceMapping" + }, + "fromHost": { + "$ref": "#/definitions/Config/$defs/ServiceMapping" + } + }, + "type": "object" + }, + "ResolveServiceHostname": { + "properties": { + "hostname": { + "type": "string" + } + }, + "type": "object" + }, + "ResolveServiceService": { + "properties": { + "service": { + "type": "string" + } + }, + "type": "object" + }, + "ResolveServiceTarget": { + "properties": { + "vcluster": { + "$ref": "#/definitions/Config/$defs/ResolveServiceService" + }, + "host": { + "$ref": "#/definitions/Config/$defs/ResolveServiceService" + }, + "external": { + "$ref": "#/definitions/Config/$defs/ResolveServiceHostname" + } + }, + "type": "object" + }, + "ResolveServices": { + "properties": { + "service": { + "type": "string" + }, + "target": { + "$ref": "#/definitions/Config/$defs/ResolveServiceTarget" + } + }, + "type": "object" + }, + "ResourceClaim": { + "properties": { + "name": { + "type": "string", + "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "ResourceClaim references one entry in PodSpec.ResourceClaims." + }, + "ResourceFieldSelector": { + "properties": { + "containerName": { + "type": "string", + "description": "Container name: required for volumes, optional for env vars\n+optional" + }, + "resource": { + "type": "string", + "description": "Required: resource to select" + }, + "divisor": { + "$ref": "#/definitions/Config/$defs/Quantity", + "description": "Specifies the output format of the exposed resources, defaults to \"1\"\n+optional" + } + }, + "type": "object", + "required": [ + "resource" + ], + "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic" + }, + "ResourceList": { + "additionalProperties": { + "$ref": "#/definitions/Config/$defs/Quantity" + }, + "type": "object", + "description": "ResourceList is a set of (resource name, quantity) pairs." + }, + "ResourceQuota": { + "properties": { + "enabled": { + "type": "boolean" + }, + "quota": { + "$ref": "#/definitions/Config/$defs/ResourceList" + }, + "scopeSelector": { + "$ref": "#/definitions/Config/$defs/ScopeSelector" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResourceRequirements": { + "properties": { + "limits": { + "$ref": "#/definitions/Config/$defs/ResourceList", + "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "requests": { + "$ref": "#/definitions/Config/$defs/ResourceList", + "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "claims": { + "items": { + "$ref": "#/definitions/Config/$defs/ResourceClaim" + }, + "type": "array", + "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.\n\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional" + } + }, + "type": "object", + "description": "ResourceRequirements describes the compute resource requirements." + }, + "RollingUpdateDeployment": { + "properties": { + "maxUnavailable": { + "$ref": "#/definitions/Config/$defs/IntOrString", + "description": "The maximum number of pods that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding down.\nThis can not be 0 if MaxSurge is 0.\nDefaults to 25%.\nExample: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods\nimmediately when the rolling update starts. Once new pods are ready, old ReplicaSet\ncan be scaled down further, followed by scaling up the new ReplicaSet, ensuring\nthat the total number of pods available at all times during the update is at\nleast 70% of desired pods.\n+optional" + }, + "maxSurge": { + "$ref": "#/definitions/Config/$defs/IntOrString", + "description": "The maximum number of pods that can be scheduled above the desired number of\npods.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nThis can not be 0 if MaxUnavailable is 0.\nAbsolute number is calculated from percentage by rounding up.\nDefaults to 25%.\nExample: when this is set to 30%, the new ReplicaSet can be scaled up immediately when\nthe rolling update starts, such that the total number of old and new pods do not exceed\n130% of desired pods. Once old pods have been killed,\nnew ReplicaSet can be scaled up further, ensuring that total number of pods running\nat any time during the update is at most 130% of desired pods.\n+optional" + } + }, + "type": "object", + "description": "Spec to control the desired behavior of rolling update." + }, + "RuleWithOperations": { + "properties": { + "operations": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or *\nfor all of those operations and any future admission operations that are added.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic" + }, + "apiGroups": { + "items": { + "type": "string" + }, + "type": "array", + "description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic" + }, + "apiVersions": { + "items": { + "type": "string" + }, + "type": "array", + "description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic" + }, + "resources": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic" + }, + "scope": { + "type": "string", + "description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional" + } + }, + "type": "object", + "description": "RuleWithOperations is a tuple of Operations and Resources." + }, + "SELinuxOptions": { + "properties": { + "user": { + "type": "string", + "description": "User is a SELinux user label that applies to the container.\n+optional" + }, + "role": { + "type": "string", + "description": "Role is a SELinux role label that applies to the container.\n+optional" + }, + "type": { + "type": "string", + "description": "Type is a SELinux type label that applies to the container.\n+optional" + }, + "level": { + "type": "string", + "description": "Level is SELinux level label that applies to the container.\n+optional" + } + }, + "type": "object", + "description": "SELinuxOptions are the labels to be applied to the container" + }, + "ScaleIOVolumeSource": { + "properties": { + "gateway": { + "type": "string", + "description": "gateway is the host address of the ScaleIO API Gateway." + }, + "system": { + "type": "string", + "description": "system is the name of the storage system as configured in ScaleIO." + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail." + }, + "sslEnabled": { + "type": "boolean", + "description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false\n+optional" + }, + "protectionDomain": { + "type": "string", + "description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.\n+optional" + }, + "storagePool": { + "type": "string", + "description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.\n+optional" + }, + "storageMode": { + "type": "string", + "description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional" + }, + "volumeName": { + "type": "string", + "description": "volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source." + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "type": "object", + "required": [ + "gateway", + "system", + "secretRef" + ], + "description": "ScaleIOVolumeSource represents a persistent ScaleIO volume" + }, + "ScopeSelector": { + "properties": { + "matchExpressions": { + "items": { + "$ref": "#/definitions/Config/$defs/LabelSelectorRequirement" + }, + "type": "array" + } + }, + "type": "object" + }, + "SeccompProfile": { + "properties": { + "type": { + "type": "string", + "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.\n+unionDiscriminator" + }, + "localhostProfile": { + "type": "string", + "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.\n+optional" + } + }, + "type": "object", + "required": [ + "type" + ], + "description": "SeccompProfile defines a pod/container's seccomp profile settings." + }, + "SecretEnvSource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "optional": { + "type": "boolean", + "description": "Specify whether the Secret must be defined\n+optional" + } + }, + "type": "object", + "description": "SecretEnvSource selects a Secret to populate the environment variables with." + }, + "SecretKeySelector": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "key": { + "type": "string", + "description": "The key of the secret to select from. Must be a valid secret key." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the Secret or its key must be defined\n+optional" + } + }, + "type": "object", + "required": [ + "key" + ], + "description": "SecretKeySelector selects a key of a Secret." + }, + "SecretProjection": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "items": { + "items": { + "$ref": "#/definitions/Config/$defs/KeyToPath" + }, + "type": "array", + "description": "items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional field specify whether the Secret or its key must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a secret into a projected volume." + }, + "SecretReference": { + "properties": { + "name": { + "type": "string", + "description": "name is unique within a namespace to reference a secret resource.\n+optional" + }, + "namespace": { + "type": "string", + "description": "namespace defines the space within which the secret name must be unique.\n+optional" + } + }, + "type": "object", + "description": "SecretReference represents a Secret Reference." + }, + "SecretVolumeSource": { + "properties": { + "secretName": { + "type": "string", + "description": "secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional" + }, + "items": { + "items": { + "$ref": "#/definitions/Config/$defs/KeyToPath" + }, + "type": "array", + "description": "items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional field specify whether the Secret or its keys must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a Secret into a volume." + }, + "SecurityContext": { + "properties": { + "capabilities": { + "$ref": "#/definitions/Config/$defs/Capabilities", + "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "privileged": { + "type": "boolean", + "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "seLinuxOptions": { + "$ref": "#/definitions/Config/$defs/SELinuxOptions", + "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "windowsOptions": { + "$ref": "#/definitions/Config/$defs/WindowsSecurityContextOptions", + "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional" + }, + "runAsUser": { + "type": "integer", + "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsGroup": { + "type": "integer", + "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsNonRoot": { + "type": "boolean", + "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "readOnlyRootFilesystem": { + "type": "boolean", + "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "procMount": { + "type": "string", + "description": "procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "seccompProfile": { + "$ref": "#/definitions/Config/$defs/SeccompProfile", + "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod \u0026 container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + } + }, + "type": "object", + "description": "SecurityContext holds security configuration that will be applied to a container." + }, + "Selector": { + "properties": { + "labelSelector": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "LabelSelector are the labels to select the object from" + } + }, + "type": "object" + }, + "ServiceAccountTokenProjection": { + "properties": { + "audience": { + "type": "string", + "description": "audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.\n+optional" + }, + "expirationSeconds": { + "type": "integer", + "description": "expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.\n+optional" + }, + "path": { + "type": "string", + "description": "path is the path relative to the mount point of the file to project the\ntoken into." + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "ServiceAccountTokenProjection represents a projected service account token volume." + }, + "ServiceBackendPort": { + "properties": { + "name": { + "type": "string", + "description": "name is the name of the port on the Service.\nThis is a mutually exclusive setting with \"Number\".\n+optional" + }, + "number": { + "type": "integer", + "description": "number is the numerical port number (e.g. 80) on the Service.\nThis is a mutually exclusive setting with \"Name\".\n+optional" + } + }, + "type": "object", + "description": "ServiceBackendPort is the service port being referenced." + }, + "ServiceMapping": { + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "type": "object" + }, + "ServicePort": { + "properties": { + "name": { + "type": "string", + "description": "The name of this port within the service. This must be a DNS_LABEL.\nAll ports within a ServiceSpec must have unique names. When considering\nthe endpoints for a Service, this must match the 'name' field in the\nEndpointPort.\nOptional if only one ServicePort is defined on this service.\n+optional" + }, + "protocol": { + "type": "string", + "description": "The IP protocol for this port. Supports \"TCP\", \"UDP\", and \"SCTP\".\nDefault is TCP.\n+default=\"TCP\"\n+optional" + }, + "appProtocol": { + "type": "string", + "description": "The application protocol for this port.\nThis is used as a hint for implementations to offer richer behavior for protocols that they understand.\nThis field follows standard Kubernetes label syntax.\nValid values are either:\n\n* Un-prefixed protocol names - reserved for IANA standard service names (as per\nRFC-6335 and https://www.iana.org/assignments/service-names).\n\n* Kubernetes-defined prefixed names:\n * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-\n * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455\n * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455\n\n* Other protocols should use implementation-defined prefixed names such as\nmycompany.com/my-custom-protocol.\n+optional" + }, + "port": { + "type": "integer", + "description": "The port that will be exposed by this service." + }, + "targetPort": { + "$ref": "#/definitions/Config/$defs/IntOrString", + "description": "Number or name of the port to access on the pods targeted by the service.\nNumber must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.\nIf this is a string, it will be looked up as a named port in the\ntarget Pod's container ports. If this is not specified, the value\nof the 'port' field is used (an identity map).\nThis field is ignored for services with clusterIP=None, and should be\nomitted or set equal to the 'port' field.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service\n+optional" + }, + "nodePort": { + "type": "integer", + "description": "The port on each node on which this service is exposed when type is\nNodePort or LoadBalancer. Usually assigned by the system. If a value is\nspecified, in-range, and not in use it will be used, otherwise the\noperation will fail. If not specified, a port will be allocated if this\nService requires one. If this field is specified when creating a\nService which does not need it, creation will fail. This field will be\nwiped when updating a Service to no longer need it (e.g. changing type\nfrom NodePort to ClusterIP).\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport\n+optional" + } + }, + "type": "object", + "required": [ + "port" + ], + "description": "ServicePort contains information on service's port." + }, + "ServiceReference": { + "properties": { + "namespace": { + "type": "string", + "description": "`namespace` is the namespace of the service.\nRequired" + }, + "name": { + "type": "string", + "description": "`name` is the name of the service.\nRequired" + }, + "path": { + "type": "string", + "description": "`path` is an optional URL path which will be sent in any request to\nthis service.\n+optional" + }, + "port": { + "type": "integer", + "description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).\n+optional" + } + }, + "type": "object", + "required": [ + "namespace", + "name" + ], + "description": "ServiceReference holds a reference to Service.legacy.k8s.io" + }, + "ServiceSpec": { + "properties": { + "ports": { + "items": { + "$ref": "#/definitions/Config/$defs/ServicePort" + }, + "type": "array", + "description": "The list of ports that are exposed by this service.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+patchMergeKey=port\n+patchStrategy=merge\n+listType=map\n+listMapKey=port\n+listMapKey=protocol" + }, + "selector": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Route service traffic to pods with label keys and values matching this\nselector. If empty or not present, the service is assumed to have an\nexternal process managing its endpoints, which Kubernetes will not\nmodify. Only applies to types ClusterIP, NodePort, and LoadBalancer.\nIgnored if type is ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/\n+optional\n+mapType=atomic" + }, + "clusterIP": { + "type": "string", + "description": "clusterIP is the IP address of the service and is usually assigned\nrandomly. If an address is specified manually, is in-range (as per\nsystem configuration), and is not in use, it will be allocated to the\nservice; otherwise creation of the service will fail. This field may not\nbe changed through updates unless the type field is also being changed\nto ExternalName (which requires this field to be blank) or the type\nfield is being changed from ExternalName (in which case this field may\noptionally be specified, as describe above). Valid values are \"None\",\nempty string (\"\"), or a valid IP address. Setting this to \"None\" makes a\n\"headless service\" (no virtual IP), which is useful when direct endpoint\nconnections are preferred and proxying is not required. Only applies to\ntypes ClusterIP, NodePort, and LoadBalancer. If this field is specified\nwhen creating a Service of type ExternalName, creation will fail. This\nfield will be wiped when updating a Service to type ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional" + }, + "clusterIPs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "ClusterIPs is a list of IP addresses assigned to this service, and are\nusually assigned randomly. If an address is specified manually, is\nin-range (as per system configuration), and is not in use, it will be\nallocated to the service; otherwise creation of the service will fail.\nThis field may not be changed through updates unless the type field is\nalso being changed to ExternalName (which requires this field to be\nempty) or the type field is being changed from ExternalName (in which\ncase this field may optionally be specified, as describe above). Valid\nvalues are \"None\", empty string (\"\"), or a valid IP address. Setting\nthis to \"None\" makes a \"headless service\" (no virtual IP), which is\nuseful when direct endpoint connections are preferred and proxying is\nnot required. Only applies to types ClusterIP, NodePort, and\nLoadBalancer. If this field is specified when creating a Service of type\nExternalName, creation will fail. This field will be wiped when updating\na Service to type ExternalName. If this field is not specified, it will\nbe initialized from the clusterIP field. If this field is specified,\nclients must ensure that clusterIPs[0] and clusterIP have the same\nvalue.\n\nThis field may hold a maximum of two entries (dual-stack IPs, in either order).\nThese IPs must correspond to the values of the ipFamilies field. Both\nclusterIPs and ipFamilies are governed by the ipFamilyPolicy field.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+listType=atomic\n+optional" + }, + "type": { + "type": "string", + "description": "type determines how the Service is exposed. Defaults to ClusterIP. Valid\noptions are ExternalName, ClusterIP, NodePort, and LoadBalancer.\n\"ClusterIP\" allocates a cluster-internal IP address for load-balancing\nto endpoints. Endpoints are determined by the selector or if that is not\nspecified, by manual construction of an Endpoints object or\nEndpointSlice objects. If clusterIP is \"None\", no virtual IP is\nallocated and the endpoints are published as a set of endpoints rather\nthan a virtual IP.\n\"NodePort\" builds on ClusterIP and allocates a port on every node which\nroutes to the same endpoints as the clusterIP.\n\"LoadBalancer\" builds on NodePort and creates an external load-balancer\n(if supported in the current cloud) which routes to the same endpoints\nas the clusterIP.\n\"ExternalName\" aliases this service to the specified externalName.\nSeveral other fields do not apply to ExternalName services.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types\n+optional" + }, + "externalIPs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "externalIPs is a list of IP addresses for which nodes in the cluster\nwill also accept traffic for this service. These IPs are not managed by\nKubernetes. The user is responsible for ensuring that traffic arrives\nat a node with this IP. A common example is external load-balancers\nthat are not part of the Kubernetes system.\n+optional" + }, + "sessionAffinity": { + "type": "string", + "description": "Supports \"ClientIP\" and \"None\". Used to maintain session affinity.\nEnable client IP based session affinity.\nMust be ClientIP or None.\nDefaults to None.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional" + }, + "loadBalancerIP": { + "type": "string", + "description": "Only applies to Service Type: LoadBalancer.\nThis feature depends on whether the underlying cloud-provider supports specifying\nthe loadBalancerIP when a load balancer is created.\nThis field will be ignored if the cloud-provider does not support the feature.\nDeprecated: This field was under-specified and its meaning varies across implementations.\nUsing it is non-portable and it may not support dual-stack.\nUsers are encouraged to use implementation-specific annotations when available.\n+optional" + }, + "loadBalancerSourceRanges": { + "items": { + "type": "string" + }, + "type": "array", + "description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider\nload-balancer will be restricted to the specified client IPs. This field will be ignored if the\ncloud-provider does not support the feature.\"\nMore info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/\n+optional" + }, + "externalName": { + "type": "string", + "description": "externalName is the external reference that discovery mechanisms will\nreturn as an alias for this service (e.g. a DNS CNAME record). No\nproxying will be involved. Must be a lowercase RFC-1123 hostname\n(https://tools.ietf.org/html/rfc1123) and requires `type` to be \"ExternalName\".\n+optional" + }, + "externalTrafficPolicy": { + "type": "string", + "description": "externalTrafficPolicy describes how nodes distribute service traffic they\nreceive on one of the Service's \"externally-facing\" addresses (NodePorts,\nExternalIPs, and LoadBalancer IPs). If set to \"Local\", the proxy will configure\nthe service in a way that assumes that external load balancers will take care\nof balancing the service traffic between nodes, and so each node will deliver\ntraffic only to the node-local endpoints of the service, without masquerading\nthe client source IP. (Traffic mistakenly sent to a node with no endpoints will\nbe dropped.) The default value, \"Cluster\", uses the standard behavior of\nrouting to all endpoints evenly (possibly modified by topology and other\nfeatures). Note that traffic sent to an External IP or LoadBalancer IP from\nwithin the cluster will always get \"Cluster\" semantics, but clients sending to\na NodePort from within the cluster may need to take traffic policy into account\nwhen picking a node.\n+optional" + }, + "healthCheckNodePort": { + "type": "integer", + "description": "healthCheckNodePort specifies the healthcheck nodePort for the service.\nThis only applies when type is set to LoadBalancer and\nexternalTrafficPolicy is set to Local. If a value is specified, is\nin-range, and is not in use, it will be used. If not specified, a value\nwill be automatically allocated. External systems (e.g. load-balancers)\ncan use this port to determine if a given node holds endpoints for this\nservice or not. If this field is specified when creating a Service\nwhich does not need it, creation will fail. This field will be wiped\nwhen updating a Service to no longer need it (e.g. changing type).\nThis field cannot be updated once set.\n+optional" + }, + "publishNotReadyAddresses": { + "type": "boolean", + "description": "publishNotReadyAddresses indicates that any agent which deals with endpoints for this\nService should disregard any indications of ready/not-ready.\nThe primary use case for setting this field is for a StatefulSet's Headless Service to\npropagate SRV DNS records for its Pods for the purpose of peer discovery.\nThe Kubernetes controllers that generate Endpoints and EndpointSlice resources for\nServices interpret this to mean that all endpoints are considered \"ready\" even if the\nPods themselves are not. Agents which consume only Kubernetes generated endpoints\nthrough the Endpoints or EndpointSlice resources can safely assume this behavior.\n+optional" + }, + "sessionAffinityConfig": { + "$ref": "#/definitions/Config/$defs/SessionAffinityConfig", + "description": "sessionAffinityConfig contains the configurations of session affinity.\n+optional" + }, + "ipFamilies": { + "items": { + "type": "string" + }, + "type": "array", + "description": "IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this\nservice. This field is usually assigned automatically based on cluster\nconfiguration and the ipFamilyPolicy field. If this field is specified\nmanually, the requested family is available in the cluster,\nand ipFamilyPolicy allows it, it will be used; otherwise creation of\nthe service will fail. This field is conditionally mutable: it allows\nfor adding or removing a secondary IP family, but it does not allow\nchanging the primary IP family of the Service. Valid values are \"IPv4\"\nand \"IPv6\". This field only applies to Services of types ClusterIP,\nNodePort, and LoadBalancer, and does apply to \"headless\" services.\nThis field will be wiped when updating a Service to type ExternalName.\n\nThis field may hold a maximum of two entries (dual-stack families, in\neither order). These families must correspond to the values of the\nclusterIPs field, if specified. Both clusterIPs and ipFamilies are\ngoverned by the ipFamilyPolicy field.\n+listType=atomic\n+optional" + }, + "ipFamilyPolicy": { + "type": "string", + "description": "IPFamilyPolicy represents the dual-stack-ness requested or required by\nthis Service. If there is no value provided, then this field will be set\nto SingleStack. Services can be \"SingleStack\" (a single IP family),\n\"PreferDualStack\" (two IP families on dual-stack configured clusters or\na single IP family on single-stack clusters), or \"RequireDualStack\"\n(two IP families on dual-stack configured clusters, otherwise fail). The\nipFamilies and clusterIPs fields depend on the value of this field. This\nfield will be wiped when updating a service to type ExternalName.\n+optional" + }, + "allocateLoadBalancerNodePorts": { + "type": "boolean", + "description": "allocateLoadBalancerNodePorts defines if NodePorts will be automatically\nallocated for services with type LoadBalancer. Default is \"true\". It\nmay be set to \"false\" if the cluster load-balancer does not rely on\nNodePorts. If the caller requests specific NodePorts (by specifying a\nvalue), those requests will be respected, regardless of this field.\nThis field may only be set for services with type LoadBalancer and will\nbe cleared if the type is changed to any other type.\n+optional" + }, + "loadBalancerClass": { + "type": "string", + "description": "loadBalancerClass is the class of the load balancer implementation this Service belongs to.\nIf specified, the value of this field must be a label-style identifier, with an optional prefix,\ne.g. \"internal-vip\" or \"example.com/internal-vip\". Unprefixed names are reserved for end-users.\nThis field can only be set when the Service type is 'LoadBalancer'. If not set, the default load\nbalancer implementation is used, today this is typically done through the cloud provider integration,\nbut should apply for any default implementation. If set, it is assumed that a load balancer\nimplementation is watching for Services with a matching class. Any default load balancer\nimplementation (e.g. cloud providers) should ignore Services that set this field.\nThis field can only be set when creating or updating a Service to type 'LoadBalancer'.\nOnce set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.\n+optional" + }, + "internalTrafficPolicy": { + "type": "string", + "description": "InternalTrafficPolicy describes how nodes distribute service traffic they\nreceive on the ClusterIP. If set to \"Local\", the proxy will assume that pods\nonly want to talk to endpoints of the service on the same node as the pod,\ndropping the traffic if there are no local endpoints. The default value,\n\"Cluster\", uses the standard behavior of routing to all endpoints evenly\n(possibly modified by topology and other features).\n+optional" + } + }, + "type": "object", + "description": "ServiceSpec describes the attributes that a user creates on a service." + }, + "SessionAffinityConfig": { + "properties": { + "clientIP": { + "$ref": "#/definitions/Config/$defs/ClientIPConfig", + "description": "clientIP contains the configurations of Client IP based session affinity.\n+optional" + } + }, + "type": "object", + "description": "SessionAffinityConfig represents the configurations of session affinity." + }, + "Sleep": { + "properties": { + "after": { + "type": "integer" + }, + "schedule": { + "type": "string", + "description": "TODO validate crontab" + }, + "timezone": { + "type": "string", + "description": "TODO set default" + }, + "ignore": { + "$ref": "#/definitions/Config/$defs/SleepIgnore" + }, + "autoDelete": { + "$ref": "#/definitions/Config/$defs/SleepAutoDelete" + } + }, + "type": "object" + }, + "SleepAction": { + "properties": { + "seconds": { + "type": "integer", + "description": "Seconds is the number of seconds to sleep." + } + }, + "type": "object", + "required": [ + "seconds" + ], + "description": "SleepAction describes a \"sleep\" action." + }, + "SleepAutoDelete": { + "properties": { + "after": { + "type": "integer" + } + }, + "type": "object" + }, + "SleepIgnore": { + "properties": { + "connections": { + "$ref": "#/definitions/Config/$defs/SleepIgnoreConnections" + }, + "resourcesWith": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "SleepIgnoreConnections": { + "properties": { + "after": { + "type": "integer" + } + }, + "type": "object" + }, + "StorageOSVolumeSource": { + "properties": { + "volumeName": { + "type": "string", + "description": "volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace." + }, + "volumeNamespace": { + "type": "string", + "description": "volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "secretRef": { + "$ref": "#/definitions/Config/$defs/LocalObjectReference", + "description": "secretRef specifies the secret to use for obtaining the StorageOS API\ncredentials. If not specified, default values will be attempted.\n+optional" + } + }, + "type": "object", + "description": "Represents a StorageOS persistent volume resource." + }, + "SyncAllResource": { + "properties": { + "enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "SyncConfig": { + "properties": { + "ToHost": { + "$ref": "#/definitions/Config/$defs/SyncToHost" + }, + "FromHost": { + "$ref": "#/definitions/Config/$defs/SyncFromHost" + } + }, + "type": "object", + "required": [ + "ToHost", + "FromHost" + ] + }, + "SyncFromHost": { + "properties": { + "csiDrivers": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "csiNodes": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "csiStorageCapacities": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "ingressClasses": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "events": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "storageClasses": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + } + }, + "type": "object" + }, + "SyncPatchesConfig": { + "properties": { + "version": { + "type": "string", + "description": "Version is the config version" + }, + "export": { + "items": { + "$ref": "#/definitions/Config/$defs/Export" + }, + "type": "array", + "description": "Exports syncs a resource from the virtual cluster to the host" + }, + "import": { + "items": { + "$ref": "#/definitions/Config/$defs/Import" + }, + "type": "array", + "description": "Imports syncs a resource from the host cluster to virtual cluster" + }, + "hooks": { + "$ref": "#/definitions/Config/$defs/Hooks", + "description": "Hooks are hooks that can be used to inject custom patches before syncing" + } + }, + "type": "object" + }, + "SyncPods": { + "properties": { + "enabled": { + "type": "boolean" + }, + "workloadServiceAccount": { + "type": "string" + }, + "translateImage": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "enforceTolerations": { + "items": { + "type": "string" + }, + "type": "array", + "description": "validate format" + }, + "useSecretsForSATokens": { + "type": "boolean" + }, + "rewriteHosts": { + "$ref": "#/definitions/Config/$defs/SyncRewriteHosts" + } + }, + "type": "object" + }, + "SyncRewriteHosts": { + "properties": { + "enabled": { + "type": "boolean" + }, + "initContainerImage": { + "type": "boolean" + } + }, + "type": "object" + }, + "SyncToHost": { + "properties": { + "services": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "endpoints": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "ingresses": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "priorityClasses": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "networkPolicies": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "volumeSnapshots": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "podDisruptionBudgets": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "serviceAccounts": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "storageClasses": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "persistentVolumes": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "persistentVolumeClaims": { + "$ref": "#/definitions/Config/$defs/EnableSwitch" + }, + "configMaps": { + "$ref": "#/definitions/Config/$defs/SyncAllResource" + }, + "secrets": { + "$ref": "#/definitions/Config/$defs/SyncAllResource" + }, + "pods": { + "$ref": "#/definitions/Config/$defs/SyncPods" + } + }, + "type": "object" + }, + "Sysctl": { + "properties": { + "name": { + "type": "string", + "description": "Name of a property to set" + }, + "value": { + "type": "string", + "description": "Value of a property to set" + } + }, + "type": "object", + "required": [ + "name", + "value" + ], + "description": "Sysctl defines a kernel parameter to be set" + }, + "TCPSocketAction": { + "properties": { + "port": { + "$ref": "#/definitions/Config/$defs/IntOrString", + "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + }, + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP.\n+optional" + } + }, + "type": "object", + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket" + }, + "Telemetry": { + "properties": { + "disabled": { + "type": "boolean" + }, + "instanceCreators": { + "type": "string" + }, + "platformUserID": { + "type": "string" + }, + "platformInstanceID": { + "type": "string" + }, + "machineID": { + "type": "string" + } + }, + "type": "object" + }, + "Template": { + "properties": { + "name": { + "type": "string", + "description": "Name is the name of the template used to populate the virtual cluster" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "Time": { + "properties": {}, + "type": "object", + "description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON." + }, + "Toleration": { + "properties": { + "key": { + "type": "string", + "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.\n+optional" + }, + "operator": { + "type": "string", + "description": "Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\n+optional" + }, + "value": { + "type": "string", + "description": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.\n+optional" + }, + "effect": { + "type": "string", + "description": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\n+optional" + }, + "tolerationSeconds": { + "type": "integer", + "description": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.\n+optional" + } + }, + "type": "object", + "description": "The pod this Toleration is attached to tolerates any taint that matches the triple \u003ckey,value,effect\u003e using the matching operator \u003coperator\u003e." + }, + "TopologySpreadConstraint": { + "properties": { + "maxSkew": { + "type": "integer", + "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P | P P | P |\n+-------+-------+-------+\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed." + }, + "topologyKey": { + "type": "string", + "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each \u003ckey, value\u003e as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field." + }, + "whenUnsatisfiable": { + "type": "string", + "description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P P | P | P |\n+-------+-------+-------+\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field." + }, + "labelSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain.\n+optional" + }, + "minDomains": { + "type": "integer", + "description": "MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P | P P | P P |\n+-------+-------+-------+\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew.\n\nThis is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).\n+optional" + }, + "nodeAffinityPolicy": { + "type": "string", + "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\n+optional" + }, + "nodeTaintsPolicy": { + "type": "string", + "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\n+optional" + }, + "matchLabelKeys": { + "items": { + "type": "string" + }, + "type": "array", + "description": "MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\n+listType=atomic\n+optional" + } + }, + "type": "object", + "required": [ + "maxSkew", + "topologyKey", + "whenUnsatisfiable" + ], + "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology." + }, + "TypedLocalObjectReference": { + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional" + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + } + }, + "type": "object", + "required": [ + "apiGroup", + "kind", + "name" + ], + "description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace." + }, + "TypedObjectReference": { + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional" + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + }, + "namespace": { + "type": "string", + "description": "Namespace is the namespace of resource being referenced\nNote 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.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+featureGate=CrossNamespaceVolumeDataSource\n+optional" + } + }, + "type": "object", + "required": [ + "apiGroup", + "kind", + "name" + ] + }, + "ValidatingWebhook": { + "properties": { + "name": { + "type": "string", + "description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.\nRequired." + }, + "clientConfig": { + "$ref": "#/definitions/Config/$defs/WebhookClientConfig", + "description": "ClientConfig defines how to communicate with the hook.\nRequired" + }, + "rules": { + "items": { + "$ref": "#/definitions/Config/$defs/RuleWithOperations" + }, + "type": "array", + "description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.\nHowever, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks\nfrom putting the cluster in a state which cannot be recovered from without completely\ndisabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called\non admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects." + }, + "failurePolicy": { + "type": "string", + "description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.\n+optional" + }, + "matchPolicy": { + "type": "string", + "description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".\n\n- Exact: match a request only if it exactly matches a specified rule.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nbut \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.\n\n- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nand \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.\n\nDefaults to \"Equivalent\"\n+optional" + }, + "namespaceSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook.\n\nFor example, to run the webhook on any objects whose namespace is not\nassociated with \"runlevel\" of \"0\" or \"1\"; you will set the selector as\nfollows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"runlevel\",\n \"operator\": \"NotIn\",\n \"values\": [\n \"0\",\n \"1\"\n ]\n }\n ]\n}\n\nIf instead you want to only run the webhook on any objects whose\nnamespace is associated with the \"environment\" of \"prod\" or \"staging\";\nyou will set the selector as follows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"environment\",\n \"operator\": \"In\",\n \"values\": [\n \"prod\",\n \"staging\"\n ]\n }\n ]\n}\n\nSee\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels\nfor more examples of label selectors.\n\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "objectSelector": { + "$ref": "#/definitions/Config/$defs/LabelSelector", + "description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector. A null\nobject (oldObject in the case of create, or newObject in the case of\ndelete) or an object that cannot have labels (like a\nDeploymentRollback or a PodProxyOptions object) is not considered to\nmatch.\nUse the object selector only if the webhook is opt-in, because end\nusers may skip the admission webhook by setting the labels.\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "sideEffects": { + "type": "string", + "description": "SideEffects states whether this webhook has side effects.\nAcceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown).\nWebhooks with side effects MUST implement a reconciliation system, since a request may be\nrejected by a future step in the admission chain and the side effects therefore need to be undone.\nRequests with the dryRun attribute will be auto-rejected if they match a webhook with\nsideEffects == Unknown or Some." + }, + "timeoutSeconds": { + "type": "integer", + "description": "TimeoutSeconds specifies the timeout for this webhook. After the timeout passes,\nthe webhook call will be ignored or the API call will fail based on the\nfailure policy.\nThe timeout value must be between 1 and 30 seconds.\nDefault to 10 seconds.\n+optional" + }, + "admissionReviewVersions": { + "items": { + "type": "string" + }, + "type": "array", + "description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects. API server will try to use first version in\nthe list which it supports. If none of the versions specified in this list\nsupported by API server, validation will fail for this object.\nIf a persisted webhook configuration specifies allowed versions and does not\ninclude any versions known to the API Server, calls to the webhook will fail\nand be subject to the failure policy." + }, + "matchConditions": { + "items": { + "$ref": "#/definitions/Config/$defs/MatchCondition" + }, + "type": "array", + "description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.\n\nThe exact matching logic is (in order):\n 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.\n 2. If ALL matchConditions evaluate to TRUE, the webhook is called.\n 3. If any matchCondition evaluates to an error (but none are FALSE):\n - If failurePolicy=Fail, reject the request\n - If failurePolicy=Ignore, the error is ignored and the webhook is skipped\n\nThis is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+featureGate=AdmissionWebhookMatchConditions\n+optional" + } + }, + "type": "object", + "required": [ + "name", + "clientConfig", + "sideEffects", + "admissionReviewVersions" + ], + "description": "ValidatingWebhook describes an admission webhook and the resources and operations it applies to." + }, + "Volume": { + "properties": { + "name": { + "type": "string", + "description": "name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "hostPath": { + "$ref": "#/definitions/Config/$defs/HostPathVolumeSource", + "description": "hostPath represents a pre-existing file or directory on the host\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write.\n+optional" + }, + "emptyDir": { + "$ref": "#/definitions/Config/$defs/EmptyDirVolumeSource", + "description": "emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional" + }, + "gcePersistentDisk": { + "$ref": "#/definitions/Config/$defs/GCEPersistentDiskVolumeSource", + "description": "gcePersistentDisk represents a GCE Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + }, + "awsElasticBlockStore": { + "$ref": "#/definitions/Config/$defs/AWSElasticBlockStoreVolumeSource", + "description": "awsElasticBlockStore represents an AWS Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional" + }, + "gitRepo": { + "$ref": "#/definitions/Config/$defs/GitRepoVolumeSource", + "description": "gitRepo represents a git repository at a particular revision.\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container.\n+optional" + }, + "secret": { + "$ref": "#/definitions/Config/$defs/SecretVolumeSource", + "description": "secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional" + }, + "nfs": { + "$ref": "#/definitions/Config/$defs/NFSVolumeSource", + "description": "nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional" + }, + "iscsi": { + "$ref": "#/definitions/Config/$defs/ISCSIVolumeSource", + "description": "iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md\n+optional" + }, + "glusterfs": { + "$ref": "#/definitions/Config/$defs/GlusterfsVolumeSource", + "description": "glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md\n+optional" + }, + "persistentVolumeClaim": { + "$ref": "#/definitions/Config/$defs/PersistentVolumeClaimVolumeSource", + "description": "persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional" + }, + "rbd": { + "$ref": "#/definitions/Config/$defs/RBDVolumeSource", + "description": "rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/rbd/README.md\n+optional" + }, + "flexVolume": { + "$ref": "#/definitions/Config/$defs/FlexVolumeSource", + "description": "flexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.\n+optional" + }, + "cinder": { + "$ref": "#/definitions/Config/$defs/CinderVolumeSource", + "description": "cinder represents a cinder volume attached and mounted on kubelets host machine.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "cephfs": { + "$ref": "#/definitions/Config/$defs/CephFSVolumeSource", + "description": "cephFS represents a Ceph FS mount on the host that shares a pod's lifetime\n+optional" + }, + "flocker": { + "$ref": "#/definitions/Config/$defs/FlockerVolumeSource", + "description": "flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\n+optional" + }, + "downwardAPI": { + "$ref": "#/definitions/Config/$defs/DownwardAPIVolumeSource", + "description": "downwardAPI represents downward API about the pod that should populate this volume\n+optional" + }, + "fc": { + "$ref": "#/definitions/Config/$defs/FCVolumeSource", + "description": "fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\n+optional" + }, + "azureFile": { + "$ref": "#/definitions/Config/$defs/AzureFileVolumeSource", + "description": "azureFile represents an Azure File Service mount on the host and bind mount to the pod.\n+optional" + }, + "configMap": { + "$ref": "#/definitions/Config/$defs/ConfigMapVolumeSource", + "description": "configMap represents a configMap that should populate this volume\n+optional" + }, + "vsphereVolume": { + "$ref": "#/definitions/Config/$defs/VsphereVirtualDiskVolumeSource", + "description": "vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine\n+optional" + }, + "quobyte": { + "$ref": "#/definitions/Config/$defs/QuobyteVolumeSource", + "description": "quobyte represents a Quobyte mount on the host that shares a pod's lifetime\n+optional" + }, + "azureDisk": { + "$ref": "#/definitions/Config/$defs/AzureDiskVolumeSource", + "description": "azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.\n+optional" + }, + "photonPersistentDisk": { + "$ref": "#/definitions/Config/$defs/PhotonPersistentDiskVolumeSource", + "description": "photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine" + }, + "projected": { + "$ref": "#/definitions/Config/$defs/ProjectedVolumeSource", + "description": "projected items for all in one resources secrets, configmaps, and downward API" + }, + "portworxVolume": { + "$ref": "#/definitions/Config/$defs/PortworxVolumeSource", + "description": "portworxVolume represents a portworx volume attached and mounted on kubelets host machine\n+optional" + }, + "scaleIO": { + "$ref": "#/definitions/Config/$defs/ScaleIOVolumeSource", + "description": "scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.\n+optional" + }, + "storageos": { + "$ref": "#/definitions/Config/$defs/StorageOSVolumeSource", + "description": "storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.\n+optional" + }, + "csi": { + "$ref": "#/definitions/Config/$defs/CSIVolumeSource", + "description": "csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).\n+optional" + }, + "ephemeral": { + "$ref": "#/definitions/Config/$defs/EphemeralVolumeSource", + "description": "ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time.\n\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod." + }, + "VolumeDevice": { + "properties": { + "name": { + "type": "string", + "description": "name must match the name of a persistentVolumeClaim in the pod" + }, + "devicePath": { + "type": "string", + "description": "devicePath is the path inside of the container that the device will be mapped to." + } + }, + "type": "object", + "required": [ + "name", + "devicePath" + ], + "description": "volumeDevice describes a mapping of a raw block device within a container." + }, + "VolumeMount": { + "properties": { + "name": { + "type": "string", + "description": "This must match the Name of a Volume." + }, + "readOnly": { + "type": "boolean", + "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional" + }, + "mountPath": { + "type": "string", + "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'." + }, + "subPath": { + "type": "string", + "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional" + }, + "mountPropagation": { + "type": "string", + "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\n+optional" + }, + "subPathExpr": { + "type": "string", + "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\n+optional" + } + }, + "type": "object", + "required": [ + "name", + "mountPath" + ], + "description": "VolumeMount describes a mounting of a Volume within a container." + }, + "VolumeProjection": { + "properties": { + "secret": { + "$ref": "#/definitions/Config/$defs/SecretProjection", + "description": "secret information about the secret data to project\n+optional" + }, + "downwardAPI": { + "$ref": "#/definitions/Config/$defs/DownwardAPIProjection", + "description": "downwardAPI information about the downwardAPI data to project\n+optional" + }, + "configMap": { + "$ref": "#/definitions/Config/$defs/ConfigMapProjection", + "description": "configMap information about the configMap data to project\n+optional" + }, + "serviceAccountToken": { + "$ref": "#/definitions/Config/$defs/ServiceAccountTokenProjection", + "description": "serviceAccountToken is information about the serviceAccountToken data to project\n+optional" + }, + "clusterTrustBundle": { + "$ref": "#/definitions/Config/$defs/ClusterTrustBundleProjection", + "description": "ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time.\n\n+featureGate=ClusterTrustBundleProjection\n+optional" + } + }, + "type": "object", + "description": "Projection that may be projected along with other supported volume types" + }, + "VolumeResourceRequirements": { + "properties": { + "limits": { + "$ref": "#/definitions/Config/$defs/ResourceList", + "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "requests": { + "$ref": "#/definitions/Config/$defs/ResourceList", + "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + } + }, + "type": "object", + "description": "VolumeResourceRequirements describes the storage resource requirements for a volume." + }, + "VsphereVirtualDiskVolumeSource": { + "properties": { + "volumePath": { + "type": "string", + "description": "volumePath is the path that identifies vSphere volume vmdk" + }, + "fsType": { + "type": "string", + "description": "fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "storagePolicyName": { + "type": "string", + "description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.\n+optional" + }, + "storagePolicyID": { + "type": "string", + "description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.\n+optional" + } + }, + "type": "object", + "required": [ + "volumePath" + ], + "description": "Represents a vSphere volume resource." + }, + "WebhookClientConfig": { + "properties": { + "url": { + "type": "string", + "description": "`url` gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.\n\nThe `host` should not refer to a service running in the cluster; use\nthe `service` field instead. The host might be resolved via external\nDNS in some apiservers (e.g., `kube-apiserver` cannot resolve\nin-cluster DNS as that would be a layering violation). `host` may\nalso be an IP address.\n\nPlease note that using `localhost` or `127.0.0.1` as a `host` is\nrisky unless you take great care to run this webhook on all hosts\nwhich run an apiserver which might need to make calls to this\nwebhook. Such installs are likely to be non-portable, i.e., not easy\nto turn up in a new cluster.\n\nThe scheme must be \"https\"; the URL must begin with \"https://\".\n\nA path is optional, and if present may be any string permissible in\na URL. You may use the path to pass an arbitrary string to the\nwebhook, for example, a cluster identifier.\n\nAttempting to use a user or basic auth e.g. \"user:password@\" is not\nallowed. Fragments (\"#...\") and query parameters (\"?...\") are not\nallowed, either.\n\n+optional" + }, + "service": { + "$ref": "#/definitions/Config/$defs/ServiceReference", + "description": "`service` is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`.\n\n+optional" + }, + "caBundle": { + "type": "string", + "contentEncoding": "base64", + "description": "`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.\n+optional" + } + }, + "type": "object", + "description": "WebhookClientConfig contains the information to make a TLS connection with the webhook" + }, + "WeightedPodAffinityTerm": { + "properties": { + "weight": { + "type": "integer", + "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100." + }, + "podAffinityTerm": { + "$ref": "#/definitions/Config/$defs/PodAffinityTerm", + "description": "Required. A pod affinity term, associated with the corresponding weight." + } + }, + "type": "object", + "required": [ + "weight", + "podAffinityTerm" + ], + "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)" + }, + "WindowsSecurityContextOptions": { + "properties": { + "gmsaCredentialSpecName": { + "type": "string", + "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\n+optional" + }, + "gmsaCredentialSpec": { + "type": "string", + "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\n+optional" + }, + "runAsUserName": { + "type": "string", + "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "hostProcess": { + "type": "boolean", + "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\n+optional" + } + }, + "type": "object", + "description": "WindowsSecurityContextOptions contain Windows-specific options and credentials." + } + }, + "properties": { + "exportKubeConfig": { + "$ref": "#/definitions/Config/$defs/ExportKubeConfig" + }, + "sync": { + "$ref": "#/definitions/Config/$defs/SyncConfig" + }, + "observability": { + "$ref": "#/definitions/Config/$defs/Observability" + }, + "networking": { + "$ref": "#/definitions/Config/$defs/Networking" + }, + "plugin": { + "additionalProperties": { + "$ref": "#/definitions/Config/$defs/Plugin" + }, + "type": "object" + }, + "plugins": { + "additionalProperties": { + "$ref": "#/definitions/Config/$defs/Plugins" + }, + "type": "object" + }, + "controlPlane": { + "$ref": "#/definitions/Config/$defs/ControlPlane" + }, + "policies": { + "$ref": "#/definitions/Config/$defs/Policies" + }, + "rbac": { + "$ref": "#/definitions/Config/$defs/RBAC" + }, + "telemetry": { + "$ref": "#/definitions/Config/$defs/Telemetry", + "description": "Telemetry is the configuration related to telemetry gathered about vcluster usage." + }, + "experimental": { + "$ref": "#/definitions/Config/$defs/Experimental" + }, + "license": { + "$ref": "#/definitions/Config/$defs/License" + }, + "platform": { + "$ref": "#/definitions/Config/$defs/Platform" + }, + "sleep": { + "$ref": "#/definitions/Config/$defs/Sleep" + }, + "template": { + "$ref": "#/definitions/Config/$defs/Template" + }, + "access": { + "$ref": "#/definitions/Config/$defs/Access" + } + }, + "type": "object" + } + } +} diff --git a/docs/sidebars.js b/docs/sidebars.js index 413b0309c..7b3948eb0 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -253,7 +253,8 @@ module.exports = { }, { type: "doc", - id: "config-reference", + className: 'code-style', + id: "configuration/reference", }, { type: "category", diff --git a/docs/src/css/content/config-fields.scss b/docs/src/css/content/config-fields.scss new file mode 100644 index 000000000..f7d587164 --- /dev/null +++ b/docs/src/css/content/config-fields.scss @@ -0,0 +1,295 @@ +body .markdown .config-field { + --docusaurus-details-decoration-color: #ccc; + + padding: 1em 1.4em; + border: 1px solid transparent; + border-bottom-color: #eee; + border-top-color: #eee; + + + .config-field { + border-top-color: transparent; + } + + margin: var(--ifm-leading) 0 0; + + + .config-field { + margin: 0; + } + + .config-field { + margin: 0; + border-top-color: transparent; + + &:last-of-type { + border-bottom-color: transparent; + } + } + + background: transparent; + box-shadow: none; + font-size: 1rem; /* must reset font-size to prevent nested fields getting smaller */ + + &[open], + &[data-expandable="false"] { + &[data-expandable="true"] { + border-color: #eee; + } + + &[data-expandable="false"] { + > summary { + cursor: text; + padding-bottom: 0.2em; + + &::before { + display: none; + } + + ~ * { + display: none !important; + } + } + } + + > summary{ + &::before { + transform: rotate(-90deg); + } + + p:first-of-type { + max-height: none; + white-space: inherit; + opacity: 1; + overflow: visible; + } + } + } + + p, + summary + * { + display: inline-block; + font-size: 0.85rem; + color: rgb(117, 117, 117); + line-height: 1.2em; + font-weight: 400; + } + + summary { + padding-left: 0; + min-height: 2.4em; + + &::before { + left: auto; + right: 0; + margin-top: 0.4em; + transform: rotate(90deg); + } + + > * { + display: none; + } + + p:first-of-type { + display: block; + max-width: 96%; + max-height: 1.6em; + padding-top: 0.4em; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; + opacity: 0.7; + transition: all 0.5s; + } + + h2, + h3, + h4, + h5, + h6 { + display: block; + + code { + font-weight: 600; + background: none; + border: none; + letter-spacing: 0.03em; + padding: 0; + } + + &:target { + &, + & ~ * { + &::before { + display: none; + } + } + } + } + + .config-field-required, + .config-field-type, + .config-field-enum, + .config-field-default { + display: inline-block; + margin-left: 0.5em; + font-size: 0.7em; + line-height: 1em; + } + + .config-field-type, + .config-field-enum, + .config-field-default { + font-family: var(--ifm-font-family-monospace); + } + + .config-field-default { + color: rgb(19, 19, 189); + + &:empty { + display: none; + } + + &::before { + content: "default: "; + display: inline-block; + margin-right: 0.15em; + } + + &.-return::before { + content: "returns: "; + margin-right: 0.3em; + } + } + + .config-field-type, + .config-field-enum { + color: rgb(147, 147, 147); + } + + .config-field-enum { + position: relative; + display: inline-block; + height: 0.8em; + overflow: visible; + + &:empty { + display: none; + } + + &::before { + content: "values: "; + display: inline; + float: left; + margin-right: 0.7em; + } + + > span { + display: table-caption; + width: 100%; + border: 1px solid #eee; + background: #fff; + z-index: 1; + padding: 0.3em 1.4em 0.3em 0.5em; + line-height: 1.2em; + max-height: 1.8em; + overflow: hidden; + transition: max-height 0.4s; + border-radius: 3px; + text-align: left; + transform: translateY(-0.48em); + + &:hover { + max-height: 1000px; + + &::after { + transform: rotate(-90deg); + } + } + + &::after { + position: absolute; + right: 0.1em; + left: auto; + top: 0.45em; + content: ''; + border-width: calc(var(--docusaurus-details-summary-arrow-size) / 1.4); + border-style: solid; + border-color: transparent transparent transparent var(--docusaurus-details-decoration-color); + transform: rotate(90deg); + transition: var(--docusaurus-details-transition); + transform-origin: calc(var(--docusaurus-details-summary-arrow-size) / 2.8) 50%; + } + } + } + + .config-field-required { + color: rgb(187, 7, 7); + text-transform: uppercase; + + &[data-required="false"] { + display: none; + } + } + /* + .hash-link { + position: absolute; + left: -1.4em; + top: 0.1em; + + &:focus { + opacity: 0; + } + }*/ + + + * { + &, + & > * { + border-top: none; + margin-top: 0; + padding-top: 0.2em; + } + + /* 2nd-level config fields */ + details { + margin-bottom: 0; + + &[data-expandable="true"] { + &:first-of-type { + margin-top: 1em; + } + + &[open] { + border-color: #eee; + } + } + } + } + } + + p:last-child, + details:not([data-expandable="true"]):last-child { + margin-bottom: 0; + padding-bottom: 0; + } +} + +.group { + margin-top: 1em; + border: 1px solid #2156f2; + + .group-name { + padding: 0.3em 0 0.3em 1.3em; + font-weight: 600; + background: #2156f2; + color: #fff; + font-size: 0.9em; + } + + > details:first-of-type { + margin-top: 0 !important; + } + + > details:last-of-type { + padding-bottom: 1.2em !important; + margin-bottom: 0 !important; + } +} diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index d71a93314..2ab8731d6 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -41,6 +41,11 @@ ul ul .table-of-contents__link--active::before { background-color: #1b1b1d !important; } +.code-style { + font-family: Menlo, 'Courier New', monospace; + word-spacing: -0.15em; +} + .menu__list { margin-right: 0; } diff --git a/docs/yarn.lock b/docs/yarn.lock index b01bff4e3..98cfcdfb6 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -2898,6 +2898,11 @@ argparse@^2.0.1: resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== +arr-union@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/arr-union/-/arr-union-3.1.0.tgz#e39b09aea9def866a8f206e288af63919bae39c4" + integrity sha512-sKpyeERZ02v1FeCZT8lrfJq5u6goHCtpTAzPwJYe7c8SPFOboNjNg1vz2L4VTn9T4PQxEx13TbXLmYUcS6Ug7Q== + array-flatten@1.1.1: version "1.1.1" resolved "https://registry.yarnpkg.com/array-flatten/-/array-flatten-1.1.1.tgz#9a5f699051b1e7073328f2a008968b64ea2955d2" @@ -2918,6 +2923,11 @@ asap@~2.0.3: resolved "https://registry.yarnpkg.com/asap/-/asap-2.0.6.tgz#e50347611d7e690943208bbdafebcbc2fb866d46" integrity sha1-5QNHYR1+aQlDIIu9r+vLwvuGbUY= +async-array-reduce@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/async-array-reduce/-/async-array-reduce-0.2.1.tgz#c8be010a2b5cd00dea96c81116034693dfdd82d1" + integrity sha512-/ywTADOcaEnwiAnOEi0UB/rAcIq5bTFfCV9euv3jLYFUMmy6KvKccTQUnLlp8Ensmfj43wHSmbGiPqjsZ6RhNA== + async@*: version "3.2.0" resolved "https://registry.yarnpkg.com/async/-/async-3.2.0.tgz#b3a2685c5ebb641d3de02d161002c60fc9f85720" @@ -3274,6 +3284,21 @@ cheerio@^1.0.0-rc.12: parse5 "^7.0.0" parse5-htmlparser2-tree-adapter "^7.0.0" +"chokidar@>=3.0.0 <4.0.0": + version "3.6.0" + resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" + integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== + dependencies: + anymatch "~3.1.2" + braces "~3.0.2" + glob-parent "~5.1.2" + is-binary-path "~2.1.0" + is-glob "~4.0.1" + normalize-path "~3.0.0" + readdirp "~3.6.0" + optionalDependencies: + fsevents "~2.3.2" + chokidar@^3.4.2, chokidar@^3.5.3: version "3.5.3" resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.5.3.tgz#1cf37c8707b932bd1af1ae22c0432e2acd1903bd" @@ -3895,6 +3920,13 @@ docusaurus-gtm-plugin@^0.0.2: resolved "https://registry.yarnpkg.com/docusaurus-gtm-plugin/-/docusaurus-gtm-plugin-0.0.2.tgz#f39864b54ca594e3281902c23b6df0763761602b" integrity sha512-Xx/df0Ppd5SultlzUj9qlQk2lX9mNVfTb41juyBUPZ1Nc/5dNx+uN0VuLyF4JEObkDRrUY1EFo9fEUDo8I6QOQ== +docusaurus-plugin-sass@^0.2.5: + version "0.2.5" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-sass/-/docusaurus-plugin-sass-0.2.5.tgz#6bfb8a227ac6265be685dcbc24ba1989e27b8005" + integrity sha512-Z+D0fLFUKcFpM+bqSUmqKIU+vO+YF1xoEQh5hoFreg2eMf722+siwXDD+sqtwU8E4MvVpuvsQfaHwODNlxJAEg== + dependencies: + sass-loader "^10.1.1" + dom-converter@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768" @@ -4182,6 +4214,13 @@ execa@^5.0.0: signal-exit "^3.0.3" strip-final-newline "^2.0.0" +expand-tilde@^2.0.0, expand-tilde@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/expand-tilde/-/expand-tilde-2.0.2.tgz#97e801aa052df02454de46b02bf621642cdc8502" + integrity sha512-A5EmesHW6rfnZ9ysHQjPdJRni0SRar0tjtG5MNtm9n5TUvsYU8oozprtRD4AqHxcZWWlVuAmQo2nWKfN9oyjTw== + dependencies: + homedir-polyfill "^1.0.1" + express@^4.17.3: version "4.18.2" resolved "https://registry.yarnpkg.com/express/-/express-4.18.2.tgz#3fabe08296e930c796c19e3c516979386ba9fd59" @@ -4556,7 +4595,7 @@ glob@^7.0.0, glob@^7.1.3: once "^1.3.0" path-is-absolute "^1.0.0" -glob@^7.1.6: +glob@^7.1.2, glob@^7.1.6: version "7.2.3" resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== @@ -4575,6 +4614,15 @@ global-dirs@^3.0.0: dependencies: ini "2.0.0" +global-modules@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/global-modules/-/global-modules-1.0.0.tgz#6d770f0eb523ac78164d72b5e71a8877265cc3ea" + integrity sha512-sKzpEkf11GpOFuw0Zzjzmt4B4UZwjOcG757PPvrfhxcLFbq0wpsgpOqxpxtxFiCG4DtG93M6XRVbF2oGdev7bg== + dependencies: + global-prefix "^1.0.1" + is-windows "^1.0.1" + resolve-dir "^1.0.0" + global-modules@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/global-modules/-/global-modules-2.0.0.tgz#997605ad2345f27f51539bea26574421215c7780" @@ -4582,6 +4630,17 @@ global-modules@^2.0.0: dependencies: global-prefix "^3.0.0" +global-prefix@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/global-prefix/-/global-prefix-1.0.2.tgz#dbf743c6c14992593c655568cb66ed32c0122ebe" + integrity sha512-5lsx1NUDHtSjfg0eHlmYvZKv8/nVqX4ckFbM+FrGcQ+04KWcWFo9P5MxPZYSzUvyzmdTbI7Eix8Q4IbELDqzKg== + dependencies: + expand-tilde "^2.0.2" + homedir-polyfill "^1.0.1" + ini "^1.3.4" + is-windows "^1.0.1" + which "^1.2.14" + global-prefix@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/global-prefix/-/global-prefix-3.0.0.tgz#fc85f73064df69f50421f47f883fe5b913ba9b97" @@ -4690,6 +4749,13 @@ has-flag@^4.0.0: resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== +has-glob@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/has-glob/-/has-glob-1.0.0.tgz#9aaa9eedbffb1ba3990a7b0010fb678ee0081207" + integrity sha512-D+8A457fBShSEI3tFCj65PAbT++5sKiFtdCdOam0gnfBgw9D277OERk+HM9qYJXmdVLZ/znez10SqHN0BBQ50g== + dependencies: + is-glob "^3.0.0" + has-symbols@^1.0.1: version "1.0.2" resolved "https://registry.yarnpkg.com/has-symbols/-/has-symbols-1.0.2.tgz#165d3070c00309752a1236a479331e3ac56f1423" @@ -4799,6 +4865,13 @@ hoist-non-react-statics@^3.1.0: dependencies: react-is "^16.7.0" +homedir-polyfill@^1.0.1: + version "1.0.3" + resolved "https://registry.yarnpkg.com/homedir-polyfill/-/homedir-polyfill-1.0.3.tgz#743298cef4e5af3e194161fbadcc2151d3a058e8" + integrity sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA== + dependencies: + parse-passwd "^1.0.0" + hpack.js@^2.1.6: version "2.1.6" resolved "https://registry.yarnpkg.com/hpack.js/-/hpack.js-2.1.6.tgz#87774c0949e513f42e84575b3c45681fade2a0b2" @@ -4963,6 +5036,11 @@ immer@^9.0.7: resolved "https://registry.yarnpkg.com/immer/-/immer-9.0.21.tgz#1e025ea31a40f24fb064f1fef23e931496330176" integrity sha512-bc4NBHqOqSfRW7POMkHd51LvClaeMXpm8dx0e8oE2GORbq5aRK7Bxl4FyzVLdGtLmvLKL7BTDBG5ACQm4HWjTA== +immutable@^4.0.0: + version "4.3.5" + resolved "https://registry.yarnpkg.com/immutable/-/immutable-4.3.5.tgz#f8b436e66d59f99760dc577f5c99a4fd2a5cc5a0" + integrity sha512-8eabxkth9gZatlwl5TBuJnCsoTADlL6ftEr7A4qgdaTsPyreilDSnUk57SO+jfKcNtxPa22U5KK6DSeAYhpBJw== + import-fresh@^3.1.0, import-fresh@^3.2.1, import-fresh@^3.3.0: version "3.3.0" resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.3.0.tgz#37162c25fcb9ebaa2e6e53d5b4d88ce17d9e0c2b" @@ -5019,7 +5097,7 @@ ini@2.0.0: resolved "https://registry.yarnpkg.com/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5" integrity sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA== -ini@^1.3.5, ini@~1.3.0: +ini@^1.3.4, ini@^1.3.5, ini@~1.3.0: version "1.3.8" resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.8.tgz#a29da425b48806f34767a4efce397269af28432c" integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== @@ -5122,7 +5200,7 @@ is-extendable@^0.1.0: resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89" integrity sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik= -is-extglob@^2.1.1: +is-extglob@^2.1.0, is-extglob@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" integrity sha1-qIwCU1eR8C7TfHahueqXc8gz+MI= @@ -5137,6 +5215,13 @@ is-fullwidth-code-point@^3.0.0: resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== +is-glob@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-3.1.0.tgz#7ba5ae24217804ac70707b96922567486cc3e84a" + integrity sha512-UFpDDrPgM6qpnFNI+rh/p3bUaq9hKLZN8bMUWzxmcnZVS3omf4IPK+BrewlnWjO1WmUsMYuSjKh4UJuV4+Lqmw== + dependencies: + is-extglob "^2.1.0" + is-glob@^4.0.1, is-glob@~4.0.1: version "4.0.1" resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.1.tgz#7567dbe9f2f5e2467bc77ab83c4a29482407a5dc" @@ -5231,11 +5316,21 @@ is-typedarray@^1.0.0: resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a" integrity sha1-5HnICFjfDBsR3dppQPlgEfzaSpo= +is-valid-glob@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-valid-glob/-/is-valid-glob-1.0.0.tgz#29bf3eff701be2d4d315dbacc39bc39fe8f601aa" + integrity sha512-AhiROmoEFDSsjx8hW+5sGwgKVIORcXnrlAx/R0ZSeaPw70Vw0CqkGBBhHGL58Uox2eXnU1AnvXJl1XlyedO5bA== + is-whitespace-character@^1.0.0: version "1.0.4" resolved "https://registry.yarnpkg.com/is-whitespace-character/-/is-whitespace-character-1.0.4.tgz#0858edd94a95594c7c9dd0b5c174ec6e45ee4aa7" integrity sha512-SDweEzfIZM0SJV0EUga669UTKlmL0Pq8Lno0QDQsPnvECB3IM2aP0gdx5TrU0A01MAPfViaZiI2V1QMZLaKK5w== +is-windows@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/is-windows/-/is-windows-1.0.2.tgz#d1850eb9791ecd18e6182ce12a30f396634bb19d" + integrity sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA== + is-word-character@^1.0.0: version "1.0.4" resolved "https://registry.yarnpkg.com/is-word-character/-/is-word-character-1.0.4.tgz#ce0e73216f98599060592f62ff31354ddbeb0230" @@ -5258,7 +5353,7 @@ isarray@0.0.1: resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf" integrity sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8= -isarray@~1.0.0: +isarray@1.0.0, isarray@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11" integrity sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE= @@ -5268,6 +5363,13 @@ isexe@^2.0.0: resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= +isobject@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/isobject/-/isobject-2.1.0.tgz#f065561096a3f1da2ef46272f815c840d87e0c89" + integrity sha512-+OUdGJlgjOBZDfxnDjYYG6zp487z0JGNQq3cYQYg5f5hKR+syHMsaztzGeml/4kGG55CSpKSpWTY+jYGgsHLgA== + dependencies: + isarray "1.0.0" + isobject@^3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df" @@ -5408,6 +5510,11 @@ kleur@^3.0.3: resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e" integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== +klona@^2.0.4: + version "2.0.6" + resolved "https://registry.yarnpkg.com/klona/-/klona-2.0.6.tgz#85bffbf819c03b2f53270412420a4555ef882e22" + integrity sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA== + latest-version@^5.1.0: version "5.1.0" resolved "https://registry.yarnpkg.com/latest-version/-/latest-version-5.1.0.tgz#119dfe908fe38d15dfa43ecd13fa12ec8832face" @@ -5564,6 +5671,18 @@ markdown-escapes@^1.0.0: resolved "https://registry.yarnpkg.com/markdown-escapes/-/markdown-escapes-1.0.4.tgz#c95415ef451499d7602b91095f3c8e8975f78535" integrity sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg== +matched@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/matched/-/matched-1.0.2.tgz#1d95d77dd5f1b5075a9e94acde5462ffd85f317a" + integrity sha512-7ivM1jFZVTOOS77QsR+TtYHH0ecdLclMkqbf5qiJdX2RorqfhsL65QHySPZgDE0ZjHoh+mQUNHTanNXIlzXd0Q== + dependencies: + arr-union "^3.1.0" + async-array-reduce "^0.2.1" + glob "^7.1.2" + has-glob "^1.0.0" + is-valid-glob "^1.0.0" + resolve-dir "^1.0.0" + mdast-squeeze-paragraphs@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/mdast-squeeze-paragraphs/-/mdast-squeeze-paragraphs-4.0.0.tgz#7c4c114679c3bee27ef10b58e2e015be79f1ef97" @@ -6057,6 +6176,11 @@ parse-numeric-range@^1.3.0: resolved "https://registry.yarnpkg.com/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz#7c63b61190d61e4d53a1197f0c83c47bb670ffa3" integrity sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ== +parse-passwd@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/parse-passwd/-/parse-passwd-1.0.0.tgz#6d5b934a456993b23d37f40a382d6f1666a8e5c6" + integrity sha512-1Y1A//QUXEZK7YKz+rD9WydcE1+EuPr6ZBgKecAB8tmoW6UFv0NREVJe1p+jRxtThkcbbKkfwIbWJe/IeE6m2Q== + parse5-htmlparser2-tree-adapter@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.0.0.tgz#23c2cc233bcf09bb7beba8b8a69d46b08c62c2f1" @@ -6931,6 +7055,13 @@ relateurl@^0.2.7: resolved "https://registry.yarnpkg.com/relateurl/-/relateurl-0.2.7.tgz#54dbf377e51440aca90a4cd274600d3ff2d888a9" integrity sha1-VNvzd+UUQKypCkzSdGANP/LYiKk= +relative@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/relative/-/relative-3.0.2.tgz#0dcd8ec54a5d35a3c15e104503d65375b5a5367f" + integrity sha512-Q5W2qeYtY9GbiR8z1yHNZ1DGhyjb4AnLEjt8iE6XfcC1QIu+FAtj3HQaO0wH28H1mX6cqNLvAqWhP402dxJGyA== + dependencies: + isobject "^2.0.0" + remark-emoji@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/remark-emoji/-/remark-emoji-2.2.0.tgz#1c702090a1525da5b80e15a8f963ef2c8236cac7" @@ -7028,11 +7159,30 @@ requires-port@^1.0.0: resolved "https://registry.yarnpkg.com/requires-port/-/requires-port-1.0.0.tgz#925d2601d39ac485e091cf0da5c6e694dc3dcaff" integrity sha1-kl0mAdOaxIXgkc8NpcbmlNw9yv8= +resolve-dir@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/resolve-dir/-/resolve-dir-1.0.1.tgz#79a40644c362be82f26effe739c9bb5382046f43" + integrity sha512-R7uiTjECzvOsWSfdM0QKFNBVFcK27aHOUwdvK53BcW8zqnGdYp0Fbj82cy54+2A4P2tFM22J5kRfe1R+lM/1yg== + dependencies: + expand-tilde "^2.0.0" + global-modules "^1.0.0" + resolve-from@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== +resolve-glob@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/resolve-glob/-/resolve-glob-1.0.0.tgz#c6142b0f850367607aae27506be7985d3a8c6931" + integrity sha512-wSW9pVGJRs89k0wEXhM7C6+va9998NsDhgc0Y+6Nv8hrHsu0hUS7Ug10J1EiVtU6N2tKlSNvx9wLihL8Ao22Lg== + dependencies: + extend-shallow "^2.0.1" + is-valid-glob "^1.0.0" + matched "^1.0.2" + relative "^3.0.2" + resolve-dir "^1.0.0" + resolve-pathname@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/resolve-pathname/-/resolve-pathname-3.0.0.tgz#99d02224d3cf263689becbb393bc560313025dcd" @@ -7123,6 +7273,26 @@ safe-buffer@5.2.1, safe-buffer@>=5.1.0, safe-buffer@^5.1.0, safe-buffer@~5.2.0: resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== +sass-loader@^10.1.1: + version "10.5.2" + resolved "https://registry.yarnpkg.com/sass-loader/-/sass-loader-10.5.2.tgz#1ca30534fff296417b853c7597ca3b0bbe8c37d0" + integrity sha512-vMUoSNOUKJILHpcNCCyD23X34gve1TS7Rjd9uXHeKqhvBG39x6XbswFDtpbTElj6XdMFezoWhkh5vtKudf2cgQ== + dependencies: + klona "^2.0.4" + loader-utils "^2.0.0" + neo-async "^2.6.2" + schema-utils "^3.0.0" + semver "^7.3.2" + +sass@^1.71.1: + version "1.71.1" + resolved "https://registry.yarnpkg.com/sass/-/sass-1.71.1.tgz#dfb09c63ce63f89353777bbd4a88c0a38386ee54" + integrity sha512-wovtnV2PxzteLlfNzbgm1tFXPLoZILYAMJtvoXXkD7/+1uP41eKkIt1ypWq5/q2uT94qHjXehEYfmjKOvjL9sg== + dependencies: + chokidar ">=3.0.0 <4.0.0" + immutable "^4.0.0" + source-map-js ">=0.6.2 <2.0.0" + sax@^1.2.4: version "1.2.4" resolved "https://registry.yarnpkg.com/sax/-/sax-1.2.4.tgz#2816234e2378bddc4e5354fab5caa895df7100d9" @@ -7404,7 +7574,7 @@ sort-css-media-queries@2.1.0: resolved "https://registry.yarnpkg.com/sort-css-media-queries/-/sort-css-media-queries-2.1.0.tgz#7c85e06f79826baabb232f5560e9745d7a78c4ce" integrity sha512-IeWvo8NkNiY2vVYdPa27MCQiR0MN0M80johAYFVxWWXQ44KU84WNxjslwBHmc/7ZL2ccwkM7/e6S5aiKZXm7jA== -source-map-js@^1.0.2: +"source-map-js@>=0.6.2 <2.0.0", source-map-js@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.0.2.tgz#adbc361d9c62df380125e7f161f71c826f1e490c" integrity sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw== @@ -8274,7 +8444,7 @@ whatwg-url@^5.0.0: tr46 "~0.0.3" webidl-conversions "^3.0.0" -which@^1.3.1: +which@^1.2.14, which@^1.3.1: version "1.3.1" resolved "https://registry.yarnpkg.com/which/-/which-1.3.1.tgz#a45043d54f5805316da8d62f9f50918d3da70b0a" integrity sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ== diff --git a/go.mod b/go.mod index 2ce1c04bc..66906c35a 100644 --- a/go.mod +++ b/go.mod @@ -5,7 +5,9 @@ go 1.21.5 require ( github.com/blang/semver v3.5.1+incompatible github.com/blang/semver/v4 v4.0.0 + github.com/creasty/defaults v1.7.0 github.com/denisbrodbeck/machineid v1.0.1 + github.com/gertd/go-pluralize v0.2.1 github.com/ghodss/yaml v1.0.0 github.com/go-logr/logr v1.4.1 github.com/go-openapi/loads v0.21.2 @@ -14,6 +16,7 @@ require ( github.com/hashicorp/go-hclog v0.14.1 github.com/hashicorp/go-plugin v1.6.0 github.com/hashicorp/golang-lru/v2 v2.0.2 + github.com/invopop/jsonschema v0.12.0 github.com/kubernetes-csi/external-snapshotter/client/v4 v4.2.0 github.com/loft-sh/agentapi/v3 v3.4.0-beta.12.0.20240207094449-7adc00ae1265 github.com/loft-sh/analytics-client v0.0.0-20240206084604-1302688c3d4c @@ -69,6 +72,8 @@ require ( github.com/Sytten/logrus-zap-hook v0.1.0 // indirect github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d // indirect github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20230305170008-8188dc5388df // indirect + github.com/bahlo/generic-list-go v0.2.0 // indirect + github.com/buger/jsonparser v1.1.1 // indirect github.com/cenkalti/backoff/v4 v4.2.1 // indirect github.com/cloudflare/circl v1.3.7 // indirect github.com/cpuguy83/go-md2man/v2 v2.0.3 // indirect @@ -98,6 +103,7 @@ require ( github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966 // indirect github.com/stoewer/go-strcase v1.3.0 // indirect + github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.22.0 // indirect go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.22.0 // indirect google.golang.org/genproto/googleapis/api v0.0.0-20240116215550-a9fa1716bcac // indirect diff --git a/go.sum b/go.sum index 8e2f0c5c1..47c384f89 100644 --- a/go.sum +++ b/go.sum @@ -112,6 +112,8 @@ github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef/go.mod h1:W github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 h1:DklsrG3dyBCFEj5IhUbnKptjxatkF07cF2ak3yi77so= github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw= github.com/aws/aws-sdk-go v1.34.28/go.mod h1:H7NKnBqNVzoTJpGfLrQkkD+ytBA93eiDYi/+8rV9s48= +github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk= +github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg= github.com/benbjohnson/clock v1.0.3/go.mod h1:bGMdMPoPVvcYyt1gHDf4J2KE153Yf9BuiUKYMaxlTDM= github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= @@ -127,6 +129,8 @@ github.com/blang/semver/v4 v4.0.0 h1:1PFHFE6yCCTv8C1TeyNNarDzntLi7wMI5i/pzqYIsAM github.com/blang/semver/v4 v4.0.0/go.mod h1:IbckMUScFkM3pff0VJDNKRiT6TG/YpiHIM2yvyW5YoQ= github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA= github.com/bufbuild/protocompile v0.4.0/go.mod h1:3v93+mbWn/v3xzN+31nwkJfrEpAUwp+BagBSZWx+TP8= +github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs= +github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0= github.com/bwesterb/go-ristretto v1.2.0/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0= github.com/cenkalti/backoff/v4 v4.2.1 h1:y4OZtCnogmCPw98Zjyt5a6+QwPLGkiQsYW5oUqylYbM= github.com/cenkalti/backoff/v4 v4.2.1/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE= @@ -174,6 +178,8 @@ github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY= github.com/creack/pty v1.1.18/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= +github.com/creasty/defaults v1.7.0 h1:eNdqZvc5B509z18lD8yc212CAqJNvfT1Jq6L8WowdBA= +github.com/creasty/defaults v1.7.0/go.mod h1:iGzKe6pbEHnpMPtfDXZEr0NVxWnPTjb1bbDy08fPzYM= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= @@ -243,6 +249,8 @@ github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nos github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM= github.com/fvbommel/sortorder v1.1.0 h1:fUmoe+HLsBTctBDoaBwpQo5N+nrCp8g/BjKb/6ZQmYw= github.com/fvbommel/sortorder v1.1.0/go.mod h1:uk88iVf1ovNn1iLfgUVU2F9o5eO30ui720w+kxuqRs0= +github.com/gertd/go-pluralize v0.2.1 h1:M3uASbVjMnTsPb0PNqg+E/24Vwigyo/tvyMTtAlLgiA= +github.com/gertd/go-pluralize v0.2.1/go.mod h1:rbYaKDbsXxmRfr8uygAEKhOWsjyrrqrkHVpZvoOp8zk= github.com/getkin/kin-openapi v0.76.0/go.mod h1:660oXbgy5JFMKreazJaQTw7o+X00qeSyhcnluiMv+Xg= github.com/getsentry/raven-go v0.2.0/go.mod h1:KungGk8q33+aIAZUIVWZDr2OfAEBsO49PX4NzFV5kcQ= github.com/ghodss/yaml v0.0.0-20150909031657-73d445a93680/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= @@ -571,6 +579,8 @@ github.com/inconshreveable/go-update v0.0.0-20160112193335-8152e7eb6ccf/go.mod h github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/invopop/jsonschema v0.12.0 h1:6ovsNSuvn9wEQVOyc72aycBMVQFKz7cPdMJn10CvzRI= +github.com/invopop/jsonschema v0.12.0/go.mod h1:ffZ5Km5SWWRAIN6wbDXItl95euhFz2uON45H2qjYt+0= github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= github.com/jhump/protoreflect v1.15.1 h1:HUMERORf3I3ZdX05WaQ6MIpd/NJ434hTp5YiKgfCL6c= github.com/jhump/protoreflect v1.15.1/go.mod h1:jD/2GMKKE6OqX8qTjhADU1e6DShO+gavG9e0Q693nKo= @@ -897,6 +907,8 @@ github.com/ulikunitz/xz v0.5.11/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0o github.com/vektah/gqlparser v1.1.2/go.mod h1:1ycwN7Ij5njmMkPPAOaRFY4rET2Enx7IkVv3vaXspKw= github.com/vmware-labs/yaml-jsonpath v0.3.2 h1:/5QKeCBGdsInyDCyVNLbXyilb61MXGi9NP674f9Hobk= github.com/vmware-labs/yaml-jsonpath v0.3.2/go.mod h1:U6whw1z03QyqgWdgXxvVnQ90zN1BWz5V+51Ewf8k+rQ= +github.com/wk8/go-ordered-map/v2 v2.1.8 h1:5h/BUHu93oj4gIdvHHHGsScSTMijfx5PeYkE/fJgbpc= +github.com/wk8/go-ordered-map/v2 v2.1.8/go.mod h1:5nJHM5DyteebpVlHnWMV0rPz6Zp7+xBAnxjb1X5vnTw= github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI= github.com/xdg-go/scram v1.1.1/go.mod h1:RaEWvsqvNKKvBPvcKeFjrG2cJqOkHTiyTpzz23ni57g= github.com/xdg-go/stringprep v1.0.3/go.mod h1:W3f5j4i+9rC0kuIEJL0ky1VpHXQU3ocBgklLGvcBnW8= diff --git a/hack/docs/partials/main.go b/hack/docs/partials/main.go new file mode 100644 index 000000000..8f87f1e6a --- /dev/null +++ b/hack/docs/partials/main.go @@ -0,0 +1,27 @@ +package main + +import ( + "github.com/loft-sh/vcluster/hack/docs/util" + "github.com/loft-sh/vcluster/pkg/config" +) + +const configPartialBasePath = "docs/pages/configuration/_partials/" + +func main() { + repository := "github.com/loft-sh/vcluster" + configGoPackage := "./pkg/config" + versionedConfigBasePath := configPartialBasePath + + schema := util.GenerateSchema(config.Config{}, map[string]string{ + repository: configGoPackage, + "k8s.io/api/admissionregistration/v1": "./vendor/k8s.io/api/admissionregistration/v1", + "k8s.io/api/app/v1": "./vendor/k8s.io/api/apps/v1", + "k8s.io/api/core/v1": "./vendor/k8s.io/api/core/v1", + "k8s.io/api/networking/v1": "./vendor/k8s.io/api/networking/v1", + "k8s.io/api/rbac/v1": "./vendor/k8s.io/api/rbac/v1", + "k8s.io/apimachinery/pkg/api/resource": "./vendor/k8s.io/apimachinery/pkg/api/resource", + "k8s.io/apimachinery/pkg/apis/meta/v1": "./vendor/k8s.io/apimachinery/pkg/apis/meta/v1", + "k8s.io/apiserver/pkg/apis/audit/v1": "./vendor/k8s.io/apiserver/pkg/apis/audit/v1", + }) + util.GenerateReference(schema, versionedConfigBasePath) +} diff --git a/hack/docs/schema/main.go b/hack/docs/schema/main.go new file mode 100644 index 000000000..636630af0 --- /dev/null +++ b/hack/docs/schema/main.go @@ -0,0 +1,177 @@ +package main + +import ( + "encoding/json" + "fmt" + "os" + "path/filepath" + "strings" + + "github.com/invopop/jsonschema" + "github.com/loft-sh/vcluster/hack/docs/util" + "github.com/loft-sh/vcluster/pkg/config" + "k8s.io/client-go/tools/clientcmd/api/latest" +) + +const jsonschemaFile = "vcluster-schema.json" +const openapiSchemaFile = "docs/schemas/config-openapi.json" + +// Run executes the command logic +func main() { + r := new(jsonschema.Reflector) + r.AllowAdditionalProperties = true + //r.PreferYAMLSchema = true + r.RequiredFromJSONSchemaTags = false + //r.YAMLEmbeddedStructs = false + r.ExpandedStruct = true + + for base, pkgpath := range map[string]string{ + "github.com/loft-sh/vcluster": "./pkg/config", + "k8s.io/api/admissionregistration/v1": "./vendor/k8s.io/api/admissionregistration/v1", + "k8s.io/api/app/v1": "./vendor/k8s.io/api/apps/v1", + "k8s.io/api/core/v1": "./vendor/k8s.io/api/core/v1", + "k8s.io/api/networking/v1": "./vendor/k8s.io/api/networking/v1", + "k8s.io/api/rbac/v1": "./vendor/k8s.io/api/rbac/v1", + "k8s.io/apimachinery/pkg/api/resource": "./vendor/k8s.io/apimachinery/pkg/api/resource", + "k8s.io/apimachinery/pkg/apis/meta/v1": "./vendor/k8s.io/apimachinery/pkg/apis/meta/v1", + "k8s.io/apiserver/pkg/apis/audit/v1": "./vendor/k8s.io/apiserver/pkg/apis/audit/v1", + } { + err := r.AddGoComments(base, pkgpath) + if err != nil { + panic(err) + } + } + + util.PostProcessVendoredComments(r.CommentMap) + + //for name, _ := range r.CommentMap { + // if strings.HasPrefix(name, "github.com/loft-sh/vcluster") { + // continue + // } + // + // parts := strings.Split(name, "/vendor/") + // if len(parts) > 1 { + // r.CommentMap[parts[1]] = r.CommentMap[name] + // delete(r.CommentMap, name) + // } + //} + + //for name, value := range r.CommentMap { + // fmt.Println(name, ":", value) + //} + + openapiSchema := r.Reflect(&config.Config{}) + genSchema(openapiSchema, openapiSchemaFile) + + jsonSchema := r.Reflect(&config.Config{}) + genSchema(jsonSchema, jsonschemaFile, CleanUp) +} + +func genSchema(schema *jsonschema.Schema, schemaFile string, visitors ...func(s *jsonschema.Schema)) { + isOpenAPISpec := schemaFile == openapiSchemaFile + prefix := "" + if isOpenAPISpec { + prefix = " " + } + + //// vars + //vars, ok := schema.Properties.Get("vars") + //if ok { + // vars.(*jsonschema.Schema).AnyOf = modifyAnyOf(vars) + // vars.(*jsonschema.Schema).PatternProperties = nil + //} + //// pipelines + //pipelines, ok := schema.Properties.Get("pipelines") + //if ok { + // pipelines.(*jsonschema.Schema).AnyOf = modifyAnyOf(pipelines) + // pipelines.(*jsonschema.Schema).PatternProperties = nil + //} + //// commands + //commands, ok := schema.Properties.Get("commands") + //if ok { + // commands.(*jsonschema.Schema).AnyOf = modifyAnyOf(commands) + // commands.(*jsonschema.Schema).PatternProperties = nil + //} + + // Apply visitors + if len(visitors) > 0 { + for _, visitor := range visitors { + walk(schema, visitor) + } + } + + schemaJSON, err := json.MarshalIndent(schema, prefix, " ") + if err != nil { + panic(err) + } + + schemaString := string(schemaJSON) + + if isOpenAPISpec { + schemaString = strings.ReplaceAll(schemaString, "#/$defs/", "#/definitions/Config/$defs/") + + schemaString = fmt.Sprintf(`{ + "swagger": "2.0", + "info": { + "version": "%s", + "title": "vcluster.yaml" + }, + "paths": {}, + "definitions": { + "Config": %s + } +} +`, latest.Version, schemaString) + } + + err = os.MkdirAll(filepath.Dir(schemaFile), os.ModePerm) + if err != nil { + panic(err) + } + + err = os.WriteFile(schemaFile, []byte(schemaString), os.ModePerm) + if err != nil { + panic(err) + } +} + +func modifyAnyOf(field interface{}) []*jsonschema.Schema { + return []*jsonschema.Schema{ + { + Type: "object", + PatternProperties: map[string]*jsonschema.Schema{ + ".*": { + Type: "string", + }, + }, + }, + { + Type: "object", + PatternProperties: field.(*jsonschema.Schema).PatternProperties, + }, + { + Type: "object", + }, + } +} + +func walk(schema *jsonschema.Schema, visit func(s *jsonschema.Schema)) { + for pair := schema.Properties.Oldest(); pair != nil; pair = pair.Next() { + visit(pair.Value) + } + + for _, definition := range schema.Definitions { + for pair := definition.Properties.Oldest(); pair != nil; pair = pair.Next() { + visit(pair.Value) + } + } +} + +func CleanUp(s *jsonschema.Schema) { + if len(s.OneOf) > 0 || len(s.AnyOf) > 0 { + s.Ref = "" + s.Type = "" + s.Items = nil + s.PatternProperties = nil + } +} diff --git a/hack/docs/util/comments.go b/hack/docs/util/comments.go new file mode 100644 index 000000000..0e4112794 --- /dev/null +++ b/hack/docs/util/comments.go @@ -0,0 +1,28 @@ +package util + +import ( + "regexp" + "strings" +) + +var k8sCommentMetadata = regexp.MustCompile(`\n\+([^=].*)(=([^=].*))?`) + +func PostProcessVendoredComments(commentMap map[string]string) { + for name, _ := range commentMap { + if !strings.Contains(name, "/vendor/") { + continue + } + + parts := strings.Split(name, "/vendor/") + if len(parts) > 1 { + commentMap[parts[1]] = commentMap[name] + delete(commentMap, name) + } + } +} + +func PostProcessK8sComments(commentMap map[string]string) { + for name, comment := range commentMap { + commentMap[name] = k8sCommentMetadata.ReplaceAllString(comment, "") + } +} diff --git a/hack/docs/util/extract_content.go b/hack/docs/util/extract_content.go new file mode 100644 index 000000000..332da06e6 --- /dev/null +++ b/hack/docs/util/extract_content.go @@ -0,0 +1,35 @@ +package util + +import ( + "regexp" +) + +func GetExistingDescription(pageContent string) string { + match := regexp.MustCompile(`(?is)^---.*?---\s*(import.*?\n)*\s*(.*?)\s*\n###? .*$`).ReplaceAllString(pageContent, "$2") + + if match != pageContent && match != "" { + return "\n" + match + "\n" + } + return "" +} + +func GetSection(headlineText, pageContent string) string { + regex := `(?is)^.*\s*\n###?\s+` + headlineText + `\s*(.*?)(\n+((##)|$).*)?$` + match := regexp.MustCompile(regex).ReplaceAllString(pageContent, "$1") + + if match != pageContent && match != "" { + return match + } + return "" +} + +/* +func GetPartOfAutogenSection(headlineText, pageContent string) string { + regex := "(?is)^.*" + AutoGenTagBegin + `\s*\n###?\s+` + headlineText + `.*?` + AutoGenTagEnd + `\s*(.*?)\s*` + AutoGenTagBegin + ".*$" + match := regexp.MustCompile(regex).ReplaceAllString(pageContent, "$1") + + if match != pageContent && match != "" { + return match + "\n\n" + } + return "" +}*/ diff --git a/hack/docs/util/groups.go b/hack/docs/util/groups.go new file mode 100644 index 000000000..71a0b9c36 --- /dev/null +++ b/hack/docs/util/groups.go @@ -0,0 +1,49 @@ +package util + +import ( + "fmt" + "os" + "path/filepath" + "strings" +) + +type Group struct { + File string + Name string + Content string + Imports *[]string +} + +func ProcessGroups(groups map[string]*Group) { + for groupID, group := range groups { + groupContent := group.Content + groupFileContent := "" + + if strings.TrimSpace(group.Content) != "" { + if group.Name != "" { + groupContent = "\n" + `
` + group.Name + `
` + "\n\n" + groupContent + } + + groupImportContent := "" + for _, partialFile := range *group.Imports { + groupImportContent = groupImportContent + GetPartialImport(partialFile, group.File) + } + + if groupImportContent != "" { + groupImportContent = groupImportContent + "\n\n" + } + + groupFileContent = fmt.Sprintf(`%s
%s`+"\n"+`
`, groupImportContent, groupID, groupContent) + } + + err := os.MkdirAll(filepath.Dir(group.File), os.ModePerm) + if err != nil { + panic(err) + } + + err = os.WriteFile(group.File, []byte(groupFileContent), os.ModePerm) + if err != nil { + panic(err) + } + } +} diff --git a/hack/docs/util/partials.go b/hack/docs/util/partials.go new file mode 100644 index 000000000..5eea3b97b --- /dev/null +++ b/hack/docs/util/partials.go @@ -0,0 +1,31 @@ +package util + +import ( + "fmt" + "path/filepath" + "regexp" + + "golang.org/x/text/cases" + "golang.org/x/text/language" +) + +var partialNameRegex = regexp.MustCompile(`(\..*$)|[^a-zA-Z0-9]`) + +func GetPartialImportName(partialImport string) string { + basename := filepath.Base(partialImport) + basename = partialNameRegex.ReplaceAllString(basename, "") + return fmt.Sprintf("Partial%s", cases.Title(language.English).String(basename)) +} + +func GetPartialImport(partialFile, importingFile string) string { + partialImportPath, err := filepath.Rel(filepath.Dir(importingFile), partialFile) + if err != nil { + panic(err) + } + + if partialImportPath[0:1] != "." { + partialImportPath = "./" + partialImportPath + } + + return fmt.Sprintf(TemplatePartialImport, GetPartialImportName(partialFile), partialImportPath) +} diff --git a/hack/docs/util/schema.go b/hack/docs/util/schema.go new file mode 100644 index 000000000..f4a086e8f --- /dev/null +++ b/hack/docs/util/schema.go @@ -0,0 +1,316 @@ +package util + +import ( + "fmt" + "os" + "path/filepath" + "strconv" + "strings" + + "github.com/gertd/go-pluralize" + "github.com/invopop/jsonschema" +) + +const nameFieldName = "name" +const groupKey = "group" +const groupNameKey = "group_name" +const prefixSeparator = "/" +const anchorSeparator = "-" + +var pluralizeClient = pluralize.NewClient() + +func GenerateSchema(configInstance interface{}, repositoryPackages map[string]string) *jsonschema.Schema { + r := new(jsonschema.Reflector) + r.AllowAdditionalProperties = true + r.RequiredFromJSONSchemaTags = true + r.ExpandedStruct = true + + for repo, pkg := range repositoryPackages { + err := r.AddGoComments(repo, pkg) + if err != nil { + panic(err) + } + } + + PostProcessVendoredComments(r.CommentMap) + PostProcessK8sComments(r.CommentMap) + + return r.Reflect(configInstance) +} + +func GenerateReference(schema *jsonschema.Schema, basePath string) { + //versionField, ok := schema.Properties.Get(versionFieldName) + //if ok { + // if fieldSchema, ok := versionField.(*jsonschema.Schema); ok { + // versionEnum := []string{} + // for version := range versions.VersionLoader { + // versionEnum = append(versionEnum, version) + // } + // + // sort.SliceStable(versionEnum, func(a, b int) bool { + // majorA, _ := strconv.Atoi(string(versionEnum[a][1])) + // majorB, _ := strconv.Atoi(string(versionEnum[b][1])) + // minorA, _ := strconv.Atoi(string(versionEnum[a][6:])) + // minorB, _ := strconv.Atoi(string(versionEnum[b][6:])) + // + // if majorA == majorB { + // return minorA > minorB + // } else { + // return majorA > majorB + // } + // }) + // + // fieldSchema.Enum = []interface{}{} + // for _, version := range versionEnum { + // fieldSchema.Enum = append(fieldSchema.Enum, version) + // } + // } + //} + + createSections(basePath, "", schema, schema.Definitions, 1, false) +} + +func createSections(basePath, prefix string, schema *jsonschema.Schema, definitions jsonschema.Definitions, depth int, parentIsNameObjectMap bool) string { + partialImports := &[]string{} + content := "" + headlinePrefix := strings.Repeat("#", depth+1) + " " + anchorPrefix := strings.TrimPrefix(strings.ReplaceAll(prefix, prefixSeparator, anchorSeparator), anchorSeparator) + + groups := map[string]*Group{} + + for pair := schema.Properties.Oldest(); pair != nil; pair = pair.Next() { + fieldName := pair.Key + fieldSchema := pair.Value + //for _, fieldName := range schema.Properties.Keys() { + if parentIsNameObjectMap && fieldName == nameFieldName { + continue + } + + fieldContent := "" + fieldFile := fmt.Sprintf("%s%s%s.mdx", basePath, prefix, fieldName) + fieldFileReference := fieldFile + fieldType := "object" + isNameObjectMap := false + groupID, _ := fieldSchema.Extras[groupKey].(string) + expandable := false + + var patternPropertySchema *jsonschema.Schema + var nestedSchema *jsonschema.Schema + var ok bool + + ref := "" + if fieldSchema.Type == "array" { + ref = fieldSchema.Items.Ref + fieldType = "object[]" + } else if patternPropertySchema, ok = fieldSchema.PatternProperties[".*"]; ok { + ref = patternPropertySchema.Ref + isNameObjectMap = true + } else if fieldSchema.Ref != "" { + ref = fieldSchema.Ref + } + + if ref != "" { + refSplit := strings.Split(ref, "/") + nestedSchema, ok = definitions[refSplit[len(refSplit)-1]] + + if ok { + newPrefix := prefix + fieldName + prefixSeparator + createSections(basePath, newPrefix, nestedSchema, definitions, depth+1, isNameObjectMap) + fieldFileReference = fmt.Sprintf("%s%s%s_reference.mdx", basePath, prefix, fieldName) + + fieldContent = GetPartialImport(fieldFileReference, fieldFile) + "\n\n" + fmt.Sprintf(TemplatePartialUse, GetPartialImportName(fieldFileReference)) + + expandable = true + } + } + + required := contains(schema.Required, fieldName) + fieldDefault := "" + + fieldType = fieldSchema.Type + if fieldType == "" && fieldSchema.OneOf != nil { + for _, oneOfType := range fieldSchema.OneOf { + if fieldType != "" { + fieldType = fieldType + "|" + } + fieldType = fieldType + oneOfType.Type + } + } + + if isNameObjectMap { + fieldNameSingular := pluralizeClient.Singular(fieldName) + fieldType = "<" + fieldNameSingular + "_name>:" + + if patternPropertySchema != nil && patternPropertySchema.Type != "" { + fieldType = fieldType + patternPropertySchema.Type + } else { + fieldType = fieldType + "object" + } + } + + if fieldType == "array" { + if fieldSchema.Items.Type == "" { + fieldType = "object[]" + } else { + fieldType = fieldSchema.Items.Type + "[]" + } + } + + fieldPartial := fmt.Sprintf(TemplatePartialUse, GetPartialImportName(fieldFileReference)) + if ref != "" { + if isNameObjectMap && nestedSchema != nil { + nameFieldSchema, ok := nestedSchema.Properties.Get(nameFieldName) + if ok { + fieldNameSingular := pluralizeClient.Singular(fieldName) + nameFieldRequired := true + nameFieldDefault := "" + nameFieldEnumValues := GetEnumValues(nameFieldSchema, nameFieldRequired, &nameFieldDefault) + + anchorName := anchorPrefix + fieldName + anchorSeparator + nameFieldName + + fieldPartial = fmt.Sprintf(TemplateConfigField, true, "open", headlinePrefix, "<"+fieldNameSingular+"_"+nameFieldName+">", nameFieldRequired, "string", nameFieldDefault, nameFieldEnumValues, anchorName, sanitizeDescription(nameFieldSchema.Description), fieldPartial) + fieldType = "<" + fieldNameSingular + "_name>:object" + } + } + + anchorName := anchorPrefix + fieldName + + fieldContent = GetPartialImport(fieldFileReference, fieldFile) + "\n\n" + fmt.Sprintf(TemplateConfigField, true, " open", headlinePrefix, fieldName, false, fieldType, "", "", anchorName, sanitizeDescription(fieldSchema.Description), fieldPartial) + + fieldPartial = fmt.Sprintf(TemplateConfigField, true, "", headlinePrefix, fieldName, false, fieldType, "", "", anchorName, sanitizeDescription(fieldSchema.Description), fieldPartial) + } else { + if fieldType == "boolean" { + if required { + fieldDefault = "true" + required = false + } else { + fieldDefault = "false" + boolDefault, ok := fieldSchema.Default.(bool) + if ok && boolDefault { + fieldDefault = "true" + } + } + } else if fieldType == "integer" { + intDefault, ok := fieldSchema.Default.(int) + if ok { + fieldDefault = strconv.Itoa(intDefault) + } else { + fieldDefault = "" + } + } else { + fieldDefault, ok = fieldSchema.Default.(string) + if !ok { + fieldDefault = "" + } + } + + enumValues := GetEnumValues(fieldSchema, required, &fieldDefault) + + anchorName := anchorPrefix + fieldName + + fieldContent = fmt.Sprintf(TemplateConfigField, expandable, " open", headlinePrefix, fieldName, required, fieldType, fieldDefault, enumValues, anchorName, sanitizeDescription(fieldSchema.Description), fieldContent) + } + + err := os.MkdirAll(filepath.Dir(fieldFileReference), os.ModePerm) + if err != nil { + panic(err) + } + + err = os.WriteFile(fieldFile, []byte(fieldContent), os.ModePerm) + if err != nil { + panic(err) + } + + if groupID != "" { + groupID = strings.ToLower(groupID) + group, ok := groups[groupID] + if !ok { + group = &Group{ + File: fmt.Sprintf("%s%sgroup_%s.mdx", basePath, prefix, groupID), + Imports: &[]string{}, + } + groups[groupID] = group + + groupPartial := fmt.Sprintf(TemplatePartialUse, GetPartialImportName(group.File)) + + content = content + "\n\n" + groupPartial + *partialImports = append(*partialImports, group.File) + } + + if groupName, ok := fieldSchema.Extras[groupNameKey]; ok { + group.Name = groupName.(string) + } + + group.Content = group.Content + fieldPartial + *group.Imports = append(*group.Imports, fieldFileReference) + } else { + content = content + "\n\n" + fieldPartial + *partialImports = append(*partialImports, fieldFileReference) + } + } + + ProcessGroups(groups) + + if prefix == "" { + prefix = "reference" + } else { + prefix = strings.TrimSuffix(prefix, "/") + "_reference" + } + + pageFile := fmt.Sprintf("%s%s.mdx", basePath, strings.TrimSuffix(prefix, "/")) + + importContent := "" + for _, partialFile := range *partialImports { + importContent = importContent + GetPartialImport(partialFile, pageFile) + } + + content = fmt.Sprintf("%s%s", importContent, content) + + err := os.MkdirAll(filepath.Dir(pageFile), os.ModePerm) + if err != nil { + panic(err) + } + + err = os.WriteFile(pageFile, []byte(content), os.ModePerm) + if err != nil { + panic(err) + } + + return content +} + +func GetEnumValues(fieldSchema *jsonschema.Schema, required bool, fieldDefault *string) string { + enumValues := "" + if fieldSchema.Enum != nil { + for i, enumVal := range fieldSchema.Enum { + enumValString, ok := enumVal.(string) + if ok { + if i == 0 && !required && *fieldDefault == "" { + *fieldDefault = enumValString + } + + if enumValues != "" { + enumValues = enumValues + "
" + } + enumValues = enumValues + enumValString + } + } + enumValues = fmt.Sprintf("%s", enumValues) + } + return enumValues +} + +func contains(s []string, e string) bool { + for _, a := range s { + if a == e { + return true + } + } + return false +} + +func sanitizeDescription(description string) string { + sanitized := strings.ReplaceAll(description, "<", "<") + sanitized = strings.ReplaceAll(sanitized, ">", ">") + return sanitized +} diff --git a/hack/docs/util/templates.go b/hack/docs/util/templates.go new file mode 100644 index 000000000..a8faa42fc --- /dev/null +++ b/hack/docs/util/templates.go @@ -0,0 +1,36 @@ +package util + +const TemplatePartialImport = ` +import %s from "%s"` +const TemplatePartialUse = `<%s /> +` +const TemplatePartialUseConfig = `<%s /> +` +const TemplateConfigField = ` +
+ + +%s` + "`%s`" + ` required %s %s %s {#%s} + +%s + + + +%s + +
+` +const TemplateFunctionRef = ` +
+ + +%s` + "`%s`" + ` %s %s %s pipeline only {#%s} + +%s + + + +%s + +
+` diff --git a/pkg/config/config.go b/pkg/config/config.go index c1b8f0ce9..855260730 100644 --- a/pkg/config/config.go +++ b/pkg/config/config.go @@ -6,7 +6,7 @@ import ( const Version = "v1beta1" -type Config struct { +type SyncPatchesConfig struct { // Version is the config version Version string `json:"version,omitempty" yaml:"version,omitempty"` diff --git a/pkg/config/parse.go b/pkg/config/parse.go index 9d0ac29f4..f33017f91 100644 --- a/pkg/config/parse.go +++ b/pkg/config/parse.go @@ -11,8 +11,8 @@ var ( verbs = []string{"get", "list", "create", "update", "patch", "watch", "delete", "deletecollection"} ) -func Parse(rawConfig string) (*Config, error) { - c := &Config{} +func Parse(rawConfig string) (*SyncPatchesConfig, error) { + c := &SyncPatchesConfig{} err := yaml.UnmarshalStrict([]byte(rawConfig), c) if err != nil { return nil, err @@ -26,7 +26,7 @@ func Parse(rawConfig string) (*Config, error) { return c, nil } -func validate(config *Config) error { +func validate(config *SyncPatchesConfig) error { if config.Version != Version { return fmt.Errorf("unsupported configuration version. Only %s is supported currently", Version) } diff --git a/pkg/config/schema.go b/pkg/config/schema.go new file mode 100644 index 000000000..a15149476 --- /dev/null +++ b/pkg/config/schema.go @@ -0,0 +1,606 @@ +package config + +import ( + "github.com/creasty/defaults" + admissionregistrationv1 "k8s.io/api/admissionregistration/v1" + appsv1 "k8s.io/api/apps/v1" + corev1 "k8s.io/api/core/v1" + networkingv1 "k8s.io/api/networking/v1" + rbacv1 "k8s.io/api/rbac/v1" + "k8s.io/apimachinery/pkg/api/resource" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + auditv1 "k8s.io/apiserver/pkg/apis/audit/v1" +) + +type Config struct { + ExportKubeConfig *ExportKubeConfig `yaml:"exportKubeConfig,omitempty" json:"exportKubeConfig,omitempty"` + Sync *SyncConfig `yaml:"sync,omitempty" json:"sync,omitempty"` + Observability *Observability `yaml:"observability,omitempty" json:"observability,omitempty"` + Networking *Networking `yaml:"networking,omitempty" json:"networking,omitempty"` + Plugin map[string]Plugin `yaml:"plugin,omitempty" json:"plugin,omitempty"` + Plugins map[string]Plugins `yaml:"plugins,omitempty" json:"plugins,omitempty"` + ControlPlane ControlPlane `yaml:"controlPlane,omitempty" json:"controlPlane,omitempty"` + Policies Policies `yaml:"policies,omitempty" json:"policies,omitempty"` + RBAC RBAC `yaml:"rbac,omitempty" json:"rbac,omitempty"` + // Telemetry is the configuration related to telemetry gathered about vcluster usage. + Telemetry Telemetry `yaml:"telemetry,omitempty" json:"telemetry,omitempty"` + Experimental Experimental `yaml:"experimental,omitempty" json:"experimental,omitempty"` + License License `yaml:"license,omitempty" json:"license,omitempty"` + Platform Platform `yaml:"platform,omitempty" json:"platform,omitempty"` + Sleep Sleep `yaml:"sleep,omitempty" json:"sleep,omitempty" product:"platform"` + Template Template `yaml:"template,omitempty" json:"template,omitempty" product:"platform"` + Access Access `yaml:"access,omitempty" json:"access,omitempty"` +} + +type ExportKubeConfig struct { + Context string `yaml:"context" json:"context"` + Server string `yaml:"server" json:"server"` + Secret *corev1.SecretReference `yaml:"secret,omitempty" json:"secret,omitempty"` +} + +type SyncConfig struct { + ToHost *SyncToHost + FromHost *SyncFromHost +} + +type SyncToHost struct { + Services EnableSwitch `yaml:"services,omitempty" json:"services,omitempty"` + Endpoints EnableSwitch `yaml:"endpoints,omitempty" json:"endpoints,omitempty"` + Ingresses EnableSwitch `yaml:"ingresses,omitempty" json:"ingresses,omitempty"` + PriorityClasses EnableSwitch `yaml:"priorityClasses,omitempty" json:"priorityClasses,omitempty"` + NetworkPolicies EnableSwitch `yaml:"networkPolicies,omitempty" json:"networkPolicies,omitempty"` + VolumeSnapshots EnableSwitch `yaml:"volumeSnapshots,omitempty" json:"volumeSnapshots,omitempty"` + PodDisruptionBudgets EnableSwitch `yaml:"podDisruptionBudgets,omitempty" json:"podDisruptionBudgets,omitempty"` + ServiceAccounts EnableSwitch `yaml:"serviceAccounts,omitempty" json:"serviceAccounts,omitempty"` + StorageClasses EnableSwitch `yaml:"storageClasses,omitempty" json:"storageClasses,omitempty"` + PersistentVolumes EnableSwitch `yaml:"persistentVolumes,omitempty" json:"persistentVolumes,omitempty"` + PersistentVolumeClaims EnableSwitch `yaml:"persistentVolumeClaims,omitempty" json:"persistentVolumeClaims,omitempty"` + ConfigMaps SyncAllResource `yaml:"configMaps,omitempty" json:"configMaps,omitempty"` + Secrets SyncAllResource `yaml:"secrets,omitempty" json:"secrets,omitempty"` + Pods SyncPods `yaml:"pods,omitempty" json:"pods,omitempty"` +} + +type SyncFromHost struct { + CSIDrivers EnableSwitch `yaml:"csiDrivers,omitempty" json:"csiDrivers,omitempty"` + CSINodes EnableSwitch `yaml:"csiNodes,omitempty" json:"csiNodes,omitempty"` + CSIStorageCapacities EnableSwitch `yaml:"csiStorageCapacities,omitempty" json:"csiStorageCapacities,omitempty"` + IngressClasses EnableSwitch `yaml:"ingressClasses,omitempty" json:"ingressClasses,omitempty"` + Events EnableSwitch `yaml:"events,omitempty" json:"events,omitempty"` + StorageClasses EnableSwitch `yaml:"storageClasses,omitempty" json:"storageClasses,omitempty"` +} + +type EnableSwitch struct { + Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty" default:"true"` +} + +type SyncAllResource struct { + EnableSwitch `yaml:",inline" json:",inline"` + + All bool `yaml:"enabled,omitempty" json:"enabled,omitempty" default:"true"` +} + +type SyncPods struct { + EnableSwitch `yaml:",inline" json:",inline"` + + WorkloadServiceAccount string `yaml:"workloadServiceAccount,omitempty" json:"workloadServiceAccount,omitempty"` + TranslateImage map[string]string `yaml:"translateImage,omitempty" json:"translateImage,omitempty"` + EnforceTolerations []string `yaml:"enforceTolerations,omitempty" json:"enforceTolerations,omitempty"` // validate format + UseSecretsForSATokens bool `yaml:"useSecretsForSATokens,omitempty" json:"useSecretsForSATokens,omitempty" default:"true"` + RewriteHosts *SyncRewriteHosts `yaml:"rewriteHosts,omitempty" json:"rewriteHosts,omitempty"` +} + +type SyncRewriteHosts struct { + Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty" default:"true"` + InitContainerImage bool `yaml:"initContainerImage,omitempty" json:"initContainerImage,omitempty" default:"true"` +} + +type SyncNodes struct { + Real *SyncRealNodes `yaml:"real,omitempty" json:"real,omitempty"` + Pseudo *SyncPseudoNodes `yaml:"pseudo,omitempty" json:"pseudo,omitempty"` +} + +type SyncRealNodes struct { + EnableSwitch `yaml:",inline" json:",inline"` + + SyncLabelsTaints bool `yaml:"syncLabelsTaints,omitempty" json:"syncLabelsTaints,omitempty"` + ClearImageStatus bool `yaml:"clearImageStatus,omitempty" json:"clearImageStatus,omitempty"` + Selector map[string]string `yaml:"selector,omitempty" json:"selector,omitempty"` +} + +type SyncPseudoNodes struct { + EnableSwitch `yaml:",inline" json:",inline"` +} + +type Observability struct { + ServiceMonitor EnableSwitch `yaml:"serviceMonitor,omitempty" json:"serviceMonitor,omitempty"` + Metrics ObservabilityMetrics `yaml:"metrics,omitempty" json:"metrics,omitempty"` +} + +type ObservabilityMetrics struct { + Proxy ObservabilityMetricsProxy `yaml:"proxy,omitempty" json:"proxy,omitempty"` +} + +type ObservabilityMetricsProxy struct { + Nodes EnableSwitch `yaml:"nodes,omitempty" json:"nodes,omitempty"` + Pods EnableSwitch `yaml:"pods,omitempty" json:"pods,omitempty"` + // TODO Docs, Logs +} + +type Networking struct { + ReplicateServices ReplicateServices `yaml:"replicateServices,omitempty" json:"replicateServices,omitempty"` + ResolveServices ResolveServices `yaml:"resolveServices,omitempty" json:"resolveServices,omitempty"` + Advanced NetworkingAdvanced `yaml:"advanced,omitempty" json:"advanced,omitempty"` +} + +type ReplicateServices struct { + ToHost ServiceMapping `yaml:"toHost,omitempty" json:"toHost,omitempty"` + FromHost ServiceMapping `yaml:"fromHost,omitempty" json:"fromHost,omitempty"` +} + +type ServiceMapping struct { + From string `yaml:"from,omitempty" json:"from,omitempty"` + To string `yaml:"to,omitempty" json:"to,omitempty"` +} + +type ResolveServices struct { + Service string `yaml:"service,omitempty" json:"service,omitempty"` + Target ResolveServiceTarget `yaml:"target,omitempty" json:"target,omitempty"` +} + +type ResolveServiceTarget struct { + VCluster ResolveServiceService `yaml:"vcluster,omitempty" json:"vcluster,omitempty"` + Host ResolveServiceService `yaml:"host,omitempty" json:"host,omitempty"` + External ResolveServiceHostname `yaml:"external,omitempty" json:"external,omitempty"` +} + +type ResolveServiceService struct { + Service string `yaml:"service,omitempty" json:"service,omitempty"` +} + +type ResolveServiceHostname struct { + Hostname string `yaml:"hostname,omitempty" json:"hostname,omitempty"` +} + +type NetworkingAdvanced struct { + ClusterDomain string `yaml:"clusterDomain,omitempty" json:"clusterDomain,omitempty"` + FallBack []NetworkDNSFallback `yaml:"fallback,omitempty" json:"fallback,omitempty"` + ProxyKubelets *NetworkProxyKubelets `yaml:"proxyKubelets,omitempty" json:"proxyKubelets,omitempty"` +} + +type NetworkDNSFallback struct { + IP string `yaml:"ip,omitempty" json:"ip,omitempty"` + HostCluster bool `yaml:"hostCluster,omitempty" json:"hostCluster,omitempty"` +} + +type NetworkProxyKubelets struct { + ByHostname bool `yaml:"byHostname,omitempty" json:"byHostname,omitempty"` + ByIP bool `yaml:"byIP,omitempty" json:"byIP,omitempty"` +} + +type Plugins struct { + Image string `yaml:"image,omitempty" json:"image,omitempty"` + Config map[string]interface{} `yaml:"config,omitempty" json:"config,omitempty"` + RBAC *PluginsRBAC `yaml:"rbac,omitempty" json:"rbac,omitempty"` +} + +type PluginsRBAC struct { + Role []rbacv1.PolicyRule `yaml:"role,omitempty" json:"role,omitempty"` + ClusterRole []rbacv1.PolicyRule `yaml:"clusterRole,omitempty" json:"clusterRole,omitempty"` +} + +type Plugin struct { + Plugins `yaml:",inline" json:",inline"` + + Version string `yaml:"version,omitempty" json:"version,omitempty"` +} + +type ControlPlane struct { + Distro Distributions `yaml:"distro,omitempty" json:"distro,omitempty"` + BackingStore BackingStore `yaml:"backingStore,omitempty" json:"backingStore,omitempty"` + HostPathMapper HostPathMapper `yaml:"hostPathMapper,omitempty" json:"hostPathMapper,omitempty"` + CoreDNS CoreDNS `yaml:"coredns,omitempty" json:"coredns,omitempty"` + VirtualScheduler *EnableSwitch `yaml:"virtualScheduler,omitempty" json:"virtualScheduler,omitempty" product:"pro"` + Proxy *ControlPlaneProxy `yaml:"proxy,omitempty" json:"proxy,omitempty"` + Service ControlPlaneService `yaml:"service,omitempty" json:"service,omitempty"` + Ingress ControlPlaneIngress `yaml:"ingress,omitempty" json:"ingress,omitempty"` + HighAvailability ControlPlaneHighAvailability `yaml:"highAvailability,omitempty" json:"highAvailability,omitempty"` + Advanced ControlPlaneAdvanced `yaml:"advanced,omitempty" json:"advanced,omitempty"` +} + +type Distributions struct { + K3S *DistributionsK3s `yaml:"k3s,omitempty" json:"k3s,omitempty"` + K8S *DistributionsK8s `yaml:"k8s,omitempty" json:"k8s,omitempty"` + K0S *corev1.Container `yaml:"k0s,omitempty" json:"k0s,omitempty"` + Advanced DistributionAdvanced `yaml:"advanced,omitempty" json:"advanced,omitempty"` +} + +type DistributionsK3s struct { + corev1.Container `yaml:",inline" json:",inline"` + Token string `yaml:"token,omitempty" json:"token,omitempty"` +} + +func (d *DistributionsK3s) SetDefaults() { + if defaults.CanUpdate(d.Container.Resources) { + d.Container.Resources = corev1.ResourceRequirements{ + Limits: map[corev1.ResourceName]resource.Quantity{ + "cpu": {Format: "100m"}, + "memory": {Format: "256Mi"}, + }, + Requests: map[corev1.ResourceName]resource.Quantity{ + "cpu": {Format: "100m"}, + "memory": {Format: "256Mi"}, + }, + } + } +} + +type DistributionsK8s struct { + APIServer *corev1.Container `yaml:"apiServer,omitempty" json:"apiServer,omitempty"` + ControllerManager *corev1.Container `yaml:"controllerManager,omitempty" json:"controllerManager,omitempty"` + Scheduler *corev1.Container `yaml:"scheduler,omitempty" json:"scheduler,omitempty"` + ETCD *corev1.Container `yaml:"etcd,omitempty" json:"etcd,omitempty"` +} + +type DistributionAdvanced struct { + Paths DistributionPaths `yaml:"paths,omitempty" json:"paths,omitempty"` +} +type DistributionPaths struct { + KubeConfig string `yaml:"kubeConfig,omitempty" json:"kubeConfig,omitempty" default:"/data/server/cred/admin.kubeconfig"` + ServerCAKey string `yaml:"serverCAKey,omitempty" json:"serverCAKey,omitempty" default:"/data/server/tls/server-ca.key"` + ServerCACert string `yaml:"serverCACert,omitempty" json:"serverCACert,omitempty" default:"/data/server/tls/server-ca.crt"` + ClientCACert string `yaml:"clientCACert,omitempty" json:"clientCACert,omitempty" default:"/data/server/tls/client-ca.crt"` + RequestHeaderCACert string `yaml:"requestHeaderCACert,omitempty" json:"requestHeaderCACert,omitempty" default:"/data/server/tls/request-header-ca.crt"` +} + +type BackingStore struct { + SQLite EnableSwitch `yaml:"sqlite,omitempty" json:"sqlite,omitempty"` + EmbeddedEtcd *EmbeddedEtcd `yaml:"embeddedEtcd,omitempty" json:"embeddedEtcd,omitempty" product:"pro"` + ExternalEtcd *ExternalEtcd `yaml:"externalEtcd,omitempty" json:"externalEtcd,omitempty"` +} + +type EmbeddedEtcd struct { + EnableSwitch `yaml:",inline" json:",inline"` + MigrateFrom EmbeddedEtcdMigrateFrom `yaml:"migrateFrom,omitempty" json:"migrateFrom,omitempty"` +} + +type EmbeddedEtcdMigrateFrom struct { + SQLite bool `yaml:"sqlite,omitempty" json:"sqlite,omitempty" default:"true"` + Etcd bool `yaml:"etcd,omitempty" json:"etcd,omitempty" default:"true"` +} + +type ExternalEtcd struct { + Image string `yaml:"image,omitempty" json:"image,omitempty" default:"TBD"` + Replicas uint8 `yaml:"replicas,omitempty" json:"replicas,omitempty" default:"1"` + Metadata *ExternalEtcdMetadata `yaml:"metadata,omitempty" json:"metadata,omitempty"` +} + +type ExternalEtcdMetadata struct { + LabelsAndAnnotations `yaml:",inline" json:",inline"` + PodLabels map[string]string `yaml:"podLabels,omitempty" json:"podLabels,omitempty"` + PodAnnotations map[string]string `yaml:"podAnnotations,omitempty" json:"podAnnotations,omitempty"` +} + +type HostPathMapper struct { + EnableSwitch `yaml:",inline" json:",inline"` + Central bool `yaml:"central,omitempty" json:"central,omitempty" product:"pro" default:"true"` +} + +type CoreDNS struct { + EnableSwitch `yaml:",inline" json:",inline"` + Embedded bool `yaml:"embedded,omitempty" json:"embedded,omitempty" product:"pro" default:"false"` + Service CoreDNSService `yaml:"service,omitempty" json:"service,omitempty"` + Deployment CoreDNSDeployment `yaml:"deployment,omitempty" json:"deployment,omitempty"` +} + +type CoreDNSService struct { + LabelsAndAnnotations `yaml:",inline" json:",inline"` + Spec *corev1.ServiceSpec `yaml:"spec,omitempty" json:"spec,omitempty"` +} + +type CoreDNSDeployment struct { + LabelsAndAnnotations `yaml:",inline" json:",inline"` + Spec *appsv1.DeploymentSpec `yaml:"spec,omitempty" json:"spec,omitempty"` +} + +type ControlPlaneProxy struct { + BindAddress string `yaml:"bindAddress,omitempty" json:"bindAddress,omitempty" default:"0.0.0.0" validate:"ip4_addr"` + Port int `yaml:"port,omitempty" json:"port,omitempty" default:"8443"` + TLS ControlPlaneProxyTLS `yaml:"tls,omitempty" json:"tls,omitempty"` +} + +type ControlPlaneProxyTLS struct { + ExtraSANs []string `yaml:"extraSANs,omitempty" json:"extraSANs,omitempty"` +} + +type ControlPlaneService struct { + LabelsAndAnnotations `yaml:",inline" json:",inline"` + + Name string `yaml:"name,omitempty" json:"name,omitempty"` + Spec *corev1.ServiceSpec `yaml:"spec,omitempty" json:"spec,omitempty"` +} + +type ControlPlaneIngress struct { + EnableSwitch `yaml:",inline" json:",inline"` + LabelsAndAnnotations `yaml:",inline" json:",inline"` + + Name string `yaml:"name,omitempty" json:"name,omitempty"` + Spec *networkingv1.IngressSpec `yaml:"spec,omitempty" json:"spec,omitempty"` +} + +type ControlPlaneHighAvailability struct { + Replicas *int32 `yaml:"replicas,omitempty" json:"replicas,omitempty" default:"1"` + LeaseDuration *int32 `yaml:"leaseDuration,omitempty" json:"leaseDuration,omitempty" default:"66"` + RenewDeadline *int32 `yaml:"renewDeadline,omitempty" json:"renewDeadline,omitempty" default:"40"` + RetryPeriod *int32 `yaml:"retryPeriod,omitempty" json:"retryPeriod,omitempty" default:"15"` +} + +type ControlPlaneAdvanced struct { + DefaultImageRegistry string `yaml:"defaultImageRegistry,omitempty" json:"defaultImageRegistry,omitempty"` + Headless bool `yaml:"headless,omitempty" json:"headless,omitempty" default:"false"` + Persistence ControlPlanePersistence `yaml:"persistence,omitempty" json:"persistence,omitempty"` + Scheduling ControlPlaneScheduling `yaml:"scheduling,omitempty" json:"scheduling,omitempty"` + ServiceAccounts ControlPlaneServiceAccounts `yaml:"serviceAccounts,omitempty" json:"serviceAccounts,omitempty"` + WorkloadServiceAccount ControlPlaneWorkloadServiceAccount `yaml:"workloadServiceAccount,omitempty" json:"workloadServiceAccount,omitempty"` + Probes ControlPlaneProbes `yaml:"probes,omitempty" json:"probes,omitempty"` + Security ControlPlaneSecurity `yaml:"security,omitempty" json:"security,omitempty"` + Metadata ControlPlaneMetadata `yaml:"metadata,omitempty" json:"metadata,omitempty"` +} + +type ControlPlanePersistence struct { + EnableSwitch `yaml:",inline" json:",inline"` + RetentionPolicy string `yaml:"retentionPolicy,omitempty" json:"retentionPolicy,omitempty" default:"Retain" validate:"oneof=Delete Retain"` + Size *resource.Quantity `yaml:"size,omitempty" json:"size,omitempty" default:"5Gi"` + StorageClass string `yaml:"storageClass,omitempty" json:"storageClass,omitempty"` + AddVolumeMounts []corev1.VolumeMount `yaml:"addVolumeMounts,omitempty" json:"addVolumeMounts,omitempty"` + OverwriteVolumeMounts []corev1.VolumeMount `yaml:"overwriteVolumeMounts,omitempty" json:"overwriteVolumeMounts,omitempty"` +} + +type ControlPlaneScheduling struct { + NodeSelector map[string]string `yaml:"nodeSelector,omitempty" json:"nodeSelector,omitempty"` + Affinity *corev1.Affinity `yaml:"affinity,omitempty" json:"affinity,omitempty"` + Tolerations []corev1.Toleration `yaml:"tolerations,omitempty" json:"tolerations,omitempty"` + PriorityClassName string `yaml:"priorityClassName,omitempty" json:"priorityClassName,omitempty"` +} + +type ControlPlaneServiceAccounts struct { + Create bool `yaml:"create,omitempty" json:"create,omitempty" default:"true"` + Name string `yaml:"name,omitempty" json:"name,omitempty" default:"default"` + ImagePullSecrets []corev1.LocalObjectReference `yaml:"imagePullSecrets,omitempty" json:"imagePullSecrets,omitempty"` +} + +type ControlPlaneWorkloadServiceAccount struct { + Create bool `yaml:"create,omitempty" json:"create,omitempty" default:"true"` + Name string `yaml:"name,omitempty" json:"name,omitempty" default:"default"` + Annotations map[string]string `yaml:"annotations,omitempty" json:"annotations,omitempty"` +} + +type ControlPlaneProbes struct { + LivenessProbe EnableSwitch `yaml:"livenessProbe,omitempty" json:"livenessProbe,omitempty"` + ReadinessProbe EnableSwitch `yaml:"readinessProbe,omitempty" json:"readinessProbe,omitempty"` +} + +type ControlPlaneSecurity struct { + PodSecurityContext *corev1.PodSecurityContext `yaml:"podSecurityContext,omitempty" json:"podSecurityContext,omitempty"` + ContainerSecurityContext *ControlPlaneContainerSecurityContext `yaml:"containerSecurityContext,omitempty" json:"containerSecurityContext,omitempty"` +} + +type ControlPlaneContainerSecurityContext struct { + AllowPrivilegeEscalation *bool `yaml:"allowPrivilegeEscalation,omitempty" json:"allowPrivilegeEscalation,omitempty"` + Capabilities *corev1.Capabilities `yaml:"capabilities,omitempty" json:"capabilities,omitempty"` + RunAsUser *int64 `yaml:"runAsUser,omitempty" json:"runAsUser,omitempty" default:"0"` + RunAsGroup *int64 `yaml:"runAsUser,omitempty" json:"runAsGroup,omitempty" default:"0"` +} + +type ControlPlaneMetadata struct { + StatefulSet LabelsAndAnnotations `yaml:"statefulSet,omitempty" json:"statefulSet,omitempty"` + Pods LabelsAndAnnotations `yaml:"pods,omitempty" json:"pods,omitempty"` + AllResources LabelsAndAnnotations `yaml:"allResources,omitempty" json:"allResources,omitempty"` +} + +type LabelsAndAnnotations struct { + Labels map[string]string `yaml:"labels,omitempty" json:"labels,omitempty"` + Annotations map[string]string `yaml:"annotations,omitempty" json:"annotations,omitempty"` +} + +type Policies struct { + PodSecurityStandard string `yaml:"podSecurityStandard,omitempty" json:"podSecurityStandard,omitempty" default:"baseline"` + ResourceQuota ResourceQuota `yaml:"resourceQuota,omitempty" json:"resourceQuota,omitempty"` + LimitRange LimitRange `yaml:"limitRange,omitempty" json:"limitRange,omitempty"` + NetworkPolicy NetworkPolicy `yaml:"networkPolicy,omitempty" json:"networkPolicy,omitempty"` + AdmissionControl AdmissionControl `yaml:"admissionControl,omitempty" json:"admissionControl,omitempty" product:"pro"` +} + +type ResourceQuota struct { + Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty" default:"false"` + Quota corev1.ResourceList `yaml:"quota,omitempty" json:"quota,omitempty"` + ScopeSelector ScopeSelector `yaml:"scopeSelector,omitempty" json:"scopeSelector,omitempty"` + Scopes []corev1.ResourceQuotaScope `yaml:"scopes,omitempty" json:"scopes,omitempty"` +} + +type ScopeSelector struct { + MatchExpressions []metav1.LabelSelectorRequirement `yaml:"matchExpressions,omitempty" json:"matchExpressions,omitempty"` +} + +type LimitRange struct { + Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty" default:"false"` + Default *LimitRangeLimits `yaml:"default,omitempty" json:"default,omitempty"` + DefaultRequest *LimitRangeLimits `yaml:"defaultRequest,omitempty" json:"defaultRequest,omitempty"` +} + +func (l *LimitRange) SetDefaults() { + if defaults.CanUpdate(l.Default) { + l.Default = &LimitRangeLimits{ + EphemeralStorage: resource.Quantity{Format: "8Gi"}, + Memory: resource.Quantity{Format: "512Mi"}, + CPU: resource.Quantity{Format: "1"}, + } + } + + if defaults.CanUpdate(l.DefaultRequest) { + l.DefaultRequest = &LimitRangeLimits{ + EphemeralStorage: resource.Quantity{Format: "3Gi"}, + Memory: resource.Quantity{Format: "128Mi"}, + CPU: resource.Quantity{Format: "100m"}, + } + } +} + +type LimitRangeLimits struct { + EphemeralStorage resource.Quantity `yaml:"ephemeral-storage,omitempty" json:"ephemeral-storage,omitempty"` + Memory resource.Quantity `yaml:"memory,omitempty" json:"memory,omitempty"` + CPU resource.Quantity `yaml:"cpu,omitempty" json:"cpu,omitempty"` +} + +type NetworkPolicy struct { + Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty" default:"false"` +} + +type NetworkPolicyOutgoingConnections struct { + IPBlock *networkingv1.IPBlock `yaml:"ipBlock,omitempty" json:"ipBlock,omitempty"` +} + +func (c *NetworkPolicyOutgoingConnections) SetDefaults() { + if defaults.CanUpdate(c.IPBlock) { + c.IPBlock = &networkingv1.IPBlock{ + CIDR: "0.0.0.0/0", + Except: []string{ + "100.64.0.0/10", + "127.0.0.0/8", + "10.0.0.0/8", + "172.16.0.0/12", + "192.168.0.0/16", + }, + } + } +} + +type AdmissionControl struct { + ValidatingWebhooks []admissionregistrationv1.ValidatingWebhook `yaml:"validatingWebhooks,omitempty" json:"validatingWebhooks,omitempty"` + MutatingWebhooks []admissionregistrationv1.MutatingWebhook `yaml:"mutatingWebhooks,omitempty" json:"mutatingWebhooks,omitempty"` +} + +type RBAC struct { + ClusterRole RBACClusterRole `yaml:"clusterRole,omitempty" json:"clusterRole,omitempty"` + RBACRole RBACRole `yaml:"role,omitempty" json:"role,omitempty"` +} + +type RBACClusterRole struct { + Create bool `yaml:"create,omitempty" json:"create,omitempty" default:"false"` + ExtraRules interface{} `yaml:"extraRules,omitempty" json:"extraRules,omitempty"` +} + +type RBACRole struct { + RBACClusterRole `yaml:",inline" json:",inline"` + ExcludedApiResources []string `yaml:"excludedApiResources,omitempty" json:"excludedApiResources,omitempty"` +} + +type Telemetry struct { + Disabled bool `yaml:"disabled,omitempty" json:"disabled,omitempty" default:"false"` + InstanceCreator string `yaml:"instanceCreators,omitempty" json:"instanceCreators,omitempty" default:"helm"` + PlatformUserID string `yaml:"platformUserID,omitempty" json:"platformUserID,omitempty"` + PlatformInstanceID string `yaml:"platformInstanceID,omitempty" json:"platformInstanceID,omitempty"` + MachineID string `yaml:"machineID,omitempty" json:"machineID,omitempty"` +} + +type Experimental struct { + Extended map[string]interface{} `yaml:",inline" json:",inline"` + + SyncSettings ExperimentalSyncSettings `yaml:"syncSettings,omitempty" json:"syncSettings,omitempty"` + SyncPatches SyncPatchesConfig `yaml:"syncPatches,omitempty" json:"syncPatches,omitempty" product:"pro"` + GenericSync SyncPatchesConfig `yaml:"genericSync,omitempty" json:"genericSync,omitempty"` + Init ExperimentalInit `yaml:"init,omitempty" json:"init,omitempty"` +} + +type ExperimentalSyncSettings struct { + DisableSync bool `yaml:"disableSync,omitempty" json:"disableSync,omitempty" default:"false"` + Target ExperimentalSyncSettingsTarget `yaml:"target,omitempty" json:"target,omitempty"` +} + +type ExperimentalSyncSettingsTarget struct { + Namespace string `yaml:"namespace,omitempty" json:"namespace,omitempty"` +} + +type ExperimentalInit struct { + Manifests string `yaml:"manifests,omitempty" json:"manifests,omitempty"` + ManifestsTemplate string `yaml:"manifestsTemplate,omitempty" json:"manifestsTemplate,omitempty"` + Helm []ExperimentalInitHelm `yaml:"helm,omitempty" json:"helm,omitempty"` +} + +type ExperimentalInitHelm struct { + // TODO pull properties from existing values.yaml +} + +type License struct { + Key string `yaml:"key,omitempty" json:"key,omitempty"` + KeySecretRef *corev1.SecretReference `yaml:"keySecretRef,omitempty" json:"keySecretRef,omitempty"` +} + +func (l *License) SetDefaults() { + if defaults.CanUpdate(l.KeySecretRef) { + l.KeySecretRef = &corev1.SecretReference{ + Name: "vcluster-license", + } + } +} + +type Platform struct { + Name string `yaml:"name,omitempty" json:"name,omitempty"` + Owner string `yaml:"owner,omitempty" json:"owner,omitempty"` + Project string `yaml:"project,omitempty" json:"project,omitempty"` + ApiKey *License `yaml:"apiKey,omitempty" json:"apiKey,omitempty"` +} + +func (l *Platform) SetDefaults() { + if defaults.CanUpdate(l.ApiKey) { + l.ApiKey = &License{ + KeySecretRef: &corev1.SecretReference{ + Name: "vcluster-platform-api-key", + }, + } + } +} + +type Sleep struct { + After int64 `yaml:"after,omitempty" json:"after,omitempty" default:"720"` + Schedule string `yaml:"schedule,omitempty" json:"schedule,omitempty"` // TODO validate crontab + Timezone string `yaml:"timezone,omitempty" json:"timezone,omitempty"` // TODO set default + Ignore SleepIgnore `yaml:"ignore,omitempty" json:"ignore,omitempty"` + AutoDelete SleepAutoDelete `yaml:"autoDelete,omitempty" json:"autoDelete,omitempty"` +} + +type SleepIgnore struct { + Connections SleepIgnoreConnections `yaml:"connections,omitempty" json:"connections,omitempty"` + ResourcesWith map[string]string `yaml:"resourcesWith,omitempty" json:"resourcesWith,omitempty"` +} + +type SleepIgnoreConnections struct { + OlderThan int64 `yaml:"after,omitempty" json:"after,omitempty" default:"3600"` +} + +type SleepWakeup struct { + Schedule string `yaml:"schedule,omitempty" json:"schedule,omitempty"` // TODO validate crontab +} + +type SleepAutoDelete struct { + After int64 `yaml:"after,omitempty" json:"after,omitempty" default:"720"` +} + +type Template struct { + // Name is the name of the template used to populate the virtual cluster + Name string `yaml:"name,omitempty" json:"name,omitempty"` + Version string `yaml:"version,omitempty" json:"version,omitempty"` +} + +type Access struct { + Audit AccessAudit `yaml:"audit,omitempty" json:"audit,omitempty" product:"platform"` +} + +type AccessAudit struct { + Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty" default:"true"` + Level int `yaml:"level,omitempty" json:"level,omitempty" default:"1"` // TODO validate log levels + Policy AccessAuditPolicy `yaml:"policy,omitempty" json:"policy,omitempty"` +} + +type AccessAuditPolicy struct { + Rules []auditv1.PolicyRule `yaml:"rules,omitempty" json:"rules,omitempty"` +} diff --git a/pkg/controllers/generic/export_syncer.go b/pkg/controllers/generic/export_syncer.go index 1e0050fbb..cca790329 100644 --- a/pkg/controllers/generic/export_syncer.go +++ b/pkg/controllers/generic/export_syncer.go @@ -32,7 +32,7 @@ import ( "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" ) -func CreateExporters(ctx *options.ControllerContext, exporterConfig *config.Config) error { +func CreateExporters(ctx *options.ControllerContext, exporterConfig *config.SyncPatchesConfig) error { if len(exporterConfig.Exports) == 0 { return nil } diff --git a/pkg/controllers/generic/import_syncer.go b/pkg/controllers/generic/import_syncer.go index e939bb88a..48d981815 100644 --- a/pkg/controllers/generic/import_syncer.go +++ b/pkg/controllers/generic/import_syncer.go @@ -33,7 +33,7 @@ import ( "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" ) -func CreateImporters(ctx *options.ControllerContext, cfg *config.Config) error { +func CreateImporters(ctx *options.ControllerContext, cfg *config.SyncPatchesConfig) error { if len(cfg.Imports) == 0 { return nil } diff --git a/vcluster-schema.json b/vcluster-schema.json new file mode 100755 index 000000000..e7a4450c8 --- /dev/null +++ b/vcluster-schema.json @@ -0,0 +1,5350 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/loft-sh/vcluster/pkg/config/config", + "$defs": { + "AWSElasticBlockStoreVolumeSource": { + "properties": { + "volumeID": { + "type": "string", + "description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "partition": { + "type": "integer", + "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional" + } + }, + "type": "object", + "required": [ + "volumeID" + ], + "description": "Represents a Persistent Disk resource in AWS." + }, + "Access": { + "properties": { + "audit": { + "$ref": "#/$defs/AccessAudit" + } + }, + "type": "object" + }, + "AccessAudit": { + "properties": { + "enabled": { + "type": "boolean" + }, + "level": { + "type": "integer", + "description": "TODO validate log levels" + }, + "policy": { + "$ref": "#/$defs/AccessAuditPolicy" + } + }, + "type": "object" + }, + "AccessAuditPolicy": { + "properties": { + "rules": { + "items": { + "$ref": "#/$defs/PolicyRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdmissionControl": { + "properties": { + "validatingWebhooks": { + "items": { + "$ref": "#/$defs/ValidatingWebhook" + }, + "type": "array" + }, + "mutatingWebhooks": { + "items": { + "$ref": "#/$defs/MutatingWebhook" + }, + "type": "array" + } + }, + "type": "object" + }, + "Affinity": { + "properties": { + "nodeAffinity": { + "$ref": "#/$defs/NodeAffinity", + "description": "Describes node affinity scheduling rules for the pod.\n+optional" + }, + "podAffinity": { + "$ref": "#/$defs/PodAffinity", + "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).\n+optional" + }, + "podAntiAffinity": { + "$ref": "#/$defs/PodAntiAffinity", + "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).\n+optional" + } + }, + "type": "object", + "description": "Affinity is a group of affinity scheduling rules." + }, + "AzureDiskVolumeSource": { + "properties": { + "diskName": { + "type": "string", + "description": "diskName is the Name of the data disk in the blob storage" + }, + "diskURI": { + "type": "string", + "description": "diskURI is the URI of data disk in the blob storage" + }, + "cachingMode": { + "type": "string", + "description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "kind": { + "type": "string", + "description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared" + } + }, + "type": "object", + "required": [ + "diskName", + "diskURI" + ], + "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod." + }, + "AzureFileVolumeSource": { + "properties": { + "secretName": { + "type": "string", + "description": "secretName is the name of secret that contains Azure Storage Account Name and Key" + }, + "shareName": { + "type": "string", + "description": "shareName is the azure share Name" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "type": "object", + "required": [ + "secretName", + "shareName" + ], + "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod." + }, + "BackingStore": { + "properties": { + "sqlite": { + "$ref": "#/$defs/EnableSwitch" + }, + "embeddedEtcd": { + "$ref": "#/$defs/EmbeddedEtcd" + }, + "externalEtcd": { + "$ref": "#/$defs/ExternalEtcd" + } + }, + "type": "object" + }, + "CSIVolumeSource": { + "properties": { + "driver": { + "type": "string", + "description": "driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster." + }, + "readOnly": { + "type": "boolean", + "description": "readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.\n+optional" + }, + "volumeAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.\n+optional" + }, + "nodePublishSecretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "nodePublishSecretRef is a reference to the secret object containing\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed.\n+optional" + } + }, + "type": "object", + "required": [ + "driver" + ], + "description": "Represents a source location of a volume to mount, managed by an external CSI driver" + }, + "Capabilities": { + "properties": { + "add": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Added capabilities\n+optional" + }, + "drop": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Removed capabilities\n+optional" + } + }, + "type": "object", + "description": "Adds and removes POSIX capabilities from running containers." + }, + "CephFSVolumeSource": { + "properties": { + "monitors": { + "items": { + "type": "string" + }, + "type": "array", + "description": "monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + }, + "path": { + "type": "string", + "description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional" + }, + "user": { + "type": "string", + "description": "user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "secretFile": { + "type": "string", + "description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "secretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + } + }, + "type": "object", + "required": [ + "monitors" + ], + "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling." + }, + "CinderVolumeSource": { + "properties": { + "volumeID": { + "type": "string", + "description": "volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "secretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack.\n+optional" + } + }, + "type": "object", + "required": [ + "volumeID" + ], + "description": "Represents a cinder volume resource in Openstack." + }, + "ClaimSource": { + "properties": { + "resourceClaimName": { + "type": "string", + "description": "ResourceClaimName is the name of a ResourceClaim object in the same\nnamespace as this pod." + }, + "resourceClaimTemplateName": { + "type": "string", + "description": "ResourceClaimTemplateName is the name of a ResourceClaimTemplate\nobject in the same namespace as this pod.\n\nThe template will be used to create a new ResourceClaim, which will\nbe bound to this pod. When this pod is deleted, the ResourceClaim\nwill also be deleted. The pod name and resource name, along with a\ngenerated component, will be used to form a unique name for the\nResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.\n\nThis field is immutable and no changes will be made to the\ncorresponding ResourceClaim by the control plane after creating the\nResourceClaim." + } + }, + "type": "object", + "description": "ClaimSource describes a reference to a ResourceClaim." + }, + "ClientIPConfig": { + "properties": { + "timeoutSeconds": { + "type": "integer", + "description": "timeoutSeconds specifies the seconds of ClientIP type session sticky time.\nThe value must be \u003e0 \u0026\u0026 \u003c=86400(for 1 day) if ServiceAffinity == \"ClientIP\".\nDefault value is 10800(for 3 hours).\n+optional" + } + }, + "type": "object", + "description": "ClientIPConfig represents the configurations of Client IP based session affinity." + }, + "ClusterTrustBundleProjection": { + "properties": { + "name": { + "type": "string", + "description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector.\n+optional" + }, + "signerName": { + "type": "string", + "description": "Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated.\n+optional" + }, + "labelSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\".\n+optional" + }, + "optional": { + "type": "boolean", + "description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles.\n+optional" + }, + "path": { + "type": "string", + "description": "Relative path from the volume root to write the bundle." + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem." + }, + "ConfigMapEnvSource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap must be defined\n+optional" + } + }, + "type": "object", + "description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with." + }, + "ConfigMapKeySelector": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "key": { + "type": "string", + "description": "The key to select." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap or its key must be defined\n+optional" + } + }, + "type": "object", + "required": [ + "key" + ], + "description": "Selects a key from a ConfigMap." + }, + "ConfigMapProjection": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "items": { + "items": { + "$ref": "#/$defs/KeyToPath" + }, + "type": "array", + "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a ConfigMap into a projected volume." + }, + "ConfigMapVolumeSource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "items": { + "items": { + "$ref": "#/$defs/KeyToPath" + }, + "type": "array", + "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a ConfigMap into a volume." + }, + "Container": { + "properties": { + "name": { + "type": "string", + "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + }, + "image": { + "type": "string", + "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional" + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "items": { + "$ref": "#/$defs/ContainerPort" + }, + "type": "array", + "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol" + }, + "envFrom": { + "items": { + "$ref": "#/$defs/EnvFromSource" + }, + "type": "array", + "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "items": { + "$ref": "#/$defs/EnvVar" + }, + "type": "array", + "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/$defs/ResourceRequirements", + "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "resizePolicy": { + "items": { + "$ref": "#/$defs/ContainerResizePolicy" + }, + "type": "array", + "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic" + }, + "restartPolicy": { + "type": "string", + "description": "RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted.\n+featureGate=SidecarContainers\n+optional" + }, + "volumeMounts": { + "items": { + "$ref": "#/$defs/VolumeMount" + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "items": { + "$ref": "#/$defs/VolumeDevice" + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/$defs/Probe", + "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "readinessProbe": { + "$ref": "#/$defs/Probe", + "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "startupProbe": { + "$ref": "#/$defs/Probe", + "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "lifecycle": { + "$ref": "#/$defs/Lifecycle", + "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.\n+optional" + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/$defs/SecurityContext", + "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/\n+optional" + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "A single application container that you want to run within a pod." + }, + "ContainerPort": { + "properties": { + "name": { + "type": "string", + "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional" + }, + "hostPort": { + "type": "integer", + "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 \u003c x \u003c 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional" + }, + "containerPort": { + "type": "integer", + "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 \u003c x \u003c 65536." + }, + "protocol": { + "type": "string", + "description": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".\n+optional\n+default=\"TCP\"" + }, + "hostIP": { + "type": "string", + "description": "What host IP to bind the external port to.\n+optional" + } + }, + "type": "object", + "required": [ + "containerPort" + ], + "description": "ContainerPort represents a network port in a single container." + }, + "ContainerResizePolicy": { + "properties": { + "resourceName": { + "type": "string", + "description": "Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + } + }, + "type": "object", + "required": [ + "resourceName", + "restartPolicy" + ], + "description": "ContainerResizePolicy represents resource resize policy for the container." + }, + "ControlPlane": { + "properties": { + "distro": { + "$ref": "#/$defs/Distributions" + }, + "backingStore": { + "$ref": "#/$defs/BackingStore" + }, + "hostPathMapper": { + "$ref": "#/$defs/HostPathMapper" + }, + "coredns": { + "$ref": "#/$defs/CoreDNS" + }, + "virtualScheduler": { + "$ref": "#/$defs/EnableSwitch" + }, + "proxy": { + "$ref": "#/$defs/ControlPlaneProxy" + }, + "service": { + "$ref": "#/$defs/ControlPlaneService" + }, + "ingress": { + "$ref": "#/$defs/ControlPlaneIngress" + }, + "highAvailability": { + "$ref": "#/$defs/ControlPlaneHighAvailability" + }, + "advanced": { + "$ref": "#/$defs/ControlPlaneAdvanced" + } + }, + "type": "object" + }, + "ControlPlaneAdvanced": { + "properties": { + "defaultImageRegistry": { + "type": "string" + }, + "headless": { + "type": "boolean" + }, + "persistence": { + "$ref": "#/$defs/ControlPlanePersistence" + }, + "scheduling": { + "$ref": "#/$defs/ControlPlaneScheduling" + }, + "serviceAccounts": { + "$ref": "#/$defs/ControlPlaneServiceAccounts" + }, + "workloadServiceAccount": { + "$ref": "#/$defs/ControlPlaneWorkloadServiceAccount" + }, + "probes": { + "$ref": "#/$defs/ControlPlaneProbes" + }, + "security": { + "$ref": "#/$defs/ControlPlaneSecurity" + }, + "metadata": { + "$ref": "#/$defs/ControlPlaneMetadata" + } + }, + "type": "object" + }, + "ControlPlaneContainerSecurityContext": { + "properties": { + "allowPrivilegeEscalation": { + "type": "boolean" + }, + "capabilities": { + "$ref": "#/$defs/Capabilities" + }, + "runAsUser": { + "type": "integer" + }, + "runAsGroup": { + "type": "integer" + } + }, + "type": "object" + }, + "ControlPlaneHighAvailability": { + "properties": { + "replicas": { + "type": "integer" + }, + "leaseDuration": { + "type": "integer" + }, + "renewDeadline": { + "type": "integer" + }, + "retryPeriod": { + "type": "integer" + } + }, + "type": "object" + }, + "ControlPlaneIngress": { + "properties": { + "enabled": { + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "name": { + "type": "string" + }, + "spec": { + "$ref": "#/$defs/IngressSpec" + } + }, + "type": "object" + }, + "ControlPlaneMetadata": { + "properties": { + "statefulSet": { + "$ref": "#/$defs/LabelsAndAnnotations" + }, + "pods": { + "$ref": "#/$defs/LabelsAndAnnotations" + }, + "allResources": { + "$ref": "#/$defs/LabelsAndAnnotations" + } + }, + "type": "object" + }, + "ControlPlanePersistence": { + "properties": { + "enabled": { + "type": "boolean" + }, + "retentionPolicy": { + "type": "string" + }, + "size": { + "$ref": "#/$defs/Quantity" + }, + "storageClass": { + "type": "string" + }, + "addVolumeMounts": { + "items": { + "$ref": "#/$defs/VolumeMount" + }, + "type": "array" + }, + "overwriteVolumeMounts": { + "items": { + "$ref": "#/$defs/VolumeMount" + }, + "type": "array" + } + }, + "type": "object" + }, + "ControlPlaneProbes": { + "properties": { + "livenessProbe": { + "$ref": "#/$defs/EnableSwitch" + }, + "readinessProbe": { + "$ref": "#/$defs/EnableSwitch" + } + }, + "type": "object" + }, + "ControlPlaneProxy": { + "properties": { + "bindAddress": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "tls": { + "$ref": "#/$defs/ControlPlaneProxyTLS" + } + }, + "type": "object" + }, + "ControlPlaneProxyTLS": { + "properties": { + "extraSANs": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ControlPlaneScheduling": { + "properties": { + "nodeSelector": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "affinity": { + "$ref": "#/$defs/Affinity" + }, + "tolerations": { + "items": { + "$ref": "#/$defs/Toleration" + }, + "type": "array" + }, + "priorityClassName": { + "type": "string" + } + }, + "type": "object" + }, + "ControlPlaneSecurity": { + "properties": { + "podSecurityContext": { + "$ref": "#/$defs/PodSecurityContext" + }, + "containerSecurityContext": { + "$ref": "#/$defs/ControlPlaneContainerSecurityContext" + } + }, + "type": "object" + }, + "ControlPlaneService": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "name": { + "type": "string" + }, + "spec": { + "$ref": "#/$defs/ServiceSpec" + } + }, + "type": "object" + }, + "ControlPlaneServiceAccounts": { + "properties": { + "create": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "imagePullSecrets": { + "items": { + "$ref": "#/$defs/LocalObjectReference" + }, + "type": "array" + } + }, + "type": "object" + }, + "ControlPlaneWorkloadServiceAccount": { + "properties": { + "create": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "CoreDNS": { + "properties": { + "enabled": { + "type": "boolean" + }, + "embedded": { + "type": "boolean" + }, + "service": { + "$ref": "#/$defs/CoreDNSService" + }, + "deployment": { + "$ref": "#/$defs/CoreDNSDeployment" + } + }, + "type": "object" + }, + "CoreDNSDeployment": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "spec": { + "$ref": "#/$defs/DeploymentSpec" + } + }, + "type": "object" + }, + "CoreDNSService": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "spec": { + "$ref": "#/$defs/ServiceSpec" + } + }, + "type": "object" + }, + "DeploymentSpec": { + "properties": { + "replicas": { + "type": "integer", + "description": "Number of desired pods. This is a pointer to distinguish between explicit\nzero and not specified. Defaults to 1.\n+optional" + }, + "selector": { + "$ref": "#/$defs/LabelSelector", + "description": "Label selector for pods. Existing ReplicaSets whose pods are\nselected by this will be the ones affected by this deployment.\nIt must match the pod template's labels." + }, + "template": { + "$ref": "#/$defs/PodTemplateSpec", + "description": "Template describes the pods that will be created.\nThe only allowed template.spec.restartPolicy value is \"Always\"." + }, + "strategy": { + "$ref": "#/$defs/DeploymentStrategy", + "description": "The deployment strategy to use to replace existing pods with new ones.\n+optional\n+patchStrategy=retainKeys" + }, + "minReadySeconds": { + "type": "integer", + "description": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing, for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n+optional" + }, + "revisionHistoryLimit": { + "type": "integer", + "description": "The number of old ReplicaSets to retain to allow rollback.\nThis is a pointer to distinguish between explicit zero and not specified.\nDefaults to 10.\n+optional" + }, + "paused": { + "type": "boolean", + "description": "Indicates that the deployment is paused.\n+optional" + }, + "progressDeadlineSeconds": { + "type": "integer", + "description": "The maximum time in seconds for a deployment to make progress before it\nis considered to be failed. The deployment controller will continue to\nprocess failed deployments and a condition with a ProgressDeadlineExceeded\nreason will be surfaced in the deployment status. Note that progress will\nnot be estimated during the time a deployment is paused. Defaults to 600s." + } + }, + "type": "object", + "required": [ + "selector", + "template" + ], + "description": "DeploymentSpec is the specification of the desired behavior of the Deployment." + }, + "DeploymentStrategy": { + "properties": { + "type": { + "type": "string", + "description": "Type of deployment. Can be \"Recreate\" or \"RollingUpdate\". Default is RollingUpdate.\n+optional" + }, + "rollingUpdate": { + "$ref": "#/$defs/RollingUpdateDeployment", + "description": "Rolling update config params. Present only if DeploymentStrategyType =\nRollingUpdate.\n---\nTODO: Update this to follow our convention for oneOf, whatever we decide it\nto be.\n+optional" + } + }, + "type": "object", + "description": "DeploymentStrategy describes how to replace existing pods with new ones." + }, + "DistributionAdvanced": { + "properties": { + "paths": { + "$ref": "#/$defs/DistributionPaths" + } + }, + "type": "object" + }, + "DistributionPaths": { + "properties": { + "kubeConfig": { + "type": "string" + }, + "serverCAKey": { + "type": "string" + }, + "serverCACert": { + "type": "string" + }, + "clientCACert": { + "type": "string" + }, + "requestHeaderCACert": { + "type": "string" + } + }, + "type": "object" + }, + "Distributions": { + "properties": { + "k3s": { + "$ref": "#/$defs/DistributionsK3s" + }, + "k8s": { + "$ref": "#/$defs/DistributionsK8s" + }, + "k0s": { + "$ref": "#/$defs/Container" + }, + "advanced": { + "$ref": "#/$defs/DistributionAdvanced" + } + }, + "type": "object" + }, + "DistributionsK3s": { + "properties": { + "name": { + "type": "string", + "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + }, + "image": { + "type": "string", + "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional" + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "items": { + "$ref": "#/$defs/ContainerPort" + }, + "type": "array", + "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol" + }, + "envFrom": { + "items": { + "$ref": "#/$defs/EnvFromSource" + }, + "type": "array", + "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "items": { + "$ref": "#/$defs/EnvVar" + }, + "type": "array", + "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/$defs/ResourceRequirements", + "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "resizePolicy": { + "items": { + "$ref": "#/$defs/ContainerResizePolicy" + }, + "type": "array", + "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic" + }, + "restartPolicy": { + "type": "string", + "description": "RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted.\n+featureGate=SidecarContainers\n+optional" + }, + "volumeMounts": { + "items": { + "$ref": "#/$defs/VolumeMount" + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "items": { + "$ref": "#/$defs/VolumeDevice" + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/$defs/Probe", + "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "readinessProbe": { + "$ref": "#/$defs/Probe", + "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "startupProbe": { + "$ref": "#/$defs/Probe", + "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "lifecycle": { + "$ref": "#/$defs/Lifecycle", + "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.\n+optional" + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/$defs/SecurityContext", + "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/\n+optional" + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + }, + "token": { + "type": "string" + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "DistributionsK8s": { + "properties": { + "apiServer": { + "$ref": "#/$defs/Container" + }, + "controllerManager": { + "$ref": "#/$defs/Container" + }, + "scheduler": { + "$ref": "#/$defs/Container" + }, + "etcd": { + "$ref": "#/$defs/Container" + } + }, + "type": "object" + }, + "DownwardAPIProjection": { + "properties": { + "items": { + "items": { + "$ref": "#/$defs/DownwardAPIVolumeFile" + }, + "type": "array", + "description": "Items is a list of DownwardAPIVolume file\n+optional" + } + }, + "type": "object", + "description": "Represents downward API info for projecting into a projected volume." + }, + "DownwardAPIVolumeFile": { + "properties": { + "path": { + "type": "string", + "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'" + }, + "fieldRef": { + "$ref": "#/$defs/ObjectFieldSelector", + "description": "Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.\n+optional" + }, + "resourceFieldRef": { + "$ref": "#/$defs/ResourceFieldSelector", + "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.\n+optional" + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field" + }, + "DownwardAPIVolumeSource": { + "properties": { + "items": { + "items": { + "$ref": "#/$defs/DownwardAPIVolumeFile" + }, + "type": "array", + "description": "Items is a list of downward API volume file\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "description": "DownwardAPIVolumeSource represents a volume containing downward API info." + }, + "EmbeddedEtcd": { + "properties": { + "enabled": { + "type": "boolean" + }, + "migrateFrom": { + "$ref": "#/$defs/EmbeddedEtcdMigrateFrom" + } + }, + "type": "object" + }, + "EmbeddedEtcdMigrateFrom": { + "properties": { + "sqlite": { + "type": "boolean" + }, + "etcd": { + "type": "boolean" + } + }, + "type": "object" + }, + "EmptyDirVolumeSource": { + "properties": { + "medium": { + "type": "string", + "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional" + }, + "sizeLimit": { + "$ref": "#/$defs/Quantity", + "description": "sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional" + } + }, + "type": "object", + "description": "Represents an empty directory for a pod." + }, + "EnableSwitch": { + "properties": { + "enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "EnvFromSource": { + "properties": { + "prefix": { + "type": "string", + "description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.\n+optional" + }, + "configMapRef": { + "$ref": "#/$defs/ConfigMapEnvSource", + "description": "The ConfigMap to select from\n+optional" + }, + "secretRef": { + "$ref": "#/$defs/SecretEnvSource", + "description": "The Secret to select from\n+optional" + } + }, + "type": "object", + "description": "EnvFromSource represents the source of a set of ConfigMaps" + }, + "EnvVar": { + "properties": { + "name": { + "type": "string", + "description": "Name of the environment variable. Must be a C_IDENTIFIER." + }, + "value": { + "type": "string", + "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional" + }, + "valueFrom": { + "$ref": "#/$defs/EnvVarSource", + "description": "Source for the environment variable's value. Cannot be used if value is not empty.\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "EnvVar represents an environment variable present in a Container." + }, + "EnvVarSource": { + "properties": { + "fieldRef": { + "$ref": "#/$defs/ObjectFieldSelector", + "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\n+optional" + }, + "resourceFieldRef": { + "$ref": "#/$defs/ResourceFieldSelector", + "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.\n+optional" + }, + "configMapKeyRef": { + "$ref": "#/$defs/ConfigMapKeySelector", + "description": "Selects a key of a ConfigMap.\n+optional" + }, + "secretKeyRef": { + "$ref": "#/$defs/SecretKeySelector", + "description": "Selects a key of a secret in the pod's namespace\n+optional" + } + }, + "type": "object", + "description": "EnvVarSource represents a source for the value of an EnvVar." + }, + "EphemeralContainer": { + "properties": { + "name": { + "type": "string", + "description": "Name of the ephemeral container specified as a DNS_LABEL.\nThis name must be unique among all containers, init containers and ephemeral containers." + }, + "image": { + "type": "string", + "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images" + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell.\nThe image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint.\nThe image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "items": { + "$ref": "#/$defs/ContainerPort" + }, + "type": "array", + "description": "Ports are not allowed for ephemeral containers.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol" + }, + "envFrom": { + "items": { + "$ref": "#/$defs/EnvFromSource" + }, + "type": "array", + "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "items": { + "$ref": "#/$defs/EnvVar" + }, + "type": "array", + "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/$defs/ResourceRequirements", + "description": "Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources\nalready allocated to the pod.\n+optional" + }, + "resizePolicy": { + "items": { + "$ref": "#/$defs/ContainerResizePolicy" + }, + "type": "array", + "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic" + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for the container to manage the restart behavior of each\ncontainer within a pod.\nThis may only be set for init containers. You cannot set this field on\nephemeral containers.\n+featureGate=SidecarContainers\n+optional" + }, + "volumeMounts": { + "items": { + "$ref": "#/$defs/VolumeMount" + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "items": { + "$ref": "#/$defs/VolumeDevice" + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/$defs/Probe", + "description": "Probes are not allowed for ephemeral containers.\n+optional" + }, + "readinessProbe": { + "$ref": "#/$defs/Probe", + "description": "Probes are not allowed for ephemeral containers.\n+optional" + }, + "startupProbe": { + "$ref": "#/$defs/Probe", + "description": "Probes are not allowed for ephemeral containers.\n+optional" + }, + "lifecycle": { + "$ref": "#/$defs/Lifecycle", + "description": "Lifecycle is not allowed for ephemeral containers.\n+optional" + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/$defs/SecurityContext", + "description": "Optional: SecurityContext defines the security options the ephemeral container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\n+optional" + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + }, + "targetContainerName": { + "type": "string", + "description": "If set, the name of the container from PodSpec that this ephemeral container targets.\nThe ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.\nIf not set then the ephemeral container uses the namespaces configured in the Pod spec.\n\nThe container runtime must implement support for this feature. If the runtime does not\nsupport namespace targeting then the result of setting this field is undefined.\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging." + }, + "EphemeralVolumeSource": { + "properties": { + "volumeClaimTemplate": { + "$ref": "#/$defs/PersistentVolumeClaimTemplate", + "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `\u003cpod name\u003e-\u003cvolume name\u003e` where\n`\u003cvolume name\u003e` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil." + } + }, + "type": "object", + "description": "Represents an ephemeral volume that is handled by a normal storage driver." + }, + "ExecAction": { + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional" + } + }, + "type": "object", + "description": "ExecAction describes a \"run in container\" action." + }, + "Experimental": { + "properties": { + "Extended": { + "type": "object" + }, + "syncSettings": { + "$ref": "#/$defs/ExperimentalSyncSettings" + }, + "syncPatches": { + "$ref": "#/$defs/SyncPatchesConfig" + }, + "genericSync": { + "$ref": "#/$defs/SyncPatchesConfig" + }, + "init": { + "$ref": "#/$defs/ExperimentalInit" + } + }, + "type": "object", + "required": [ + "Extended" + ] + }, + "ExperimentalInit": { + "properties": { + "manifests": { + "type": "string" + }, + "manifestsTemplate": { + "type": "string" + }, + "helm": { + "items": { + "$ref": "#/$defs/ExperimentalInitHelm" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExperimentalInitHelm": { + "properties": {}, + "type": "object" + }, + "ExperimentalSyncSettings": { + "properties": { + "disableSync": { + "type": "boolean" + }, + "target": { + "$ref": "#/$defs/ExperimentalSyncSettingsTarget" + } + }, + "type": "object" + }, + "ExperimentalSyncSettingsTarget": { + "properties": { + "namespace": { + "type": "string" + } + }, + "type": "object" + }, + "Export": { + "properties": { + "apiVersion": { + "type": "string", + "description": "APIVersion of the object to sync" + }, + "kind": { + "type": "string", + "description": "Kind of the object to sync" + }, + "optional": { + "type": "boolean" + }, + "replaceOnConflict": { + "type": "boolean", + "description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying" + }, + "patches": { + "items": { + "$ref": "#/$defs/Patch" + }, + "type": "array", + "description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster" + }, + "reversePatches": { + "items": { + "$ref": "#/$defs/Patch" + }, + "type": "array", + "description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster" + }, + "selector": { + "$ref": "#/$defs/Selector", + "description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced." + } + }, + "type": "object" + }, + "ExportKubeConfig": { + "properties": { + "context": { + "type": "string" + }, + "server": { + "type": "string" + }, + "secret": { + "$ref": "#/$defs/SecretReference" + } + }, + "type": "object", + "required": [ + "context", + "server" + ] + }, + "ExternalEtcd": { + "properties": { + "image": { + "type": "string" + }, + "replicas": { + "type": "integer" + }, + "metadata": { + "$ref": "#/$defs/ExternalEtcdMetadata" + } + }, + "type": "object" + }, + "ExternalEtcdMetadata": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "podLabels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "podAnnotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "FCVolumeSource": { + "properties": { + "targetWWNs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "targetWWNs is Optional: FC target worldwide names (WWNs)\n+optional" + }, + "lun": { + "type": "integer", + "description": "lun is Optional: FC target lun number\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "wwids": { + "items": { + "type": "string" + }, + "type": "array", + "description": "wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.\n+optional" + } + }, + "type": "object", + "description": "Represents a Fibre Channel volume." + }, + "FieldsV1": { + "properties": {}, + "type": "object", + "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format." + }, + "FlexVolumeSource": { + "properties": { + "driver": { + "type": "string", + "description": "driver is the name of the driver to use for this volume." + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional" + }, + "secretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts.\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "options": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "options is Optional: this field holds extra command options if any.\n+optional" + } + }, + "type": "object", + "required": [ + "driver" + ], + "description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin." + }, + "FlockerVolumeSource": { + "properties": { + "datasetName": { + "type": "string", + "description": "datasetName is Name of the dataset stored as metadata -\u003e name on the dataset for Flocker\nshould be considered as deprecated\n+optional" + }, + "datasetUUID": { + "type": "string", + "description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset\n+optional" + } + }, + "type": "object", + "description": "Represents a Flocker volume mounted by the Flocker agent." + }, + "GCEPersistentDiskVolumeSource": { + "properties": { + "pdName": { + "type": "string", + "description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + }, + "fsType": { + "type": "string", + "description": "fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "partition": { + "type": "integer", + "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + } + }, + "type": "object", + "required": [ + "pdName" + ], + "description": "Represents a Persistent Disk resource in Google Compute Engine." + }, + "GRPCAction": { + "properties": { + "port": { + "type": "integer", + "description": "Port number of the gRPC service. Number must be in the range 1 to 65535." + }, + "service": { + "type": "string", + "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.\n+optional\n+default=\"\"" + } + }, + "type": "object", + "required": [ + "port", + "service" + ] + }, + "GitRepoVolumeSource": { + "properties": { + "repository": { + "type": "string", + "description": "repository is the URL" + }, + "revision": { + "type": "string", + "description": "revision is the commit hash for the specified revision.\n+optional" + }, + "directory": { + "type": "string", + "description": "directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.\n+optional" + } + }, + "type": "object", + "required": [ + "repository" + ], + "description": "Represents a volume that is populated with the contents of a git repository." + }, + "GlusterfsVolumeSource": { + "properties": { + "endpoints": { + "type": "string", + "description": "endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + }, + "path": { + "type": "string", + "description": "path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional" + } + }, + "type": "object", + "required": [ + "endpoints", + "path" + ], + "description": "Represents a Glusterfs mount that lasts the lifetime of a pod." + }, + "HTTPGetAction": { + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server.\n+optional" + }, + "port": { + "$ref": "#/$defs/IntOrString", + "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional" + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional" + }, + "httpHeaders": { + "items": { + "$ref": "#/$defs/HTTPHeader" + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional" + } + }, + "type": "object", + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests." + }, + "HTTPHeader": { + "properties": { + "name": { + "type": "string", + "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + }, + "value": { + "type": "string", + "description": "The header field value" + } + }, + "type": "object", + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes" + }, + "HTTPIngressPath": { + "properties": { + "path": { + "type": "string", + "description": "path is matched against the path of an incoming request. Currently it can\ncontain characters disallowed from the conventional \"path\" part of a URL\nas defined by RFC 3986. Paths must begin with a '/' and must be present\nwhen using PathType with value \"Exact\" or \"Prefix\".\n+optional" + }, + "pathType": { + "type": "string", + "description": "pathType determines the interpretation of the path matching. PathType can\nbe one of the following values:\n* Exact: Matches the URL path exactly.\n* Prefix: Matches based on a URL path prefix split by '/'. Matching is\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types." + }, + "backend": { + "$ref": "#/$defs/IngressBackend", + "description": "backend defines the referenced service endpoint to which the traffic\nwill be forwarded to." + } + }, + "type": "object", + "required": [ + "pathType", + "backend" + ], + "description": "HTTPIngressPath associates a path with a backend." + }, + "HTTPIngressRuleValue": { + "properties": { + "paths": { + "items": { + "$ref": "#/$defs/HTTPIngressPath" + }, + "type": "array", + "description": "paths is a collection of paths that map requests to backends.\n+listType=atomic" + } + }, + "type": "object", + "required": [ + "paths" + ], + "description": "HTTPIngressRuleValue is a list of http selectors pointing to backends." + }, + "Hook": { + "properties": { + "apiVersion": { + "type": "string", + "description": "APIVersion of the object to sync" + }, + "kind": { + "type": "string", + "description": "Kind of the object to sync" + }, + "verbs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Verbs are the verbs that the hook should mutate" + }, + "patches": { + "items": { + "$ref": "#/$defs/Patch" + }, + "type": "array", + "description": "Patches are the patches to apply on the object to be synced" + } + }, + "type": "object" + }, + "Hooks": { + "properties": { + "hostToVirtual": { + "items": { + "$ref": "#/$defs/Hook" + }, + "type": "array", + "description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster" + }, + "virtualToHost": { + "items": { + "$ref": "#/$defs/Hook" + }, + "type": "array", + "description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster" + } + }, + "type": "object" + }, + "HostAlias": { + "properties": { + "ip": { + "type": "string", + "description": "IP address of the host file entry." + }, + "hostnames": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Hostnames for the above IP address." + } + }, + "type": "object", + "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file." + }, + "HostPathMapper": { + "properties": { + "enabled": { + "type": "boolean" + }, + "central": { + "type": "boolean" + } + }, + "type": "object" + }, + "HostPathVolumeSource": { + "properties": { + "path": { + "type": "string", + "description": "path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + }, + "type": { + "type": "string", + "description": "type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n+optional" + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "Represents a host path mapped into a pod." + }, + "ISCSIVolumeSource": { + "properties": { + "targetPortal": { + "type": "string", + "description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + }, + "iqn": { + "type": "string", + "description": "iqn is the target iSCSI Qualified Name." + }, + "lun": { + "type": "integer", + "description": "lun represents iSCSI Target Lun number." + }, + "iscsiInterface": { + "type": "string", + "description": "iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional" + }, + "portals": { + "items": { + "type": "string" + }, + "type": "array", + "description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).\n+optional" + }, + "chapAuthDiscovery": { + "type": "boolean", + "description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication\n+optional" + }, + "chapAuthSession": { + "type": "boolean", + "description": "chapAuthSession defines whether support iSCSI Session CHAP authentication\n+optional" + }, + "secretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "secretRef is the CHAP Secret for iSCSI target and initiator authentication\n+optional" + }, + "initiatorName": { + "type": "string", + "description": "initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n\u003ctarget portal\u003e:\u003cvolume name\u003e will be created for the connection.\n+optional" + } + }, + "type": "object", + "required": [ + "targetPortal", + "iqn", + "lun" + ], + "description": "Represents an ISCSI disk." + }, + "Import": { + "properties": { + "apiVersion": { + "type": "string", + "description": "APIVersion of the object to sync" + }, + "kind": { + "type": "string", + "description": "Kind of the object to sync" + }, + "optional": { + "type": "boolean" + }, + "replaceOnConflict": { + "type": "boolean", + "description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying" + }, + "patches": { + "items": { + "$ref": "#/$defs/Patch" + }, + "type": "array", + "description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster" + }, + "reversePatches": { + "items": { + "$ref": "#/$defs/Patch" + }, + "type": "array", + "description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster" + } + }, + "type": "object" + }, + "IngressBackend": { + "properties": { + "service": { + "$ref": "#/$defs/IngressServiceBackend", + "description": "service references a service as a backend.\nThis is a mutually exclusive setting with \"Resource\".\n+optional" + }, + "resource": { + "$ref": "#/$defs/TypedLocalObjectReference", + "description": "resource is an ObjectRef to another Kubernetes resource in the namespace\nof the Ingress object. If resource is specified, a service.Name and\nservice.Port must not be specified.\nThis is a mutually exclusive setting with \"Service\".\n+optional" + } + }, + "type": "object", + "description": "IngressBackend describes all endpoints for a given service and port." + }, + "IngressRule": { + "properties": { + "host": { + "type": "string", + "description": "host is the fully qualified domain name of a network host, as defined by RFC 3986.\nNote the following deviations from the \"host\" part of the\nURI as defined in RFC 3986:\n1. IPs are not allowed. Currently an IngressRuleValue can only apply to\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth these may change in the future.\nIncoming requests are matched against the host before the\nIngressRuleValue. If the host is unspecified, the Ingress routes all\ntraffic based on the specified IngressRuleValue.\n\nhost can be \"precise\" which is a domain name without the terminating dot of\na network host (e.g. \"foo.bar.com\") or \"wildcard\", which is a domain name\nprefixed with a single wildcard label (e.g. \"*.foo.com\").\nThe wildcard character '*' must appear by itself as the first DNS label and\nmatches only a single label. You cannot have a wildcard label by itself (e.g. Host == \"*\").\nRequests will be matched against the Host field in the following way:\n1. If host is precise, the request matches this rule if the http host header is equal to Host.\n2. If host is a wildcard, then the request matches this rule if the http host header\nis to equal to the suffix (removing the first label) of the wildcard rule.\n+optional" + }, + "http": { + "$ref": "#/$defs/HTTPIngressRuleValue", + "description": "+optional" + } + }, + "type": "object", + "description": "IngressRule represents the rules mapping the paths under a specified host to the related backend services." + }, + "IngressServiceBackend": { + "properties": { + "name": { + "type": "string", + "description": "name is the referenced service. The service must exist in\nthe same namespace as the Ingress object." + }, + "port": { + "$ref": "#/$defs/ServiceBackendPort", + "description": "port of the referenced service. A port name or port number\nis required for a IngressServiceBackend." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "IngressServiceBackend references a Kubernetes Service as a Backend." + }, + "IngressSpec": { + "properties": { + "ingressClassName": { + "type": "string", + "description": "ingressClassName is the name of an IngressClass cluster resource. Ingress\ncontroller implementations use this field to know whether they should be\nserving this Ingress resource, by a transitive connection\n(controller -\u003e IngressClass -\u003e Ingress resource). Although the\n`kubernetes.io/ingress.class` annotation (simple constant name) was never\nformally defined, it was widely supported by Ingress controllers to create\na direct binding between Ingress controller and Ingress resources. Newly\ncreated Ingress resources should prefer using the field. However, even\nthough the annotation is officially deprecated, for backwards compatibility\nreasons, ingress controllers should still honor that annotation if present.\n+optional" + }, + "defaultBackend": { + "$ref": "#/$defs/IngressBackend", + "description": "defaultBackend is the backend that should handle requests that don't\nmatch any rule. If Rules are not specified, DefaultBackend must be specified.\nIf DefaultBackend is not set, the handling of requests that do not match any\nof the rules will be up to the Ingress controller.\n+optional" + }, + "tls": { + "items": { + "$ref": "#/$defs/IngressTLS" + }, + "type": "array", + "description": "tls represents the TLS configuration. Currently the Ingress only supports a\nsingle TLS port, 443. If multiple members of this list specify different hosts,\nthey will be multiplexed on the same port according to the hostname specified\nthrough the SNI TLS extension, if the ingress controller fulfilling the\ningress supports SNI.\n+listType=atomic\n+optional" + }, + "rules": { + "items": { + "$ref": "#/$defs/IngressRule" + }, + "type": "array", + "description": "rules is a list of host rules used to configure the Ingress. If unspecified,\nor no rule matches, all traffic is sent to the default backend.\n+listType=atomic\n+optional" + } + }, + "type": "object", + "description": "IngressSpec describes the Ingress the user wishes to exist." + }, + "IngressTLS": { + "properties": { + "hosts": { + "items": { + "type": "string" + }, + "type": "array", + "description": "hosts is a list of hosts included in the TLS certificate. The values in\nthis list must match the name/s used in the tlsSecret. Defaults to the\nwildcard host setting for the loadbalancer controller fulfilling this\nIngress, if left unspecified.\n+listType=atomic\n+optional" + }, + "secretName": { + "type": "string", + "description": "secretName is the name of the secret used to terminate TLS traffic on\nport 443. Field is left optional to allow TLS routing based on SNI\nhostname alone. If the SNI host in a listener conflicts with the \"Host\"\nheader field used by an IngressRule, the SNI host is used for termination\nand value of the \"Host\" header is used for routing.\n+optional" + } + }, + "type": "object", + "description": "IngressTLS describes the transport layer security associated with an ingress." + }, + "IntOrString": { + "properties": { + "Type": { + "type": "integer" + }, + "IntVal": { + "type": "integer" + }, + "StrVal": { + "type": "string" + } + }, + "type": "object", + "required": [ + "Type", + "IntVal", + "StrVal" + ] + }, + "KeyToPath": { + "properties": { + "key": { + "type": "string", + "description": "key is the key to project." + }, + "path": { + "type": "string", + "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + }, + "mode": { + "type": "integer", + "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "required": [ + "key", + "path" + ], + "description": "Maps a string key to a path within a volume." + }, + "LabelSelector": { + "properties": { + "matchLabels": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional" + }, + "matchExpressions": { + "items": { + "$ref": "#/$defs/LabelSelectorRequirement" + }, + "type": "array", + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional" + } + }, + "type": "object", + "description": "A label selector is a label query over a set of resources." + }, + "LabelSelectorRequirement": { + "properties": { + "key": { + "type": "string", + "description": "key is the label key that the selector applies to." + }, + "operator": { + "type": "string", + "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.\n+optional" + } + }, + "type": "object", + "required": [ + "key", + "operator" + ], + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values." + }, + "LabelsAndAnnotations": { + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "License": { + "properties": { + "key": { + "type": "string" + }, + "keySecretRef": { + "$ref": "#/$defs/SecretReference" + } + }, + "type": "object" + }, + "Lifecycle": { + "properties": { + "postStart": { + "$ref": "#/$defs/LifecycleHandler", + "description": "PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional" + }, + "preStop": { + "$ref": "#/$defs/LifecycleHandler", + "description": "PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional" + } + }, + "type": "object", + "description": "Lifecycle describes actions that the management system should take in response to container lifecycle events." + }, + "LifecycleHandler": { + "properties": { + "exec": { + "$ref": "#/$defs/ExecAction", + "description": "Exec specifies the action to take.\n+optional" + }, + "httpGet": { + "$ref": "#/$defs/HTTPGetAction", + "description": "HTTPGet specifies the http request to perform.\n+optional" + }, + "tcpSocket": { + "$ref": "#/$defs/TCPSocketAction", + "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified.\n+optional" + }, + "sleep": { + "$ref": "#/$defs/SleepAction", + "description": "Sleep represents the duration that the container should sleep before being terminated.\n+featureGate=PodLifecycleSleepAction\n+optional" + } + }, + "type": "object", + "description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook." + }, + "LimitRange": { + "properties": { + "enabled": { + "type": "boolean" + }, + "default": { + "$ref": "#/$defs/LimitRangeLimits" + }, + "defaultRequest": { + "$ref": "#/$defs/LimitRangeLimits" + } + }, + "type": "object" + }, + "LimitRangeLimits": { + "properties": { + "ephemeral-storage": { + "$ref": "#/$defs/Quantity" + }, + "memory": { + "$ref": "#/$defs/Quantity" + }, + "cpu": { + "$ref": "#/$defs/Quantity" + } + }, + "type": "object" + }, + "LocalObjectReference": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + } + }, + "type": "object", + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace." + }, + "ManagedFieldsEntry": { + "properties": { + "manager": { + "type": "string", + "description": "Manager is an identifier of the workflow managing these fields." + }, + "operation": { + "type": "string", + "description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.\nThe only valid values for this field are 'Apply' and 'Update'." + }, + "apiVersion": { + "type": "string", + "description": "APIVersion defines the version of this resource that this field set\napplies to. The format is \"group/version\" just like the top-level\nAPIVersion field. It is necessary to track the version of a field\nset because it cannot be automatically converted." + }, + "time": { + "$ref": "#/$defs/Time", + "description": "Time is the timestamp of when the ManagedFields entry was added. The\ntimestamp will also be updated if a field is added, the manager\nchanges any of the owned fields value or removes a field. The\ntimestamp does not update when a field is removed from the entry\nbecause another manager took it over.\n+optional" + }, + "fieldsType": { + "type": "string", + "description": "FieldsType is the discriminator for the different fields format and version.\nThere is currently only one possible value: \"FieldsV1\"" + }, + "fieldsV1": { + "$ref": "#/$defs/FieldsV1", + "description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.\n+optional" + }, + "subresource": { + "type": "string", + "description": "Subresource is the name of the subresource used to update that object, or\nempty string if the object was updated through the main resource. The\nvalue of this field is used to distinguish between managers, even if they\nshare the same name. For example, a status update will be distinct from a\nregular update using the same manager name.\nNote that the APIVersion field is not related to the Subresource field and\nit always corresponds to the version of the main resource." + } + }, + "type": "object", + "description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to." + }, + "MatchCondition": { + "properties": { + "name": { + "type": "string", + "description": "Name is an identifier for this match condition, used for strategic merging of MatchConditions,\nas well as providing an identifier for logging purposes. A good name should be descriptive of\nthe associated expression.\nName must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and\nmust start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or\n'123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an\noptional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')\n\nRequired." + }, + "expression": { + "type": "string", + "description": "Expression represents the expression which will be evaluated by CEL. Must evaluate to bool.\nCEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:\n\n'object' - The object from the incoming request. The value is null for DELETE requests.\n'oldObject' - The existing object. The value is null for CREATE requests.\n'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest).\n'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.\n See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz\n'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the\n request resource.\nDocumentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/\n\nRequired." + } + }, + "type": "object", + "required": [ + "name", + "expression" + ], + "description": "MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook." + }, + "MutatingWebhook": { + "properties": { + "name": { + "type": "string", + "description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.\nRequired." + }, + "clientConfig": { + "$ref": "#/$defs/WebhookClientConfig", + "description": "ClientConfig defines how to communicate with the hook.\nRequired" + }, + "rules": { + "items": { + "$ref": "#/$defs/RuleWithOperations" + }, + "type": "array", + "description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.\nHowever, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks\nfrom putting the cluster in a state which cannot be recovered from without completely\ndisabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called\non admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects." + }, + "failurePolicy": { + "type": "string", + "description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.\n+optional" + }, + "matchPolicy": { + "type": "string", + "description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".\n\n- Exact: match a request only if it exactly matches a specified rule.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nbut \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.\n\n- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nand \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.\n\nDefaults to \"Equivalent\"\n+optional" + }, + "namespaceSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook.\n\nFor example, to run the webhook on any objects whose namespace is not\nassociated with \"runlevel\" of \"0\" or \"1\"; you will set the selector as\nfollows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"runlevel\",\n \"operator\": \"NotIn\",\n \"values\": [\n \"0\",\n \"1\"\n ]\n }\n ]\n}\n\nIf instead you want to only run the webhook on any objects whose\nnamespace is associated with the \"environment\" of \"prod\" or \"staging\";\nyou will set the selector as follows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"environment\",\n \"operator\": \"In\",\n \"values\": [\n \"prod\",\n \"staging\"\n ]\n }\n ]\n}\n\nSee\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/\nfor more examples of label selectors.\n\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "objectSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector. A null\nobject (oldObject in the case of create, or newObject in the case of\ndelete) or an object that cannot have labels (like a\nDeploymentRollback or a PodProxyOptions object) is not considered to\nmatch.\nUse the object selector only if the webhook is opt-in, because end\nusers may skip the admission webhook by setting the labels.\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "sideEffects": { + "type": "string", + "description": "SideEffects states whether this webhook has side effects.\nAcceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown).\nWebhooks with side effects MUST implement a reconciliation system, since a request may be\nrejected by a future step in the admission chain and the side effects therefore need to be undone.\nRequests with the dryRun attribute will be auto-rejected if they match a webhook with\nsideEffects == Unknown or Some." + }, + "timeoutSeconds": { + "type": "integer", + "description": "TimeoutSeconds specifies the timeout for this webhook. After the timeout passes,\nthe webhook call will be ignored or the API call will fail based on the\nfailure policy.\nThe timeout value must be between 1 and 30 seconds.\nDefault to 10 seconds.\n+optional" + }, + "admissionReviewVersions": { + "items": { + "type": "string" + }, + "type": "array", + "description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects. API server will try to use first version in\nthe list which it supports. If none of the versions specified in this list\nsupported by API server, validation will fail for this object.\nIf a persisted webhook configuration specifies allowed versions and does not\ninclude any versions known to the API Server, calls to the webhook will fail\nand be subject to the failure policy." + }, + "reinvocationPolicy": { + "type": "string", + "description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".\n\nNever: the webhook will not be called more than once in a single admission evaluation.\n\nIfNeeded: the webhook will be called at least one additional time as part of the admission evaluation\nif the object being admitted is modified by other admission plugins after the initial webhook call.\nWebhooks that specify this option *must* be idempotent, able to process objects they previously admitted.\nNote:\n* the number of additional invocations is not guaranteed to be exactly one.\n* if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again.\n* webhooks that use this option may be reordered to minimize the number of additional invocations.\n* to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead.\n\nDefaults to \"Never\".\n+optional" + }, + "matchConditions": { + "items": { + "$ref": "#/$defs/MatchCondition" + }, + "type": "array", + "description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.\n\nThe exact matching logic is (in order):\n 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.\n 2. If ALL matchConditions evaluate to TRUE, the webhook is called.\n 3. If any matchCondition evaluates to an error (but none are FALSE):\n - If failurePolicy=Fail, reject the request\n - If failurePolicy=Ignore, the error is ignored and the webhook is skipped\n\nThis is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+featureGate=AdmissionWebhookMatchConditions\n+optional" + } + }, + "type": "object", + "required": [ + "name", + "clientConfig", + "sideEffects", + "admissionReviewVersions" + ], + "description": "MutatingWebhook describes an admission webhook and the resources and operations it applies to." + }, + "NFSVolumeSource": { + "properties": { + "server": { + "type": "string", + "description": "server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "path": { + "type": "string", + "description": "path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional" + } + }, + "type": "object", + "required": [ + "server", + "path" + ], + "description": "Represents an NFS mount that lasts the lifetime of a pod." + }, + "NetworkDNSFallback": { + "properties": { + "ip": { + "type": "string" + }, + "hostCluster": { + "type": "boolean" + } + }, + "type": "object" + }, + "NetworkPolicy": { + "properties": { + "enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "NetworkProxyKubelets": { + "properties": { + "byHostname": { + "type": "boolean" + }, + "byIP": { + "type": "boolean" + } + }, + "type": "object" + }, + "Networking": { + "properties": { + "replicateServices": { + "$ref": "#/$defs/ReplicateServices" + }, + "resolveServices": { + "$ref": "#/$defs/ResolveServices" + }, + "advanced": { + "$ref": "#/$defs/NetworkingAdvanced" + } + }, + "type": "object" + }, + "NetworkingAdvanced": { + "properties": { + "clusterDomain": { + "type": "string" + }, + "fallback": { + "items": { + "$ref": "#/$defs/NetworkDNSFallback" + }, + "type": "array" + }, + "proxyKubelets": { + "$ref": "#/$defs/NetworkProxyKubelets" + } + }, + "type": "object" + }, + "NodeAffinity": { + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "$ref": "#/$defs/NodeSelector", + "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/$defs/PreferredSchedulingTerm" + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "type": "object", + "description": "Node affinity is a group of node affinity scheduling rules." + }, + "NodeSelector": { + "properties": { + "nodeSelectorTerms": { + "items": { + "$ref": "#/$defs/NodeSelectorTerm" + }, + "type": "array", + "description": "Required. A list of node selector terms. The terms are ORed." + } + }, + "type": "object", + "required": [ + "nodeSelectorTerms" + ], + "description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms." + }, + "NodeSelectorRequirement": { + "properties": { + "key": { + "type": "string", + "description": "The label key that the selector applies to." + }, + "operator": { + "type": "string", + "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.\n+optional" + } + }, + "type": "object", + "required": [ + "key", + "operator" + ], + "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values." + }, + "NodeSelectorTerm": { + "properties": { + "matchExpressions": { + "items": { + "$ref": "#/$defs/NodeSelectorRequirement" + }, + "type": "array", + "description": "A list of node selector requirements by node's labels.\n+optional" + }, + "matchFields": { + "items": { + "$ref": "#/$defs/NodeSelectorRequirement" + }, + "type": "array", + "description": "A list of node selector requirements by node's fields.\n+optional" + } + }, + "type": "object", + "description": "A null or empty node selector term matches no objects." + }, + "ObjectFieldSelector": { + "properties": { + "apiVersion": { + "type": "string", + "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional" + }, + "fieldPath": { + "type": "string", + "description": "Path of the field to select in the specified API version." + } + }, + "type": "object", + "required": [ + "fieldPath" + ], + "description": "ObjectFieldSelector selects an APIVersioned field of an object." + }, + "ObjectMeta": { + "properties": { + "name": { + "type": "string", + "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional" + }, + "generateName": { + "type": "string", + "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional" + }, + "namespace": { + "type": "string", + "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional" + }, + "selfLink": { + "type": "string", + "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional" + }, + "uid": { + "type": "string", + "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids\n+optional" + }, + "resourceVersion": { + "type": "string", + "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional" + }, + "generation": { + "type": "integer", + "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional" + }, + "creationTimestamp": { + "$ref": "#/$defs/Time", + "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional" + }, + "deletionTimestamp": { + "$ref": "#/$defs/Time", + "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional" + }, + "deletionGracePeriodSeconds": { + "type": "integer", + "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional" + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional" + }, + "ownerReferences": { + "items": { + "$ref": "#/$defs/OwnerReference" + }, + "type": "array", + "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge" + }, + "finalizers": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge" + }, + "managedFields": { + "items": { + "$ref": "#/$defs/ManagedFieldsEntry" + }, + "type": "array", + "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional" + } + }, + "type": "object", + "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + }, + "Observability": { + "properties": { + "serviceMonitor": { + "$ref": "#/$defs/EnableSwitch" + }, + "metrics": { + "$ref": "#/$defs/ObservabilityMetrics" + } + }, + "type": "object" + }, + "ObservabilityMetrics": { + "properties": { + "proxy": { + "$ref": "#/$defs/ObservabilityMetricsProxy" + } + }, + "type": "object" + }, + "ObservabilityMetricsProxy": { + "properties": { + "nodes": { + "$ref": "#/$defs/EnableSwitch" + }, + "pods": { + "$ref": "#/$defs/EnableSwitch" + } + }, + "type": "object" + }, + "OwnerReference": { + "properties": { + "apiVersion": { + "type": "string", + "description": "API version of the referent." + }, + "kind": { + "type": "string", + "description": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + }, + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names" + }, + "uid": { + "type": "string", + "description": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids" + }, + "controller": { + "type": "boolean", + "description": "If true, this reference points to the managing controller.\n+optional" + }, + "blockOwnerDeletion": { + "type": "boolean", + "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nSee https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion\nfor how the garbage collector interacts with this field and enforces the foreground deletion.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional" + } + }, + "type": "object", + "required": [ + "apiVersion", + "kind", + "name", + "uid" + ], + "description": "OwnerReference contains enough information to let you identify an owning object." + }, + "Patch": { + "properties": { + "op": { + "type": "string", + "description": "Operation is the type of the patch" + }, + "fromPath": { + "type": "string", + "description": "FromPath is the path from the other object" + }, + "path": { + "type": "string", + "description": "Path is the path of the patch" + }, + "namePath": { + "type": "string", + "description": "NamePath is the path to the name of a child resource within Path" + }, + "namespacePath": { + "type": "string", + "description": "NamespacePath is path to the namespace of a child resource within Path" + }, + "value": { + "description": "Value is the new value to be set to the path" + }, + "regex": { + "type": "string", + "description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace" + }, + "conditions": { + "items": { + "$ref": "#/$defs/PatchCondition" + }, + "type": "array", + "description": "Conditions are conditions that must be true for\nthe patch to get executed" + }, + "ignore": { + "type": "boolean", + "description": "Ignore determines if the path should be ignored if handled as a reverse patch" + }, + "sync": { + "$ref": "#/$defs/PatchSync", + "description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced" + } + }, + "type": "object" + }, + "PatchCondition": { + "properties": { + "path": { + "type": "string", + "description": "Path is the path within the object to select" + }, + "subPath": { + "type": "string", + "description": "SubPath is the path below the selected object to select" + }, + "equal": { + "description": "Equal is the value the path should be equal to" + }, + "notEqual": { + "description": "NotEqual is the value the path should not be equal to" + }, + "empty": { + "type": "boolean", + "description": "Empty means that the path value should be empty or unset" + } + }, + "type": "object" + }, + "PatchSync": { + "properties": { + "secret": { + "type": "boolean" + }, + "configmap": { + "type": "boolean" + } + }, + "type": "object" + }, + "PersistentVolumeClaimSpec": { + "properties": { + "accessModes": { + "items": { + "type": "string" + }, + "type": "array", + "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1\n+optional" + }, + "selector": { + "$ref": "#/$defs/LabelSelector", + "description": "selector is a label query over volumes to consider for binding.\n+optional" + }, + "resources": { + "$ref": "#/$defs/VolumeResourceRequirements", + "description": "resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources\n+optional" + }, + "volumeName": { + "type": "string", + "description": "volumeName is the binding reference to the PersistentVolume backing this claim.\n+optional" + }, + "storageClassName": { + "type": "string", + "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1\n+optional" + }, + "volumeMode": { + "type": "string", + "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.\n+optional" + }, + "dataSource": { + "$ref": "#/$defs/TypedLocalObjectReference", + "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.\n+optional" + }, + "dataSourceRef": { + "$ref": "#/$defs/TypedObjectReference", + "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+optional" + }, + "volumeAttributesClassName": { + "type": "string", + "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\n+featureGate=VolumeAttributesClass\n+optional" + } + }, + "type": "object", + "description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes" + }, + "PersistentVolumeClaimTemplate": { + "properties": { + "metadata": { + "$ref": "#/$defs/ObjectMeta" + }, + "spec": { + "$ref": "#/$defs/PersistentVolumeClaimSpec", + "description": "The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + } + }, + "type": "object", + "required": [ + "spec" + ], + "description": "PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource." + }, + "PersistentVolumeClaimVolumeSource": { + "properties": { + "claimName": { + "type": "string", + "description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false.\n+optional" + } + }, + "type": "object", + "required": [ + "claimName" + ], + "description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace." + }, + "PhotonPersistentDiskVolumeSource": { + "properties": { + "pdID": { + "type": "string", + "description": "pdID is the ID that identifies Photon Controller persistent disk" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + }, + "type": "object", + "required": [ + "pdID" + ], + "description": "Represents a Photon Controller persistent disk resource." + }, + "Platform": { + "properties": { + "name": { + "type": "string" + }, + "owner": { + "type": "string" + }, + "project": { + "type": "string" + }, + "apiKey": { + "$ref": "#/$defs/License" + } + }, + "type": "object" + }, + "Plugin": { + "properties": { + "image": { + "type": "string" + }, + "config": { + "type": "object" + }, + "rbac": { + "$ref": "#/$defs/PluginsRBAC" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "Plugins": { + "properties": { + "image": { + "type": "string" + }, + "config": { + "type": "object" + }, + "rbac": { + "$ref": "#/$defs/PluginsRBAC" + } + }, + "type": "object" + }, + "PluginsRBAC": { + "properties": { + "role": { + "items": { + "$ref": "#/$defs/PolicyRule" + }, + "type": "array" + }, + "clusterRole": { + "items": { + "$ref": "#/$defs/PolicyRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "PodAffinity": { + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/$defs/PodAffinityTerm" + }, + "type": "array", + "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/$defs/WeightedPodAffinityTerm" + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "type": "object", + "description": "Pod affinity is a group of inter pod affinity scheduling rules." + }, + "PodAffinityTerm": { + "properties": { + "labelSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.\n+optional" + }, + "namespaces": { + "items": { + "type": "string" + }, + "type": "array", + "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".\n+optional" + }, + "topologyKey": { + "type": "string", + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + }, + "namespaceSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.\n+optional" + }, + "matchLabelKeys": { + "items": { + "type": "string" + }, + "type": "array", + "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nAlso, MatchLabelKeys cannot be set when LabelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\n+listType=atomic\n+optional" + }, + "mismatchLabelKeys": { + "items": { + "type": "string" + }, + "type": "array", + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both MismatchLabelKeys and LabelSelector.\nAlso, MismatchLabelKeys cannot be set when LabelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\n+listType=atomic\n+optional" + } + }, + "type": "object", + "required": [ + "topologyKey" + ], + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key \u003ctopologyKey\u003e matches that of any node on which a pod of the set of pods is running" + }, + "PodAntiAffinity": { + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/$defs/PodAffinityTerm" + }, + "type": "array", + "description": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "$ref": "#/$defs/WeightedPodAffinityTerm" + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "type": "object", + "description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules." + }, + "PodDNSConfig": { + "properties": { + "nameservers": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed.\n+optional" + }, + "searches": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed.\n+optional" + }, + "options": { + "items": { + "$ref": "#/$defs/PodDNSConfigOption" + }, + "type": "array", + "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy.\n+optional" + } + }, + "type": "object", + "description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy." + }, + "PodDNSConfigOption": { + "properties": { + "name": { + "type": "string", + "description": "Required." + }, + "value": { + "type": "string", + "description": "+optional" + } + }, + "type": "object", + "description": "PodDNSConfigOption defines DNS resolver options of a pod." + }, + "PodOS": { + "properties": { + "name": { + "type": "string", + "description": "Name is the name of the operating system. The currently supported values are linux and windows.\nAdditional value may be defined in future and can be one of:\nhttps://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration\nClients should expect to handle additional values and treat unrecognized values in this field as os: null" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "PodOS defines the OS parameters of a pod." + }, + "PodReadinessGate": { + "properties": { + "conditionType": { + "type": "string", + "description": "ConditionType refers to a condition in the pod's condition list with matching type." + } + }, + "type": "object", + "required": [ + "conditionType" + ], + "description": "PodReadinessGate contains the reference to a pod condition" + }, + "PodResourceClaim": { + "properties": { + "name": { + "type": "string", + "description": "Name uniquely identifies this resource claim inside the pod.\nThis must be a DNS_LABEL." + }, + "source": { + "$ref": "#/$defs/ClaimSource", + "description": "Source describes where to find the ResourceClaim." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "PodResourceClaim references exactly one ResourceClaim through a ClaimSource." + }, + "PodSchedulingGate": { + "properties": { + "name": { + "type": "string", + "description": "Name of the scheduling gate.\nEach scheduling gate must have a unique name field." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "PodSchedulingGate is associated to a Pod to guard its scheduling." + }, + "PodSecurityContext": { + "properties": { + "seLinuxOptions": { + "$ref": "#/$defs/SELinuxOptions", + "description": "The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "windowsOptions": { + "$ref": "#/$defs/WindowsSecurityContextOptions", + "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional" + }, + "runAsUser": { + "type": "integer", + "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsGroup": { + "type": "integer", + "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsNonRoot": { + "type": "boolean", + "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "supplementalGroups": { + "items": { + "type": "integer" + }, + "type": "array", + "description": "A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "fsGroup": { + "type": "integer", + "description": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "sysctls": { + "items": { + "$ref": "#/$defs/Sysctl" + }, + "type": "array", + "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "fsGroupChangePolicy": { + "type": "string", + "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "seccompProfile": { + "$ref": "#/$defs/SeccompProfile", + "description": "The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + } + }, + "type": "object", + "description": "PodSecurityContext holds pod-level security attributes and common container settings." + }, + "PodSpec": { + "properties": { + "volumes": { + "items": { + "$ref": "#/$defs/Volume" + }, + "type": "array", + "description": "List of volumes that can be mounted by containers belonging to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes\n+optional\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys" + }, + "initContainers": { + "items": { + "$ref": "#/$defs/Container" + }, + "type": "array", + "description": "List of initialization containers belonging to the pod.\nInit containers are executed in order prior to containers being started. If any\ninit container fails, the pod is considered to have failed and is handled according\nto its restartPolicy. The name for an init container or normal container must be\nunique among all containers.\nInit containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.\nThe resourceRequirements of an init container are taken into account during scheduling\nby finding the highest request/limit for each resource type, and then using the max of\nof that value or the sum of the normal containers. Limits are applied to init containers\nin a similar fashion.\nInit containers cannot currently be added or removed.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "containers": { + "items": { + "$ref": "#/$defs/Container" + }, + "type": "array", + "description": "List of containers belonging to the pod.\nContainers cannot currently be added or removed.\nThere must be at least one container in a Pod.\nCannot be updated.\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "ephemeralContainers": { + "items": { + "$ref": "#/$defs/EphemeralContainer" + }, + "type": "array", + "description": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing\npod to perform user-initiated actions such as debugging. This list cannot be specified when\ncreating a pod, and it cannot be modified by updating the pod spec. In order to add an\nephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the pod.\nOne of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted.\nDefault to Always.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy\n+optional" + }, + "terminationGracePeriodSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional" + }, + "activeDeadlineSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod may be active on the node relative to\nStartTime before the system will actively try to mark it failed and kill associated containers.\nValue must be a positive integer.\n+optional" + }, + "dnsPolicy": { + "type": "string", + "description": "Set DNS policy for the pod.\nDefaults to \"ClusterFirst\".\nValid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.\nDNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.\nTo have DNS options set along with hostNetwork, you have to specify DNS policy\nexplicitly to 'ClusterFirstWithHostNet'.\n+optional" + }, + "nodeSelector": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "NodeSelector is a selector which must be true for the pod to fit on a node.\nSelector which must match a node's labels for the pod to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n+optional\n+mapType=atomic" + }, + "serviceAccountName": { + "type": "string", + "description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional" + }, + "serviceAccount": { + "type": "string", + "description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.\nDeprecated: Use serviceAccountName instead.\n+k8s:conversion-gen=false\n+optional" + }, + "automountServiceAccountToken": { + "type": "boolean", + "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.\n+optional" + }, + "nodeName": { + "type": "string", + "description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty,\nthe scheduler simply schedules this pod onto that node, assuming that it fits resource\nrequirements.\n+optional" + }, + "hostNetwork": { + "type": "boolean", + "description": "Host networking requested for this pod. Use the host's network namespace.\nIf this option is set, the ports that will be used must be specified.\nDefault to false.\n+k8s:conversion-gen=false\n+optional" + }, + "hostPID": { + "type": "boolean", + "description": "Use the host's pid namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "hostIPC": { + "type": "boolean", + "description": "Use the host's ipc namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "shareProcessNamespace": { + "type": "boolean", + "description": "Share a single process namespace between all of the containers in a pod.\nWhen this is set containers will be able to view and signal processes from other containers\nin the same pod, and the first process in each container will not be assigned PID 1.\nHostPID and ShareProcessNamespace cannot both be set.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "securityContext": { + "$ref": "#/$defs/PodSecurityContext", + "description": "SecurityContext holds pod-level security attributes and common container settings.\nOptional: Defaults to empty. See type description for default values of each field.\n+optional" + }, + "imagePullSecrets": { + "items": { + "$ref": "#/$defs/LocalObjectReference" + }, + "type": "array", + "description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.\nIf specified, these secrets will be passed to individual puller implementations for them to use.\nMore info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "hostname": { + "type": "string", + "description": "Specifies the hostname of the Pod\nIf not specified, the pod's hostname will be set to a system-defined value.\n+optional" + }, + "subdomain": { + "type": "string", + "description": "If specified, the fully qualified Pod hostname will be \"\u003chostname\u003e.\u003csubdomain\u003e.\u003cpod namespace\u003e.svc.\u003ccluster domain\u003e\".\nIf not specified, the pod will not have a domainname at all.\n+optional" + }, + "affinity": { + "$ref": "#/$defs/Affinity", + "description": "If specified, the pod's scheduling constraints\n+optional" + }, + "schedulerName": { + "type": "string", + "description": "If specified, the pod will be dispatched by specified scheduler.\nIf not specified, the pod will be dispatched by default scheduler.\n+optional" + }, + "tolerations": { + "items": { + "$ref": "#/$defs/Toleration" + }, + "type": "array", + "description": "If specified, the pod's tolerations.\n+optional" + }, + "hostAliases": { + "items": { + "$ref": "#/$defs/HostAlias" + }, + "type": "array", + "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts\nfile if specified. This is only valid for non-hostNetwork pods.\n+optional\n+patchMergeKey=ip\n+patchStrategy=merge" + }, + "priorityClassName": { + "type": "string", + "description": "If specified, indicates the pod's priority. \"system-node-critical\" and\n\"system-cluster-critical\" are two special keywords which indicate the\nhighest priorities with the former being the highest priority. Any other\nname must be defined by creating a PriorityClass object with that name.\nIf not specified, the pod priority will be default or zero if there is no\ndefault.\n+optional" + }, + "priority": { + "type": "integer", + "description": "The priority value. Various system components use this field to find the\npriority of the pod. When Priority Admission Controller is enabled, it\nprevents users from setting this field. The admission controller populates\nthis field from PriorityClassName.\nThe higher the value, the higher the priority.\n+optional" + }, + "dnsConfig": { + "$ref": "#/$defs/PodDNSConfig", + "description": "Specifies the DNS parameters of a pod.\nParameters specified here will be merged to the generated DNS\nconfiguration based on DNSPolicy.\n+optional" + }, + "readinessGates": { + "items": { + "$ref": "#/$defs/PodReadinessGate" + }, + "type": "array", + "description": "If specified, all readiness gates will be evaluated for pod readiness.\nA pod is ready when all its containers are ready AND\nall conditions specified in the readiness gates have status equal to \"True\"\nMore info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates\n+optional" + }, + "runtimeClassName": { + "type": "string", + "description": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used\nto run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.\nIf unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an\nempty definition that uses the default runtime handler.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class\n+optional" + }, + "enableServiceLinks": { + "type": "boolean", + "description": "EnableServiceLinks indicates whether information about services should be injected into pod's\nenvironment variables, matching the syntax of Docker links.\nOptional: Defaults to true.\n+optional" + }, + "preemptionPolicy": { + "type": "string", + "description": "PreemptionPolicy is the Policy for preempting pods with lower priority.\nOne of Never, PreemptLowerPriority.\nDefaults to PreemptLowerPriority if unset.\n+optional" + }, + "overhead": { + "$ref": "#/$defs/ResourceList", + "description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.\nThis field will be autopopulated at admission time by the RuntimeClass admission controller. If\nthe RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.\nThe RuntimeClass admission controller will reject Pod create requests which have the overhead already\nset. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value\ndefined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md\n+optional" + }, + "topologySpreadConstraints": { + "items": { + "$ref": "#/$defs/TopologySpreadConstraint" + }, + "type": "array", + "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nAll topologySpreadConstraints are ANDed.\n+optional\n+patchMergeKey=topologyKey\n+patchStrategy=merge\n+listType=map\n+listMapKey=topologyKey\n+listMapKey=whenUnsatisfiable" + }, + "setHostnameAsFQDN": { + "type": "boolean", + "description": "If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).\nIn Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).\nIn Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\\\SYSTEM\\\\CurrentControlSet\\\\Services\\\\Tcpip\\\\Parameters to FQDN.\nIf a pod does not have FQDN, this has no effect.\nDefault to false.\n+optional" + }, + "os": { + "$ref": "#/$defs/PodOS", + "description": "Specifies the OS of the containers in the pod.\nSome pod and container fields are restricted if this is set.\n\nIf the OS field is set to linux, the following fields must be unset:\n-securityContext.windowsOptions\n\nIf the OS field is set to windows, following fields must be unset:\n- spec.hostPID\n- spec.hostIPC\n- spec.hostUsers\n- spec.securityContext.seLinuxOptions\n- spec.securityContext.seccompProfile\n- spec.securityContext.fsGroup\n- spec.securityContext.fsGroupChangePolicy\n- spec.securityContext.sysctls\n- spec.shareProcessNamespace\n- spec.securityContext.runAsUser\n- spec.securityContext.runAsGroup\n- spec.securityContext.supplementalGroups\n- spec.containers[*].securityContext.seLinuxOptions\n- spec.containers[*].securityContext.seccompProfile\n- spec.containers[*].securityContext.capabilities\n- spec.containers[*].securityContext.readOnlyRootFilesystem\n- spec.containers[*].securityContext.privileged\n- spec.containers[*].securityContext.allowPrivilegeEscalation\n- spec.containers[*].securityContext.procMount\n- spec.containers[*].securityContext.runAsUser\n- spec.containers[*].securityContext.runAsGroup\n+optional" + }, + "hostUsers": { + "type": "boolean", + "description": "Use the host's user namespace.\nOptional: Default to true.\nIf set to true or not present, the pod will be run in the host user namespace, useful\nfor when the pod needs a feature only available to the host user namespace, such as\nloading a kernel module with CAP_SYS_MODULE.\nWhen set to false, a new userns is created for the pod. Setting false is useful for\nmitigating container breakout vulnerabilities even allowing users to run their\ncontainers as root without actually having root privileges on the host.\nThis field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.\n+k8s:conversion-gen=false\n+optional" + }, + "schedulingGates": { + "items": { + "$ref": "#/$defs/PodSchedulingGate" + }, + "type": "array", + "description": "SchedulingGates is an opaque list of values that if specified will block scheduling the pod.\nIf schedulingGates is not empty, the pod will stay in the SchedulingGated state and the\nscheduler will not attempt to schedule the pod.\n\nSchedulingGates can only be set at pod creation time, and be removed only afterwards.\n\nThis is a beta feature enabled by the PodSchedulingReadiness feature gate.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+featureGate=PodSchedulingReadiness\n+optional" + }, + "resourceClaims": { + "items": { + "$ref": "#/$defs/PodResourceClaim" + }, + "type": "array", + "description": "ResourceClaims defines which ResourceClaims must be allocated\nand reserved before the Pod is allowed to start. The resources\nwill be made available to those containers which consume them\nby name.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable.\n\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional" + } + }, + "type": "object", + "required": [ + "containers" + ], + "description": "PodSpec is a description of a pod." + }, + "PodTemplateSpec": { + "properties": { + "metadata": { + "$ref": "#/$defs/ObjectMeta" + }, + "spec": { + "$ref": "#/$defs/PodSpec", + "description": "Specification of the desired behavior of the pod.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status\n+optional" + } + }, + "type": "object", + "description": "PodTemplateSpec describes the data a pod should have when created from a template" + }, + "Policies": { + "properties": { + "podSecurityStandard": { + "type": "string" + }, + "resourceQuota": { + "$ref": "#/$defs/ResourceQuota" + }, + "limitRange": { + "$ref": "#/$defs/LimitRange" + }, + "networkPolicy": { + "$ref": "#/$defs/NetworkPolicy" + }, + "admissionControl": { + "$ref": "#/$defs/AdmissionControl" + } + }, + "type": "object" + }, + "PolicyRule": { + "properties": { + "verbs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs." + }, + "apiGroups": { + "items": { + "type": "string" + }, + "type": "array", + "description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.\n+optional" + }, + "resources": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Resources is a list of resources this rule applies to. '*' represents all resources.\n+optional" + }, + "resourceNames": { + "items": { + "type": "string" + }, + "type": "array", + "description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.\n+optional" + }, + "nonResourceURLs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.\n+optional" + } + }, + "type": "object", + "required": [ + "verbs" + ], + "description": "PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to." + }, + "PortworxVolumeSource": { + "properties": { + "volumeID": { + "type": "string", + "description": "volumeID uniquely identifies a Portworx volume" + }, + "fsType": { + "type": "string", + "description": "fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "type": "object", + "required": [ + "volumeID" + ], + "description": "PortworxVolumeSource represents a Portworx volume resource." + }, + "PreferredSchedulingTerm": { + "properties": { + "weight": { + "type": "integer", + "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100." + }, + "preference": { + "$ref": "#/$defs/NodeSelectorTerm", + "description": "A node selector term, associated with the corresponding weight." + } + }, + "type": "object", + "required": [ + "weight", + "preference" + ], + "description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e." + }, + "Probe": { + "properties": { + "exec": { + "$ref": "#/$defs/ExecAction", + "description": "Exec specifies the action to take.\n+optional" + }, + "httpGet": { + "$ref": "#/$defs/HTTPGetAction", + "description": "HTTPGet specifies the http request to perform.\n+optional" + }, + "tcpSocket": { + "$ref": "#/$defs/TCPSocketAction", + "description": "TCPSocket specifies an action involving a TCP port.\n+optional" + }, + "grpc": { + "$ref": "#/$defs/GRPCAction", + "description": "GRPC specifies an action involving a GRPC port.\n+optional" + }, + "initialDelaySeconds": { + "type": "integer", + "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "timeoutSeconds": { + "type": "integer", + "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "periodSeconds": { + "type": "integer", + "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional" + }, + "successThreshold": { + "type": "integer", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional" + }, + "failureThreshold": { + "type": "integer", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional" + }, + "terminationGracePeriodSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\n+optional" + } + }, + "type": "object", + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic." + }, + "ProjectedVolumeSource": { + "properties": { + "sources": { + "items": { + "$ref": "#/$defs/VolumeProjection" + }, + "type": "array", + "description": "sources is the list of volume projections\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "type": "object", + "required": [ + "sources" + ], + "description": "Represents a projected volume source" + }, + "Quantity": { + "properties": { + "Format": { + "type": "string" + } + }, + "type": "object", + "required": [ + "Format" + ], + "description": "Quantity is a fixed-point representation of a number." + }, + "QuobyteVolumeSource": { + "properties": { + "registry": { + "type": "string", + "description": "registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes" + }, + "volume": { + "type": "string", + "description": "volume is a string that references an already created Quobyte volume by name." + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.\n+optional" + }, + "user": { + "type": "string", + "description": "user to map volume access to\nDefaults to serivceaccount user\n+optional" + }, + "group": { + "type": "string", + "description": "group to map volume access to\nDefault is no group\n+optional" + }, + "tenant": { + "type": "string", + "description": "tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin\n+optional" + } + }, + "type": "object", + "required": [ + "registry", + "volume" + ], + "description": "Represents a Quobyte mount that lasts the lifetime of a pod." + }, + "RBAC": { + "properties": { + "clusterRole": { + "$ref": "#/$defs/RBACClusterRole" + }, + "role": { + "$ref": "#/$defs/RBACRole" + } + }, + "type": "object" + }, + "RBACClusterRole": { + "properties": { + "create": { + "type": "boolean" + }, + "extraRules": true + }, + "type": "object" + }, + "RBACRole": { + "properties": { + "create": { + "type": "boolean" + }, + "extraRules": true, + "excludedApiResources": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RBDVolumeSource": { + "properties": { + "monitors": { + "items": { + "type": "string" + }, + "type": "array", + "description": "monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + }, + "image": { + "type": "string", + "description": "image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "pool": { + "type": "string", + "description": "pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "user": { + "type": "string", + "description": "user is the rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "keyring": { + "type": "string", + "description": "keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "secretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "secretRef is name of the authentication secret for RBDUser. If provided\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + } + }, + "type": "object", + "required": [ + "monitors", + "image" + ], + "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod." + }, + "ReplicateServices": { + "properties": { + "toHost": { + "$ref": "#/$defs/ServiceMapping" + }, + "fromHost": { + "$ref": "#/$defs/ServiceMapping" + } + }, + "type": "object" + }, + "ResolveServiceHostname": { + "properties": { + "hostname": { + "type": "string" + } + }, + "type": "object" + }, + "ResolveServiceService": { + "properties": { + "service": { + "type": "string" + } + }, + "type": "object" + }, + "ResolveServiceTarget": { + "properties": { + "vcluster": { + "$ref": "#/$defs/ResolveServiceService" + }, + "host": { + "$ref": "#/$defs/ResolveServiceService" + }, + "external": { + "$ref": "#/$defs/ResolveServiceHostname" + } + }, + "type": "object" + }, + "ResolveServices": { + "properties": { + "service": { + "type": "string" + }, + "target": { + "$ref": "#/$defs/ResolveServiceTarget" + } + }, + "type": "object" + }, + "ResourceClaim": { + "properties": { + "name": { + "type": "string", + "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "ResourceClaim references one entry in PodSpec.ResourceClaims." + }, + "ResourceFieldSelector": { + "properties": { + "containerName": { + "type": "string", + "description": "Container name: required for volumes, optional for env vars\n+optional" + }, + "resource": { + "type": "string", + "description": "Required: resource to select" + }, + "divisor": { + "$ref": "#/$defs/Quantity", + "description": "Specifies the output format of the exposed resources, defaults to \"1\"\n+optional" + } + }, + "type": "object", + "required": [ + "resource" + ], + "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic" + }, + "ResourceList": { + "additionalProperties": { + "$ref": "#/$defs/Quantity" + }, + "type": "object", + "description": "ResourceList is a set of (resource name, quantity) pairs." + }, + "ResourceQuota": { + "properties": { + "enabled": { + "type": "boolean" + }, + "quota": { + "$ref": "#/$defs/ResourceList" + }, + "scopeSelector": { + "$ref": "#/$defs/ScopeSelector" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResourceRequirements": { + "properties": { + "limits": { + "$ref": "#/$defs/ResourceList", + "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "requests": { + "$ref": "#/$defs/ResourceList", + "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "claims": { + "items": { + "$ref": "#/$defs/ResourceClaim" + }, + "type": "array", + "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.\n\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional" + } + }, + "type": "object", + "description": "ResourceRequirements describes the compute resource requirements." + }, + "RollingUpdateDeployment": { + "properties": { + "maxUnavailable": { + "$ref": "#/$defs/IntOrString", + "description": "The maximum number of pods that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding down.\nThis can not be 0 if MaxSurge is 0.\nDefaults to 25%.\nExample: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods\nimmediately when the rolling update starts. Once new pods are ready, old ReplicaSet\ncan be scaled down further, followed by scaling up the new ReplicaSet, ensuring\nthat the total number of pods available at all times during the update is at\nleast 70% of desired pods.\n+optional" + }, + "maxSurge": { + "$ref": "#/$defs/IntOrString", + "description": "The maximum number of pods that can be scheduled above the desired number of\npods.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nThis can not be 0 if MaxUnavailable is 0.\nAbsolute number is calculated from percentage by rounding up.\nDefaults to 25%.\nExample: when this is set to 30%, the new ReplicaSet can be scaled up immediately when\nthe rolling update starts, such that the total number of old and new pods do not exceed\n130% of desired pods. Once old pods have been killed,\nnew ReplicaSet can be scaled up further, ensuring that total number of pods running\nat any time during the update is at most 130% of desired pods.\n+optional" + } + }, + "type": "object", + "description": "Spec to control the desired behavior of rolling update." + }, + "RuleWithOperations": { + "properties": { + "operations": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or *\nfor all of those operations and any future admission operations that are added.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic" + }, + "apiGroups": { + "items": { + "type": "string" + }, + "type": "array", + "description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic" + }, + "apiVersions": { + "items": { + "type": "string" + }, + "type": "array", + "description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic" + }, + "resources": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic" + }, + "scope": { + "type": "string", + "description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional" + } + }, + "type": "object", + "description": "RuleWithOperations is a tuple of Operations and Resources." + }, + "SELinuxOptions": { + "properties": { + "user": { + "type": "string", + "description": "User is a SELinux user label that applies to the container.\n+optional" + }, + "role": { + "type": "string", + "description": "Role is a SELinux role label that applies to the container.\n+optional" + }, + "type": { + "type": "string", + "description": "Type is a SELinux type label that applies to the container.\n+optional" + }, + "level": { + "type": "string", + "description": "Level is SELinux level label that applies to the container.\n+optional" + } + }, + "type": "object", + "description": "SELinuxOptions are the labels to be applied to the container" + }, + "ScaleIOVolumeSource": { + "properties": { + "gateway": { + "type": "string", + "description": "gateway is the host address of the ScaleIO API Gateway." + }, + "system": { + "type": "string", + "description": "system is the name of the storage system as configured in ScaleIO." + }, + "secretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail." + }, + "sslEnabled": { + "type": "boolean", + "description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false\n+optional" + }, + "protectionDomain": { + "type": "string", + "description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.\n+optional" + }, + "storagePool": { + "type": "string", + "description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.\n+optional" + }, + "storageMode": { + "type": "string", + "description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional" + }, + "volumeName": { + "type": "string", + "description": "volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source." + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "type": "object", + "required": [ + "gateway", + "system", + "secretRef" + ], + "description": "ScaleIOVolumeSource represents a persistent ScaleIO volume" + }, + "ScopeSelector": { + "properties": { + "matchExpressions": { + "items": { + "$ref": "#/$defs/LabelSelectorRequirement" + }, + "type": "array" + } + }, + "type": "object" + }, + "SeccompProfile": { + "properties": { + "type": { + "type": "string", + "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.\n+unionDiscriminator" + }, + "localhostProfile": { + "type": "string", + "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.\n+optional" + } + }, + "type": "object", + "required": [ + "type" + ], + "description": "SeccompProfile defines a pod/container's seccomp profile settings." + }, + "SecretEnvSource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "optional": { + "type": "boolean", + "description": "Specify whether the Secret must be defined\n+optional" + } + }, + "type": "object", + "description": "SecretEnvSource selects a Secret to populate the environment variables with." + }, + "SecretKeySelector": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "key": { + "type": "string", + "description": "The key of the secret to select from. Must be a valid secret key." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the Secret or its key must be defined\n+optional" + } + }, + "type": "object", + "required": [ + "key" + ], + "description": "SecretKeySelector selects a key of a Secret." + }, + "SecretProjection": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + }, + "items": { + "items": { + "$ref": "#/$defs/KeyToPath" + }, + "type": "array", + "description": "items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional field specify whether the Secret or its key must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a secret into a projected volume." + }, + "SecretReference": { + "properties": { + "name": { + "type": "string", + "description": "name is unique within a namespace to reference a secret resource.\n+optional" + }, + "namespace": { + "type": "string", + "description": "namespace defines the space within which the secret name must be unique.\n+optional" + } + }, + "type": "object", + "description": "SecretReference represents a Secret Reference." + }, + "SecretVolumeSource": { + "properties": { + "secretName": { + "type": "string", + "description": "secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional" + }, + "items": { + "items": { + "$ref": "#/$defs/KeyToPath" + }, + "type": "array", + "description": "items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "defaultMode": { + "type": "integer", + "description": "defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + }, + "optional": { + "type": "boolean", + "description": "optional field specify whether the Secret or its keys must be defined\n+optional" + } + }, + "type": "object", + "description": "Adapts a Secret into a volume." + }, + "SecurityContext": { + "properties": { + "capabilities": { + "$ref": "#/$defs/Capabilities", + "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "privileged": { + "type": "boolean", + "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "seLinuxOptions": { + "$ref": "#/$defs/SELinuxOptions", + "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "windowsOptions": { + "$ref": "#/$defs/WindowsSecurityContextOptions", + "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional" + }, + "runAsUser": { + "type": "integer", + "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsGroup": { + "type": "integer", + "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "runAsNonRoot": { + "type": "boolean", + "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "readOnlyRootFilesystem": { + "type": "boolean", + "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "procMount": { + "type": "string", + "description": "procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + }, + "seccompProfile": { + "$ref": "#/$defs/SeccompProfile", + "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod \u0026 container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.\n+optional" + } + }, + "type": "object", + "description": "SecurityContext holds security configuration that will be applied to a container." + }, + "Selector": { + "properties": { + "labelSelector": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "LabelSelector are the labels to select the object from" + } + }, + "type": "object" + }, + "ServiceAccountTokenProjection": { + "properties": { + "audience": { + "type": "string", + "description": "audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.\n+optional" + }, + "expirationSeconds": { + "type": "integer", + "description": "expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.\n+optional" + }, + "path": { + "type": "string", + "description": "path is the path relative to the mount point of the file to project the\ntoken into." + } + }, + "type": "object", + "required": [ + "path" + ], + "description": "ServiceAccountTokenProjection represents a projected service account token volume." + }, + "ServiceBackendPort": { + "properties": { + "name": { + "type": "string", + "description": "name is the name of the port on the Service.\nThis is a mutually exclusive setting with \"Number\".\n+optional" + }, + "number": { + "type": "integer", + "description": "number is the numerical port number (e.g. 80) on the Service.\nThis is a mutually exclusive setting with \"Name\".\n+optional" + } + }, + "type": "object", + "description": "ServiceBackendPort is the service port being referenced." + }, + "ServiceMapping": { + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "type": "object" + }, + "ServicePort": { + "properties": { + "name": { + "type": "string", + "description": "The name of this port within the service. This must be a DNS_LABEL.\nAll ports within a ServiceSpec must have unique names. When considering\nthe endpoints for a Service, this must match the 'name' field in the\nEndpointPort.\nOptional if only one ServicePort is defined on this service.\n+optional" + }, + "protocol": { + "type": "string", + "description": "The IP protocol for this port. Supports \"TCP\", \"UDP\", and \"SCTP\".\nDefault is TCP.\n+default=\"TCP\"\n+optional" + }, + "appProtocol": { + "type": "string", + "description": "The application protocol for this port.\nThis is used as a hint for implementations to offer richer behavior for protocols that they understand.\nThis field follows standard Kubernetes label syntax.\nValid values are either:\n\n* Un-prefixed protocol names - reserved for IANA standard service names (as per\nRFC-6335 and https://www.iana.org/assignments/service-names).\n\n* Kubernetes-defined prefixed names:\n * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-\n * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455\n * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455\n\n* Other protocols should use implementation-defined prefixed names such as\nmycompany.com/my-custom-protocol.\n+optional" + }, + "port": { + "type": "integer", + "description": "The port that will be exposed by this service." + }, + "targetPort": { + "$ref": "#/$defs/IntOrString", + "description": "Number or name of the port to access on the pods targeted by the service.\nNumber must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.\nIf this is a string, it will be looked up as a named port in the\ntarget Pod's container ports. If this is not specified, the value\nof the 'port' field is used (an identity map).\nThis field is ignored for services with clusterIP=None, and should be\nomitted or set equal to the 'port' field.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service\n+optional" + }, + "nodePort": { + "type": "integer", + "description": "The port on each node on which this service is exposed when type is\nNodePort or LoadBalancer. Usually assigned by the system. If a value is\nspecified, in-range, and not in use it will be used, otherwise the\noperation will fail. If not specified, a port will be allocated if this\nService requires one. If this field is specified when creating a\nService which does not need it, creation will fail. This field will be\nwiped when updating a Service to no longer need it (e.g. changing type\nfrom NodePort to ClusterIP).\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport\n+optional" + } + }, + "type": "object", + "required": [ + "port" + ], + "description": "ServicePort contains information on service's port." + }, + "ServiceReference": { + "properties": { + "namespace": { + "type": "string", + "description": "`namespace` is the namespace of the service.\nRequired" + }, + "name": { + "type": "string", + "description": "`name` is the name of the service.\nRequired" + }, + "path": { + "type": "string", + "description": "`path` is an optional URL path which will be sent in any request to\nthis service.\n+optional" + }, + "port": { + "type": "integer", + "description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).\n+optional" + } + }, + "type": "object", + "required": [ + "namespace", + "name" + ], + "description": "ServiceReference holds a reference to Service.legacy.k8s.io" + }, + "ServiceSpec": { + "properties": { + "ports": { + "items": { + "$ref": "#/$defs/ServicePort" + }, + "type": "array", + "description": "The list of ports that are exposed by this service.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+patchMergeKey=port\n+patchStrategy=merge\n+listType=map\n+listMapKey=port\n+listMapKey=protocol" + }, + "selector": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Route service traffic to pods with label keys and values matching this\nselector. If empty or not present, the service is assumed to have an\nexternal process managing its endpoints, which Kubernetes will not\nmodify. Only applies to types ClusterIP, NodePort, and LoadBalancer.\nIgnored if type is ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/\n+optional\n+mapType=atomic" + }, + "clusterIP": { + "type": "string", + "description": "clusterIP is the IP address of the service and is usually assigned\nrandomly. If an address is specified manually, is in-range (as per\nsystem configuration), and is not in use, it will be allocated to the\nservice; otherwise creation of the service will fail. This field may not\nbe changed through updates unless the type field is also being changed\nto ExternalName (which requires this field to be blank) or the type\nfield is being changed from ExternalName (in which case this field may\noptionally be specified, as describe above). Valid values are \"None\",\nempty string (\"\"), or a valid IP address. Setting this to \"None\" makes a\n\"headless service\" (no virtual IP), which is useful when direct endpoint\nconnections are preferred and proxying is not required. Only applies to\ntypes ClusterIP, NodePort, and LoadBalancer. If this field is specified\nwhen creating a Service of type ExternalName, creation will fail. This\nfield will be wiped when updating a Service to type ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional" + }, + "clusterIPs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "ClusterIPs is a list of IP addresses assigned to this service, and are\nusually assigned randomly. If an address is specified manually, is\nin-range (as per system configuration), and is not in use, it will be\nallocated to the service; otherwise creation of the service will fail.\nThis field may not be changed through updates unless the type field is\nalso being changed to ExternalName (which requires this field to be\nempty) or the type field is being changed from ExternalName (in which\ncase this field may optionally be specified, as describe above). Valid\nvalues are \"None\", empty string (\"\"), or a valid IP address. Setting\nthis to \"None\" makes a \"headless service\" (no virtual IP), which is\nuseful when direct endpoint connections are preferred and proxying is\nnot required. Only applies to types ClusterIP, NodePort, and\nLoadBalancer. If this field is specified when creating a Service of type\nExternalName, creation will fail. This field will be wiped when updating\na Service to type ExternalName. If this field is not specified, it will\nbe initialized from the clusterIP field. If this field is specified,\nclients must ensure that clusterIPs[0] and clusterIP have the same\nvalue.\n\nThis field may hold a maximum of two entries (dual-stack IPs, in either order).\nThese IPs must correspond to the values of the ipFamilies field. Both\nclusterIPs and ipFamilies are governed by the ipFamilyPolicy field.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+listType=atomic\n+optional" + }, + "type": { + "type": "string", + "description": "type determines how the Service is exposed. Defaults to ClusterIP. Valid\noptions are ExternalName, ClusterIP, NodePort, and LoadBalancer.\n\"ClusterIP\" allocates a cluster-internal IP address for load-balancing\nto endpoints. Endpoints are determined by the selector or if that is not\nspecified, by manual construction of an Endpoints object or\nEndpointSlice objects. If clusterIP is \"None\", no virtual IP is\nallocated and the endpoints are published as a set of endpoints rather\nthan a virtual IP.\n\"NodePort\" builds on ClusterIP and allocates a port on every node which\nroutes to the same endpoints as the clusterIP.\n\"LoadBalancer\" builds on NodePort and creates an external load-balancer\n(if supported in the current cloud) which routes to the same endpoints\nas the clusterIP.\n\"ExternalName\" aliases this service to the specified externalName.\nSeveral other fields do not apply to ExternalName services.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types\n+optional" + }, + "externalIPs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "externalIPs is a list of IP addresses for which nodes in the cluster\nwill also accept traffic for this service. These IPs are not managed by\nKubernetes. The user is responsible for ensuring that traffic arrives\nat a node with this IP. A common example is external load-balancers\nthat are not part of the Kubernetes system.\n+optional" + }, + "sessionAffinity": { + "type": "string", + "description": "Supports \"ClientIP\" and \"None\". Used to maintain session affinity.\nEnable client IP based session affinity.\nMust be ClientIP or None.\nDefaults to None.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional" + }, + "loadBalancerIP": { + "type": "string", + "description": "Only applies to Service Type: LoadBalancer.\nThis feature depends on whether the underlying cloud-provider supports specifying\nthe loadBalancerIP when a load balancer is created.\nThis field will be ignored if the cloud-provider does not support the feature.\nDeprecated: This field was under-specified and its meaning varies across implementations.\nUsing it is non-portable and it may not support dual-stack.\nUsers are encouraged to use implementation-specific annotations when available.\n+optional" + }, + "loadBalancerSourceRanges": { + "items": { + "type": "string" + }, + "type": "array", + "description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider\nload-balancer will be restricted to the specified client IPs. This field will be ignored if the\ncloud-provider does not support the feature.\"\nMore info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/\n+optional" + }, + "externalName": { + "type": "string", + "description": "externalName is the external reference that discovery mechanisms will\nreturn as an alias for this service (e.g. a DNS CNAME record). No\nproxying will be involved. Must be a lowercase RFC-1123 hostname\n(https://tools.ietf.org/html/rfc1123) and requires `type` to be \"ExternalName\".\n+optional" + }, + "externalTrafficPolicy": { + "type": "string", + "description": "externalTrafficPolicy describes how nodes distribute service traffic they\nreceive on one of the Service's \"externally-facing\" addresses (NodePorts,\nExternalIPs, and LoadBalancer IPs). If set to \"Local\", the proxy will configure\nthe service in a way that assumes that external load balancers will take care\nof balancing the service traffic between nodes, and so each node will deliver\ntraffic only to the node-local endpoints of the service, without masquerading\nthe client source IP. (Traffic mistakenly sent to a node with no endpoints will\nbe dropped.) The default value, \"Cluster\", uses the standard behavior of\nrouting to all endpoints evenly (possibly modified by topology and other\nfeatures). Note that traffic sent to an External IP or LoadBalancer IP from\nwithin the cluster will always get \"Cluster\" semantics, but clients sending to\na NodePort from within the cluster may need to take traffic policy into account\nwhen picking a node.\n+optional" + }, + "healthCheckNodePort": { + "type": "integer", + "description": "healthCheckNodePort specifies the healthcheck nodePort for the service.\nThis only applies when type is set to LoadBalancer and\nexternalTrafficPolicy is set to Local. If a value is specified, is\nin-range, and is not in use, it will be used. If not specified, a value\nwill be automatically allocated. External systems (e.g. load-balancers)\ncan use this port to determine if a given node holds endpoints for this\nservice or not. If this field is specified when creating a Service\nwhich does not need it, creation will fail. This field will be wiped\nwhen updating a Service to no longer need it (e.g. changing type).\nThis field cannot be updated once set.\n+optional" + }, + "publishNotReadyAddresses": { + "type": "boolean", + "description": "publishNotReadyAddresses indicates that any agent which deals with endpoints for this\nService should disregard any indications of ready/not-ready.\nThe primary use case for setting this field is for a StatefulSet's Headless Service to\npropagate SRV DNS records for its Pods for the purpose of peer discovery.\nThe Kubernetes controllers that generate Endpoints and EndpointSlice resources for\nServices interpret this to mean that all endpoints are considered \"ready\" even if the\nPods themselves are not. Agents which consume only Kubernetes generated endpoints\nthrough the Endpoints or EndpointSlice resources can safely assume this behavior.\n+optional" + }, + "sessionAffinityConfig": { + "$ref": "#/$defs/SessionAffinityConfig", + "description": "sessionAffinityConfig contains the configurations of session affinity.\n+optional" + }, + "ipFamilies": { + "items": { + "type": "string" + }, + "type": "array", + "description": "IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this\nservice. This field is usually assigned automatically based on cluster\nconfiguration and the ipFamilyPolicy field. If this field is specified\nmanually, the requested family is available in the cluster,\nand ipFamilyPolicy allows it, it will be used; otherwise creation of\nthe service will fail. This field is conditionally mutable: it allows\nfor adding or removing a secondary IP family, but it does not allow\nchanging the primary IP family of the Service. Valid values are \"IPv4\"\nand \"IPv6\". This field only applies to Services of types ClusterIP,\nNodePort, and LoadBalancer, and does apply to \"headless\" services.\nThis field will be wiped when updating a Service to type ExternalName.\n\nThis field may hold a maximum of two entries (dual-stack families, in\neither order). These families must correspond to the values of the\nclusterIPs field, if specified. Both clusterIPs and ipFamilies are\ngoverned by the ipFamilyPolicy field.\n+listType=atomic\n+optional" + }, + "ipFamilyPolicy": { + "type": "string", + "description": "IPFamilyPolicy represents the dual-stack-ness requested or required by\nthis Service. If there is no value provided, then this field will be set\nto SingleStack. Services can be \"SingleStack\" (a single IP family),\n\"PreferDualStack\" (two IP families on dual-stack configured clusters or\na single IP family on single-stack clusters), or \"RequireDualStack\"\n(two IP families on dual-stack configured clusters, otherwise fail). The\nipFamilies and clusterIPs fields depend on the value of this field. This\nfield will be wiped when updating a service to type ExternalName.\n+optional" + }, + "allocateLoadBalancerNodePorts": { + "type": "boolean", + "description": "allocateLoadBalancerNodePorts defines if NodePorts will be automatically\nallocated for services with type LoadBalancer. Default is \"true\". It\nmay be set to \"false\" if the cluster load-balancer does not rely on\nNodePorts. If the caller requests specific NodePorts (by specifying a\nvalue), those requests will be respected, regardless of this field.\nThis field may only be set for services with type LoadBalancer and will\nbe cleared if the type is changed to any other type.\n+optional" + }, + "loadBalancerClass": { + "type": "string", + "description": "loadBalancerClass is the class of the load balancer implementation this Service belongs to.\nIf specified, the value of this field must be a label-style identifier, with an optional prefix,\ne.g. \"internal-vip\" or \"example.com/internal-vip\". Unprefixed names are reserved for end-users.\nThis field can only be set when the Service type is 'LoadBalancer'. If not set, the default load\nbalancer implementation is used, today this is typically done through the cloud provider integration,\nbut should apply for any default implementation. If set, it is assumed that a load balancer\nimplementation is watching for Services with a matching class. Any default load balancer\nimplementation (e.g. cloud providers) should ignore Services that set this field.\nThis field can only be set when creating or updating a Service to type 'LoadBalancer'.\nOnce set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.\n+optional" + }, + "internalTrafficPolicy": { + "type": "string", + "description": "InternalTrafficPolicy describes how nodes distribute service traffic they\nreceive on the ClusterIP. If set to \"Local\", the proxy will assume that pods\nonly want to talk to endpoints of the service on the same node as the pod,\ndropping the traffic if there are no local endpoints. The default value,\n\"Cluster\", uses the standard behavior of routing to all endpoints evenly\n(possibly modified by topology and other features).\n+optional" + } + }, + "type": "object", + "description": "ServiceSpec describes the attributes that a user creates on a service." + }, + "SessionAffinityConfig": { + "properties": { + "clientIP": { + "$ref": "#/$defs/ClientIPConfig", + "description": "clientIP contains the configurations of Client IP based session affinity.\n+optional" + } + }, + "type": "object", + "description": "SessionAffinityConfig represents the configurations of session affinity." + }, + "Sleep": { + "properties": { + "after": { + "type": "integer" + }, + "schedule": { + "type": "string", + "description": "TODO validate crontab" + }, + "timezone": { + "type": "string", + "description": "TODO set default" + }, + "ignore": { + "$ref": "#/$defs/SleepIgnore" + }, + "autoDelete": { + "$ref": "#/$defs/SleepAutoDelete" + } + }, + "type": "object" + }, + "SleepAction": { + "properties": { + "seconds": { + "type": "integer", + "description": "Seconds is the number of seconds to sleep." + } + }, + "type": "object", + "required": [ + "seconds" + ], + "description": "SleepAction describes a \"sleep\" action." + }, + "SleepAutoDelete": { + "properties": { + "after": { + "type": "integer" + } + }, + "type": "object" + }, + "SleepIgnore": { + "properties": { + "connections": { + "$ref": "#/$defs/SleepIgnoreConnections" + }, + "resourcesWith": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "SleepIgnoreConnections": { + "properties": { + "after": { + "type": "integer" + } + }, + "type": "object" + }, + "StorageOSVolumeSource": { + "properties": { + "volumeName": { + "type": "string", + "description": "volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace." + }, + "volumeNamespace": { + "type": "string", + "description": "volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional" + }, + "fsType": { + "type": "string", + "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "readOnly": { + "type": "boolean", + "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "secretRef": { + "$ref": "#/$defs/LocalObjectReference", + "description": "secretRef specifies the secret to use for obtaining the StorageOS API\ncredentials. If not specified, default values will be attempted.\n+optional" + } + }, + "type": "object", + "description": "Represents a StorageOS persistent volume resource." + }, + "SyncAllResource": { + "properties": { + "enabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "SyncConfig": { + "properties": { + "ToHost": { + "$ref": "#/$defs/SyncToHost" + }, + "FromHost": { + "$ref": "#/$defs/SyncFromHost" + } + }, + "type": "object", + "required": [ + "ToHost", + "FromHost" + ] + }, + "SyncFromHost": { + "properties": { + "csiDrivers": { + "$ref": "#/$defs/EnableSwitch" + }, + "csiNodes": { + "$ref": "#/$defs/EnableSwitch" + }, + "csiStorageCapacities": { + "$ref": "#/$defs/EnableSwitch" + }, + "ingressClasses": { + "$ref": "#/$defs/EnableSwitch" + }, + "events": { + "$ref": "#/$defs/EnableSwitch" + }, + "storageClasses": { + "$ref": "#/$defs/EnableSwitch" + } + }, + "type": "object" + }, + "SyncPatchesConfig": { + "properties": { + "version": { + "type": "string", + "description": "Version is the config version" + }, + "export": { + "items": { + "$ref": "#/$defs/Export" + }, + "type": "array", + "description": "Exports syncs a resource from the virtual cluster to the host" + }, + "import": { + "items": { + "$ref": "#/$defs/Import" + }, + "type": "array", + "description": "Imports syncs a resource from the host cluster to virtual cluster" + }, + "hooks": { + "$ref": "#/$defs/Hooks", + "description": "Hooks are hooks that can be used to inject custom patches before syncing" + } + }, + "type": "object" + }, + "SyncPods": { + "properties": { + "enabled": { + "type": "boolean" + }, + "workloadServiceAccount": { + "type": "string" + }, + "translateImage": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "enforceTolerations": { + "items": { + "type": "string" + }, + "type": "array", + "description": "validate format" + }, + "useSecretsForSATokens": { + "type": "boolean" + }, + "rewriteHosts": { + "$ref": "#/$defs/SyncRewriteHosts" + } + }, + "type": "object" + }, + "SyncRewriteHosts": { + "properties": { + "enabled": { + "type": "boolean" + }, + "initContainerImage": { + "type": "boolean" + } + }, + "type": "object" + }, + "SyncToHost": { + "properties": { + "services": { + "$ref": "#/$defs/EnableSwitch" + }, + "endpoints": { + "$ref": "#/$defs/EnableSwitch" + }, + "ingresses": { + "$ref": "#/$defs/EnableSwitch" + }, + "priorityClasses": { + "$ref": "#/$defs/EnableSwitch" + }, + "networkPolicies": { + "$ref": "#/$defs/EnableSwitch" + }, + "volumeSnapshots": { + "$ref": "#/$defs/EnableSwitch" + }, + "podDisruptionBudgets": { + "$ref": "#/$defs/EnableSwitch" + }, + "serviceAccounts": { + "$ref": "#/$defs/EnableSwitch" + }, + "storageClasses": { + "$ref": "#/$defs/EnableSwitch" + }, + "persistentVolumes": { + "$ref": "#/$defs/EnableSwitch" + }, + "persistentVolumeClaims": { + "$ref": "#/$defs/EnableSwitch" + }, + "configMaps": { + "$ref": "#/$defs/SyncAllResource" + }, + "secrets": { + "$ref": "#/$defs/SyncAllResource" + }, + "pods": { + "$ref": "#/$defs/SyncPods" + } + }, + "type": "object" + }, + "Sysctl": { + "properties": { + "name": { + "type": "string", + "description": "Name of a property to set" + }, + "value": { + "type": "string", + "description": "Value of a property to set" + } + }, + "type": "object", + "required": [ + "name", + "value" + ], + "description": "Sysctl defines a kernel parameter to be set" + }, + "TCPSocketAction": { + "properties": { + "port": { + "$ref": "#/$defs/IntOrString", + "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + }, + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP.\n+optional" + } + }, + "type": "object", + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket" + }, + "Telemetry": { + "properties": { + "disabled": { + "type": "boolean" + }, + "instanceCreators": { + "type": "string" + }, + "platformUserID": { + "type": "string" + }, + "platformInstanceID": { + "type": "string" + }, + "machineID": { + "type": "string" + } + }, + "type": "object" + }, + "Template": { + "properties": { + "name": { + "type": "string", + "description": "Name is the name of the template used to populate the virtual cluster" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "Time": { + "properties": {}, + "type": "object", + "description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON." + }, + "Toleration": { + "properties": { + "key": { + "type": "string", + "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.\n+optional" + }, + "operator": { + "type": "string", + "description": "Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\n+optional" + }, + "value": { + "type": "string", + "description": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.\n+optional" + }, + "effect": { + "type": "string", + "description": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\n+optional" + }, + "tolerationSeconds": { + "type": "integer", + "description": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.\n+optional" + } + }, + "type": "object", + "description": "The pod this Toleration is attached to tolerates any taint that matches the triple \u003ckey,value,effect\u003e using the matching operator \u003coperator\u003e." + }, + "TopologySpreadConstraint": { + "properties": { + "maxSkew": { + "type": "integer", + "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P | P P | P |\n+-------+-------+-------+\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed." + }, + "topologyKey": { + "type": "string", + "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each \u003ckey, value\u003e as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field." + }, + "whenUnsatisfiable": { + "type": "string", + "description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P P | P | P |\n+-------+-------+-------+\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field." + }, + "labelSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain.\n+optional" + }, + "minDomains": { + "type": "integer", + "description": "MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P | P P | P P |\n+-------+-------+-------+\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew.\n\nThis is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).\n+optional" + }, + "nodeAffinityPolicy": { + "type": "string", + "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\n+optional" + }, + "nodeTaintsPolicy": { + "type": "string", + "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\n+optional" + }, + "matchLabelKeys": { + "items": { + "type": "string" + }, + "type": "array", + "description": "MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\n+listType=atomic\n+optional" + } + }, + "type": "object", + "required": [ + "maxSkew", + "topologyKey", + "whenUnsatisfiable" + ], + "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology." + }, + "TypedLocalObjectReference": { + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional" + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + } + }, + "type": "object", + "required": [ + "apiGroup", + "kind", + "name" + ], + "description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace." + }, + "TypedObjectReference": { + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional" + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + }, + "namespace": { + "type": "string", + "description": "Namespace is the namespace of resource being referenced\nNote 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.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+featureGate=CrossNamespaceVolumeDataSource\n+optional" + } + }, + "type": "object", + "required": [ + "apiGroup", + "kind", + "name" + ] + }, + "ValidatingWebhook": { + "properties": { + "name": { + "type": "string", + "description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.\nRequired." + }, + "clientConfig": { + "$ref": "#/$defs/WebhookClientConfig", + "description": "ClientConfig defines how to communicate with the hook.\nRequired" + }, + "rules": { + "items": { + "$ref": "#/$defs/RuleWithOperations" + }, + "type": "array", + "description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.\nHowever, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks\nfrom putting the cluster in a state which cannot be recovered from without completely\ndisabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called\non admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects." + }, + "failurePolicy": { + "type": "string", + "description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.\n+optional" + }, + "matchPolicy": { + "type": "string", + "description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".\n\n- Exact: match a request only if it exactly matches a specified rule.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nbut \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.\n\n- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version.\nFor example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1,\nand \"rules\" only included `apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"]`,\na request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.\n\nDefaults to \"Equivalent\"\n+optional" + }, + "namespaceSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook.\n\nFor example, to run the webhook on any objects whose namespace is not\nassociated with \"runlevel\" of \"0\" or \"1\"; you will set the selector as\nfollows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"runlevel\",\n \"operator\": \"NotIn\",\n \"values\": [\n \"0\",\n \"1\"\n ]\n }\n ]\n}\n\nIf instead you want to only run the webhook on any objects whose\nnamespace is associated with the \"environment\" of \"prod\" or \"staging\";\nyou will set the selector as follows:\n\"namespaceSelector\": {\n \"matchExpressions\": [\n {\n \"key\": \"environment\",\n \"operator\": \"In\",\n \"values\": [\n \"prod\",\n \"staging\"\n ]\n }\n ]\n}\n\nSee\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels\nfor more examples of label selectors.\n\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "objectSelector": { + "$ref": "#/$defs/LabelSelector", + "description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector. A null\nobject (oldObject in the case of create, or newObject in the case of\ndelete) or an object that cannot have labels (like a\nDeploymentRollback or a PodProxyOptions object) is not considered to\nmatch.\nUse the object selector only if the webhook is opt-in, because end\nusers may skip the admission webhook by setting the labels.\nDefault to the empty LabelSelector, which matches everything.\n+optional" + }, + "sideEffects": { + "type": "string", + "description": "SideEffects states whether this webhook has side effects.\nAcceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown).\nWebhooks with side effects MUST implement a reconciliation system, since a request may be\nrejected by a future step in the admission chain and the side effects therefore need to be undone.\nRequests with the dryRun attribute will be auto-rejected if they match a webhook with\nsideEffects == Unknown or Some." + }, + "timeoutSeconds": { + "type": "integer", + "description": "TimeoutSeconds specifies the timeout for this webhook. After the timeout passes,\nthe webhook call will be ignored or the API call will fail based on the\nfailure policy.\nThe timeout value must be between 1 and 30 seconds.\nDefault to 10 seconds.\n+optional" + }, + "admissionReviewVersions": { + "items": { + "type": "string" + }, + "type": "array", + "description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects. API server will try to use first version in\nthe list which it supports. If none of the versions specified in this list\nsupported by API server, validation will fail for this object.\nIf a persisted webhook configuration specifies allowed versions and does not\ninclude any versions known to the API Server, calls to the webhook will fail\nand be subject to the failure policy." + }, + "matchConditions": { + "items": { + "$ref": "#/$defs/MatchCondition" + }, + "type": "array", + "description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.\n\nThe exact matching logic is (in order):\n 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.\n 2. If ALL matchConditions evaluate to TRUE, the webhook is called.\n 3. If any matchCondition evaluates to an error (but none are FALSE):\n - If failurePolicy=Fail, reject the request\n - If failurePolicy=Ignore, the error is ignored and the webhook is skipped\n\nThis is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+featureGate=AdmissionWebhookMatchConditions\n+optional" + } + }, + "type": "object", + "required": [ + "name", + "clientConfig", + "sideEffects", + "admissionReviewVersions" + ], + "description": "ValidatingWebhook describes an admission webhook and the resources and operations it applies to." + }, + "Volume": { + "properties": { + "name": { + "type": "string", + "description": "name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "hostPath": { + "$ref": "#/$defs/HostPathVolumeSource", + "description": "hostPath represents a pre-existing file or directory on the host\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write.\n+optional" + }, + "emptyDir": { + "$ref": "#/$defs/EmptyDirVolumeSource", + "description": "emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional" + }, + "gcePersistentDisk": { + "$ref": "#/$defs/GCEPersistentDiskVolumeSource", + "description": "gcePersistentDisk represents a GCE Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + }, + "awsElasticBlockStore": { + "$ref": "#/$defs/AWSElasticBlockStoreVolumeSource", + "description": "awsElasticBlockStore represents an AWS Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional" + }, + "gitRepo": { + "$ref": "#/$defs/GitRepoVolumeSource", + "description": "gitRepo represents a git repository at a particular revision.\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container.\n+optional" + }, + "secret": { + "$ref": "#/$defs/SecretVolumeSource", + "description": "secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional" + }, + "nfs": { + "$ref": "#/$defs/NFSVolumeSource", + "description": "nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional" + }, + "iscsi": { + "$ref": "#/$defs/ISCSIVolumeSource", + "description": "iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md\n+optional" + }, + "glusterfs": { + "$ref": "#/$defs/GlusterfsVolumeSource", + "description": "glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md\n+optional" + }, + "persistentVolumeClaim": { + "$ref": "#/$defs/PersistentVolumeClaimVolumeSource", + "description": "persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional" + }, + "rbd": { + "$ref": "#/$defs/RBDVolumeSource", + "description": "rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/rbd/README.md\n+optional" + }, + "flexVolume": { + "$ref": "#/$defs/FlexVolumeSource", + "description": "flexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.\n+optional" + }, + "cinder": { + "$ref": "#/$defs/CinderVolumeSource", + "description": "cinder represents a cinder volume attached and mounted on kubelets host machine.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "cephfs": { + "$ref": "#/$defs/CephFSVolumeSource", + "description": "cephFS represents a Ceph FS mount on the host that shares a pod's lifetime\n+optional" + }, + "flocker": { + "$ref": "#/$defs/FlockerVolumeSource", + "description": "flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\n+optional" + }, + "downwardAPI": { + "$ref": "#/$defs/DownwardAPIVolumeSource", + "description": "downwardAPI represents downward API about the pod that should populate this volume\n+optional" + }, + "fc": { + "$ref": "#/$defs/FCVolumeSource", + "description": "fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\n+optional" + }, + "azureFile": { + "$ref": "#/$defs/AzureFileVolumeSource", + "description": "azureFile represents an Azure File Service mount on the host and bind mount to the pod.\n+optional" + }, + "configMap": { + "$ref": "#/$defs/ConfigMapVolumeSource", + "description": "configMap represents a configMap that should populate this volume\n+optional" + }, + "vsphereVolume": { + "$ref": "#/$defs/VsphereVirtualDiskVolumeSource", + "description": "vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine\n+optional" + }, + "quobyte": { + "$ref": "#/$defs/QuobyteVolumeSource", + "description": "quobyte represents a Quobyte mount on the host that shares a pod's lifetime\n+optional" + }, + "azureDisk": { + "$ref": "#/$defs/AzureDiskVolumeSource", + "description": "azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.\n+optional" + }, + "photonPersistentDisk": { + "$ref": "#/$defs/PhotonPersistentDiskVolumeSource", + "description": "photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine" + }, + "projected": { + "$ref": "#/$defs/ProjectedVolumeSource", + "description": "projected items for all in one resources secrets, configmaps, and downward API" + }, + "portworxVolume": { + "$ref": "#/$defs/PortworxVolumeSource", + "description": "portworxVolume represents a portworx volume attached and mounted on kubelets host machine\n+optional" + }, + "scaleIO": { + "$ref": "#/$defs/ScaleIOVolumeSource", + "description": "scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.\n+optional" + }, + "storageos": { + "$ref": "#/$defs/StorageOSVolumeSource", + "description": "storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.\n+optional" + }, + "csi": { + "$ref": "#/$defs/CSIVolumeSource", + "description": "csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).\n+optional" + }, + "ephemeral": { + "$ref": "#/$defs/EphemeralVolumeSource", + "description": "ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time.\n\n+optional" + } + }, + "type": "object", + "required": [ + "name" + ], + "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod." + }, + "VolumeDevice": { + "properties": { + "name": { + "type": "string", + "description": "name must match the name of a persistentVolumeClaim in the pod" + }, + "devicePath": { + "type": "string", + "description": "devicePath is the path inside of the container that the device will be mapped to." + } + }, + "type": "object", + "required": [ + "name", + "devicePath" + ], + "description": "volumeDevice describes a mapping of a raw block device within a container." + }, + "VolumeMount": { + "properties": { + "name": { + "type": "string", + "description": "This must match the Name of a Volume." + }, + "readOnly": { + "type": "boolean", + "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional" + }, + "mountPath": { + "type": "string", + "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'." + }, + "subPath": { + "type": "string", + "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional" + }, + "mountPropagation": { + "type": "string", + "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\n+optional" + }, + "subPathExpr": { + "type": "string", + "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\n+optional" + } + }, + "type": "object", + "required": [ + "name", + "mountPath" + ], + "description": "VolumeMount describes a mounting of a Volume within a container." + }, + "VolumeProjection": { + "properties": { + "secret": { + "$ref": "#/$defs/SecretProjection", + "description": "secret information about the secret data to project\n+optional" + }, + "downwardAPI": { + "$ref": "#/$defs/DownwardAPIProjection", + "description": "downwardAPI information about the downwardAPI data to project\n+optional" + }, + "configMap": { + "$ref": "#/$defs/ConfigMapProjection", + "description": "configMap information about the configMap data to project\n+optional" + }, + "serviceAccountToken": { + "$ref": "#/$defs/ServiceAccountTokenProjection", + "description": "serviceAccountToken is information about the serviceAccountToken data to project\n+optional" + }, + "clusterTrustBundle": { + "$ref": "#/$defs/ClusterTrustBundleProjection", + "description": "ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time.\n\n+featureGate=ClusterTrustBundleProjection\n+optional" + } + }, + "type": "object", + "description": "Projection that may be projected along with other supported volume types" + }, + "VolumeResourceRequirements": { + "properties": { + "limits": { + "$ref": "#/$defs/ResourceList", + "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + }, + "requests": { + "$ref": "#/$defs/ResourceList", + "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional" + } + }, + "type": "object", + "description": "VolumeResourceRequirements describes the storage resource requirements for a volume." + }, + "VsphereVirtualDiskVolumeSource": { + "properties": { + "volumePath": { + "type": "string", + "description": "volumePath is the path that identifies vSphere volume vmdk" + }, + "fsType": { + "type": "string", + "description": "fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "storagePolicyName": { + "type": "string", + "description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.\n+optional" + }, + "storagePolicyID": { + "type": "string", + "description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.\n+optional" + } + }, + "type": "object", + "required": [ + "volumePath" + ], + "description": "Represents a vSphere volume resource." + }, + "WebhookClientConfig": { + "properties": { + "url": { + "type": "string", + "description": "`url` gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.\n\nThe `host` should not refer to a service running in the cluster; use\nthe `service` field instead. The host might be resolved via external\nDNS in some apiservers (e.g., `kube-apiserver` cannot resolve\nin-cluster DNS as that would be a layering violation). `host` may\nalso be an IP address.\n\nPlease note that using `localhost` or `127.0.0.1` as a `host` is\nrisky unless you take great care to run this webhook on all hosts\nwhich run an apiserver which might need to make calls to this\nwebhook. Such installs are likely to be non-portable, i.e., not easy\nto turn up in a new cluster.\n\nThe scheme must be \"https\"; the URL must begin with \"https://\".\n\nA path is optional, and if present may be any string permissible in\na URL. You may use the path to pass an arbitrary string to the\nwebhook, for example, a cluster identifier.\n\nAttempting to use a user or basic auth e.g. \"user:password@\" is not\nallowed. Fragments (\"#...\") and query parameters (\"?...\") are not\nallowed, either.\n\n+optional" + }, + "service": { + "$ref": "#/$defs/ServiceReference", + "description": "`service` is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`.\n\n+optional" + }, + "caBundle": { + "type": "string", + "contentEncoding": "base64", + "description": "`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.\n+optional" + } + }, + "type": "object", + "description": "WebhookClientConfig contains the information to make a TLS connection with the webhook" + }, + "WeightedPodAffinityTerm": { + "properties": { + "weight": { + "type": "integer", + "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100." + }, + "podAffinityTerm": { + "$ref": "#/$defs/PodAffinityTerm", + "description": "Required. A pod affinity term, associated with the corresponding weight." + } + }, + "type": "object", + "required": [ + "weight", + "podAffinityTerm" + ], + "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)" + }, + "WindowsSecurityContextOptions": { + "properties": { + "gmsaCredentialSpecName": { + "type": "string", + "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\n+optional" + }, + "gmsaCredentialSpec": { + "type": "string", + "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\n+optional" + }, + "runAsUserName": { + "type": "string", + "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "hostProcess": { + "type": "boolean", + "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\n+optional" + } + }, + "type": "object", + "description": "WindowsSecurityContextOptions contain Windows-specific options and credentials." + } + }, + "properties": { + "exportKubeConfig": { + "$ref": "#/$defs/ExportKubeConfig" + }, + "sync": { + "$ref": "#/$defs/SyncConfig" + }, + "observability": { + "$ref": "#/$defs/Observability" + }, + "networking": { + "$ref": "#/$defs/Networking" + }, + "plugin": { + "additionalProperties": { + "$ref": "#/$defs/Plugin" + }, + "type": "object" + }, + "plugins": { + "additionalProperties": { + "$ref": "#/$defs/Plugins" + }, + "type": "object" + }, + "controlPlane": { + "$ref": "#/$defs/ControlPlane" + }, + "policies": { + "$ref": "#/$defs/Policies" + }, + "rbac": { + "$ref": "#/$defs/RBAC" + }, + "telemetry": { + "$ref": "#/$defs/Telemetry", + "description": "Telemetry is the configuration related to telemetry gathered about vcluster usage." + }, + "experimental": { + "$ref": "#/$defs/Experimental" + }, + "license": { + "$ref": "#/$defs/License" + }, + "platform": { + "$ref": "#/$defs/Platform" + }, + "sleep": { + "$ref": "#/$defs/Sleep" + }, + "template": { + "$ref": "#/$defs/Template" + }, + "access": { + "$ref": "#/$defs/Access" + } + }, + "type": "object" +} \ No newline at end of file diff --git a/vendor/github.com/bahlo/generic-list-go/LICENSE b/vendor/github.com/bahlo/generic-list-go/LICENSE new file mode 100644 index 000000000..6a66aea5e --- /dev/null +++ b/vendor/github.com/bahlo/generic-list-go/LICENSE @@ -0,0 +1,27 @@ +Copyright (c) 2009 The Go Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/vendor/github.com/bahlo/generic-list-go/README.md b/vendor/github.com/bahlo/generic-list-go/README.md new file mode 100644 index 000000000..68bbce9fb --- /dev/null +++ b/vendor/github.com/bahlo/generic-list-go/README.md @@ -0,0 +1,5 @@ +# generic-list-go [![CI](https://github.com/bahlo/generic-list-go/actions/workflows/ci.yml/badge.svg)](https://github.com/bahlo/generic-list-go/actions/workflows/ci.yml) + +Go [container/list](https://pkg.go.dev/container/list) but with generics. + +The code is based on `container/list` in `go1.18beta2`. diff --git a/vendor/github.com/bahlo/generic-list-go/list.go b/vendor/github.com/bahlo/generic-list-go/list.go new file mode 100644 index 000000000..a06a7c612 --- /dev/null +++ b/vendor/github.com/bahlo/generic-list-go/list.go @@ -0,0 +1,235 @@ +// Copyright 2009 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package list implements a doubly linked list. +// +// To iterate over a list (where l is a *List): +// for e := l.Front(); e != nil; e = e.Next() { +// // do something with e.Value +// } +// +package list + +// Element is an element of a linked list. +type Element[T any] struct { + // Next and previous pointers in the doubly-linked list of elements. + // To simplify the implementation, internally a list l is implemented + // as a ring, such that &l.root is both the next element of the last + // list element (l.Back()) and the previous element of the first list + // element (l.Front()). + next, prev *Element[T] + + // The list to which this element belongs. + list *List[T] + + // The value stored with this element. + Value T +} + +// Next returns the next list element or nil. +func (e *Element[T]) Next() *Element[T] { + if p := e.next; e.list != nil && p != &e.list.root { + return p + } + return nil +} + +// Prev returns the previous list element or nil. +func (e *Element[T]) Prev() *Element[T] { + if p := e.prev; e.list != nil && p != &e.list.root { + return p + } + return nil +} + +// List represents a doubly linked list. +// The zero value for List is an empty list ready to use. +type List[T any] struct { + root Element[T] // sentinel list element, only &root, root.prev, and root.next are used + len int // current list length excluding (this) sentinel element +} + +// Init initializes or clears list l. +func (l *List[T]) Init() *List[T] { + l.root.next = &l.root + l.root.prev = &l.root + l.len = 0 + return l +} + +// New returns an initialized list. +func New[T any]() *List[T] { return new(List[T]).Init() } + +// Len returns the number of elements of list l. +// The complexity is O(1). +func (l *List[T]) Len() int { return l.len } + +// Front returns the first element of list l or nil if the list is empty. +func (l *List[T]) Front() *Element[T] { + if l.len == 0 { + return nil + } + return l.root.next +} + +// Back returns the last element of list l or nil if the list is empty. +func (l *List[T]) Back() *Element[T] { + if l.len == 0 { + return nil + } + return l.root.prev +} + +// lazyInit lazily initializes a zero List value. +func (l *List[T]) lazyInit() { + if l.root.next == nil { + l.Init() + } +} + +// insert inserts e after at, increments l.len, and returns e. +func (l *List[T]) insert(e, at *Element[T]) *Element[T] { + e.prev = at + e.next = at.next + e.prev.next = e + e.next.prev = e + e.list = l + l.len++ + return e +} + +// insertValue is a convenience wrapper for insert(&Element{Value: v}, at). +func (l *List[T]) insertValue(v T, at *Element[T]) *Element[T] { + return l.insert(&Element[T]{Value: v}, at) +} + +// remove removes e from its list, decrements l.len +func (l *List[T]) remove(e *Element[T]) { + e.prev.next = e.next + e.next.prev = e.prev + e.next = nil // avoid memory leaks + e.prev = nil // avoid memory leaks + e.list = nil + l.len-- +} + +// move moves e to next to at. +func (l *List[T]) move(e, at *Element[T]) { + if e == at { + return + } + e.prev.next = e.next + e.next.prev = e.prev + + e.prev = at + e.next = at.next + e.prev.next = e + e.next.prev = e +} + +// Remove removes e from l if e is an element of list l. +// It returns the element value e.Value. +// The element must not be nil. +func (l *List[T]) Remove(e *Element[T]) T { + if e.list == l { + // if e.list == l, l must have been initialized when e was inserted + // in l or l == nil (e is a zero Element) and l.remove will crash + l.remove(e) + } + return e.Value +} + +// PushFront inserts a new element e with value v at the front of list l and returns e. +func (l *List[T]) PushFront(v T) *Element[T] { + l.lazyInit() + return l.insertValue(v, &l.root) +} + +// PushBack inserts a new element e with value v at the back of list l and returns e. +func (l *List[T]) PushBack(v T) *Element[T] { + l.lazyInit() + return l.insertValue(v, l.root.prev) +} + +// InsertBefore inserts a new element e with value v immediately before mark and returns e. +// If mark is not an element of l, the list is not modified. +// The mark must not be nil. +func (l *List[T]) InsertBefore(v T, mark *Element[T]) *Element[T] { + if mark.list != l { + return nil + } + // see comment in List.Remove about initialization of l + return l.insertValue(v, mark.prev) +} + +// InsertAfter inserts a new element e with value v immediately after mark and returns e. +// If mark is not an element of l, the list is not modified. +// The mark must not be nil. +func (l *List[T]) InsertAfter(v T, mark *Element[T]) *Element[T] { + if mark.list != l { + return nil + } + // see comment in List.Remove about initialization of l + return l.insertValue(v, mark) +} + +// MoveToFront moves element e to the front of list l. +// If e is not an element of l, the list is not modified. +// The element must not be nil. +func (l *List[T]) MoveToFront(e *Element[T]) { + if e.list != l || l.root.next == e { + return + } + // see comment in List.Remove about initialization of l + l.move(e, &l.root) +} + +// MoveToBack moves element e to the back of list l. +// If e is not an element of l, the list is not modified. +// The element must not be nil. +func (l *List[T]) MoveToBack(e *Element[T]) { + if e.list != l || l.root.prev == e { + return + } + // see comment in List.Remove about initialization of l + l.move(e, l.root.prev) +} + +// MoveBefore moves element e to its new position before mark. +// If e or mark is not an element of l, or e == mark, the list is not modified. +// The element and mark must not be nil. +func (l *List[T]) MoveBefore(e, mark *Element[T]) { + if e.list != l || e == mark || mark.list != l { + return + } + l.move(e, mark.prev) +} + +// MoveAfter moves element e to its new position after mark. +// If e or mark is not an element of l, or e == mark, the list is not modified. +// The element and mark must not be nil. +func (l *List[T]) MoveAfter(e, mark *Element[T]) { + if e.list != l || e == mark || mark.list != l { + return + } + l.move(e, mark) +} + +// PushBackList inserts a copy of another list at the back of list l. +// The lists l and other may be the same. They must not be nil. +func (l *List[T]) PushBackList(other *List[T]) { + l.lazyInit() + for i, e := other.Len(), other.Front(); i > 0; i, e = i-1, e.Next() { + l.insertValue(e.Value, l.root.prev) + } +} + +// PushFrontList inserts a copy of another list at the front of list l. +// The lists l and other may be the same. They must not be nil. +func (l *List[T]) PushFrontList(other *List[T]) { + l.lazyInit() + for i, e := other.Len(), other.Back(); i > 0; i, e = i-1, e.Prev() { + l.insertValue(e.Value, &l.root) + } +} diff --git a/vendor/github.com/buger/jsonparser/.gitignore b/vendor/github.com/buger/jsonparser/.gitignore new file mode 100644 index 000000000..5598d8a56 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/.gitignore @@ -0,0 +1,12 @@ + +*.test + +*.out + +*.mprof + +.idea + +vendor/github.com/buger/goterm/ +prof.cpu +prof.mem diff --git a/vendor/github.com/buger/jsonparser/.travis.yml b/vendor/github.com/buger/jsonparser/.travis.yml new file mode 100644 index 000000000..dbfb7cf98 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/.travis.yml @@ -0,0 +1,11 @@ +language: go +arch: + - amd64 + - ppc64le +go: + - 1.7.x + - 1.8.x + - 1.9.x + - 1.10.x + - 1.11.x +script: go test -v ./. diff --git a/vendor/github.com/buger/jsonparser/Dockerfile b/vendor/github.com/buger/jsonparser/Dockerfile new file mode 100644 index 000000000..37fc9fd0b --- /dev/null +++ b/vendor/github.com/buger/jsonparser/Dockerfile @@ -0,0 +1,12 @@ +FROM golang:1.6 + +RUN go get github.com/Jeffail/gabs +RUN go get github.com/bitly/go-simplejson +RUN go get github.com/pquerna/ffjson +RUN go get github.com/antonholmquist/jason +RUN go get github.com/mreiferson/go-ujson +RUN go get -tags=unsafe -u github.com/ugorji/go/codec +RUN go get github.com/mailru/easyjson + +WORKDIR /go/src/github.com/buger/jsonparser +ADD . /go/src/github.com/buger/jsonparser \ No newline at end of file diff --git a/vendor/github.com/buger/jsonparser/LICENSE b/vendor/github.com/buger/jsonparser/LICENSE new file mode 100644 index 000000000..ac25aeb7d --- /dev/null +++ b/vendor/github.com/buger/jsonparser/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2016 Leonid Bugaev + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/vendor/github.com/buger/jsonparser/Makefile b/vendor/github.com/buger/jsonparser/Makefile new file mode 100644 index 000000000..e843368cf --- /dev/null +++ b/vendor/github.com/buger/jsonparser/Makefile @@ -0,0 +1,36 @@ +SOURCE = parser.go +CONTAINER = jsonparser +SOURCE_PATH = /go/src/github.com/buger/jsonparser +BENCHMARK = JsonParser +BENCHTIME = 5s +TEST = . +DRUN = docker run -v `pwd`:$(SOURCE_PATH) -i -t $(CONTAINER) + +build: + docker build -t $(CONTAINER) . + +race: + $(DRUN) --env GORACE="halt_on_error=1" go test ./. $(ARGS) -v -race -timeout 15s + +bench: + $(DRUN) go test $(LDFLAGS) -test.benchmem -bench $(BENCHMARK) ./benchmark/ $(ARGS) -benchtime $(BENCHTIME) -v + +bench_local: + $(DRUN) go test $(LDFLAGS) -test.benchmem -bench . $(ARGS) -benchtime $(BENCHTIME) -v + +profile: + $(DRUN) go test $(LDFLAGS) -test.benchmem -bench $(BENCHMARK) ./benchmark/ $(ARGS) -memprofile mem.mprof -v + $(DRUN) go test $(LDFLAGS) -test.benchmem -bench $(BENCHMARK) ./benchmark/ $(ARGS) -cpuprofile cpu.out -v + $(DRUN) go test $(LDFLAGS) -test.benchmem -bench $(BENCHMARK) ./benchmark/ $(ARGS) -c + +test: + $(DRUN) go test $(LDFLAGS) ./ -run $(TEST) -timeout 10s $(ARGS) -v + +fmt: + $(DRUN) go fmt ./... + +vet: + $(DRUN) go vet ./. + +bash: + $(DRUN) /bin/bash \ No newline at end of file diff --git a/vendor/github.com/buger/jsonparser/README.md b/vendor/github.com/buger/jsonparser/README.md new file mode 100644 index 000000000..d7e0ec397 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/README.md @@ -0,0 +1,365 @@ +[![Go Report Card](https://goreportcard.com/badge/github.com/buger/jsonparser)](https://goreportcard.com/report/github.com/buger/jsonparser) ![License](https://img.shields.io/dub/l/vibe-d.svg) +# Alternative JSON parser for Go (10x times faster standard library) + +It does not require you to know the structure of the payload (eg. create structs), and allows accessing fields by providing the path to them. It is up to **10 times faster** than standard `encoding/json` package (depending on payload size and usage), **allocates no memory**. See benchmarks below. + +## Rationale +Originally I made this for a project that relies on a lot of 3rd party APIs that can be unpredictable and complex. +I love simplicity and prefer to avoid external dependecies. `encoding/json` requires you to know exactly your data structures, or if you prefer to use `map[string]interface{}` instead, it will be very slow and hard to manage. +I investigated what's on the market and found that most libraries are just wrappers around `encoding/json`, there is few options with own parsers (`ffjson`, `easyjson`), but they still requires you to create data structures. + + +Goal of this project is to push JSON parser to the performance limits and not sacrifice with compliance and developer user experience. + +## Example +For the given JSON our goal is to extract the user's full name, number of github followers and avatar. + +```go +import "github.com/buger/jsonparser" + +... + +data := []byte(`{ + "person": { + "name": { + "first": "Leonid", + "last": "Bugaev", + "fullName": "Leonid Bugaev" + }, + "github": { + "handle": "buger", + "followers": 109 + }, + "avatars": [ + { "url": "https://avatars1.githubusercontent.com/u/14009?v=3&s=460", "type": "thumbnail" } + ] + }, + "company": { + "name": "Acme" + } +}`) + +// You can specify key path by providing arguments to Get function +jsonparser.Get(data, "person", "name", "fullName") + +// There is `GetInt` and `GetBoolean` helpers if you exactly know key data type +jsonparser.GetInt(data, "person", "github", "followers") + +// When you try to get object, it will return you []byte slice pointer to data containing it +// In `company` it will be `{"name": "Acme"}` +jsonparser.Get(data, "company") + +// If the key doesn't exist it will throw an error +var size int64 +if value, err := jsonparser.GetInt(data, "company", "size"); err == nil { + size = value +} + +// You can use `ArrayEach` helper to iterate items [item1, item2 .... itemN] +jsonparser.ArrayEach(data, func(value []byte, dataType jsonparser.ValueType, offset int, err error) { + fmt.Println(jsonparser.Get(value, "url")) +}, "person", "avatars") + +// Or use can access fields by index! +jsonparser.GetString(data, "person", "avatars", "[0]", "url") + +// You can use `ObjectEach` helper to iterate objects { "key1":object1, "key2":object2, .... "keyN":objectN } +jsonparser.ObjectEach(data, func(key []byte, value []byte, dataType jsonparser.ValueType, offset int) error { + fmt.Printf("Key: '%s'\n Value: '%s'\n Type: %s\n", string(key), string(value), dataType) + return nil +}, "person", "name") + +// The most efficient way to extract multiple keys is `EachKey` + +paths := [][]string{ + []string{"person", "name", "fullName"}, + []string{"person", "avatars", "[0]", "url"}, + []string{"company", "url"}, +} +jsonparser.EachKey(data, func(idx int, value []byte, vt jsonparser.ValueType, err error){ + switch idx { + case 0: // []string{"person", "name", "fullName"} + ... + case 1: // []string{"person", "avatars", "[0]", "url"} + ... + case 2: // []string{"company", "url"}, + ... + } +}, paths...) + +// For more information see docs below +``` + +## Need to speedup your app? + +I'm available for consulting and can help you push your app performance to the limits. Ping me at: leonsbox@gmail.com. + +## Reference + +Library API is really simple. You just need the `Get` method to perform any operation. The rest is just helpers around it. + +You also can view API at [godoc.org](https://godoc.org/github.com/buger/jsonparser) + + +### **`Get`** +```go +func Get(data []byte, keys ...string) (value []byte, dataType jsonparser.ValueType, offset int, err error) +``` +Receives data structure, and key path to extract value from. + +Returns: +* `value` - Pointer to original data structure containing key value, or just empty slice if nothing found or error +* `dataType` - Can be: `NotExist`, `String`, `Number`, `Object`, `Array`, `Boolean` or `Null` +* `offset` - Offset from provided data structure where key value ends. Used mostly internally, for example for `ArrayEach` helper. +* `err` - If the key is not found or any other parsing issue, it should return error. If key not found it also sets `dataType` to `NotExist` + +Accepts multiple keys to specify path to JSON value (in case of quering nested structures). +If no keys are provided it will try to extract the closest JSON value (simple ones or object/array), useful for reading streams or arrays, see `ArrayEach` implementation. + +Note that keys can be an array indexes: `jsonparser.GetInt("person", "avatars", "[0]", "url")`, pretty cool, yeah? + +### **`GetString`** +```go +func GetString(data []byte, keys ...string) (val string, err error) +``` +Returns strings properly handing escaped and unicode characters. Note that this will cause additional memory allocations. + +### **`GetUnsafeString`** +If you need string in your app, and ready to sacrifice with support of escaped symbols in favor of speed. It returns string mapped to existing byte slice memory, without any allocations: +```go +s, _, := jsonparser.GetUnsafeString(data, "person", "name", "title") +switch s { + case 'CEO': + ... + case 'Engineer' + ... + ... +} +``` +Note that `unsafe` here means that your string will exist until GC will free underlying byte slice, for most of cases it means that you can use this string only in current context, and should not pass it anywhere externally: through channels or any other way. + + +### **`GetBoolean`**, **`GetInt`** and **`GetFloat`** +```go +func GetBoolean(data []byte, keys ...string) (val bool, err error) + +func GetFloat(data []byte, keys ...string) (val float64, err error) + +func GetInt(data []byte, keys ...string) (val int64, err error) +``` +If you know the key type, you can use the helpers above. +If key data type do not match, it will return error. + +### **`ArrayEach`** +```go +func ArrayEach(data []byte, cb func(value []byte, dataType jsonparser.ValueType, offset int, err error), keys ...string) +``` +Needed for iterating arrays, accepts a callback function with the same return arguments as `Get`. + +### **`ObjectEach`** +```go +func ObjectEach(data []byte, callback func(key []byte, value []byte, dataType ValueType, offset int) error, keys ...string) (err error) +``` +Needed for iterating object, accepts a callback function. Example: +```go +var handler func([]byte, []byte, jsonparser.ValueType, int) error +handler = func(key []byte, value []byte, dataType jsonparser.ValueType, offset int) error { + //do stuff here +} +jsonparser.ObjectEach(myJson, handler) +``` + + +### **`EachKey`** +```go +func EachKey(data []byte, cb func(idx int, value []byte, dataType jsonparser.ValueType, err error), paths ...[]string) +``` +When you need to read multiple keys, and you do not afraid of low-level API `EachKey` is your friend. It read payload only single time, and calls callback function once path is found. For example when you call multiple times `Get`, it has to process payload multiple times, each time you call it. Depending on payload `EachKey` can be multiple times faster than `Get`. Path can use nested keys as well! + +```go +paths := [][]string{ + []string{"uuid"}, + []string{"tz"}, + []string{"ua"}, + []string{"st"}, +} +var data SmallPayload + +jsonparser.EachKey(smallFixture, func(idx int, value []byte, vt jsonparser.ValueType, err error){ + switch idx { + case 0: + data.Uuid, _ = value + case 1: + v, _ := jsonparser.ParseInt(value) + data.Tz = int(v) + case 2: + data.Ua, _ = value + case 3: + v, _ := jsonparser.ParseInt(value) + data.St = int(v) + } +}, paths...) +``` + +### **`Set`** +```go +func Set(data []byte, setValue []byte, keys ...string) (value []byte, err error) +``` +Receives existing data structure, key path to set, and value to set at that key. *This functionality is experimental.* + +Returns: +* `value` - Pointer to original data structure with updated or added key value. +* `err` - If any parsing issue, it should return error. + +Accepts multiple keys to specify path to JSON value (in case of updating or creating nested structures). + +Note that keys can be an array indexes: `jsonparser.Set(data, []byte("http://github.com"), "person", "avatars", "[0]", "url")` + +### **`Delete`** +```go +func Delete(data []byte, keys ...string) value []byte +``` +Receives existing data structure, and key path to delete. *This functionality is experimental.* + +Returns: +* `value` - Pointer to original data structure with key path deleted if it can be found. If there is no key path, then the whole data structure is deleted. + +Accepts multiple keys to specify path to JSON value (in case of updating or creating nested structures). + +Note that keys can be an array indexes: `jsonparser.Delete(data, "person", "avatars", "[0]", "url")` + + +## What makes it so fast? +* It does not rely on `encoding/json`, `reflection` or `interface{}`, the only real package dependency is `bytes`. +* Operates with JSON payload on byte level, providing you pointers to the original data structure: no memory allocation. +* No automatic type conversions, by default everything is a []byte, but it provides you value type, so you can convert by yourself (there is few helpers included). +* Does not parse full record, only keys you specified + + +## Benchmarks + +There are 3 benchmark types, trying to simulate real-life usage for small, medium and large JSON payloads. +For each metric, the lower value is better. Time/op is in nanoseconds. Values better than standard encoding/json marked as bold text. +Benchmarks run on standard Linode 1024 box. + +Compared libraries: +* https://golang.org/pkg/encoding/json +* https://github.com/Jeffail/gabs +* https://github.com/a8m/djson +* https://github.com/bitly/go-simplejson +* https://github.com/antonholmquist/jason +* https://github.com/mreiferson/go-ujson +* https://github.com/ugorji/go/codec +* https://github.com/pquerna/ffjson +* https://github.com/mailru/easyjson +* https://github.com/buger/jsonparser + +#### TLDR +If you want to skip next sections we have 2 winner: `jsonparser` and `easyjson`. +`jsonparser` is up to 10 times faster than standard `encoding/json` package (depending on payload size and usage), and almost infinitely (literally) better in memory consumption because it operates with data on byte level, and provide direct slice pointers. +`easyjson` wins in CPU in medium tests and frankly i'm impressed with this package: it is remarkable results considering that it is almost drop-in replacement for `encoding/json` (require some code generation). + +It's hard to fully compare `jsonparser` and `easyjson` (or `ffson`), they a true parsers and fully process record, unlike `jsonparser` which parse only keys you specified. + +If you searching for replacement of `encoding/json` while keeping structs, `easyjson` is an amazing choice. If you want to process dynamic JSON, have memory constrains, or more control over your data you should try `jsonparser`. + +`jsonparser` performance heavily depends on usage, and it works best when you do not need to process full record, only some keys. The more calls you need to make, the slower it will be, in contrast `easyjson` (or `ffjson`, `encoding/json`) parser record only 1 time, and then you can make as many calls as you want. + +With great power comes great responsibility! :) + + +#### Small payload + +Each test processes 190 bytes of http log as a JSON record. +It should read multiple fields. +https://github.com/buger/jsonparser/blob/master/benchmark/benchmark_small_payload_test.go + +Library | time/op | bytes/op | allocs/op + ------ | ------- | -------- | ------- +encoding/json struct | 7879 | 880 | 18 +encoding/json interface{} | 8946 | 1521 | 38 +Jeffail/gabs | 10053 | 1649 | 46 +bitly/go-simplejson | 10128 | 2241 | 36 +antonholmquist/jason | 27152 | 7237 | 101 +github.com/ugorji/go/codec | 8806 | 2176 | 31 +mreiferson/go-ujson | **7008** | **1409** | 37 +a8m/djson | 3862 | 1249 | 30 +pquerna/ffjson | **3769** | **624** | **15** +mailru/easyjson | **2002** | **192** | **9** +buger/jsonparser | **1367** | **0** | **0** +buger/jsonparser (EachKey API) | **809** | **0** | **0** + +Winners are ffjson, easyjson and jsonparser, where jsonparser is up to 9.8x faster than encoding/json and 4.6x faster than ffjson, and slightly faster than easyjson. +If you look at memory allocation, jsonparser has no rivals, as it makes no data copy and operates with raw []byte structures and pointers to it. + +#### Medium payload + +Each test processes a 2.4kb JSON record (based on Clearbit API). +It should read multiple nested fields and 1 array. + +https://github.com/buger/jsonparser/blob/master/benchmark/benchmark_medium_payload_test.go + +| Library | time/op | bytes/op | allocs/op | +| ------- | ------- | -------- | --------- | +| encoding/json struct | 57749 | 1336 | 29 | +| encoding/json interface{} | 79297 | 10627 | 215 | +| Jeffail/gabs | 83807 | 11202 | 235 | +| bitly/go-simplejson | 88187 | 17187 | 220 | +| antonholmquist/jason | 94099 | 19013 | 247 | +| github.com/ugorji/go/codec | 114719 | 6712 | 152 | +| mreiferson/go-ujson | **56972** | 11547 | 270 | +| a8m/djson | 28525 | 10196 | 198 | +| pquerna/ffjson | **20298** | **856** | **20** | +| mailru/easyjson | **10512** | **336** | **12** | +| buger/jsonparser | **15955** | **0** | **0** | +| buger/jsonparser (EachKey API) | **8916** | **0** | **0** | + +The difference between ffjson and jsonparser in CPU usage is smaller, while the memory consumption difference is growing. On the other hand `easyjson` shows remarkable performance for medium payload. + +`gabs`, `go-simplejson` and `jason` are based on encoding/json and map[string]interface{} and actually only helpers for unstructured JSON, their performance correlate with `encoding/json interface{}`, and they will skip next round. +`go-ujson` while have its own parser, shows same performance as `encoding/json`, also skips next round. Same situation with `ugorji/go/codec`, but it showed unexpectedly bad performance for complex payloads. + + +#### Large payload + +Each test processes a 24kb JSON record (based on Discourse API) +It should read 2 arrays, and for each item in array get a few fields. +Basically it means processing a full JSON file. + +https://github.com/buger/jsonparser/blob/master/benchmark/benchmark_large_payload_test.go + +| Library | time/op | bytes/op | allocs/op | +| --- | --- | --- | --- | +| encoding/json struct | 748336 | 8272 | 307 | +| encoding/json interface{} | 1224271 | 215425 | 3395 | +| a8m/djson | 510082 | 213682 | 2845 | +| pquerna/ffjson | **312271** | **7792** | **298** | +| mailru/easyjson | **154186** | **6992** | **288** | +| buger/jsonparser | **85308** | **0** | **0** | + +`jsonparser` now is a winner, but do not forget that it is way more lightweight parser than `ffson` or `easyjson`, and they have to parser all the data, while `jsonparser` parse only what you need. All `ffjson`, `easysjon` and `jsonparser` have their own parsing code, and does not depend on `encoding/json` or `interface{}`, thats one of the reasons why they are so fast. `easyjson` also use a bit of `unsafe` package to reduce memory consuption (in theory it can lead to some unexpected GC issue, but i did not tested enough) + +Also last benchmark did not included `EachKey` test, because in this particular case we need to read lot of Array values, and using `ArrayEach` is more efficient. + +## Questions and support + +All bug-reports and suggestions should go though Github Issues. + +## Contributing + +1. Fork it +2. Create your feature branch (git checkout -b my-new-feature) +3. Commit your changes (git commit -am 'Added some feature') +4. Push to the branch (git push origin my-new-feature) +5. Create new Pull Request + +## Development + +All my development happens using Docker, and repo include some Make tasks to simplify development. + +* `make build` - builds docker image, usually can be called only once +* `make test` - run tests +* `make fmt` - run go fmt +* `make bench` - run benchmarks (if you need to run only single benchmark modify `BENCHMARK` variable in make file) +* `make profile` - runs benchmark and generate 3 files- `cpu.out`, `mem.mprof` and `benchmark.test` binary, which can be used for `go tool pprof` +* `make bash` - enter container (i use it for running `go tool pprof` above) diff --git a/vendor/github.com/buger/jsonparser/bytes.go b/vendor/github.com/buger/jsonparser/bytes.go new file mode 100644 index 000000000..0bb0ff395 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/bytes.go @@ -0,0 +1,47 @@ +package jsonparser + +import ( + bio "bytes" +) + +// minInt64 '-9223372036854775808' is the smallest representable number in int64 +const minInt64 = `9223372036854775808` + +// About 2x faster then strconv.ParseInt because it only supports base 10, which is enough for JSON +func parseInt(bytes []byte) (v int64, ok bool, overflow bool) { + if len(bytes) == 0 { + return 0, false, false + } + + var neg bool = false + if bytes[0] == '-' { + neg = true + bytes = bytes[1:] + } + + var b int64 = 0 + for _, c := range bytes { + if c >= '0' && c <= '9' { + b = (10 * v) + int64(c-'0') + } else { + return 0, false, false + } + if overflow = (b < v); overflow { + break + } + v = b + } + + if overflow { + if neg && bio.Equal(bytes, []byte(minInt64)) { + return b, true, false + } + return 0, false, true + } + + if neg { + return -v, true, false + } else { + return v, true, false + } +} diff --git a/vendor/github.com/buger/jsonparser/bytes_safe.go b/vendor/github.com/buger/jsonparser/bytes_safe.go new file mode 100644 index 000000000..ff16a4a19 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/bytes_safe.go @@ -0,0 +1,25 @@ +// +build appengine appenginevm + +package jsonparser + +import ( + "strconv" +) + +// See fastbytes_unsafe.go for explanation on why *[]byte is used (signatures must be consistent with those in that file) + +func equalStr(b *[]byte, s string) bool { + return string(*b) == s +} + +func parseFloat(b *[]byte) (float64, error) { + return strconv.ParseFloat(string(*b), 64) +} + +func bytesToString(b *[]byte) string { + return string(*b) +} + +func StringToBytes(s string) []byte { + return []byte(s) +} diff --git a/vendor/github.com/buger/jsonparser/bytes_unsafe.go b/vendor/github.com/buger/jsonparser/bytes_unsafe.go new file mode 100644 index 000000000..589fea87e --- /dev/null +++ b/vendor/github.com/buger/jsonparser/bytes_unsafe.go @@ -0,0 +1,44 @@ +// +build !appengine,!appenginevm + +package jsonparser + +import ( + "reflect" + "strconv" + "unsafe" + "runtime" +) + +// +// The reason for using *[]byte rather than []byte in parameters is an optimization. As of Go 1.6, +// the compiler cannot perfectly inline the function when using a non-pointer slice. That is, +// the non-pointer []byte parameter version is slower than if its function body is manually +// inlined, whereas the pointer []byte version is equally fast to the manually inlined +// version. Instruction count in assembly taken from "go tool compile" confirms this difference. +// +// TODO: Remove hack after Go 1.7 release +// +func equalStr(b *[]byte, s string) bool { + return *(*string)(unsafe.Pointer(b)) == s +} + +func parseFloat(b *[]byte) (float64, error) { + return strconv.ParseFloat(*(*string)(unsafe.Pointer(b)), 64) +} + +// A hack until issue golang/go#2632 is fixed. +// See: https://github.com/golang/go/issues/2632 +func bytesToString(b *[]byte) string { + return *(*string)(unsafe.Pointer(b)) +} + +func StringToBytes(s string) []byte { + b := make([]byte, 0, 0) + bh := (*reflect.SliceHeader)(unsafe.Pointer(&b)) + sh := (*reflect.StringHeader)(unsafe.Pointer(&s)) + bh.Data = sh.Data + bh.Cap = sh.Len + bh.Len = sh.Len + runtime.KeepAlive(s) + return b +} diff --git a/vendor/github.com/buger/jsonparser/escape.go b/vendor/github.com/buger/jsonparser/escape.go new file mode 100644 index 000000000..49669b942 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/escape.go @@ -0,0 +1,173 @@ +package jsonparser + +import ( + "bytes" + "unicode/utf8" +) + +// JSON Unicode stuff: see https://tools.ietf.org/html/rfc7159#section-7 + +const supplementalPlanesOffset = 0x10000 +const highSurrogateOffset = 0xD800 +const lowSurrogateOffset = 0xDC00 + +const basicMultilingualPlaneReservedOffset = 0xDFFF +const basicMultilingualPlaneOffset = 0xFFFF + +func combineUTF16Surrogates(high, low rune) rune { + return supplementalPlanesOffset + (high-highSurrogateOffset)<<10 + (low - lowSurrogateOffset) +} + +const badHex = -1 + +func h2I(c byte) int { + switch { + case c >= '0' && c <= '9': + return int(c - '0') + case c >= 'A' && c <= 'F': + return int(c - 'A' + 10) + case c >= 'a' && c <= 'f': + return int(c - 'a' + 10) + } + return badHex +} + +// decodeSingleUnicodeEscape decodes a single \uXXXX escape sequence. The prefix \u is assumed to be present and +// is not checked. +// In JSON, these escapes can either come alone or as part of "UTF16 surrogate pairs" that must be handled together. +// This function only handles one; decodeUnicodeEscape handles this more complex case. +func decodeSingleUnicodeEscape(in []byte) (rune, bool) { + // We need at least 6 characters total + if len(in) < 6 { + return utf8.RuneError, false + } + + // Convert hex to decimal + h1, h2, h3, h4 := h2I(in[2]), h2I(in[3]), h2I(in[4]), h2I(in[5]) + if h1 == badHex || h2 == badHex || h3 == badHex || h4 == badHex { + return utf8.RuneError, false + } + + // Compose the hex digits + return rune(h1<<12 + h2<<8 + h3<<4 + h4), true +} + +// isUTF16EncodedRune checks if a rune is in the range for non-BMP characters, +// which is used to describe UTF16 chars. +// Source: https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_Multilingual_Plane +func isUTF16EncodedRune(r rune) bool { + return highSurrogateOffset <= r && r <= basicMultilingualPlaneReservedOffset +} + +func decodeUnicodeEscape(in []byte) (rune, int) { + if r, ok := decodeSingleUnicodeEscape(in); !ok { + // Invalid Unicode escape + return utf8.RuneError, -1 + } else if r <= basicMultilingualPlaneOffset && !isUTF16EncodedRune(r) { + // Valid Unicode escape in Basic Multilingual Plane + return r, 6 + } else if r2, ok := decodeSingleUnicodeEscape(in[6:]); !ok { // Note: previous decodeSingleUnicodeEscape success guarantees at least 6 bytes remain + // UTF16 "high surrogate" without manditory valid following Unicode escape for the "low surrogate" + return utf8.RuneError, -1 + } else if r2 < lowSurrogateOffset { + // Invalid UTF16 "low surrogate" + return utf8.RuneError, -1 + } else { + // Valid UTF16 surrogate pair + return combineUTF16Surrogates(r, r2), 12 + } +} + +// backslashCharEscapeTable: when '\X' is found for some byte X, it is to be replaced with backslashCharEscapeTable[X] +var backslashCharEscapeTable = [...]byte{ + '"': '"', + '\\': '\\', + '/': '/', + 'b': '\b', + 'f': '\f', + 'n': '\n', + 'r': '\r', + 't': '\t', +} + +// unescapeToUTF8 unescapes the single escape sequence starting at 'in' into 'out' and returns +// how many characters were consumed from 'in' and emitted into 'out'. +// If a valid escape sequence does not appear as a prefix of 'in', (-1, -1) to signal the error. +func unescapeToUTF8(in, out []byte) (inLen int, outLen int) { + if len(in) < 2 || in[0] != '\\' { + // Invalid escape due to insufficient characters for any escape or no initial backslash + return -1, -1 + } + + // https://tools.ietf.org/html/rfc7159#section-7 + switch e := in[1]; e { + case '"', '\\', '/', 'b', 'f', 'n', 'r', 't': + // Valid basic 2-character escapes (use lookup table) + out[0] = backslashCharEscapeTable[e] + return 2, 1 + case 'u': + // Unicode escape + if r, inLen := decodeUnicodeEscape(in); inLen == -1 { + // Invalid Unicode escape + return -1, -1 + } else { + // Valid Unicode escape; re-encode as UTF8 + outLen := utf8.EncodeRune(out, r) + return inLen, outLen + } + } + + return -1, -1 +} + +// unescape unescapes the string contained in 'in' and returns it as a slice. +// If 'in' contains no escaped characters: +// Returns 'in'. +// Else, if 'out' is of sufficient capacity (guaranteed if cap(out) >= len(in)): +// 'out' is used to build the unescaped string and is returned with no extra allocation +// Else: +// A new slice is allocated and returned. +func Unescape(in, out []byte) ([]byte, error) { + firstBackslash := bytes.IndexByte(in, '\\') + if firstBackslash == -1 { + return in, nil + } + + // Get a buffer of sufficient size (allocate if needed) + if cap(out) < len(in) { + out = make([]byte, len(in)) + } else { + out = out[0:len(in)] + } + + // Copy the first sequence of unescaped bytes to the output and obtain a buffer pointer (subslice) + copy(out, in[:firstBackslash]) + in = in[firstBackslash:] + buf := out[firstBackslash:] + + for len(in) > 0 { + // Unescape the next escaped character + inLen, bufLen := unescapeToUTF8(in, buf) + if inLen == -1 { + return nil, MalformedStringEscapeError + } + + in = in[inLen:] + buf = buf[bufLen:] + + // Copy everything up until the next backslash + nextBackslash := bytes.IndexByte(in, '\\') + if nextBackslash == -1 { + copy(buf, in) + buf = buf[len(in):] + break + } else { + copy(buf, in[:nextBackslash]) + buf = buf[nextBackslash:] + in = in[nextBackslash:] + } + } + + // Trim the out buffer to the amount that was actually emitted + return out[:len(out)-len(buf)], nil +} diff --git a/vendor/github.com/buger/jsonparser/fuzz.go b/vendor/github.com/buger/jsonparser/fuzz.go new file mode 100644 index 000000000..854bd11b2 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/fuzz.go @@ -0,0 +1,117 @@ +package jsonparser + +func FuzzParseString(data []byte) int { + r, err := ParseString(data) + if err != nil || r == "" { + return 0 + } + return 1 +} + +func FuzzEachKey(data []byte) int { + paths := [][]string{ + {"name"}, + {"order"}, + {"nested", "a"}, + {"nested", "b"}, + {"nested2", "a"}, + {"nested", "nested3", "b"}, + {"arr", "[1]", "b"}, + {"arrInt", "[3]"}, + {"arrInt", "[5]"}, + {"nested"}, + {"arr", "["}, + {"a\n", "b\n"}, + } + EachKey(data, func(idx int, value []byte, vt ValueType, err error) {}, paths...) + return 1 +} + +func FuzzDelete(data []byte) int { + Delete(data, "test") + return 1 +} + +func FuzzSet(data []byte) int { + _, err := Set(data, []byte(`"new value"`), "test") + if err != nil { + return 0 + } + return 1 +} + +func FuzzObjectEach(data []byte) int { + _ = ObjectEach(data, func(key, value []byte, valueType ValueType, off int) error { + return nil + }) + return 1 +} + +func FuzzParseFloat(data []byte) int { + _, err := ParseFloat(data) + if err != nil { + return 0 + } + return 1 +} + +func FuzzParseInt(data []byte) int { + _, err := ParseInt(data) + if err != nil { + return 0 + } + return 1 +} + +func FuzzParseBool(data []byte) int { + _, err := ParseBoolean(data) + if err != nil { + return 0 + } + return 1 +} + +func FuzzTokenStart(data []byte) int { + _ = tokenStart(data) + return 1 +} + +func FuzzGetString(data []byte) int { + _, err := GetString(data, "test") + if err != nil { + return 0 + } + return 1 +} + +func FuzzGetFloat(data []byte) int { + _, err := GetFloat(data, "test") + if err != nil { + return 0 + } + return 1 +} + +func FuzzGetInt(data []byte) int { + _, err := GetInt(data, "test") + if err != nil { + return 0 + } + return 1 +} + +func FuzzGetBoolean(data []byte) int { + _, err := GetBoolean(data, "test") + if err != nil { + return 0 + } + return 1 +} + +func FuzzGetUnsafeString(data []byte) int { + _, err := GetUnsafeString(data, "test") + if err != nil { + return 0 + } + return 1 +} diff --git a/vendor/github.com/buger/jsonparser/oss-fuzz-build.sh b/vendor/github.com/buger/jsonparser/oss-fuzz-build.sh new file mode 100644 index 000000000..c573b0e2d --- /dev/null +++ b/vendor/github.com/buger/jsonparser/oss-fuzz-build.sh @@ -0,0 +1,47 @@ +#!/bin/bash -eu + +git clone https://github.com/dvyukov/go-fuzz-corpus +zip corpus.zip go-fuzz-corpus/json/corpus/* + +cp corpus.zip $OUT/fuzzparsestring_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzParseString fuzzparsestring + +cp corpus.zip $OUT/fuzzeachkey_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzEachKey fuzzeachkey + +cp corpus.zip $OUT/fuzzdelete_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzDelete fuzzdelete + +cp corpus.zip $OUT/fuzzset_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzSet fuzzset + +cp corpus.zip $OUT/fuzzobjecteach_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzObjectEach fuzzobjecteach + +cp corpus.zip $OUT/fuzzparsefloat_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzParseFloat fuzzparsefloat + +cp corpus.zip $OUT/fuzzparseint_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzParseInt fuzzparseint + +cp corpus.zip $OUT/fuzzparsebool_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzParseBool fuzzparsebool + +cp corpus.zip $OUT/fuzztokenstart_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzTokenStart fuzztokenstart + +cp corpus.zip $OUT/fuzzgetstring_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzGetString fuzzgetstring + +cp corpus.zip $OUT/fuzzgetfloat_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzGetFloat fuzzgetfloat + +cp corpus.zip $OUT/fuzzgetint_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzGetInt fuzzgetint + +cp corpus.zip $OUT/fuzzgetboolean_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzGetBoolean fuzzgetboolean + +cp corpus.zip $OUT/fuzzgetunsafestring_seed_corpus.zip +compile_go_fuzzer github.com/buger/jsonparser FuzzGetUnsafeString fuzzgetunsafestring + diff --git a/vendor/github.com/buger/jsonparser/parser.go b/vendor/github.com/buger/jsonparser/parser.go new file mode 100644 index 000000000..14b80bc48 --- /dev/null +++ b/vendor/github.com/buger/jsonparser/parser.go @@ -0,0 +1,1283 @@ +package jsonparser + +import ( + "bytes" + "errors" + "fmt" + "strconv" +) + +// Errors +var ( + KeyPathNotFoundError = errors.New("Key path not found") + UnknownValueTypeError = errors.New("Unknown value type") + MalformedJsonError = errors.New("Malformed JSON error") + MalformedStringError = errors.New("Value is string, but can't find closing '\"' symbol") + MalformedArrayError = errors.New("Value is array, but can't find closing ']' symbol") + MalformedObjectError = errors.New("Value looks like object, but can't find closing '}' symbol") + MalformedValueError = errors.New("Value looks like Number/Boolean/None, but can't find its end: ',' or '}' symbol") + OverflowIntegerError = errors.New("Value is number, but overflowed while parsing") + MalformedStringEscapeError = errors.New("Encountered an invalid escape sequence in a string") +) + +// How much stack space to allocate for unescaping JSON strings; if a string longer +// than this needs to be escaped, it will result in a heap allocation +const unescapeStackBufSize = 64 + +func tokenEnd(data []byte) int { + for i, c := range data { + switch c { + case ' ', '\n', '\r', '\t', ',', '}', ']': + return i + } + } + + return len(data) +} + +func findTokenStart(data []byte, token byte) int { + for i := len(data) - 1; i >= 0; i-- { + switch data[i] { + case token: + return i + case '[', '{': + return 0 + } + } + + return 0 +} + +func findKeyStart(data []byte, key string) (int, error) { + i := 0 + ln := len(data) + if ln > 0 && (data[0] == '{' || data[0] == '[') { + i = 1 + } + var stackbuf [unescapeStackBufSize]byte // stack-allocated array for allocation-free unescaping of small strings + + if ku, err := Unescape(StringToBytes(key), stackbuf[:]); err == nil { + key = bytesToString(&ku) + } + + for i < ln { + switch data[i] { + case '"': + i++ + keyBegin := i + + strEnd, keyEscaped := stringEnd(data[i:]) + if strEnd == -1 { + break + } + i += strEnd + keyEnd := i - 1 + + valueOffset := nextToken(data[i:]) + if valueOffset == -1 { + break + } + + i += valueOffset + + // if string is a key, and key level match + k := data[keyBegin:keyEnd] + // for unescape: if there are no escape sequences, this is cheap; if there are, it is a + // bit more expensive, but causes no allocations unless len(key) > unescapeStackBufSize + if keyEscaped { + if ku, err := Unescape(k, stackbuf[:]); err != nil { + break + } else { + k = ku + } + } + + if data[i] == ':' && len(key) == len(k) && bytesToString(&k) == key { + return keyBegin - 1, nil + } + + case '[': + end := blockEnd(data[i:], data[i], ']') + if end != -1 { + i = i + end + } + case '{': + end := blockEnd(data[i:], data[i], '}') + if end != -1 { + i = i + end + } + } + i++ + } + + return -1, KeyPathNotFoundError +} + +func tokenStart(data []byte) int { + for i := len(data) - 1; i >= 0; i-- { + switch data[i] { + case '\n', '\r', '\t', ',', '{', '[': + return i + } + } + + return 0 +} + +// Find position of next character which is not whitespace +func nextToken(data []byte) int { + for i, c := range data { + switch c { + case ' ', '\n', '\r', '\t': + continue + default: + return i + } + } + + return -1 +} + +// Find position of last character which is not whitespace +func lastToken(data []byte) int { + for i := len(data) - 1; i >= 0; i-- { + switch data[i] { + case ' ', '\n', '\r', '\t': + continue + default: + return i + } + } + + return -1 +} + +// Tries to find the end of string +// Support if string contains escaped quote symbols. +func stringEnd(data []byte) (int, bool) { + escaped := false + for i, c := range data { + if c == '"' { + if !escaped { + return i + 1, false + } else { + j := i - 1 + for { + if j < 0 || data[j] != '\\' { + return i + 1, true // even number of backslashes + } + j-- + if j < 0 || data[j] != '\\' { + break // odd number of backslashes + } + j-- + + } + } + } else if c == '\\' { + escaped = true + } + } + + return -1, escaped +} + +// Find end of the data structure, array or object. +// For array openSym and closeSym will be '[' and ']', for object '{' and '}' +func blockEnd(data []byte, openSym byte, closeSym byte) int { + level := 0 + i := 0 + ln := len(data) + + for i < ln { + switch data[i] { + case '"': // If inside string, skip it + se, _ := stringEnd(data[i+1:]) + if se == -1 { + return -1 + } + i += se + case openSym: // If open symbol, increase level + level++ + case closeSym: // If close symbol, increase level + level-- + + // If we have returned to the original level, we're done + if level == 0 { + return i + 1 + } + } + i++ + } + + return -1 +} + +func searchKeys(data []byte, keys ...string) int { + keyLevel := 0 + level := 0 + i := 0 + ln := len(data) + lk := len(keys) + lastMatched := true + + if lk == 0 { + return 0 + } + + var stackbuf [unescapeStackBufSize]byte // stack-allocated array for allocation-free unescaping of small strings + + for i < ln { + switch data[i] { + case '"': + i++ + keyBegin := i + + strEnd, keyEscaped := stringEnd(data[i:]) + if strEnd == -1 { + return -1 + } + i += strEnd + keyEnd := i - 1 + + valueOffset := nextToken(data[i:]) + if valueOffset == -1 { + return -1 + } + + i += valueOffset + + // if string is a key + if data[i] == ':' { + if level < 1 { + return -1 + } + + key := data[keyBegin:keyEnd] + + // for unescape: if there are no escape sequences, this is cheap; if there are, it is a + // bit more expensive, but causes no allocations unless len(key) > unescapeStackBufSize + var keyUnesc []byte + if !keyEscaped { + keyUnesc = key + } else if ku, err := Unescape(key, stackbuf[:]); err != nil { + return -1 + } else { + keyUnesc = ku + } + + if level <= len(keys) { + if equalStr(&keyUnesc, keys[level-1]) { + lastMatched = true + + // if key level match + if keyLevel == level-1 { + keyLevel++ + // If we found all keys in path + if keyLevel == lk { + return i + 1 + } + } + } else { + lastMatched = false + } + } else { + return -1 + } + } else { + i-- + } + case '{': + + // in case parent key is matched then only we will increase the level otherwise can directly + // can move to the end of this block + if !lastMatched { + end := blockEnd(data[i:], '{', '}') + if end == -1 { + return -1 + } + i += end - 1 + } else { + level++ + } + case '}': + level-- + if level == keyLevel { + keyLevel-- + } + case '[': + // If we want to get array element by index + if keyLevel == level && keys[level][0] == '[' { + var keyLen = len(keys[level]) + if keyLen < 3 || keys[level][0] != '[' || keys[level][keyLen-1] != ']' { + return -1 + } + aIdx, err := strconv.Atoi(keys[level][1 : keyLen-1]) + if err != nil { + return -1 + } + var curIdx int + var valueFound []byte + var valueOffset int + var curI = i + ArrayEach(data[i:], func(value []byte, dataType ValueType, offset int, err error) { + if curIdx == aIdx { + valueFound = value + valueOffset = offset + if dataType == String { + valueOffset = valueOffset - 2 + valueFound = data[curI+valueOffset : curI+valueOffset+len(value)+2] + } + } + curIdx += 1 + }) + + if valueFound == nil { + return -1 + } else { + subIndex := searchKeys(valueFound, keys[level+1:]...) + if subIndex < 0 { + return -1 + } + return i + valueOffset + subIndex + } + } else { + // Do not search for keys inside arrays + if arraySkip := blockEnd(data[i:], '[', ']'); arraySkip == -1 { + return -1 + } else { + i += arraySkip - 1 + } + } + case ':': // If encountered, JSON data is malformed + return -1 + } + + i++ + } + + return -1 +} + +func sameTree(p1, p2 []string) bool { + minLen := len(p1) + if len(p2) < minLen { + minLen = len(p2) + } + + for pi_1, p_1 := range p1[:minLen] { + if p2[pi_1] != p_1 { + return false + } + } + + return true +} + +func EachKey(data []byte, cb func(int, []byte, ValueType, error), paths ...[]string) int { + var x struct{} + pathFlags := make([]bool, len(paths)) + var level, pathsMatched, i int + ln := len(data) + + var maxPath int + for _, p := range paths { + if len(p) > maxPath { + maxPath = len(p) + } + } + + pathsBuf := make([]string, maxPath) + + for i < ln { + switch data[i] { + case '"': + i++ + keyBegin := i + + strEnd, keyEscaped := stringEnd(data[i:]) + if strEnd == -1 { + return -1 + } + i += strEnd + + keyEnd := i - 1 + + valueOffset := nextToken(data[i:]) + if valueOffset == -1 { + return -1 + } + + i += valueOffset + + // if string is a key, and key level match + if data[i] == ':' { + match := -1 + key := data[keyBegin:keyEnd] + + // for unescape: if there are no escape sequences, this is cheap; if there are, it is a + // bit more expensive, but causes no allocations unless len(key) > unescapeStackBufSize + var keyUnesc []byte + if !keyEscaped { + keyUnesc = key + } else { + var stackbuf [unescapeStackBufSize]byte + if ku, err := Unescape(key, stackbuf[:]); err != nil { + return -1 + } else { + keyUnesc = ku + } + } + + if maxPath >= level { + if level < 1 { + cb(-1, nil, Unknown, MalformedJsonError) + return -1 + } + + pathsBuf[level-1] = bytesToString(&keyUnesc) + for pi, p := range paths { + if len(p) != level || pathFlags[pi] || !equalStr(&keyUnesc, p[level-1]) || !sameTree(p, pathsBuf[:level]) { + continue + } + + match = pi + + pathsMatched++ + pathFlags[pi] = true + + v, dt, _, e := Get(data[i+1:]) + cb(pi, v, dt, e) + + if pathsMatched == len(paths) { + break + } + } + if pathsMatched == len(paths) { + return i + } + } + + if match == -1 { + tokenOffset := nextToken(data[i+1:]) + i += tokenOffset + + if data[i] == '{' { + blockSkip := blockEnd(data[i:], '{', '}') + i += blockSkip + 1 + } + } + + if i < ln { + switch data[i] { + case '{', '}', '[', '"': + i-- + } + } + } else { + i-- + } + case '{': + level++ + case '}': + level-- + case '[': + var ok bool + arrIdxFlags := make(map[int]struct{}) + pIdxFlags := make([]bool, len(paths)) + + if level < 0 { + cb(-1, nil, Unknown, MalformedJsonError) + return -1 + } + + for pi, p := range paths { + if len(p) < level+1 || pathFlags[pi] || p[level][0] != '[' || !sameTree(p, pathsBuf[:level]) { + continue + } + if len(p[level]) >= 2 { + aIdx, _ := strconv.Atoi(p[level][1 : len(p[level])-1]) + arrIdxFlags[aIdx] = x + pIdxFlags[pi] = true + } + } + + if len(arrIdxFlags) > 0 { + level++ + + var curIdx int + arrOff, _ := ArrayEach(data[i:], func(value []byte, dataType ValueType, offset int, err error) { + if _, ok = arrIdxFlags[curIdx]; ok { + for pi, p := range paths { + if pIdxFlags[pi] { + aIdx, _ := strconv.Atoi(p[level-1][1 : len(p[level-1])-1]) + + if curIdx == aIdx { + of := searchKeys(value, p[level:]...) + + pathsMatched++ + pathFlags[pi] = true + + if of != -1 { + v, dt, _, e := Get(value[of:]) + cb(pi, v, dt, e) + } + } + } + } + } + + curIdx += 1 + }) + + if pathsMatched == len(paths) { + return i + } + + i += arrOff - 1 + } else { + // Do not search for keys inside arrays + if arraySkip := blockEnd(data[i:], '[', ']'); arraySkip == -1 { + return -1 + } else { + i += arraySkip - 1 + } + } + case ']': + level-- + } + + i++ + } + + return -1 +} + +// Data types available in valid JSON data. +type ValueType int + +const ( + NotExist = ValueType(iota) + String + Number + Object + Array + Boolean + Null + Unknown +) + +func (vt ValueType) String() string { + switch vt { + case NotExist: + return "non-existent" + case String: + return "string" + case Number: + return "number" + case Object: + return "object" + case Array: + return "array" + case Boolean: + return "boolean" + case Null: + return "null" + default: + return "unknown" + } +} + +var ( + trueLiteral = []byte("true") + falseLiteral = []byte("false") + nullLiteral = []byte("null") +) + +func createInsertComponent(keys []string, setValue []byte, comma, object bool) []byte { + isIndex := string(keys[0][0]) == "[" + offset := 0 + lk := calcAllocateSpace(keys, setValue, comma, object) + buffer := make([]byte, lk, lk) + if comma { + offset += WriteToBuffer(buffer[offset:], ",") + } + if isIndex && !comma { + offset += WriteToBuffer(buffer[offset:], "[") + } else { + if object { + offset += WriteToBuffer(buffer[offset:], "{") + } + if !isIndex { + offset += WriteToBuffer(buffer[offset:], "\"") + offset += WriteToBuffer(buffer[offset:], keys[0]) + offset += WriteToBuffer(buffer[offset:], "\":") + } + } + + for i := 1; i < len(keys); i++ { + if string(keys[i][0]) == "[" { + offset += WriteToBuffer(buffer[offset:], "[") + } else { + offset += WriteToBuffer(buffer[offset:], "{\"") + offset += WriteToBuffer(buffer[offset:], keys[i]) + offset += WriteToBuffer(buffer[offset:], "\":") + } + } + offset += WriteToBuffer(buffer[offset:], string(setValue)) + for i := len(keys) - 1; i > 0; i-- { + if string(keys[i][0]) == "[" { + offset += WriteToBuffer(buffer[offset:], "]") + } else { + offset += WriteToBuffer(buffer[offset:], "}") + } + } + if isIndex && !comma { + offset += WriteToBuffer(buffer[offset:], "]") + } + if object && !isIndex { + offset += WriteToBuffer(buffer[offset:], "}") + } + return buffer +} + +func calcAllocateSpace(keys []string, setValue []byte, comma, object bool) int { + isIndex := string(keys[0][0]) == "[" + lk := 0 + if comma { + // , + lk += 1 + } + if isIndex && !comma { + // [] + lk += 2 + } else { + if object { + // { + lk += 1 + } + if !isIndex { + // "keys[0]" + lk += len(keys[0]) + 3 + } + } + + + lk += len(setValue) + for i := 1; i < len(keys); i++ { + if string(keys[i][0]) == "[" { + // [] + lk += 2 + } else { + // {"keys[i]":setValue} + lk += len(keys[i]) + 5 + } + } + + if object && !isIndex { + // } + lk += 1 + } + + return lk +} + +func WriteToBuffer(buffer []byte, str string) int { + copy(buffer, str) + return len(str) +} + +/* + +Del - Receives existing data structure, path to delete. + +Returns: +`data` - return modified data + +*/ +func Delete(data []byte, keys ...string) []byte { + lk := len(keys) + if lk == 0 { + return data[:0] + } + + array := false + if len(keys[lk-1]) > 0 && string(keys[lk-1][0]) == "[" { + array = true + } + + var startOffset, keyOffset int + endOffset := len(data) + var err error + if !array { + if len(keys) > 1 { + _, _, startOffset, endOffset, err = internalGet(data, keys[:lk-1]...) + if err == KeyPathNotFoundError { + // problem parsing the data + return data + } + } + + keyOffset, err = findKeyStart(data[startOffset:endOffset], keys[lk-1]) + if err == KeyPathNotFoundError { + // problem parsing the data + return data + } + keyOffset += startOffset + _, _, _, subEndOffset, _ := internalGet(data[startOffset:endOffset], keys[lk-1]) + endOffset = startOffset + subEndOffset + tokEnd := tokenEnd(data[endOffset:]) + tokStart := findTokenStart(data[:keyOffset], ","[0]) + + if data[endOffset+tokEnd] == ","[0] { + endOffset += tokEnd + 1 + } else if data[endOffset+tokEnd] == " "[0] && len(data) > endOffset+tokEnd+1 && data[endOffset+tokEnd+1] == ","[0] { + endOffset += tokEnd + 2 + } else if data[endOffset+tokEnd] == "}"[0] && data[tokStart] == ","[0] { + keyOffset = tokStart + } + } else { + _, _, keyOffset, endOffset, err = internalGet(data, keys...) + if err == KeyPathNotFoundError { + // problem parsing the data + return data + } + + tokEnd := tokenEnd(data[endOffset:]) + tokStart := findTokenStart(data[:keyOffset], ","[0]) + + if data[endOffset+tokEnd] == ","[0] { + endOffset += tokEnd + 1 + } else if data[endOffset+tokEnd] == "]"[0] && data[tokStart] == ","[0] { + keyOffset = tokStart + } + } + + // We need to remove remaining trailing comma if we delete las element in the object + prevTok := lastToken(data[:keyOffset]) + remainedValue := data[endOffset:] + + var newOffset int + if nextToken(remainedValue) > -1 && remainedValue[nextToken(remainedValue)] == '}' && data[prevTok] == ',' { + newOffset = prevTok + } else { + newOffset = prevTok + 1 + } + + // We have to make a copy here if we don't want to mangle the original data, because byte slices are + // accessed by reference and not by value + dataCopy := make([]byte, len(data)) + copy(dataCopy, data) + data = append(dataCopy[:newOffset], dataCopy[endOffset:]...) + + return data +} + +/* + +Set - Receives existing data structure, path to set, and data to set at that key. + +Returns: +`value` - modified byte array +`err` - On any parsing error + +*/ +func Set(data []byte, setValue []byte, keys ...string) (value []byte, err error) { + // ensure keys are set + if len(keys) == 0 { + return nil, KeyPathNotFoundError + } + + _, _, startOffset, endOffset, err := internalGet(data, keys...) + if err != nil { + if err != KeyPathNotFoundError { + // problem parsing the data + return nil, err + } + // full path doesnt exist + // does any subpath exist? + var depth int + for i := range keys { + _, _, start, end, sErr := internalGet(data, keys[:i+1]...) + if sErr != nil { + break + } else { + endOffset = end + startOffset = start + depth++ + } + } + comma := true + object := false + if endOffset == -1 { + firstToken := nextToken(data) + // We can't set a top-level key if data isn't an object + if firstToken < 0 || data[firstToken] != '{' { + return nil, KeyPathNotFoundError + } + // Don't need a comma if the input is an empty object + secondToken := firstToken + 1 + nextToken(data[firstToken+1:]) + if data[secondToken] == '}' { + comma = false + } + // Set the top level key at the end (accounting for any trailing whitespace) + // This assumes last token is valid like '}', could check and return error + endOffset = lastToken(data) + } + depthOffset := endOffset + if depth != 0 { + // if subpath is a non-empty object, add to it + // or if subpath is a non-empty array, add to it + if (data[startOffset] == '{' && data[startOffset+1+nextToken(data[startOffset+1:])] != '}') || + (data[startOffset] == '[' && data[startOffset+1+nextToken(data[startOffset+1:])] == '{') && keys[depth:][0][0] == 91 { + depthOffset-- + startOffset = depthOffset + // otherwise, over-write it with a new object + } else { + comma = false + object = true + } + } else { + startOffset = depthOffset + } + value = append(data[:startOffset], append(createInsertComponent(keys[depth:], setValue, comma, object), data[depthOffset:]...)...) + } else { + // path currently exists + startComponent := data[:startOffset] + endComponent := data[endOffset:] + + value = make([]byte, len(startComponent)+len(endComponent)+len(setValue)) + newEndOffset := startOffset + len(setValue) + copy(value[0:startOffset], startComponent) + copy(value[startOffset:newEndOffset], setValue) + copy(value[newEndOffset:], endComponent) + } + return value, nil +} + +func getType(data []byte, offset int) ([]byte, ValueType, int, error) { + var dataType ValueType + endOffset := offset + + // if string value + if data[offset] == '"' { + dataType = String + if idx, _ := stringEnd(data[offset+1:]); idx != -1 { + endOffset += idx + 1 + } else { + return nil, dataType, offset, MalformedStringError + } + } else if data[offset] == '[' { // if array value + dataType = Array + // break label, for stopping nested loops + endOffset = blockEnd(data[offset:], '[', ']') + + if endOffset == -1 { + return nil, dataType, offset, MalformedArrayError + } + + endOffset += offset + } else if data[offset] == '{' { // if object value + dataType = Object + // break label, for stopping nested loops + endOffset = blockEnd(data[offset:], '{', '}') + + if endOffset == -1 { + return nil, dataType, offset, MalformedObjectError + } + + endOffset += offset + } else { + // Number, Boolean or None + end := tokenEnd(data[endOffset:]) + + if end == -1 { + return nil, dataType, offset, MalformedValueError + } + + value := data[offset : endOffset+end] + + switch data[offset] { + case 't', 'f': // true or false + if bytes.Equal(value, trueLiteral) || bytes.Equal(value, falseLiteral) { + dataType = Boolean + } else { + return nil, Unknown, offset, UnknownValueTypeError + } + case 'u', 'n': // undefined or null + if bytes.Equal(value, nullLiteral) { + dataType = Null + } else { + return nil, Unknown, offset, UnknownValueTypeError + } + case '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-': + dataType = Number + default: + return nil, Unknown, offset, UnknownValueTypeError + } + + endOffset += end + } + return data[offset:endOffset], dataType, endOffset, nil +} + +/* +Get - Receives data structure, and key path to extract value from. + +Returns: +`value` - Pointer to original data structure containing key value, or just empty slice if nothing found or error +`dataType` - Can be: `NotExist`, `String`, `Number`, `Object`, `Array`, `Boolean` or `Null` +`offset` - Offset from provided data structure where key value ends. Used mostly internally, for example for `ArrayEach` helper. +`err` - If key not found or any other parsing issue it should return error. If key not found it also sets `dataType` to `NotExist` + +Accept multiple keys to specify path to JSON value (in case of quering nested structures). +If no keys provided it will try to extract closest JSON value (simple ones or object/array), useful for reading streams or arrays, see `ArrayEach` implementation. +*/ +func Get(data []byte, keys ...string) (value []byte, dataType ValueType, offset int, err error) { + a, b, _, d, e := internalGet(data, keys...) + return a, b, d, e +} + +func internalGet(data []byte, keys ...string) (value []byte, dataType ValueType, offset, endOffset int, err error) { + if len(keys) > 0 { + if offset = searchKeys(data, keys...); offset == -1 { + return nil, NotExist, -1, -1, KeyPathNotFoundError + } + } + + // Go to closest value + nO := nextToken(data[offset:]) + if nO == -1 { + return nil, NotExist, offset, -1, MalformedJsonError + } + + offset += nO + value, dataType, endOffset, err = getType(data, offset) + if err != nil { + return value, dataType, offset, endOffset, err + } + + // Strip quotes from string values + if dataType == String { + value = value[1 : len(value)-1] + } + + return value[:len(value):len(value)], dataType, offset, endOffset, nil +} + +// ArrayEach is used when iterating arrays, accepts a callback function with the same return arguments as `Get`. +func ArrayEach(data []byte, cb func(value []byte, dataType ValueType, offset int, err error), keys ...string) (offset int, err error) { + if len(data) == 0 { + return -1, MalformedObjectError + } + + nT := nextToken(data) + if nT == -1 { + return -1, MalformedJsonError + } + + offset = nT + 1 + + if len(keys) > 0 { + if offset = searchKeys(data, keys...); offset == -1 { + return offset, KeyPathNotFoundError + } + + // Go to closest value + nO := nextToken(data[offset:]) + if nO == -1 { + return offset, MalformedJsonError + } + + offset += nO + + if data[offset] != '[' { + return offset, MalformedArrayError + } + + offset++ + } + + nO := nextToken(data[offset:]) + if nO == -1 { + return offset, MalformedJsonError + } + + offset += nO + + if data[offset] == ']' { + return offset, nil + } + + for true { + v, t, o, e := Get(data[offset:]) + + if e != nil { + return offset, e + } + + if o == 0 { + break + } + + if t != NotExist { + cb(v, t, offset+o-len(v), e) + } + + if e != nil { + break + } + + offset += o + + skipToToken := nextToken(data[offset:]) + if skipToToken == -1 { + return offset, MalformedArrayError + } + offset += skipToToken + + if data[offset] == ']' { + break + } + + if data[offset] != ',' { + return offset, MalformedArrayError + } + + offset++ + } + + return offset, nil +} + +// ObjectEach iterates over the key-value pairs of a JSON object, invoking a given callback for each such entry +func ObjectEach(data []byte, callback func(key []byte, value []byte, dataType ValueType, offset int) error, keys ...string) (err error) { + offset := 0 + + // Descend to the desired key, if requested + if len(keys) > 0 { + if off := searchKeys(data, keys...); off == -1 { + return KeyPathNotFoundError + } else { + offset = off + } + } + + // Validate and skip past opening brace + if off := nextToken(data[offset:]); off == -1 { + return MalformedObjectError + } else if offset += off; data[offset] != '{' { + return MalformedObjectError + } else { + offset++ + } + + // Skip to the first token inside the object, or stop if we find the ending brace + if off := nextToken(data[offset:]); off == -1 { + return MalformedJsonError + } else if offset += off; data[offset] == '}' { + return nil + } + + // Loop pre-condition: data[offset] points to what should be either the next entry's key, or the closing brace (if it's anything else, the JSON is malformed) + for offset < len(data) { + // Step 1: find the next key + var key []byte + + // Check what the the next token is: start of string, end of object, or something else (error) + switch data[offset] { + case '"': + offset++ // accept as string and skip opening quote + case '}': + return nil // we found the end of the object; stop and return success + default: + return MalformedObjectError + } + + // Find the end of the key string + var keyEscaped bool + if off, esc := stringEnd(data[offset:]); off == -1 { + return MalformedJsonError + } else { + key, keyEscaped = data[offset:offset+off-1], esc + offset += off + } + + // Unescape the string if needed + if keyEscaped { + var stackbuf [unescapeStackBufSize]byte // stack-allocated array for allocation-free unescaping of small strings + if keyUnescaped, err := Unescape(key, stackbuf[:]); err != nil { + return MalformedStringEscapeError + } else { + key = keyUnescaped + } + } + + // Step 2: skip the colon + if off := nextToken(data[offset:]); off == -1 { + return MalformedJsonError + } else if offset += off; data[offset] != ':' { + return MalformedJsonError + } else { + offset++ + } + + // Step 3: find the associated value, then invoke the callback + if value, valueType, off, err := Get(data[offset:]); err != nil { + return err + } else if err := callback(key, value, valueType, offset+off); err != nil { // Invoke the callback here! + return err + } else { + offset += off + } + + // Step 4: skip over the next comma to the following token, or stop if we hit the ending brace + if off := nextToken(data[offset:]); off == -1 { + return MalformedArrayError + } else { + offset += off + switch data[offset] { + case '}': + return nil // Stop if we hit the close brace + case ',': + offset++ // Ignore the comma + default: + return MalformedObjectError + } + } + + // Skip to the next token after the comma + if off := nextToken(data[offset:]); off == -1 { + return MalformedArrayError + } else { + offset += off + } + } + + return MalformedObjectError // we shouldn't get here; it's expected that we will return via finding the ending brace +} + +// GetUnsafeString returns the value retrieved by `Get`, use creates string without memory allocation by mapping string to slice memory. It does not handle escape symbols. +func GetUnsafeString(data []byte, keys ...string) (val string, err error) { + v, _, _, e := Get(data, keys...) + + if e != nil { + return "", e + } + + return bytesToString(&v), nil +} + +// GetString returns the value retrieved by `Get`, cast to a string if possible, trying to properly handle escape and utf8 symbols +// If key data type do not match, it will return an error. +func GetString(data []byte, keys ...string) (val string, err error) { + v, t, _, e := Get(data, keys...) + + if e != nil { + return "", e + } + + if t != String { + return "", fmt.Errorf("Value is not a string: %s", string(v)) + } + + // If no escapes return raw content + if bytes.IndexByte(v, '\\') == -1 { + return string(v), nil + } + + return ParseString(v) +} + +// GetFloat returns the value retrieved by `Get`, cast to a float64 if possible. +// The offset is the same as in `Get`. +// If key data type do not match, it will return an error. +func GetFloat(data []byte, keys ...string) (val float64, err error) { + v, t, _, e := Get(data, keys...) + + if e != nil { + return 0, e + } + + if t != Number { + return 0, fmt.Errorf("Value is not a number: %s", string(v)) + } + + return ParseFloat(v) +} + +// GetInt returns the value retrieved by `Get`, cast to a int64 if possible. +// If key data type do not match, it will return an error. +func GetInt(data []byte, keys ...string) (val int64, err error) { + v, t, _, e := Get(data, keys...) + + if e != nil { + return 0, e + } + + if t != Number { + return 0, fmt.Errorf("Value is not a number: %s", string(v)) + } + + return ParseInt(v) +} + +// GetBoolean returns the value retrieved by `Get`, cast to a bool if possible. +// The offset is the same as in `Get`. +// If key data type do not match, it will return error. +func GetBoolean(data []byte, keys ...string) (val bool, err error) { + v, t, _, e := Get(data, keys...) + + if e != nil { + return false, e + } + + if t != Boolean { + return false, fmt.Errorf("Value is not a boolean: %s", string(v)) + } + + return ParseBoolean(v) +} + +// ParseBoolean parses a Boolean ValueType into a Go bool (not particularly useful, but here for completeness) +func ParseBoolean(b []byte) (bool, error) { + switch { + case bytes.Equal(b, trueLiteral): + return true, nil + case bytes.Equal(b, falseLiteral): + return false, nil + default: + return false, MalformedValueError + } +} + +// ParseString parses a String ValueType into a Go string (the main parsing work is unescaping the JSON string) +func ParseString(b []byte) (string, error) { + var stackbuf [unescapeStackBufSize]byte // stack-allocated array for allocation-free unescaping of small strings + if bU, err := Unescape(b, stackbuf[:]); err != nil { + return "", MalformedValueError + } else { + return string(bU), nil + } +} + +// ParseNumber parses a Number ValueType into a Go float64 +func ParseFloat(b []byte) (float64, error) { + if v, err := parseFloat(&b); err != nil { + return 0, MalformedValueError + } else { + return v, nil + } +} + +// ParseInt parses a Number ValueType into a Go int64 +func ParseInt(b []byte) (int64, error) { + if v, ok, overflow := parseInt(b); !ok { + if overflow { + return 0, OverflowIntegerError + } + return 0, MalformedValueError + } else { + return v, nil + } +} diff --git a/vendor/github.com/creasty/defaults/.gitignore b/vendor/github.com/creasty/defaults/.gitignore new file mode 100644 index 000000000..e43b0f988 --- /dev/null +++ b/vendor/github.com/creasty/defaults/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/vendor/github.com/creasty/defaults/LICENSE b/vendor/github.com/creasty/defaults/LICENSE new file mode 100644 index 000000000..1483dd2d8 --- /dev/null +++ b/vendor/github.com/creasty/defaults/LICENSE @@ -0,0 +1,22 @@ +Copyright (c) 2017-present Yuki Iwanaga + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/vendor/github.com/creasty/defaults/Makefile b/vendor/github.com/creasty/defaults/Makefile new file mode 100644 index 000000000..404212a2e --- /dev/null +++ b/vendor/github.com/creasty/defaults/Makefile @@ -0,0 +1,29 @@ +SHELL := /bin/bash -eu -o pipefail + +GO_TEST_FLAGS := -v + +PACKAGE_DIRS := $(shell go list ./... 2> /dev/null | grep -v /vendor/) +SRC_FILES := $(shell find . -name '*.go' -not -path './vendor/*') + + +# Tasks +#----------------------------------------------- +.PHONY: lint +lint: + @gofmt -e -d -s $(SRC_FILES) | awk '{ e = 1; print $0 } END { if (e) exit(1) }' + @golangci-lint --disable errcheck,unused run + +.PHONY: test +test: lint + @go test $(GO_TEST_FLAGS) $(PACKAGE_DIRS) + +.PHONY: ci-test +ci-test: lint + @echo > coverage.txt + @for d in $(PACKAGE_DIRS); do \ + go test -coverprofile=profile.out -covermode=atomic -race -v $$d; \ + if [ -f profile.out ]; then \ + cat profile.out >> coverage.txt; \ + rm profile.out; \ + fi; \ + done diff --git a/vendor/github.com/creasty/defaults/README.md b/vendor/github.com/creasty/defaults/README.md new file mode 100644 index 000000000..0efdc4485 --- /dev/null +++ b/vendor/github.com/creasty/defaults/README.md @@ -0,0 +1,75 @@ +defaults +======== + +[![CircleCI](https://circleci.com/gh/creasty/defaults/tree/master.svg?style=svg)](https://circleci.com/gh/creasty/defaults/tree/master) +[![codecov](https://codecov.io/gh/creasty/defaults/branch/master/graph/badge.svg)](https://codecov.io/gh/creasty/defaults) +[![GitHub release](https://img.shields.io/github/release/creasty/defaults.svg)](https://github.com/creasty/defaults/releases) +[![License](https://img.shields.io/github/license/creasty/defaults.svg)](./LICENSE) + +Initialize structs with default values + +- Supports almost all kind of types + - Scalar types + - `int/8/16/32/64`, `uint/8/16/32/64`, `float32/64` + - `uintptr`, `bool`, `string` + - Complex types + - `map`, `slice`, `struct` + - Nested types + - `map[K1]map[K2]Struct`, `[]map[K1]Struct[]` + - Aliased types + - `time.Duration` + - e.g., `type Enum string` + - Pointer types + - e.g., `*SampleStruct`, `*int` +- Recursively initializes fields in a struct +- Dynamically sets default values by [`defaults.Setter`](./setter.go) interface +- Preserves non-initial values from being reset with a default value + + +Usage +----- + +```go +type Gender string + +type Sample struct { + Name string `default:"John Smith"` + Age int `default:"27"` + Gender Gender `default:"m"` + + Slice []string `default:"[]"` + SliceByJSON []int `default:"[1, 2, 3]"` // Supports JSON + + Map map[string]int `default:"{}"` + MapByJSON map[string]int `default:"{\"foo\": 123}"` + MapOfStruct map[string]OtherStruct + MapOfPtrStruct map[string]*OtherStruct + MapOfStructWithTag map[string]OtherStruct `default:"{\"Key1\": {\"Foo\":123}}"` + + Struct OtherStruct `default:"{}"` + StructPtr *OtherStruct `default:"{\"Foo\": 123}"` + + NoTag OtherStruct // Recurses into a nested struct by default + OptOut OtherStruct `default:"-"` // Opt-out +} + +type OtherStruct struct { + Hello string `default:"world"` // Tags in a nested struct also work + Foo int `default:"-"` + Random int `default:"-"` +} + +// SetDefaults implements defaults.Setter interface +func (s *OtherStruct) SetDefaults() { + if defaults.CanUpdate(s.Random) { // Check if it's a zero value (recommended) + s.Random = rand.Int() // Set a dynamic value + } +} +``` + +```go +obj := &Sample{} +if err := defaults.Set(obj); err != nil { + panic(err) +} +``` diff --git a/vendor/github.com/creasty/defaults/defaults.go b/vendor/github.com/creasty/defaults/defaults.go new file mode 100644 index 000000000..b5e7eb9c4 --- /dev/null +++ b/vendor/github.com/creasty/defaults/defaults.go @@ -0,0 +1,244 @@ +package defaults + +import ( + "encoding" + "encoding/json" + "errors" + "reflect" + "strconv" + "time" +) + +var ( + errInvalidType = errors.New("not a struct pointer") +) + +const ( + fieldName = "default" +) + +// Set initializes members in a struct referenced by a pointer. +// Maps and slices are initialized by `make` and other primitive types are set with default values. +// `ptr` should be a struct pointer +func Set(ptr interface{}) error { + if reflect.TypeOf(ptr).Kind() != reflect.Ptr { + return errInvalidType + } + + v := reflect.ValueOf(ptr).Elem() + t := v.Type() + + if t.Kind() != reflect.Struct { + return errInvalidType + } + + for i := 0; i < t.NumField(); i++ { + if defaultVal := t.Field(i).Tag.Get(fieldName); defaultVal != "-" { + if err := setField(v.Field(i), defaultVal); err != nil { + return err + } + } + } + callSetter(ptr) + return nil +} + +// MustSet function is a wrapper of Set function +// It will call Set and panic if err not equals nil. +func MustSet(ptr interface{}) { + if err := Set(ptr); err != nil { + panic(err) + } +} + +func setField(field reflect.Value, defaultVal string) error { + if !field.CanSet() { + return nil + } + + if !shouldInitializeField(field, defaultVal) { + return nil + } + + isInitial := isInitialValue(field) + if isInitial { + if unmarshalByInterface(field, defaultVal) { + return nil + } + + switch field.Kind() { + case reflect.Bool: + if val, err := strconv.ParseBool(defaultVal); err == nil { + field.Set(reflect.ValueOf(val).Convert(field.Type())) + } + case reflect.Int: + if val, err := strconv.ParseInt(defaultVal, 0, strconv.IntSize); err == nil { + field.Set(reflect.ValueOf(int(val)).Convert(field.Type())) + } + case reflect.Int8: + if val, err := strconv.ParseInt(defaultVal, 0, 8); err == nil { + field.Set(reflect.ValueOf(int8(val)).Convert(field.Type())) + } + case reflect.Int16: + if val, err := strconv.ParseInt(defaultVal, 0, 16); err == nil { + field.Set(reflect.ValueOf(int16(val)).Convert(field.Type())) + } + case reflect.Int32: + if val, err := strconv.ParseInt(defaultVal, 0, 32); err == nil { + field.Set(reflect.ValueOf(int32(val)).Convert(field.Type())) + } + case reflect.Int64: + if val, err := time.ParseDuration(defaultVal); err == nil { + field.Set(reflect.ValueOf(val).Convert(field.Type())) + } else if val, err := strconv.ParseInt(defaultVal, 0, 64); err == nil { + field.Set(reflect.ValueOf(val).Convert(field.Type())) + } + case reflect.Uint: + if val, err := strconv.ParseUint(defaultVal, 0, strconv.IntSize); err == nil { + field.Set(reflect.ValueOf(uint(val)).Convert(field.Type())) + } + case reflect.Uint8: + if val, err := strconv.ParseUint(defaultVal, 0, 8); err == nil { + field.Set(reflect.ValueOf(uint8(val)).Convert(field.Type())) + } + case reflect.Uint16: + if val, err := strconv.ParseUint(defaultVal, 0, 16); err == nil { + field.Set(reflect.ValueOf(uint16(val)).Convert(field.Type())) + } + case reflect.Uint32: + if val, err := strconv.ParseUint(defaultVal, 0, 32); err == nil { + field.Set(reflect.ValueOf(uint32(val)).Convert(field.Type())) + } + case reflect.Uint64: + if val, err := strconv.ParseUint(defaultVal, 0, 64); err == nil { + field.Set(reflect.ValueOf(val).Convert(field.Type())) + } + case reflect.Uintptr: + if val, err := strconv.ParseUint(defaultVal, 0, strconv.IntSize); err == nil { + field.Set(reflect.ValueOf(uintptr(val)).Convert(field.Type())) + } + case reflect.Float32: + if val, err := strconv.ParseFloat(defaultVal, 32); err == nil { + field.Set(reflect.ValueOf(float32(val)).Convert(field.Type())) + } + case reflect.Float64: + if val, err := strconv.ParseFloat(defaultVal, 64); err == nil { + field.Set(reflect.ValueOf(val).Convert(field.Type())) + } + case reflect.String: + field.Set(reflect.ValueOf(defaultVal).Convert(field.Type())) + + case reflect.Slice: + ref := reflect.New(field.Type()) + ref.Elem().Set(reflect.MakeSlice(field.Type(), 0, 0)) + if defaultVal != "" && defaultVal != "[]" { + if err := json.Unmarshal([]byte(defaultVal), ref.Interface()); err != nil { + return err + } + } + field.Set(ref.Elem().Convert(field.Type())) + case reflect.Map: + ref := reflect.New(field.Type()) + ref.Elem().Set(reflect.MakeMap(field.Type())) + if defaultVal != "" && defaultVal != "{}" { + if err := json.Unmarshal([]byte(defaultVal), ref.Interface()); err != nil { + return err + } + } + field.Set(ref.Elem().Convert(field.Type())) + case reflect.Struct: + if defaultVal != "" && defaultVal != "{}" { + if err := json.Unmarshal([]byte(defaultVal), field.Addr().Interface()); err != nil { + return err + } + } + case reflect.Ptr: + field.Set(reflect.New(field.Type().Elem())) + } + } + + switch field.Kind() { + case reflect.Ptr: + if isInitial || field.Elem().Kind() == reflect.Struct { + setField(field.Elem(), defaultVal) + callSetter(field.Interface()) + } + case reflect.Struct: + if err := Set(field.Addr().Interface()); err != nil { + return err + } + case reflect.Slice: + for j := 0; j < field.Len(); j++ { + if err := setField(field.Index(j), defaultVal); err != nil { + return err + } + } + case reflect.Map: + for _, e := range field.MapKeys() { + var v = field.MapIndex(e) + + switch v.Kind() { + case reflect.Ptr: + switch v.Elem().Kind() { + case reflect.Struct, reflect.Slice, reflect.Map: + if err := setField(v.Elem(), ""); err != nil { + return err + } + } + case reflect.Struct, reflect.Slice, reflect.Map: + ref := reflect.New(v.Type()) + ref.Elem().Set(v) + if err := setField(ref.Elem(), ""); err != nil { + return err + } + field.SetMapIndex(e, ref.Elem().Convert(v.Type())) + } + } + } + + return nil +} + +func unmarshalByInterface(field reflect.Value, defaultVal string) bool { + asText, ok := field.Addr().Interface().(encoding.TextUnmarshaler) + if ok && defaultVal != "" { + // if field implements encode.TextUnmarshaler, try to use it before decode by kind + if err := asText.UnmarshalText([]byte(defaultVal)); err == nil { + return true + } + } + asJSON, ok := field.Addr().Interface().(json.Unmarshaler) + if ok && defaultVal != "" && defaultVal != "{}" && defaultVal != "[]" { + // if field implements json.Unmarshaler, try to use it before decode by kind + if err := asJSON.UnmarshalJSON([]byte(defaultVal)); err == nil { + return true + } + } + return false +} + +func isInitialValue(field reflect.Value) bool { + return reflect.DeepEqual(reflect.Zero(field.Type()).Interface(), field.Interface()) +} + +func shouldInitializeField(field reflect.Value, tag string) bool { + switch field.Kind() { + case reflect.Struct: + return true + case reflect.Ptr: + if !field.IsNil() && field.Elem().Kind() == reflect.Struct { + return true + } + case reflect.Slice: + return field.Len() > 0 || tag != "" + case reflect.Map: + return field.Len() > 0 || tag != "" + } + + return tag != "" +} + +// CanUpdate returns true when the given value is an initial value of its type +func CanUpdate(v interface{}) bool { + return isInitialValue(reflect.ValueOf(v)) +} diff --git a/vendor/github.com/creasty/defaults/setter.go b/vendor/github.com/creasty/defaults/setter.go new file mode 100644 index 000000000..1f64aa659 --- /dev/null +++ b/vendor/github.com/creasty/defaults/setter.go @@ -0,0 +1,12 @@ +package defaults + +// Setter is an interface for setting default values +type Setter interface { + SetDefaults() +} + +func callSetter(v interface{}) { + if ds, ok := v.(Setter); ok { + ds.SetDefaults() + } +} diff --git a/vendor/github.com/gertd/go-pluralize/.gitignore b/vendor/github.com/gertd/go-pluralize/.gitignore new file mode 100644 index 000000000..50b430e83 --- /dev/null +++ b/vendor/github.com/gertd/go-pluralize/.gitignore @@ -0,0 +1,22 @@ +# Binaries for programs and plugins +*.exe +*.dll +*.so +*.dylib + +# Test binary, build with `go test -c` +*.test + +# Log files +*.log + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# exclude binery files +pdx +debug + +# exclude directories +bin/ +release/ diff --git a/vendor/github.com/gertd/go-pluralize/.travis.yml b/vendor/github.com/gertd/go-pluralize/.travis.yml new file mode 100644 index 000000000..3e0ee5017 --- /dev/null +++ b/vendor/github.com/gertd/go-pluralize/.travis.yml @@ -0,0 +1,29 @@ +language: go +go: +- 1.14.3 +cache: + directories: + - "$HOME/local" +script: +- make +before_install: +install: +before_deploy: +- make VERSION=${TRAVIS_TAG} release -j3 +- ls release/ +deploy: + provider: releases + api_key: + secure: 5tGm98IBWwiIwsZSRFNWSSP85IHAZrysGu1Z5od2N9n7crf1Q2RmNLLaDd9VMJc9zd9QDQb68BJBe8W+XT4XKAtcE6HRrgDveV5JpBIdAYQOqN9CBqEb0WEjYJeypoRzDTBfIayJnaZs3uNMcJm9e063ezhwOevflxbBOkBgVycVjA5kW8da5lVj0HnbTraUsIPjkpFDwyqgaVxCIKTe9eUwEUbKHBW8Sfp1b6sYLLiZrLyvAMvorMcnTdo0UfymwXxXlVOiDhTbiF6zGlW7aZ9uhxJRay3GIfFgqz8qcK1GIfG3HKl3wDtcWIGr3lNEsGTeBVr+55LD1gb+sCbMz3+mH4xK6d+LVuACmdHei/34WhXy0JXsIXthYnH/VbGLgELlL6UObat5Kjo7Db7Je5WcJuJ9GBGZ9o1MGfFG835QIYc3TMrFbnXrvAC7iefNKs/jr4Bdgapt7N0h9B/Ra5VUxZBmPveOC4tk3Km3j2ORau3rO4QvXTSuvvYXMLDENNwQlaDT5IFlAANLmcWY1vN16UoEXdPnOQyE90nsvpIQYnFGqLxgEJYJmp1br+U5ldKHIvnYke6h/f6FGDPsbIspxj6jSoITz7jHh3m8vEMuIl4pd1sreC5eQULJNZIZw786MVES2CSxsBsLB1nRZfE+uQu8B1vPRfnFvNBZ83Q= + file_glob: true + file: release/**/*.zip + skip_cleanup: true + overwrite: true + on: + tags: true +notifications: + email: false +env: + global: + - PATH=$PATH:$HOME/local/bin + - GO111MODULE=on diff --git a/vendor/github.com/gertd/go-pluralize/LICENSE b/vendor/github.com/gertd/go-pluralize/LICENSE new file mode 100644 index 000000000..f002d157e --- /dev/null +++ b/vendor/github.com/gertd/go-pluralize/LICENSE @@ -0,0 +1,23 @@ +MIT License + +Copyright (c) 2019 Gert Drapers + +Copyright (c) 2013 Blake Embrey (hello@blakeembrey.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/vendor/github.com/gertd/go-pluralize/Makefile b/vendor/github.com/gertd/go-pluralize/Makefile new file mode 100644 index 000000000..30a80996c --- /dev/null +++ b/vendor/github.com/gertd/go-pluralize/Makefile @@ -0,0 +1,151 @@ +SHELL := $(shell which bash) + +## BOF define block + +BINARIES := pluralize +BINARY = $(word 1, $@) + +PLATFORMS := windows linux darwin +PLATFORM = $(word 1, $@) + +ROOT_DIR := $(shell git rev-parse --show-toplevel) +BIN_DIR := $(ROOT_DIR)/bin +REL_DIR := $(ROOT_DIR)/release +SRC_DIR := $(ROOT_DIR)/cmd +INC_DIR := $(ROOT_DIR)/include +TMP_DIR := $(ROOT_DIR)/tmp + +VERSION :=`git describe --tags 2>/dev/null` +COMMIT :=`git rev-parse --short HEAD 2>/dev/null` +DATE :=`date "+%FT%T%z"` + +LDBASE := github.com/gertd/go-pluralize/pkg/version +LDFLAGS := -ldflags "-w -s -X $(LDBASE).ver=${VERSION} -X $(LDBASE).date=${DATE} -X $(LDBASE).commit=${COMMIT}" + +GOARCH ?= amd64 +GOOS ?= $(shell go env GOOS) + +LINTER := $(BIN_DIR)/golangci-lint +LINTVERSION:= v1.27.0 + +TESTRUNNER := $(BIN_DIR)/gotestsum +TESTVERSION:= v0.5.0 + +PROTOC := $(BIN_DIR)/protoc +PROTOCVER := 3.12.3 + +NO_COLOR :=\033[0m +OK_COLOR :=\033[32;01m +ERR_COLOR :=\033[31;01m +WARN_COLOR :=\033[36;01m +ATTN_COLOR :=\033[33;01m + +## EOF define block + +.PHONY: all +all: deps gen build test lint + +deps: + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @GO111MODULE=on go mod download + +.PHONY: gen +gen: deps $(BIN_DIR) + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @go generate ./... + +.PHONY: dobuild +dobuild: + @echo -e "$(ATTN_COLOR)==> $@ $(B) GOOS=$(P) GOARCH=$(GOARCH) VERSION=$(VERSION) COMMIT=$(COMMIT) DATE=$(DATE) $(NO_COLOR)" + @GOOS=$(P) GOARCH=$(GOARCH) GO111MODULE=on go build $(LDFLAGS) -o $(T)/$(P)-$(GOARCH)/$(B)$(if $(findstring $(P),windows),".exe","") $(SRC_DIR)/$(B) +ifneq ($(P),windows) + @chmod +x $(T)/$(P)-$(GOARCH)/$(B) +endif + +.PHONY: build +build: $(BIN_DIR) deps + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @for b in ${BINARIES}; \ + do \ + $(MAKE) dobuild B=$${b} P=${GOOS} T=${BIN_DIR}; \ + done + +.PHONY: doinstall +doinstall: + @echo -e "$(ATTN_COLOR)==> $@ $(B) GOOS=$(P) GOARCH=$(GOARCH) VERSION=$(VERSION) COMMIT=$(COMMIT) DATE=$(DATE) $(NO_COLOR)" + @GOOS=$(P) GOARCH=$(GOARCH) GO111MODULE=on go install $(LDFLAGS) $(SRC_DIR)/$(B) + +.PHONY: install +install: + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @for b in ${BINARIES}; \ + do \ + $(MAKE) doinstall B=$${b} P=${GOOS}; \ + done + +.PHONY: dorelease +dorelease: + @echo -e "$(ATTN_COLOR)==> $@ build GOOS=$(P) GOARCH=$(GOARCH) VERSION=$(VERSION) COMMIT=$(COMMIT) DATE=$(DATE) $(NO_COLOR)" + @GOOS=$(P) GOARCH=$(GOARCH) GO111MODULE=on go build $(LDFLAGS) -o $(T)/$(P)-$(GOARCH)/$(B)$(if $(findstring $(P),windows),".exe","") $(SRC_DIR)/$(B) +ifneq ($(P),windows) + @chmod +x $(T)/$(P)-$(GOARCH)/$(B) +endif + @echo -e "$(ATTN_COLOR)==> $@ zip $(B)-$(P)-$(GOARCH).zip $(NO_COLOR)" + @zip -j $(T)/$(P)-$(GOARCH)/$(B)-$(P)-$(GOARCH).zip $(T)/$(P)-$(GOARCH)/$(B)$(if $(findstring $(P),windows),".exe","") >/dev/null + +.PHONY: release +release: $(REL_DIR) + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @for b in ${BINARIES}; \ + do \ + for p in ${PLATFORMS}; \ + do \ + $(MAKE) dorelease B=$${b} P=$${p} T=${REL_DIR}; \ + done; \ + done \ + +$(TESTRUNNER): + @echo -e "$(ATTN_COLOR)==> get $@ $(NO_COLOR)" + @GOBIN=$(BIN_DIR) go get -u gotest.tools/gotestsum + +.PHONY: test +test: $(TESTRUNNER) + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @CGO_ENABLED=0 $(BIN_DIR)/gotestsum --format short-verbose -- -count=1 -v $(ROOT_DIR)/... + +$(LINTER): + @echo -e "$(ATTN_COLOR)==> get $@ $(NO_COLOR)" + @curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s $(LINTVERSION) + +.PHONY: lint +lint: $(LINTER) + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @CGO_ENABLED=0 $(LINTER) run --enable-all + @echo -e "$(NO_COLOR)\c" + +.PHONY: doclean +doclean: + @echo -e "$(ATTN_COLOR)==> $@ $(B) GOOS=$(P) $(NO_COLOR)" + @if [ -a $(GOPATH)/bin/$(B)$(if $(findstring $(P),windows),".exe","") ];\ + then \ + rm $(GOPATH)/bin/$(B)$(if $(findstring $(P),windows),".exe",""); \ + fi + +.PHONY: clean +clean: + @echo -e "$(ATTN_COLOR)==> $@ $(NO_COLOR)" + @rm -rf $(BIN_DIR) + @rm -rf $(REL_DIR) + @go clean + @for b in ${BINARIES}; \ + do \ + $(MAKE) doclean B=$${b} P=${GOOS}; \ + done + +$(REL_DIR): + @echo -e "$(ATTN_COLOR)==> create REL_DIR $(REL_DIR) $(NO_COLOR)" + @mkdir -p $(REL_DIR) + +$(BIN_DIR): + @echo -e "$(ATTN_COLOR)==> create BIN_DIR $(BIN_DIR) $(NO_COLOR)" + @mkdir -p $(BIN_DIR) diff --git a/vendor/github.com/gertd/go-pluralize/README.md b/vendor/github.com/gertd/go-pluralize/README.md new file mode 100644 index 000000000..0a41c3ce7 --- /dev/null +++ b/vendor/github.com/gertd/go-pluralize/README.md @@ -0,0 +1,106 @@ +# go-pluralize +[![Build Status](https://travis-ci.org/gertd/go-pluralize.svg?branch=master)](https://travis-ci.org/gertd/go-pluralize) +[![Go Report Card](https://goreportcard.com/badge/github.com/gertd/go-pluralize)](https://goreportcard.com/report/github.com/gertd/go-pluralize) +[![GoDoc](https://godoc.org/github.com/gertd/go-pluralize?status.svg)](https://godoc.org/github.com/gertd/go-pluralize) + +Pluralize and singularize any word + +# Acknowledgements +> The go-pluralize module is the Golang adaptation of the great work from [Blake Embrey](https://www.npmjs.com/~blakeembrey) and other contributors who created and maintain the NPM JavaScript [pluralize](https://www.npmjs.com/package/pluralize) package. +> The originating Javascript implementation can be found on https://github.com/blakeembrey/pluralize +> +> Without their great work this module would have taken a lot more effort, **thank you all**! + +# Version mapping + +The latest go-pluralize version is compatible with [pluralize](https://www.npmjs.com/package/pluralize) version 8.0.0 commit [#36f03cd](https://github.com/blakeembrey/pluralize/commit/36f03cd2d573fa6d23e12e1529fa4627e2af74b4) + +| go-pluralize version | NPM Pluralize Package version | +| ------------- | ------------- | +| 0.2.0 - Jan 25, 2022 [v0.2.0](https://github.com/gertd/go-pluralize/releases/tag/v0.2.0) | 8.0.0 - Oct 6, 2021 [#36f03cd](https://github.com/blakeembrey/pluralize/commit/36f03cd2d573fa6d23e12e1529fa4627e2af74b4) +| 0.1.7 - Jun 23, 2020 [v0.1.7](https://github.com/gertd/go-pluralize/releases/tag/v0.1.7) | 8.0.0 - Mar 14, 2020 [#e507706](https://github.com/blakeembrey/pluralize/commit/e507706be779612c06ebfd6043163e063e791d79) +| 0.1.2 - Apr 1, 2020 [v0.1.2](https://github.com/gertd/go-pluralize/releases/tag/v0.1.2) | 8.0.0 - Mar 14, 2020 [#e507706](https://github.com/blakeembrey/pluralize/commit/e507706be779612c06ebfd6043163e063e791d79) +| 0.1.1 - Sep 15, 2019 [v0.1.1](https://github.com/gertd/go-pluralize/releases/tag/v0.1.1) | 8.0.0 - Aug 27, 2019 [#abb3991](https://github.com/blakeembrey/pluralize/commit/abb399111aedd1d62dd418d7e0217d85f5bf22c9) +| 0.1.0 - Jun 12, 2019 [v0.1.0](https://github.com/gertd/go-pluralize/releases/tag/v0.1.0) | 8.0.0 - May 24, 2019 [#0265e4d](https://github.com/blakeembrey/pluralize/commit/0265e4d131ecad8e11c420fa4be98b75dc92c33d) + +# Installation + +To install the go module: + + go get -u github.com/gertd/go-pluralize + +To lock down a specific the version: + + go get -u github.com/gertd/go-pluralize@v0.2.0 + +Download the sources and binaries from the latest [release](https://github.com/gertd/go-pluralize/releases/latest) + + +# Usage + +## Code + import pluralize "github.com/gertd/go-pluralize" + + word := "Empire" + + pluralize := pluralize.NewClient() + + fmt.Printf("IsPlural(%s) => %t\n", input, pluralize.IsPlural(word)) + fmt.Printf("IsSingular(%s) => %t\n", input, pluralize.IsSingular(word)) + fmt.Printf("Plural(%s) => %s\n", input, pluralize.Plural(word)) + fmt.Printf("Singular(%s) => %s\n", input, pluralize.Singular(word)) + +## Result + IsPlural(Empire) => false + IsSingular(Empire) => true + Plural(Empire) => Empires + Singular(Empire) => Empire + + +# Pluralize Command Line + +## Installation + go get -x github.com/gertd/go-pluralize/cmd/pluralize + + + + +## Usage + +### Help + pluralize -help + Usage of ./bin/pluralize: + -cmd string + command [All|IsPlural|IsSingular|Plural|Singular] (default "All") + -version + display version info + -word string + input value + +### Word with All Commands + pluralize -word Empire + + IsPlural(Empire) => false + IsSingular(Empire) => true + Plural(Empire) => Empires + Singular(Empire) => Empire + +### Is Word Plural? + pluralize -word Cactus -cmd IsPlural + + IsPlural(Cactus) => false + +### Is Word Singular? + pluralize -word Cacti -cmd IsSingular + + IsSingular(Cacti) => false + +### Word Make Plural + pluralize -word Cactus -cmd Plural + + Plural(Cactus) => Cacti + +### Word Make Singular + pluralize -word Cacti -cmd Singular + + Singular(Cacti) => Cactus diff --git a/vendor/github.com/gertd/go-pluralize/pluralize.go b/vendor/github.com/gertd/go-pluralize/pluralize.go new file mode 100644 index 000000000..9d2144479 --- /dev/null +++ b/vendor/github.com/gertd/go-pluralize/pluralize.go @@ -0,0 +1,500 @@ +package pluralize + +import ( + "fmt" + "regexp" + "strconv" + "strings" +) + +// Rule -- pluralize rule expression and replacement value. +type Rule struct { + expression *regexp.Regexp + replacement string +} + +// Client -- pluralize client. +type Client struct { + pluralRules []Rule + singularRules []Rule + uncountables map[string]bool + irregularSingles map[string]string + irregularPlurals map[string]string + interpolateExpr *regexp.Regexp +} + +// NewClient - pluralization client factory method. +func NewClient() *Client { + client := Client{} + client.init() + + return &client +} + +func (c *Client) init() { + c.pluralRules = make([]Rule, 0) + c.singularRules = make([]Rule, 0) + c.uncountables = make(map[string]bool) + c.irregularSingles = make(map[string]string) + c.irregularPlurals = make(map[string]string) + + c.loadIrregularRules() + c.loadPluralizationRules() + c.loadSingularizationRules() + c.loadUncountableRules() + c.interpolateExpr = regexp.MustCompile(`\$(\d{1,2})`) +} + +// Pluralize -- Pluralize or singularize a word based on the passed in count. +// word: the word to pluralize +// count: how many of the word exist +// inclusive: whether to prefix with the number (e.g. 3 ducks) +func (c *Client) Pluralize(word string, count int, inclusive bool) string { + pluralized := func() func(string) string { + if count == 1 { + return c.Singular + } + + return c.Plural + } + + if inclusive { + return fmt.Sprintf("%d %s", count, pluralized()(word)) + } + + return pluralized()(word) +} + +// Plural -- Pluralize a word. +func (c *Client) Plural(word string) string { + return c.replaceWord(c.irregularSingles, c.irregularPlurals, c.pluralRules)(word) +} + +// IsPlural -- Check if a word is plural. +func (c *Client) IsPlural(word string) bool { + return c.checkWord(c.irregularSingles, c.irregularPlurals, c.pluralRules)(word) +} + +// Singular -- Singularize a word. +func (c *Client) Singular(word string) string { + return c.replaceWord(c.irregularPlurals, c.irregularSingles, c.singularRules)(word) +} + +// IsSingular -- Check if a word is singular. +func (c *Client) IsSingular(word string) bool { + return c.checkWord(c.irregularPlurals, c.irregularSingles, c.singularRules)(word) +} + +// AddPluralRule -- Add a pluralization rule to the collection. +func (c *Client) AddPluralRule(rule string, replacement string) { + c.pluralRules = append(c.pluralRules, Rule{sanitizeRule(rule), replacement}) +} + +// AddSingularRule -- Add a singularization rule to the collection. +func (c *Client) AddSingularRule(rule string, replacement string) { + c.singularRules = append(c.singularRules, Rule{sanitizeRule(rule), replacement}) +} + +// AddUncountableRule -- Add an uncountable word rule. +func (c *Client) AddUncountableRule(word string) { + if !isExpr(word) { + c.uncountables[strings.ToLower(word)] = true + return + } + + c.AddPluralRule(word, `$0`) + c.AddSingularRule(word, `$0`) +} + +// AddIrregularRule -- Add an irregular word definition. +func (c *Client) AddIrregularRule(single string, plural string) { + p := strings.ToLower(plural) + s := strings.ToLower(single) + + c.irregularSingles[s] = p + c.irregularPlurals[p] = s +} + +func (c *Client) replaceWord(replaceMap map[string]string, keepMap map[string]string, rules []Rule) func(w string) string { //nolint:lll + f := func(word string) string { + // Get the correct token and case restoration functions. + var token = strings.ToLower(word) + + // Check against the keep object map. + if _, ok := keepMap[token]; ok { + return restoreCase(word, token) + } + + // Check against the replacement map for a direct word replacement. + if replaceToken, ok := replaceMap[token]; ok { + return restoreCase(word, replaceToken) + } + + // Run all the rules against the word. + return c.sanitizeWord(token, word, rules) + } + + return f +} + +func (c *Client) checkWord(replaceMap map[string]string, keepMap map[string]string, rules []Rule) func(w string) bool { + f := func(word string) bool { + var token = strings.ToLower(word) + + if _, ok := keepMap[token]; ok { + return true + } + + if _, ok := replaceMap[token]; ok { + return false + } + + return c.sanitizeWord(token, token, rules) == token + } + + return f +} + +func (c *Client) interpolate(str string, args []string) string { + lookup := map[string]string{} + + for _, submatch := range c.interpolateExpr.FindAllStringSubmatch(str, -1) { + element, _ := strconv.Atoi(submatch[1]) + lookup[submatch[0]] = args[element] + } + + result := c.interpolateExpr.ReplaceAllStringFunc(str, func(repl string) string { + return lookup[repl] + }) + + return result +} + +func (c *Client) replace(word string, rule Rule) string { + return rule.expression.ReplaceAllStringFunc(word, func(w string) string { + match := rule.expression.FindString(word) + index := rule.expression.FindStringIndex(word)[0] + args := rule.expression.FindAllStringSubmatch(word, -1)[0] + + result := c.interpolate(rule.replacement, args) + + if match == `` { + return restoreCase(word[index-1:index], result) + } + return restoreCase(match, result) + }) +} + +func (c *Client) sanitizeWord(token string, word string, rules []Rule) string { + // If empty string + if len(token) == 0 { + return word + } + // If does not need fixup + if _, ok := c.uncountables[token]; ok { + return word + } + + // Iterate over the sanitization rules and use the first one to match. + // NOTE: iterate rules array in reverse order specific => general rules + for i := len(rules) - 1; i >= 0; i-- { + if rules[i].expression.MatchString(word) { + return c.replace(word, rules[i]) + } + } + + return word +} + +func sanitizeRule(rule string) *regexp.Regexp { + if isExpr(rule) { + return regexp.MustCompile(rule) + } + + return regexp.MustCompile(`(?i)^` + rule + `$`) +} + +func restoreCase(word string, token string) string { + // Tokens are an exact match. + if word == token { + return token + } + + // Lower cased words. E.g. "hello". + if word == strings.ToLower(word) { + return strings.ToLower(token) + } + + // Upper cased words. E.g. "WHISKY". + if word == strings.ToUpper(word) { + return strings.ToUpper(token) + } + + // Title cased words. E.g. "Title". + if word[:1] == strings.ToUpper(word[:1]) { + return strings.ToUpper(token[:1]) + strings.ToLower(token[1:]) + } + + // Lower cased words. E.g. "test". + return strings.ToLower(token) +} + +// isExpr -- helper to detect if string represents an expression by checking first character to be `(`. +func isExpr(s string) bool { + return s[:1] == `(` +} + +func (c *Client) loadIrregularRules() { //nolint:funlen + var irregularRules = []struct { + single string + plural string + }{ + // Pronouns. + {`I`, `we`}, + {`me`, `us`}, + {`he`, `they`}, + {`she`, `they`}, + {`them`, `them`}, + {`myself`, `ourselves`}, + {`yourself`, `yourselves`}, + {`itself`, `themselves`}, + {`herself`, `themselves`}, + {`himself`, `themselves`}, + {`themself`, `themselves`}, + {`is`, `are`}, + {`was`, `were`}, + {`has`, `have`}, + {`this`, `these`}, + {`that`, `those`}, + {`my`, `our`}, + {`its`, `their`}, + {`his`, `their`}, + {`her`, `their`}, + // Words ending in with a consonant and `o`. + {`echo`, `echoes`}, + {`dingo`, `dingoes`}, + {`volcano`, `volcanoes`}, + {`tornado`, `tornadoes`}, + {`torpedo`, `torpedoes`}, + // Ends with `us`. + {`genus`, `genera`}, + {`viscus`, `viscera`}, + // Ends with `ma`. + {`stigma`, `stigmata`}, + {`stoma`, `stomata`}, + {`dogma`, `dogmata`}, + {`lemma`, `lemmata`}, + {`schema`, `schemata`}, + {`anathema`, `anathemata`}, + // Other irregular rules. + {`ox`, `oxen`}, + {`axe`, `axes`}, + {`die`, `dice`}, + {`yes`, `yeses`}, + {`foot`, `feet`}, + {`eave`, `eaves`}, + {`goose`, `geese`}, + {`tooth`, `teeth`}, + {`quiz`, `quizzes`}, + {`human`, `humans`}, + {`proof`, `proofs`}, + {`carve`, `carves`}, + {`valve`, `valves`}, + {`looey`, `looies`}, + {`thief`, `thieves`}, + {`groove`, `grooves`}, + {`pickaxe`, `pickaxes`}, + {`passerby`, `passersby`}, + {`canvas`, `canvases`}, + {`sms`, `sms`}, + } + + for _, r := range irregularRules { + c.AddIrregularRule(r.single, r.plural) + } +} + +func (c *Client) loadPluralizationRules() { + var pluralizationRules = []struct { + rule string + replacement string + }{ + {`(?i)s?$`, `s`}, + {`(?i)[^[:ascii:]]$`, `$0`}, + {`(?i)([^aeiou]ese)$`, `$1`}, + {`(?i)(ax|test)is$`, `$1es`}, + {`(?i)(alias|[^aou]us|t[lm]as|gas|ris)$`, `$1es`}, + {`(?i)(e[mn]u)s?$`, `$1s`}, + {`(?i)([^l]ias|[aeiou]las|[ejzr]as|[iu]am)$`, `$1`}, + {`(?i)(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$`, `$1i`}, //nolint:lll,misspell + {`(?i)(alumn|alg|vertebr)(?:a|ae)$`, `$1ae`}, + {`(?i)(seraph|cherub)(?:im)?$`, `$1im`}, + {`(?i)(her|at|gr)o$`, `$1oes`}, + {`(?i)(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|automat|quor)(?:a|um)$`, `$1a`}, //nolint:lll,misspell + {`(?i)(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)(?:a|on)$`, `$1a`}, + {`(?i)sis$`, `ses`}, + {`(?i)(?:(kni|wi|li)fe|(ar|l|ea|eo|oa|hoo)f)$`, `$1$2ves`}, + {`(?i)([^aeiouy]|qu)y$`, `$1ies`}, + {`(?i)([^ch][ieo][ln])ey$`, `$1ies`}, + {`(?i)(x|ch|ss|sh|zz)$`, `$1es`}, + {`(?i)(matr|cod|mur|sil|vert|ind|append)(?:ix|ex)$`, `$1ices`}, + {`(?i)\b((?:tit)?m|l)(?:ice|ouse)$`, `$1ice`}, + {`(?i)(pe)(?:rson|ople)$`, `$1ople`}, + {`(?i)(child)(?:ren)?$`, `$1ren`}, + {`(?i)eaux$`, `$0`}, + {`(?i)m[ae]n$`, `men`}, + {`thou`, `you`}, + } + + for _, r := range pluralizationRules { + c.AddPluralRule(r.rule, r.replacement) + } +} + +func (c *Client) loadSingularizationRules() { + var singularizationRules = []struct { + rule string + replacement string + }{ + {`(?i)s$`, ``}, + {`(?i)(ss)$`, `$1`}, + {`(?i)(wi|kni|(?:after|half|high|low|mid|non|night|[^\w]|^)li)ves$`, `$1fe`}, + {`(?i)(ar|(?:wo|[ae])l|[eo][ao])ves$`, `$1f`}, + {`(?i)ies$`, `y`}, + {`(?i)(dg|ss|ois|lk|ok|wn|mb|th|ch|ec|oal|is|ck|ix|sser|ts|wb)ies$`, `$1ie`}, + {`(?i)\b(l|(?:neck|cross|hog|aun)?t|coll|faer|food|gen|goon|group|hipp|junk|vegg|(?:pork)?p|charl|calor|cut)ies$`, `$1ie`}, //nolint:lll + {`(?i)\b(mon|smil)ies$`, `$1ey`}, + {`(?i)\b((?:tit)?m|l)ice$`, `$1ouse`}, + {`(?i)(seraph|cherub)im$`, `$1`}, + {`(?i)(x|ch|ss|sh|zz|tto|go|cho|alias|[^aou]us|t[lm]as|gas|(?:her|at|gr)o|[aeiou]ris)(?:es)?$`, `$1`}, + {`(?i)(analy|diagno|parenthe|progno|synop|the|empha|cri|ne)(?:sis|ses)$`, `$1sis`}, + {`(?i)(movie|twelve|abuse|e[mn]u)s$`, `$1`}, + {`(?i)(test)(?:is|es)$`, `$1is`}, + {`(?i)(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$`, `$1us`}, //nolint:lll,misspell + {`(?i)(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|quor)a$`, `$1um`}, //nolint:lll,misspell + {`(?i)(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)a$`, `$1on`}, + {`(?i)(alumn|alg|vertebr)ae$`, `$1a`}, + {`(?i)(cod|mur|sil|vert|ind)ices$`, `$1ex`}, + {`(?i)(matr|append)ices$`, `$1ix`}, + {`(?i)(pe)(rson|ople)$`, `$1rson`}, + {`(?i)(child)ren$`, `$1`}, + {`(?i)(eau)x?$`, `$1`}, + {`(?i)men$`, `man`}, + } + + for _, r := range singularizationRules { + c.AddSingularRule(r.rule, r.replacement) + } +} + +func (c *Client) loadUncountableRules() { //nolint:funlen + var uncountableRules = []string{ + // Singular words with no plurals. + `adulthood`, + `advice`, + `agenda`, + `aid`, + `aircraft`, + `alcohol`, + `ammo`, + `analytics`, + `anime`, + `athletics`, + `audio`, + `bison`, + `blood`, + `bream`, + `buffalo`, + `butter`, + `carp`, + `cash`, + `chassis`, + `chess`, + `clothing`, + `cod`, + `commerce`, + `cooperation`, + `corps`, + `debris`, + `diabetes`, + `digestion`, + `elk`, + `energy`, + `equipment`, + `excretion`, + `expertise`, + `firmware`, + `flounder`, + `fun`, + `gallows`, + `garbage`, + `graffiti`, + `hardware`, + `headquarters`, + `health`, + `herpes`, + `highjinks`, + `homework`, + `housework`, + `information`, + `jeans`, + `justice`, + `kudos`, + `labour`, + `literature`, + `machinery`, + `mackerel`, + `mail`, + `media`, + `mews`, + `moose`, + `music`, + `mud`, + `manga`, + `news`, + `only`, + `personnel`, + `pike`, + `plankton`, + `pliers`, + `police`, + `pollution`, + `premises`, + `rain`, + `research`, + `rice`, + `salmon`, + `scissors`, + `series`, + `sewage`, + `shambles`, + `shrimp`, + `software`, + `staff`, + `swine`, + `tennis`, + `traffic`, + `transportation`, + `trout`, + `tuna`, + `wealth`, + `welfare`, + `whiting`, + `wildebeest`, + `wildlife`, + `you`, + // Regexes. + `(?i)pok[eé]mon$`, // + `(?i)[^aeiou]ese$`, // "chinese", "japanese" + `(?i)deer$`, // "deer", "reindeer" + `(?i)(fish)$`, // "fish", "blowfish", "angelfish" + `(?i)measles$`, // + `(?i)o[iu]s$`, // "carnivorous" + `(?i)pox$`, // "chickpox", "smallpox" + `(?i)sheep$`, // + } + + for _, w := range uncountableRules { + c.AddUncountableRule(w) + } +} diff --git a/vendor/github.com/invopop/jsonschema/.gitignore b/vendor/github.com/invopop/jsonschema/.gitignore new file mode 100644 index 000000000..8ef0e14fc --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/.gitignore @@ -0,0 +1,2 @@ +vendor/ +.idea/ diff --git a/vendor/github.com/invopop/jsonschema/.golangci.yml b/vendor/github.com/invopop/jsonschema/.golangci.yml new file mode 100644 index 000000000..3dac8a37d --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/.golangci.yml @@ -0,0 +1,70 @@ +run: + tests: true + max-same-issues: 50 + skip-dirs: + - resources + - old + skip-files: + - cmd/protopkg/main.go + +output: + print-issued-lines: false + +linters: + enable: + - gocyclo + - gocritic + - goconst + - dupl + - unconvert + - goimports + - unused + - vetshadow + - nakedret + - errcheck + - revive + - ineffassign + - goconst + - vet + - unparam + - gofmt + +linters-settings: + vet: + check-shadowing: true + use-installed-packages: true + dupl: + threshold: 100 + goconst: + min-len: 8 + min-occurrences: 3 + gocyclo: + min-complexity: 20 + gocritic: + disabled-checks: + - ifElseChain + gofmt: + rewrite-rules: + - pattern: 'interface{}' + replacement: 'any' + - pattern: 'a[b:len(a)]' + replacement: 'a[b:]' + +issues: + max-per-linter: 0 + max-same: 0 + exclude-use-default: false + exclude: + # Captured by errcheck. + - "^(G104|G204):" + # Very commonly not checked. + - 'Error return value of .(.*\.Help|.*\.MarkFlagRequired|(os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*Print(f|ln|)|os\.(Un)?Setenv). is not checked' + # Weird error only seen on Kochiku... + - "internal error: no range for" + - 'exported method `.*\.(MarshalJSON|UnmarshalJSON|URN|Payload|GoString|Close|Provides|Requires|ExcludeFromHash|MarshalText|UnmarshalText|Description|Check|Poll|Severity)` should have comment or be unexported' + - "composite literal uses unkeyed fields" + - 'declaration of "err" shadows declaration' + - "by other packages, and that stutters" + - "Potential file inclusion via variable" + - "at least one file in a package should have a package comment" + - "bad syntax for struct tag pair" diff --git a/vendor/github.com/invopop/jsonschema/COPYING b/vendor/github.com/invopop/jsonschema/COPYING new file mode 100644 index 000000000..2993ec085 --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/COPYING @@ -0,0 +1,19 @@ +Copyright (C) 2014 Alec Thomas + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/vendor/github.com/invopop/jsonschema/README.md b/vendor/github.com/invopop/jsonschema/README.md new file mode 100644 index 000000000..1a68a09cb --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/README.md @@ -0,0 +1,373 @@ +# Go JSON Schema Reflection + +[![Lint](https://github.com/invopop/jsonschema/actions/workflows/lint.yaml/badge.svg)](https://github.com/invopop/jsonschema/actions/workflows/lint.yaml) +[![Test Go](https://github.com/invopop/jsonschema/actions/workflows/test.yaml/badge.svg)](https://github.com/invopop/jsonschema/actions/workflows/test.yaml) +[![Go Report Card](https://goreportcard.com/badge/github.com/invopop/jsonschema)](https://goreportcard.com/report/github.com/invopop/jsonschema) +[![GoDoc](https://godoc.org/github.com/invopop/jsonschema?status.svg)](https://godoc.org/github.com/invopop/jsonschema) +![Latest Tag](https://img.shields.io/github/v/tag/invopop/jsonschema) + +This package can be used to generate [JSON Schemas](http://json-schema.org/latest/json-schema-validation.html) from Go types through reflection. + +- Supports arbitrarily complex types, including `interface{}`, maps, slices, etc. +- Supports json-schema features such as minLength, maxLength, pattern, format, etc. +- Supports simple string and numeric enums. +- Supports custom property fields via the `jsonschema_extras` struct tag. + +This repository is a fork of the original [jsonschema](https://github.com/alecthomas/jsonschema) by [@alecthomas](https://github.com/alecthomas). At [Invopop](https://invopop.com) we use jsonschema as a cornerstone in our [GOBL library](https://github.com/invopop/gobl), and wanted to be able to continue building and adding features without taking up Alec's time. There have been a few significant changes that probably mean this version is a not compatible with with Alec's: + +- The original was stuck on the draft-04 version of JSON Schema, we've now moved to the latest JSON Schema Draft 2020-12. +- Schema IDs are added automatically from the current Go package's URL in order to be unique, and can be disabled with the `Anonymous` option. +- Support for the `FullyQualifyTypeName` option has been removed. If you have conflicts, you should use multiple schema files with different IDs, set the `DoNotReference` option to true to hide definitions completely, or add your own naming strategy using the `Namer` property. +- Support for `yaml` tags and related options has been dropped for the sake of simplification. There were a [few inconsistencies](https://github.com/invopop/jsonschema/pull/21) around this that have now been fixed. + +## Versions + +This project is still under v0 scheme, as per Go convention, breaking changes are likely. Please pin go modules to version tags or branches, and reach out if you think something can be improved. + +Go version >= 1.18 is required as generics are now being used. + +## Example + +The following Go type: + +```go +type TestUser struct { + ID int `json:"id"` + Name string `json:"name" jsonschema:"title=the name,description=The name of a friend,example=joe,example=lucy,default=alex"` + Friends []int `json:"friends,omitempty" jsonschema_description:"The list of IDs, omitted when empty"` + Tags map[string]interface{} `json:"tags,omitempty" jsonschema_extras:"a=b,foo=bar,foo=bar1"` + BirthDate time.Time `json:"birth_date,omitempty" jsonschema:"oneof_required=date"` + YearOfBirth string `json:"year_of_birth,omitempty" jsonschema:"oneof_required=year"` + Metadata interface{} `json:"metadata,omitempty" jsonschema:"oneof_type=string;array"` + FavColor string `json:"fav_color,omitempty" jsonschema:"enum=red,enum=green,enum=blue"` +} +``` + +Results in following JSON Schema: + +```go +jsonschema.Reflect(&TestUser{}) +``` + +```json +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/invopop/jsonschema_test/sample-user", + "$ref": "#/$defs/SampleUser", + "$defs": { + "SampleUser": { + "oneOf": [ + { + "required": ["birth_date"], + "title": "date" + }, + { + "required": ["year_of_birth"], + "title": "year" + } + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "title": "the name", + "description": "The name of a friend", + "default": "alex", + "examples": ["joe", "lucy"] + }, + "friends": { + "items": { + "type": "integer" + }, + "type": "array", + "description": "The list of IDs, omitted when empty" + }, + "tags": { + "type": "object", + "a": "b", + "foo": ["bar", "bar1"] + }, + "birth_date": { + "type": "string", + "format": "date-time" + }, + "year_of_birth": { + "type": "string" + }, + "metadata": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "fav_color": { + "type": "string", + "enum": ["red", "green", "blue"] + } + }, + "additionalProperties": false, + "type": "object", + "required": ["id", "name"] + } + } +} +``` + +## YAML + +Support for `yaml` tags has now been removed. If you feel very strongly about this, we've opened a discussion to hear your comments: https://github.com/invopop/jsonschema/discussions/28 + +The recommended approach if you need to deal with YAML data is to first convert to JSON. The [invopop/yaml](https://github.com/invopop/yaml) library will make this trivial. + +## Configurable behaviour + +The behaviour of the schema generator can be altered with parameters when a `jsonschema.Reflector` +instance is created. + +### ExpandedStruct + +If set to `true`, makes the top level struct not to reference itself in the definitions. But type passed should be a struct type. + +eg. + +```go +type GrandfatherType struct { + FamilyName string `json:"family_name" jsonschema:"required"` +} + +type SomeBaseType struct { + SomeBaseProperty int `json:"some_base_property"` + // The jsonschema required tag is nonsensical for private and ignored properties. + // Their presence here tests that the fields *will not* be required in the output + // schema, even if they are tagged required. + somePrivateBaseProperty string `json:"i_am_private" jsonschema:"required"` + SomeIgnoredBaseProperty string `json:"-" jsonschema:"required"` + SomeSchemaIgnoredProperty string `jsonschema:"-,required"` + SomeUntaggedBaseProperty bool `jsonschema:"required"` + someUnexportedUntaggedBaseProperty bool + Grandfather GrandfatherType `json:"grand"` +} +``` + +will output: + +```json +{ + "$schema": "http://json-schema.org/draft/2020-12/schema", + "required": ["some_base_property", "grand", "SomeUntaggedBaseProperty"], + "properties": { + "SomeUntaggedBaseProperty": { + "type": "boolean" + }, + "grand": { + "$schema": "http://json-schema.org/draft/2020-12/schema", + "$ref": "#/definitions/GrandfatherType" + }, + "some_base_property": { + "type": "integer" + } + }, + "type": "object", + "$defs": { + "GrandfatherType": { + "required": ["family_name"], + "properties": { + "family_name": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object" + } + } +} +``` + +### Using Go Comments + +Writing a good schema with descriptions inside tags can become cumbersome and tedious, especially if you already have some Go comments around your types and field definitions. If you'd like to take advantage of these existing comments, you can use the `AddGoComments(base, path string)` method that forms part of the reflector to parse your go files and automatically generate a dictionary of Go import paths, types, and fields, to individual comments. These will then be used automatically as description fields, and can be overridden with a manual definition if needed. + +Take a simplified example of a User struct which for the sake of simplicity we assume is defined inside this package: + +```go +package main + +// User is used as a base to provide tests for comments. +type User struct { + // Unique sequential identifier. + ID int `json:"id" jsonschema:"required"` + // Name of the user + Name string `json:"name"` +} +``` + +To get the comments provided into your JSON schema, use a regular `Reflector` and add the go code using an import module URL and path. Fully qualified go module paths cannot be determined reliably by the `go/parser` library, so we need to introduce this manually: + +```go +r := new(Reflector) +if err := r.AddGoComments("github.com/invopop/jsonschema", "./"); err != nil { + // deal with error +} +s := r.Reflect(&User{}) +// output +``` + +Expect the results to be similar to: + +```json +{ + "$schema": "http://json-schema.org/draft/2020-12/schema", + "$ref": "#/$defs/User", + "$defs": { + "User": { + "required": ["id"], + "properties": { + "id": { + "type": "integer", + "description": "Unique sequential identifier." + }, + "name": { + "type": "string", + "description": "Name of the user" + } + }, + "additionalProperties": false, + "type": "object", + "description": "User is used as a base to provide tests for comments." + } + } +} +``` + +### Custom Key Naming + +In some situations, the keys actually used to write files are different from Go structs'. + +This is often the case when writing a configuration file to YAML or JSON from a Go struct, or when returning a JSON response for a Web API: APIs typically use snake_case, while Go uses PascalCase. + +You can pass a `func(string) string` function to `Reflector`'s `KeyNamer` option to map Go field names to JSON key names and reflect the aforementioned transformations, without having to specify `json:"..."` on every struct field. + +For example, consider the following struct + +```go +type User struct { + GivenName string + PasswordSalted []byte `json:"salted_password"` +} +``` + +We can transform field names to snake_case in the generated JSON schema: + +```go +r := new(jsonschema.Reflector) +r.KeyNamer = strcase.SnakeCase // from package github.com/stoewer/go-strcase + +r.Reflect(&User{}) +``` + +Will yield + +```diff + { + "$schema": "http://json-schema.org/draft/2020-12/schema", + "$ref": "#/$defs/User", + "$defs": { + "User": { + "properties": { +- "GivenName": { ++ "given_name": { + "type": "string" + }, + "salted_password": { + "type": "string", + "contentEncoding": "base64" + } + }, + "additionalProperties": false, + "type": "object", +- "required": ["GivenName", "salted_password"] ++ "required": ["given_name", "salted_password"] + } + } + } +``` + +As you can see, if a field name has a `json:""` tag set, the `key` argument to `KeyNamer` will have the value of that tag. + +### Custom Type Definitions + +Sometimes it can be useful to have custom JSON Marshal and Unmarshal methods in your structs that automatically convert for example a string into an object. + +This library will recognize and attempt to call four different methods that help you adjust schemas to your specific needs: + +- `JSONSchema() *Schema` - will prevent auto-generation of the schema so that you can provide your own definition. +- `JSONSchemaExtend(schema *jsonschema.Schema)` - will be called _after_ the schema has been generated, allowing you to add or manipulate the fields easily. +- `JSONSchemaAlias() any` - is called when reflecting the type of object and allows for an alternative to be used instead. +- `JSONSchemaProperty(prop string) any` - will be called for every property inside a struct giving you the chance to provide an alternative object to convert into a schema. + +Note that all of these methods **must** be defined on a non-pointer object for them to be called. + +Take the following simplified example of a `CompactDate` that only includes the Year and Month: + +```go +type CompactDate struct { + Year int + Month int +} + +func (d *CompactDate) UnmarshalJSON(data []byte) error { + if len(data) != 9 { + return errors.New("invalid compact date length") + } + var err error + d.Year, err = strconv.Atoi(string(data[1:5])) + if err != nil { + return err + } + d.Month, err = strconv.Atoi(string(data[7:8])) + if err != nil { + return err + } + return nil +} + +func (d *CompactDate) MarshalJSON() ([]byte, error) { + buf := new(bytes.Buffer) + buf.WriteByte('"') + buf.WriteString(fmt.Sprintf("%d-%02d", d.Year, d.Month)) + buf.WriteByte('"') + return buf.Bytes(), nil +} + +func (CompactDate) JSONSchema() *Schema { + return &Schema{ + Type: "string", + Title: "Compact Date", + Description: "Short date that only includes year and month", + Pattern: "^[0-9]{4}-[0-1][0-9]$", + } +} +``` + +The resulting schema generated for this struct would look like: + +```json +{ + "$schema": "http://json-schema.org/draft/2020-12/schema", + "$ref": "#/$defs/CompactDate", + "$defs": { + "CompactDate": { + "pattern": "^[0-9]{4}-[0-1][0-9]$", + "type": "string", + "title": "Compact Date", + "description": "Short date that only includes year and month" + } + } +} +``` diff --git a/vendor/github.com/invopop/jsonschema/comment_extractor.go b/vendor/github.com/invopop/jsonschema/comment_extractor.go new file mode 100644 index 000000000..e157837af --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/comment_extractor.go @@ -0,0 +1,93 @@ +package jsonschema + +import ( + "fmt" + "io/fs" + gopath "path" + "path/filepath" + "strings" + + "go/ast" + "go/doc" + "go/parser" + "go/token" +) + +// ExtractGoComments will read all the go files contained in the provided path, +// including sub-directories, in order to generate a dictionary of comments +// associated with Types and Fields. The results will be added to the `commentsMap` +// provided in the parameters and expected to be used for Schema "description" fields. +// +// The `go/parser` library is used to extract all the comments and unfortunately doesn't +// have a built-in way to determine the fully qualified name of a package. The `base` paremeter, +// the URL used to import that package, is thus required to be able to match reflected types. +// +// When parsing type comments, we use the `go/doc`'s Synopsis method to extract the first phrase +// only. Field comments, which tend to be much shorter, will include everything. +func ExtractGoComments(base, path string, commentMap map[string]string) error { + fset := token.NewFileSet() + dict := make(map[string][]*ast.Package) + err := filepath.Walk(path, func(path string, info fs.FileInfo, err error) error { + if err != nil { + return err + } + if info.IsDir() { + d, err := parser.ParseDir(fset, path, nil, parser.ParseComments) + if err != nil { + return err + } + for _, v := range d { + // paths may have multiple packages, like for tests + k := gopath.Join(base, path) + dict[k] = append(dict[k], v) + } + } + return nil + }) + if err != nil { + return err + } + + for pkg, p := range dict { + for _, f := range p { + gtxt := "" + typ := "" + ast.Inspect(f, func(n ast.Node) bool { + switch x := n.(type) { + case *ast.TypeSpec: + typ = x.Name.String() + if !ast.IsExported(typ) { + typ = "" + } else { + txt := x.Doc.Text() + if txt == "" && gtxt != "" { + txt = gtxt + gtxt = "" + } + txt = doc.Synopsis(txt) + commentMap[fmt.Sprintf("%s.%s", pkg, typ)] = strings.TrimSpace(txt) + } + case *ast.Field: + txt := x.Doc.Text() + if txt == "" { + txt = x.Comment.Text() + } + if typ != "" && txt != "" { + for _, n := range x.Names { + if ast.IsExported(n.String()) { + k := fmt.Sprintf("%s.%s.%s", pkg, typ, n) + commentMap[k] = strings.TrimSpace(txt) + } + } + } + case *ast.GenDecl: + // remember for the next type + gtxt = x.Doc.Text() + } + return true + }) + } + } + + return nil +} diff --git a/vendor/github.com/invopop/jsonschema/id.go b/vendor/github.com/invopop/jsonschema/id.go new file mode 100644 index 000000000..73fafb38d --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/id.go @@ -0,0 +1,76 @@ +package jsonschema + +import ( + "errors" + "fmt" + "net/url" + "strings" +) + +// ID represents a Schema ID type which should always be a URI. +// See draft-bhutton-json-schema-00 section 8.2.1 +type ID string + +// EmptyID is used to explicitly define an ID with no value. +const EmptyID ID = "" + +// Validate is used to check if the ID looks like a proper schema. +// This is done by parsing the ID as a URL and checking it has all the +// relevant parts. +func (id ID) Validate() error { + u, err := url.Parse(id.String()) + if err != nil { + return fmt.Errorf("invalid URL: %w", err) + } + if u.Hostname() == "" { + return errors.New("missing hostname") + } + if !strings.Contains(u.Hostname(), ".") { + return errors.New("hostname does not look valid") + } + if u.Path == "" { + return errors.New("path is expected") + } + if u.Scheme != "https" && u.Scheme != "http" { + return errors.New("unexpected schema") + } + return nil +} + +// Anchor sets the anchor part of the schema URI. +func (id ID) Anchor(name string) ID { + b := id.Base() + return ID(b.String() + "#" + name) +} + +// Def adds or replaces a definition identifier. +func (id ID) Def(name string) ID { + b := id.Base() + return ID(b.String() + "#/$defs/" + name) +} + +// Add appends the provided path to the id, and removes any +// anchor data that might be there. +func (id ID) Add(path string) ID { + b := id.Base() + if !strings.HasPrefix(path, "/") { + path = "/" + path + } + return ID(b.String() + path) +} + +// Base removes any anchor information from the schema +func (id ID) Base() ID { + s := id.String() + i := strings.LastIndex(s, "#") + if i != -1 { + s = s[0:i] + } + s = strings.TrimRight(s, "/") + return ID(s) +} + +// String provides string version of ID +func (id ID) String() string { + return string(id) +} diff --git a/vendor/github.com/invopop/jsonschema/reflect.go b/vendor/github.com/invopop/jsonschema/reflect.go new file mode 100644 index 000000000..3249c8c36 --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/reflect.go @@ -0,0 +1,1150 @@ +// Package jsonschema uses reflection to generate JSON Schemas from Go types [1]. +// +// If json tags are present on struct fields, they will be used to infer +// property names and if a property is required (omitempty is present). +// +// [1] http://json-schema.org/latest/json-schema-validation.html +package jsonschema + +import ( + "bytes" + "encoding/json" + "net" + "net/url" + "reflect" + "strconv" + "strings" + "time" +) + +// customSchemaImpl is used to detect if the type provides it's own +// custom Schema Type definition to use instead. Very useful for situations +// where there are custom JSON Marshal and Unmarshal methods. +type customSchemaImpl interface { + JSONSchema() *Schema +} + +// Function to be run after the schema has been generated. +// this will let you modify a schema afterwards +type extendSchemaImpl interface { + JSONSchemaExtend(*Schema) +} + +// If the object to be reflected defines a `JSONSchemaAlias` method, its type will +// be used instead of the original type. +type aliasSchemaImpl interface { + JSONSchemaAlias() any +} + +// If an object to be reflected defines a `JSONSchemaPropertyAlias` method, +// it will be called for each property to determine if another object +// should be used for the contents. +type propertyAliasSchemaImpl interface { + JSONSchemaProperty(prop string) any +} + +var customAliasSchema = reflect.TypeOf((*aliasSchemaImpl)(nil)).Elem() +var customPropertyAliasSchema = reflect.TypeOf((*propertyAliasSchemaImpl)(nil)).Elem() + +var customType = reflect.TypeOf((*customSchemaImpl)(nil)).Elem() +var extendType = reflect.TypeOf((*extendSchemaImpl)(nil)).Elem() + +// customSchemaGetFieldDocString +type customSchemaGetFieldDocString interface { + GetFieldDocString(fieldName string) string +} + +type customGetFieldDocString func(fieldName string) string + +var customStructGetFieldDocString = reflect.TypeOf((*customSchemaGetFieldDocString)(nil)).Elem() + +// Reflect reflects to Schema from a value using the default Reflector +func Reflect(v any) *Schema { + return ReflectFromType(reflect.TypeOf(v)) +} + +// ReflectFromType generates root schema using the default Reflector +func ReflectFromType(t reflect.Type) *Schema { + r := &Reflector{} + return r.ReflectFromType(t) +} + +// A Reflector reflects values into a Schema. +type Reflector struct { + // BaseSchemaID defines the URI that will be used as a base to determine Schema + // IDs for models. For example, a base Schema ID of `https://invopop.com/schemas` + // when defined with a struct called `User{}`, will result in a schema with an + // ID set to `https://invopop.com/schemas/user`. + // + // If no `BaseSchemaID` is provided, we'll take the type's complete package path + // and use that as a base instead. Set `Anonymous` to try if you do not want to + // include a schema ID. + BaseSchemaID ID + + // Anonymous when true will hide the auto-generated Schema ID and provide what is + // known as an "anonymous schema". As a rule, this is not recommended. + Anonymous bool + + // AssignAnchor when true will use the original struct's name as an anchor inside + // every definition, including the root schema. These can be useful for having a + // reference to the original struct's name in CamelCase instead of the snake-case used + // by default for URI compatibility. + // + // Anchors do not appear to be widely used out in the wild, so at this time the + // anchors themselves will not be used inside generated schema. + AssignAnchor bool + + // AllowAdditionalProperties will cause the Reflector to generate a schema + // without additionalProperties set to 'false' for all struct types. This means + // the presence of additional keys in JSON objects will not cause validation + // to fail. Note said additional keys will simply be dropped when the + // validated JSON is unmarshaled. + AllowAdditionalProperties bool + + // RequiredFromJSONSchemaTags will cause the Reflector to generate a schema + // that requires any key tagged with `jsonschema:required`, overriding the + // default of requiring any key *not* tagged with `json:,omitempty`. + RequiredFromJSONSchemaTags bool + + // Do not reference definitions. This will remove the top-level $defs map and + // instead cause the entire structure of types to be output in one tree. The + // list of type definitions (`$defs`) will not be included. + DoNotReference bool + + // ExpandedStruct when true will include the reflected type's definition in the + // root as opposed to a definition with a reference. + ExpandedStruct bool + + // FieldNameTag will change the tag used to get field names. json tags are used by default. + FieldNameTag string + + // IgnoredTypes defines a slice of types that should be ignored in the schema, + // switching to just allowing additional properties instead. + IgnoredTypes []any + + // Lookup allows a function to be defined that will provide a custom mapping of + // types to Schema IDs. This allows existing schema documents to be referenced + // by their ID instead of being embedded into the current schema definitions. + // Reflected types will never be pointers, only underlying elements. + Lookup func(reflect.Type) ID + + // Mapper is a function that can be used to map custom Go types to jsonschema schemas. + Mapper func(reflect.Type) *Schema + + // Namer allows customizing of type names. The default is to use the type's name + // provided by the reflect package. + Namer func(reflect.Type) string + + // KeyNamer allows customizing of key names. + // The default is to use the key's name as is, or the json tag if present. + // If a json tag is present, KeyNamer will receive the tag's name as an argument, not the original key name. + KeyNamer func(string) string + + // AdditionalFields allows adding structfields for a given type + AdditionalFields func(reflect.Type) []reflect.StructField + + // CommentMap is a dictionary of fully qualified go types and fields to comment + // strings that will be used if a description has not already been provided in + // the tags. Types and fields are added to the package path using "." as a + // separator. + // + // Type descriptions should be defined like: + // + // map[string]string{"github.com/invopop/jsonschema.Reflector": "A Reflector reflects values into a Schema."} + // + // And Fields defined as: + // + // map[string]string{"github.com/invopop/jsonschema.Reflector.DoNotReference": "Do not reference definitions."} + // + // See also: AddGoComments + CommentMap map[string]string +} + +// Reflect reflects to Schema from a value. +func (r *Reflector) Reflect(v any) *Schema { + return r.ReflectFromType(reflect.TypeOf(v)) +} + +// ReflectFromType generates root schema +func (r *Reflector) ReflectFromType(t reflect.Type) *Schema { + if t.Kind() == reflect.Ptr { + t = t.Elem() // re-assign from pointer + } + + name := r.typeName(t) + + s := new(Schema) + definitions := Definitions{} + s.Definitions = definitions + bs := r.reflectTypeToSchemaWithID(definitions, t) + if r.ExpandedStruct { + *s = *definitions[name] + delete(definitions, name) + } else { + *s = *bs + } + + // Attempt to set the schema ID + if !r.Anonymous && s.ID == EmptyID { + baseSchemaID := r.BaseSchemaID + if baseSchemaID == EmptyID { + id := ID("https://" + t.PkgPath()) + if err := id.Validate(); err == nil { + // it's okay to silently ignore URL errors + baseSchemaID = id + } + } + if baseSchemaID != EmptyID { + s.ID = baseSchemaID.Add(ToSnakeCase(name)) + } + } + + s.Version = Version + if !r.DoNotReference { + s.Definitions = definitions + } + + return s +} + +// Available Go defined types for JSON Schema Validation. +// RFC draft-wright-json-schema-validation-00, section 7.3 +var ( + timeType = reflect.TypeOf(time.Time{}) // date-time RFC section 7.3.1 + ipType = reflect.TypeOf(net.IP{}) // ipv4 and ipv6 RFC section 7.3.4, 7.3.5 + uriType = reflect.TypeOf(url.URL{}) // uri RFC section 7.3.6 +) + +// Byte slices will be encoded as base64 +var byteSliceType = reflect.TypeOf([]byte(nil)) + +// Except for json.RawMessage +var rawMessageType = reflect.TypeOf(json.RawMessage{}) + +// Go code generated from protobuf enum types should fulfil this interface. +type protoEnum interface { + EnumDescriptor() ([]byte, []int) +} + +var protoEnumType = reflect.TypeOf((*protoEnum)(nil)).Elem() + +// SetBaseSchemaID is a helper use to be able to set the reflectors base +// schema ID from a string as opposed to then ID instance. +func (r *Reflector) SetBaseSchemaID(id string) { + r.BaseSchemaID = ID(id) +} + +func (r *Reflector) refOrReflectTypeToSchema(definitions Definitions, t reflect.Type) *Schema { + id := r.lookupID(t) + if id != EmptyID { + return &Schema{ + Ref: id.String(), + } + } + + // Already added to definitions? + if def := r.refDefinition(definitions, t); def != nil { + return def + } + + return r.reflectTypeToSchemaWithID(definitions, t) +} + +func (r *Reflector) reflectTypeToSchemaWithID(defs Definitions, t reflect.Type) *Schema { + s := r.reflectTypeToSchema(defs, t) + if s != nil { + if r.Lookup != nil { + id := r.Lookup(t) + if id != EmptyID { + s.ID = id + } + } + } + return s +} + +func (r *Reflector) reflectTypeToSchema(definitions Definitions, t reflect.Type) *Schema { + // only try to reflect non-pointers + if t.Kind() == reflect.Ptr { + return r.refOrReflectTypeToSchema(definitions, t.Elem()) + } + + // Check if the there is an alias method that provides an object + // that we should use instead of this one. + if t.Implements(customAliasSchema) { + v := reflect.New(t) + o := v.Interface().(aliasSchemaImpl) + t = reflect.TypeOf(o.JSONSchemaAlias()) + return r.refOrReflectTypeToSchema(definitions, t) + } + + // Do any pre-definitions exist? + if r.Mapper != nil { + if t := r.Mapper(t); t != nil { + return t + } + } + if rt := r.reflectCustomSchema(definitions, t); rt != nil { + return rt + } + + // Prepare a base to which details can be added + st := new(Schema) + + // jsonpb will marshal protobuf enum options as either strings or integers. + // It will unmarshal either. + if t.Implements(protoEnumType) { + st.OneOf = []*Schema{ + {Type: "string"}, + {Type: "integer"}, + } + return st + } + + // Defined format types for JSON Schema Validation + // RFC draft-wright-json-schema-validation-00, section 7.3 + // TODO email RFC section 7.3.2, hostname RFC section 7.3.3, uriref RFC section 7.3.7 + if t == ipType { + // TODO differentiate ipv4 and ipv6 RFC section 7.3.4, 7.3.5 + st.Type = "string" + st.Format = "ipv4" + return st + } + + switch t.Kind() { + case reflect.Struct: + r.reflectStruct(definitions, t, st) + + case reflect.Slice, reflect.Array: + r.reflectSliceOrArray(definitions, t, st) + + case reflect.Map: + r.reflectMap(definitions, t, st) + + case reflect.Interface: + // empty + + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, + reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: + st.Type = "integer" + + case reflect.Float32, reflect.Float64: + st.Type = "number" + + case reflect.Bool: + st.Type = "boolean" + + case reflect.String: + st.Type = "string" + + default: + panic("unsupported type " + t.String()) + } + + r.reflectSchemaExtend(definitions, t, st) + + // Always try to reference the definition which may have just been created + if def := r.refDefinition(definitions, t); def != nil { + return def + } + + return st +} + +func (r *Reflector) reflectCustomSchema(definitions Definitions, t reflect.Type) *Schema { + if t.Kind() == reflect.Ptr { + return r.reflectCustomSchema(definitions, t.Elem()) + } + + if t.Implements(customType) { + v := reflect.New(t) + o := v.Interface().(customSchemaImpl) + st := o.JSONSchema() + r.addDefinition(definitions, t, st) + if ref := r.refDefinition(definitions, t); ref != nil { + return ref + } + return st + } + + return nil +} + +func (r *Reflector) reflectSchemaExtend(definitions Definitions, t reflect.Type, s *Schema) *Schema { + if t.Implements(extendType) { + v := reflect.New(t) + o := v.Interface().(extendSchemaImpl) + o.JSONSchemaExtend(s) + if ref := r.refDefinition(definitions, t); ref != nil { + return ref + } + } + + return s +} + +func (r *Reflector) reflectSliceOrArray(definitions Definitions, t reflect.Type, st *Schema) { + if t == rawMessageType { + return + } + + r.addDefinition(definitions, t, st) + + if st.Description == "" { + st.Description = r.lookupComment(t, "") + } + + if t.Kind() == reflect.Array { + l := uint64(t.Len()) + st.MinItems = &l + st.MaxItems = &l + } + if t.Kind() == reflect.Slice && t.Elem() == byteSliceType.Elem() { + st.Type = "string" + // NOTE: ContentMediaType is not set here + st.ContentEncoding = "base64" + } else { + st.Type = "array" + st.Items = r.refOrReflectTypeToSchema(definitions, t.Elem()) + } +} + +func (r *Reflector) reflectMap(definitions Definitions, t reflect.Type, st *Schema) { + r.addDefinition(definitions, t, st) + + st.Type = "object" + if st.Description == "" { + st.Description = r.lookupComment(t, "") + } + + switch t.Key().Kind() { + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: + st.PatternProperties = map[string]*Schema{ + "^[0-9]+$": r.refOrReflectTypeToSchema(definitions, t.Elem()), + } + st.AdditionalProperties = FalseSchema + return + } + if t.Elem().Kind() != reflect.Interface { + st.AdditionalProperties = r.refOrReflectTypeToSchema(definitions, t.Elem()) + } +} + +// Reflects a struct to a JSON Schema type. +func (r *Reflector) reflectStruct(definitions Definitions, t reflect.Type, s *Schema) { + // Handle special types + switch t { + case timeType: // date-time RFC section 7.3.1 + s.Type = "string" + s.Format = "date-time" + return + case uriType: // uri RFC section 7.3.6 + s.Type = "string" + s.Format = "uri" + return + } + + r.addDefinition(definitions, t, s) + s.Type = "object" + s.Properties = NewProperties() + s.Description = r.lookupComment(t, "") + if r.AssignAnchor { + s.Anchor = t.Name() + } + if !r.AllowAdditionalProperties && s.AdditionalProperties == nil { + s.AdditionalProperties = FalseSchema + } + + ignored := false + for _, it := range r.IgnoredTypes { + if reflect.TypeOf(it) == t { + ignored = true + break + } + } + if !ignored { + r.reflectStructFields(s, definitions, t) + } +} + +func (r *Reflector) reflectStructFields(st *Schema, definitions Definitions, t reflect.Type) { + if t.Kind() == reflect.Ptr { + t = t.Elem() + } + if t.Kind() != reflect.Struct { + return + } + + var getFieldDocString customGetFieldDocString + if t.Implements(customStructGetFieldDocString) { + v := reflect.New(t) + o := v.Interface().(customSchemaGetFieldDocString) + getFieldDocString = o.GetFieldDocString + } + + customPropertyMethod := func(string) any { + return nil + } + if t.Implements(customPropertyAliasSchema) { + v := reflect.New(t) + o := v.Interface().(propertyAliasSchemaImpl) + customPropertyMethod = o.JSONSchemaProperty + } + + handleField := func(f reflect.StructField) { + name, shouldEmbed, required, nullable := r.reflectFieldName(f) + // if anonymous and exported type should be processed recursively + // current type should inherit properties of anonymous one + if name == "" { + if shouldEmbed { + r.reflectStructFields(st, definitions, f.Type) + } + return + } + + // If a JSONSchemaAlias(prop string) method is defined, attempt to use + // the provided object's type instead of the field's type. + var property *Schema + if alias := customPropertyMethod(name); alias != nil { + property = r.refOrReflectTypeToSchema(definitions, reflect.TypeOf(alias)) + } else { + property = r.refOrReflectTypeToSchema(definitions, f.Type) + } + + property.structKeywordsFromTags(f, st, name) + if property.Description == "" { + property.Description = r.lookupComment(t, f.Name) + } + if getFieldDocString != nil { + property.Description = getFieldDocString(f.Name) + } + + if nullable { + property = &Schema{ + OneOf: []*Schema{ + property, + { + Type: "null", + }, + }, + } + } + + st.Properties.Set(name, property) + if required { + st.Required = appendUniqueString(st.Required, name) + } + } + + for i := 0; i < t.NumField(); i++ { + f := t.Field(i) + handleField(f) + } + if r.AdditionalFields != nil { + if af := r.AdditionalFields(t); af != nil { + for _, sf := range af { + handleField(sf) + } + } + } +} + +func appendUniqueString(base []string, value string) []string { + for _, v := range base { + if v == value { + return base + } + } + return append(base, value) +} + +func (r *Reflector) lookupComment(t reflect.Type, name string) string { + if r.CommentMap == nil { + return "" + } + + n := fullyQualifiedTypeName(t) + if name != "" { + n = n + "." + name + } + + return r.CommentMap[n] +} + +// addDefinition will append the provided schema. If needed, an ID and anchor will also be added. +func (r *Reflector) addDefinition(definitions Definitions, t reflect.Type, s *Schema) { + name := r.typeName(t) + if name == "" { + return + } + definitions[name] = s +} + +// refDefinition will provide a schema with a reference to an existing definition. +func (r *Reflector) refDefinition(definitions Definitions, t reflect.Type) *Schema { + if r.DoNotReference { + return nil + } + name := r.typeName(t) + if name == "" { + return nil + } + if _, ok := definitions[name]; !ok { + return nil + } + return &Schema{ + Ref: "#/$defs/" + name, + } +} + +func (r *Reflector) lookupID(t reflect.Type) ID { + if r.Lookup != nil { + if t.Kind() == reflect.Ptr { + t = t.Elem() + } + return r.Lookup(t) + + } + return EmptyID +} + +func (t *Schema) structKeywordsFromTags(f reflect.StructField, parent *Schema, propertyName string) { + t.Description = f.Tag.Get("jsonschema_description") + + tags := splitOnUnescapedCommas(f.Tag.Get("jsonschema")) + tags = t.genericKeywords(tags, parent, propertyName) + + switch t.Type { + case "string": + t.stringKeywords(tags) + case "number": + t.numericalKeywords(tags) + case "integer": + t.numericalKeywords(tags) + case "array": + t.arrayKeywords(tags) + case "boolean": + t.booleanKeywords(tags) + } + extras := strings.Split(f.Tag.Get("jsonschema_extras"), ",") + t.extraKeywords(extras) +} + +// read struct tags for generic keywords +func (t *Schema) genericKeywords(tags []string, parent *Schema, propertyName string) []string { //nolint:gocyclo + unprocessed := make([]string, 0, len(tags)) + for _, tag := range tags { + nameValue := strings.SplitN(tag, "=", 2) + if len(nameValue) == 2 { + name, val := nameValue[0], nameValue[1] + switch name { + case "title": + t.Title = val + case "description": + t.Description = val + case "type": + t.Type = val + case "anchor": + t.Anchor = val + case "oneof_required": + var typeFound *Schema + for i := range parent.OneOf { + if parent.OneOf[i].Title == nameValue[1] { + typeFound = parent.OneOf[i] + } + } + if typeFound == nil { + typeFound = &Schema{ + Title: nameValue[1], + Required: []string{}, + } + parent.OneOf = append(parent.OneOf, typeFound) + } + typeFound.Required = append(typeFound.Required, propertyName) + case "anyof_required": + var typeFound *Schema + for i := range parent.AnyOf { + if parent.AnyOf[i].Title == nameValue[1] { + typeFound = parent.AnyOf[i] + } + } + if typeFound == nil { + typeFound = &Schema{ + Title: nameValue[1], + Required: []string{}, + } + parent.AnyOf = append(parent.AnyOf, typeFound) + } + typeFound.Required = append(typeFound.Required, propertyName) + case "oneof_ref": + subSchema := t + if t.Items != nil { + subSchema = t.Items + } + if subSchema.OneOf == nil { + subSchema.OneOf = make([]*Schema, 0, 1) + } + subSchema.Ref = "" + refs := strings.Split(nameValue[1], ";") + for _, r := range refs { + subSchema.OneOf = append(subSchema.OneOf, &Schema{ + Ref: r, + }) + } + case "oneof_type": + if t.OneOf == nil { + t.OneOf = make([]*Schema, 0, 1) + } + t.Type = "" + types := strings.Split(nameValue[1], ";") + for _, ty := range types { + t.OneOf = append(t.OneOf, &Schema{ + Type: ty, + }) + } + case "anyof_ref": + subSchema := t + if t.Items != nil { + subSchema = t.Items + } + if subSchema.AnyOf == nil { + subSchema.AnyOf = make([]*Schema, 0, 1) + } + subSchema.Ref = "" + refs := strings.Split(nameValue[1], ";") + for _, r := range refs { + subSchema.AnyOf = append(subSchema.AnyOf, &Schema{ + Ref: r, + }) + } + case "anyof_type": + if t.AnyOf == nil { + t.AnyOf = make([]*Schema, 0, 1) + } + t.Type = "" + types := strings.Split(nameValue[1], ";") + for _, ty := range types { + t.AnyOf = append(t.AnyOf, &Schema{ + Type: ty, + }) + } + default: + unprocessed = append(unprocessed, tag) + } + } + } + return unprocessed +} + +// read struct tags for boolean type keywords +func (t *Schema) booleanKeywords(tags []string) { + for _, tag := range tags { + nameValue := strings.Split(tag, "=") + if len(nameValue) != 2 { + continue + } + name, val := nameValue[0], nameValue[1] + if name == "default" { + if val == "true" { + t.Default = true + } else if val == "false" { + t.Default = false + } + } + } +} + +// read struct tags for string type keywords +func (t *Schema) stringKeywords(tags []string) { + for _, tag := range tags { + nameValue := strings.SplitN(tag, "=", 2) + if len(nameValue) == 2 { + name, val := nameValue[0], nameValue[1] + switch name { + case "minLength": + t.MinLength = parseUint(val) + case "maxLength": + t.MaxLength = parseUint(val) + case "pattern": + t.Pattern = val + case "format": + switch val { + case "date-time", "email", "hostname", "ipv4", "ipv6", "uri", "uuid": + t.Format = val + } + case "readOnly": + i, _ := strconv.ParseBool(val) + t.ReadOnly = i + case "writeOnly": + i, _ := strconv.ParseBool(val) + t.WriteOnly = i + case "default": + t.Default = val + case "example": + t.Examples = append(t.Examples, val) + case "enum": + t.Enum = append(t.Enum, val) + } + } + } +} + +// read struct tags for numerical type keywords +func (t *Schema) numericalKeywords(tags []string) { + for _, tag := range tags { + nameValue := strings.Split(tag, "=") + if len(nameValue) == 2 { + name, val := nameValue[0], nameValue[1] + switch name { + case "multipleOf": + t.MultipleOf, _ = toJSONNumber(val) + case "minimum": + t.Minimum, _ = toJSONNumber(val) + case "maximum": + t.Maximum, _ = toJSONNumber(val) + case "exclusiveMaximum": + t.ExclusiveMaximum, _ = toJSONNumber(val) + case "exclusiveMinimum": + t.ExclusiveMinimum, _ = toJSONNumber(val) + case "default": + if num, ok := toJSONNumber(val); ok { + t.Default = num + } + case "example": + if num, ok := toJSONNumber(val); ok { + t.Examples = append(t.Examples, num) + } + case "enum": + if num, ok := toJSONNumber(val); ok { + t.Enum = append(t.Enum, num) + } + } + } + } +} + +// read struct tags for object type keywords +// func (t *Type) objectKeywords(tags []string) { +// for _, tag := range tags{ +// nameValue := strings.Split(tag, "=") +// name, val := nameValue[0], nameValue[1] +// switch name{ +// case "dependencies": +// t.Dependencies = val +// break; +// case "patternProperties": +// t.PatternProperties = val +// break; +// } +// } +// } + +// read struct tags for array type keywords +func (t *Schema) arrayKeywords(tags []string) { + var defaultValues []any + + unprocessed := make([]string, 0, len(tags)) + for _, tag := range tags { + nameValue := strings.Split(tag, "=") + if len(nameValue) == 2 { + name, val := nameValue[0], nameValue[1] + switch name { + case "minItems": + t.MinItems = parseUint(val) + case "maxItems": + t.MaxItems = parseUint(val) + case "uniqueItems": + t.UniqueItems = true + case "default": + defaultValues = append(defaultValues, val) + case "format": + t.Items.Format = val + case "pattern": + t.Items.Pattern = val + default: + unprocessed = append(unprocessed, tag) // left for further processing by underlying type + } + } + } + if len(defaultValues) > 0 { + t.Default = defaultValues + } + + if len(unprocessed) == 0 { + // we don't have anything else to process + return + } + + switch t.Items.Type { + case "string": + t.Items.stringKeywords(unprocessed) + case "number": + t.Items.numericalKeywords(unprocessed) + case "integer": + t.Items.numericalKeywords(unprocessed) + case "array": + // explicitly don't support traversal for the [][]..., as it's unclear where the array tags belong + case "boolean": + t.Items.booleanKeywords(unprocessed) + } +} + +func (t *Schema) extraKeywords(tags []string) { + for _, tag := range tags { + nameValue := strings.SplitN(tag, "=", 2) + if len(nameValue) == 2 { + t.setExtra(nameValue[0], nameValue[1]) + } + } +} + +func (t *Schema) setExtra(key, val string) { + if t.Extras == nil { + t.Extras = map[string]any{} + } + if existingVal, ok := t.Extras[key]; ok { + switch existingVal := existingVal.(type) { + case string: + t.Extras[key] = []string{existingVal, val} + case []string: + t.Extras[key] = append(existingVal, val) + case int: + t.Extras[key], _ = strconv.Atoi(val) + case bool: + t.Extras[key] = (val == "true" || val == "t") + } + } else { + switch key { + case "minimum": + t.Extras[key], _ = strconv.Atoi(val) + default: + var x any + if val == "true" { + x = true + } else if val == "false" { + x = false + } else { + x = val + } + t.Extras[key] = x + } + } +} + +func requiredFromJSONTags(tags []string, val *bool) { + if ignoredByJSONTags(tags) { + return + } + + for _, tag := range tags[1:] { + if tag == "omitempty" { + *val = false + return + } + } + *val = true +} + +func requiredFromJSONSchemaTags(tags []string, val *bool) { + if ignoredByJSONSchemaTags(tags) { + return + } + for _, tag := range tags { + if tag == "required" { + *val = true + } + } +} + +func nullableFromJSONSchemaTags(tags []string) bool { + if ignoredByJSONSchemaTags(tags) { + return false + } + for _, tag := range tags { + if tag == "nullable" { + return true + } + } + return false +} + +func ignoredByJSONTags(tags []string) bool { + return tags[0] == "-" +} + +func ignoredByJSONSchemaTags(tags []string) bool { + return tags[0] == "-" +} + +// toJSONNumber converts string to *json.Number. +// It'll aso return whether the number is valid. +func toJSONNumber(s string) (json.Number, bool) { + num := json.Number(s) + if _, err := num.Int64(); err == nil { + return num, true + } + if _, err := num.Float64(); err == nil { + return num, true + } + return json.Number(""), false +} + +func parseUint(num string) *uint64 { + val, err := strconv.ParseUint(num, 10, 64) + if err != nil { + return nil + } + return &val +} + +func (r *Reflector) fieldNameTag() string { + if r.FieldNameTag != "" { + return r.FieldNameTag + } + return "json" +} + +func (r *Reflector) reflectFieldName(f reflect.StructField) (string, bool, bool, bool) { + jsonTagString := f.Tag.Get(r.fieldNameTag()) + jsonTags := strings.Split(jsonTagString, ",") + + if ignoredByJSONTags(jsonTags) { + return "", false, false, false + } + + schemaTags := strings.Split(f.Tag.Get("jsonschema"), ",") + if ignoredByJSONSchemaTags(schemaTags) { + return "", false, false, false + } + + var required bool + if !r.RequiredFromJSONSchemaTags { + requiredFromJSONTags(jsonTags, &required) + } + requiredFromJSONSchemaTags(schemaTags, &required) + + nullable := nullableFromJSONSchemaTags(schemaTags) + + if f.Anonymous && jsonTags[0] == "" { + // As per JSON Marshal rules, anonymous structs are inherited + if f.Type.Kind() == reflect.Struct { + return "", true, false, false + } + + // As per JSON Marshal rules, anonymous pointer to structs are inherited + if f.Type.Kind() == reflect.Ptr && f.Type.Elem().Kind() == reflect.Struct { + return "", true, false, false + } + } + + // Try to determine the name from the different combos + name := f.Name + if jsonTags[0] != "" { + name = jsonTags[0] + } + if !f.Anonymous && f.PkgPath != "" { + // field not anonymous and not export has no export name + name = "" + } else if r.KeyNamer != nil { + name = r.KeyNamer(name) + } + + return name, false, required, nullable +} + +// UnmarshalJSON is used to parse a schema object or boolean. +func (t *Schema) UnmarshalJSON(data []byte) error { + if bytes.Equal(data, []byte("true")) { + *t = *TrueSchema + return nil + } else if bytes.Equal(data, []byte("false")) { + *t = *FalseSchema + return nil + } + type SchemaAlt Schema + aux := &struct { + *SchemaAlt + }{ + SchemaAlt: (*SchemaAlt)(t), + } + return json.Unmarshal(data, aux) +} + +// MarshalJSON is used to serialize a schema object or boolean. +func (t *Schema) MarshalJSON() ([]byte, error) { + if t.boolean != nil { + if *t.boolean { + return []byte("true"), nil + } + return []byte("false"), nil + } + if reflect.DeepEqual(&Schema{}, t) { + // Don't bother returning empty schemas + return []byte("true"), nil + } + type SchemaAlt Schema + b, err := json.Marshal((*SchemaAlt)(t)) + if err != nil { + return nil, err + } + if t.Extras == nil || len(t.Extras) == 0 { + return b, nil + } + m, err := json.Marshal(t.Extras) + if err != nil { + return nil, err + } + if len(b) == 2 { + return m, nil + } + b[len(b)-1] = ',' + return append(b, m[1:]...), nil +} + +func (r *Reflector) typeName(t reflect.Type) string { + if r.Namer != nil { + if name := r.Namer(t); name != "" { + return name + } + } + return t.Name() +} + +// Split on commas that are not preceded by `\`. +// This way, we prevent splitting regexes +func splitOnUnescapedCommas(tagString string) []string { + ret := make([]string, 0) + separated := strings.Split(tagString, ",") + ret = append(ret, separated[0]) + i := 0 + for _, nextTag := range separated[1:] { + if len(ret[i]) == 0 { + ret = append(ret, nextTag) + i++ + continue + } + + if ret[i][len(ret[i])-1] == '\\' { + ret[i] = ret[i][:len(ret[i])-1] + "," + nextTag + } else { + ret = append(ret, nextTag) + i++ + } + } + + return ret +} + +func fullyQualifiedTypeName(t reflect.Type) string { + return t.PkgPath() + "." + t.Name() +} + +// AddGoComments will update the reflectors comment map with all the comments +// found in the provided source directories. See the #ExtractGoComments method +// for more details. +func (r *Reflector) AddGoComments(base, path string) error { + if r.CommentMap == nil { + r.CommentMap = make(map[string]string) + } + return ExtractGoComments(base, path, r.CommentMap) +} diff --git a/vendor/github.com/invopop/jsonschema/schema.go b/vendor/github.com/invopop/jsonschema/schema.go new file mode 100644 index 000000000..2d914b8c8 --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/schema.go @@ -0,0 +1,94 @@ +package jsonschema + +import ( + "encoding/json" + + orderedmap "github.com/wk8/go-ordered-map/v2" +) + +// Version is the JSON Schema version. +var Version = "https://json-schema.org/draft/2020-12/schema" + +// Schema represents a JSON Schema object type. +// RFC draft-bhutton-json-schema-00 section 4.3 +type Schema struct { + // RFC draft-bhutton-json-schema-00 + Version string `json:"$schema,omitempty"` // section 8.1.1 + ID ID `json:"$id,omitempty"` // section 8.2.1 + Anchor string `json:"$anchor,omitempty"` // section 8.2.2 + Ref string `json:"$ref,omitempty"` // section 8.2.3.1 + DynamicRef string `json:"$dynamicRef,omitempty"` // section 8.2.3.2 + Definitions Definitions `json:"$defs,omitempty"` // section 8.2.4 + Comments string `json:"$comment,omitempty"` // section 8.3 + // RFC draft-bhutton-json-schema-00 section 10.2.1 (Sub-schemas with logic) + AllOf []*Schema `json:"allOf,omitempty"` // section 10.2.1.1 + AnyOf []*Schema `json:"anyOf,omitempty"` // section 10.2.1.2 + OneOf []*Schema `json:"oneOf,omitempty"` // section 10.2.1.3 + Not *Schema `json:"not,omitempty"` // section 10.2.1.4 + // RFC draft-bhutton-json-schema-00 section 10.2.2 (Apply sub-schemas conditionally) + If *Schema `json:"if,omitempty"` // section 10.2.2.1 + Then *Schema `json:"then,omitempty"` // section 10.2.2.2 + Else *Schema `json:"else,omitempty"` // section 10.2.2.3 + DependentSchemas map[string]*Schema `json:"dependentSchemas,omitempty"` // section 10.2.2.4 + // RFC draft-bhutton-json-schema-00 section 10.3.1 (arrays) + PrefixItems []*Schema `json:"prefixItems,omitempty"` // section 10.3.1.1 + Items *Schema `json:"items,omitempty"` // section 10.3.1.2 (replaces additionalItems) + Contains *Schema `json:"contains,omitempty"` // section 10.3.1.3 + // RFC draft-bhutton-json-schema-00 section 10.3.2 (sub-schemas) + Properties *orderedmap.OrderedMap[string, *Schema] `json:"properties,omitempty"` // section 10.3.2.1 + PatternProperties map[string]*Schema `json:"patternProperties,omitempty"` // section 10.3.2.2 + AdditionalProperties *Schema `json:"additionalProperties,omitempty"` // section 10.3.2.3 + PropertyNames *Schema `json:"propertyNames,omitempty"` // section 10.3.2.4 + // RFC draft-bhutton-json-schema-validation-00, section 6 + Type string `json:"type,omitempty"` // section 6.1.1 + Enum []any `json:"enum,omitempty"` // section 6.1.2 + Const any `json:"const,omitempty"` // section 6.1.3 + MultipleOf json.Number `json:"multipleOf,omitempty"` // section 6.2.1 + Maximum json.Number `json:"maximum,omitempty"` // section 6.2.2 + ExclusiveMaximum json.Number `json:"exclusiveMaximum,omitempty"` // section 6.2.3 + Minimum json.Number `json:"minimum,omitempty"` // section 6.2.4 + ExclusiveMinimum json.Number `json:"exclusiveMinimum,omitempty"` // section 6.2.5 + MaxLength *uint64 `json:"maxLength,omitempty"` // section 6.3.1 + MinLength *uint64 `json:"minLength,omitempty"` // section 6.3.2 + Pattern string `json:"pattern,omitempty"` // section 6.3.3 + MaxItems *uint64 `json:"maxItems,omitempty"` // section 6.4.1 + MinItems *uint64 `json:"minItems,omitempty"` // section 6.4.2 + UniqueItems bool `json:"uniqueItems,omitempty"` // section 6.4.3 + MaxContains *uint64 `json:"maxContains,omitempty"` // section 6.4.4 + MinContains *uint64 `json:"minContains,omitempty"` // section 6.4.5 + MaxProperties *uint64 `json:"maxProperties,omitempty"` // section 6.5.1 + MinProperties *uint64 `json:"minProperties,omitempty"` // section 6.5.2 + Required []string `json:"required,omitempty"` // section 6.5.3 + DependentRequired map[string][]string `json:"dependentRequired,omitempty"` // section 6.5.4 + // RFC draft-bhutton-json-schema-validation-00, section 7 + Format string `json:"format,omitempty"` + // RFC draft-bhutton-json-schema-validation-00, section 8 + ContentEncoding string `json:"contentEncoding,omitempty"` // section 8.3 + ContentMediaType string `json:"contentMediaType,omitempty"` // section 8.4 + ContentSchema *Schema `json:"contentSchema,omitempty"` // section 8.5 + // RFC draft-bhutton-json-schema-validation-00, section 9 + Title string `json:"title,omitempty"` // section 9.1 + Description string `json:"description,omitempty"` // section 9.1 + Default any `json:"default,omitempty"` // section 9.2 + Deprecated bool `json:"deprecated,omitempty"` // section 9.3 + ReadOnly bool `json:"readOnly,omitempty"` // section 9.4 + WriteOnly bool `json:"writeOnly,omitempty"` // section 9.4 + Examples []any `json:"examples,omitempty"` // section 9.5 + + Extras map[string]any `json:"-"` + + // Special boolean representation of the Schema - section 4.3.2 + boolean *bool +} + +var ( + // TrueSchema defines a schema with a true value + TrueSchema = &Schema{boolean: &[]bool{true}[0]} + // FalseSchema defines a schema with a false value + FalseSchema = &Schema{boolean: &[]bool{false}[0]} +) + +// Definitions hold schema definitions. +// http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.26 +// RFC draft-wright-json-schema-validation-00, section 5.26 +type Definitions map[string]*Schema diff --git a/vendor/github.com/invopop/jsonschema/utils.go b/vendor/github.com/invopop/jsonschema/utils.go new file mode 100644 index 000000000..ed8edf741 --- /dev/null +++ b/vendor/github.com/invopop/jsonschema/utils.go @@ -0,0 +1,26 @@ +package jsonschema + +import ( + "regexp" + "strings" + + orderedmap "github.com/wk8/go-ordered-map/v2" +) + +var matchFirstCap = regexp.MustCompile("(.)([A-Z][a-z]+)") +var matchAllCap = regexp.MustCompile("([a-z0-9])([A-Z])") + +// ToSnakeCase converts the provided string into snake case using dashes. +// This is useful for Schema IDs and definitions to be coherent with +// common JSON Schema examples. +func ToSnakeCase(str string) string { + snake := matchFirstCap.ReplaceAllString(str, "${1}-${2}") + snake = matchAllCap.ReplaceAllString(snake, "${1}-${2}") + return strings.ToLower(snake) +} + +// NewProperties is a helper method to instantiate a new properties ordered +// map. +func NewProperties() *orderedmap.OrderedMap[string, *Schema] { + return orderedmap.New[string, *Schema]() +} diff --git a/vendor/github.com/wk8/go-ordered-map/v2/.gitignore b/vendor/github.com/wk8/go-ordered-map/v2/.gitignore new file mode 100644 index 000000000..57872d0f1 --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/.gitignore @@ -0,0 +1 @@ +/vendor/ diff --git a/vendor/github.com/wk8/go-ordered-map/v2/.golangci.yml b/vendor/github.com/wk8/go-ordered-map/v2/.golangci.yml new file mode 100644 index 000000000..2417df10d --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/.golangci.yml @@ -0,0 +1,80 @@ +run: + tests: false + +linters: + disable-all: true + enable: + - asciicheck + - bidichk + - bodyclose + - containedctx + - contextcheck + - decorder + - depguard + - dogsled + - dupl + - durationcheck + - errcheck + - errchkjson + # FIXME: commented out as it crashes with 1.18 for now + # - errname + - errorlint + - exportloopref + - forbidigo + - funlen + - gci + - gochecknoglobals + - gochecknoinits + - gocognit + - goconst + - gocritic + - gocyclo + - godox + - gofmt + - gofumpt + - goheader + - goimports + - gomnd + - gomoddirectives + - gomodguard + - goprintffuncname + - gosec + - gosimple + - govet + - grouper + - ifshort + - importas + - ineffassign + - lll + - maintidx + - makezero + - misspell + - nakedret + - nilerr + - nilnil + - noctx + - nolintlint + - paralleltest + - prealloc + - predeclared + - promlinter + # FIXME: doesn't support 1.18 yet + # - revive + - rowserrcheck + - sqlclosecheck + - staticcheck + - structcheck + - stylecheck + - tagliatelle + - tenv + - testpackage + - thelper + - tparallel + - typecheck + - unconvert + - unparam + - unused + - varcheck + - varnamelen + - wastedassign + - whitespace diff --git a/vendor/github.com/wk8/go-ordered-map/v2/CHANGELOG.md b/vendor/github.com/wk8/go-ordered-map/v2/CHANGELOG.md new file mode 100644 index 000000000..f27126f84 --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/CHANGELOG.md @@ -0,0 +1,38 @@ +# Changelog + +[comment]: # (Changes since last release go here) + +## 2.1.8 - Jun 27th 2023 + +* Added support for YAML serialization/deserialization + +## 2.1.7 - Apr 13th 2023 + +* Renamed test_utils.go to utils_test.go + +## 2.1.6 - Feb 15th 2023 + +* Added `GetAndMoveToBack()` and `GetAndMoveToFront()` methods + +## 2.1.5 - Dec 13th 2022 + +* Added `Value()` method + +## 2.1.4 - Dec 12th 2022 + +* Fixed a bug with UTF-8 special characters in JSON keys + +## 2.1.3 - Dec 11th 2022 + +* Added support for JSON marshalling/unmarshalling of wrapper of primitive types + +## 2.1.2 - Dec 10th 2022 +* Allowing to pass options to `New`, to give a capacity hint, or initial data +* Allowing to deserialize nested ordered maps from JSON without having to explicitly instantiate them +* Added the `AddPairs` method + +## 2.1.1 - Dec 9th 2022 +* Fixing a bug with JSON marshalling + +## 2.1.0 - Dec 7th 2022 +* Added support for JSON serialization/deserialization diff --git a/vendor/github.com/wk8/go-ordered-map/v2/LICENSE b/vendor/github.com/wk8/go-ordered-map/v2/LICENSE new file mode 100644 index 000000000..8dada3eda --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/vendor/github.com/wk8/go-ordered-map/v2/Makefile b/vendor/github.com/wk8/go-ordered-map/v2/Makefile new file mode 100644 index 000000000..6e0e18a1b --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/Makefile @@ -0,0 +1,32 @@ +.DEFAULT_GOAL := all + +.PHONY: all +all: test_with_fuzz lint + +# the TEST_FLAGS env var can be set to eg run only specific tests +TEST_COMMAND = go test -v -count=1 -race -cover $(TEST_FLAGS) + +.PHONY: test +test: + $(TEST_COMMAND) + +.PHONY: bench +bench: + go test -bench=. + +FUZZ_TIME ?= 10s + +# see https://github.com/golang/go/issues/46312 +# and https://stackoverflow.com/a/72673487/4867444 +# if we end up having more fuzz tests +.PHONY: test_with_fuzz +test_with_fuzz: + $(TEST_COMMAND) -fuzz=FuzzRoundTripJSON -fuzztime=$(FUZZ_TIME) + $(TEST_COMMAND) -fuzz=FuzzRoundTripYAML -fuzztime=$(FUZZ_TIME) + +.PHONY: fuzz +fuzz: test_with_fuzz + +.PHONY: lint +lint: + golangci-lint run diff --git a/vendor/github.com/wk8/go-ordered-map/v2/README.md b/vendor/github.com/wk8/go-ordered-map/v2/README.md new file mode 100644 index 000000000..b02894443 --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/README.md @@ -0,0 +1,154 @@ +[![Go Reference](https://pkg.go.dev/badge/github.com/wk8/go-ordered-map/v2.svg)](https://pkg.go.dev/github.com/wk8/go-ordered-map/v2) +[![Build Status](https://circleci.com/gh/wk8/go-ordered-map.svg?style=svg)](https://app.circleci.com/pipelines/github/wk8/go-ordered-map) + +# Golang Ordered Maps + +Same as regular maps, but also remembers the order in which keys were inserted, akin to [Python's `collections.OrderedDict`s](https://docs.python.org/3.7/library/collections.html#ordereddict-objects). + +It offers the following features: +* optimal runtime performance (all operations are constant time) +* optimal memory usage (only one copy of values, no unnecessary memory allocation) +* allows iterating from newest or oldest keys indifferently, without memory copy, allowing to `break` the iteration, and in time linear to the number of keys iterated over rather than the total length of the ordered map +* supports any generic types for both keys and values. If you're running go < 1.18, you can use [version 1](https://github.com/wk8/go-ordered-map/tree/v1) that takes and returns generic `interface{}`s instead of using generics +* idiomatic API, akin to that of [`container/list`](https://golang.org/pkg/container/list) +* support for JSON and YAML marshalling + +## Documentation + +[The full documentation is available on pkg.go.dev](https://pkg.go.dev/github.com/wk8/go-ordered-map/v2). + +## Installation +```bash +go get -u github.com/wk8/go-ordered-map/v2 +``` + +Or use your favorite golang vendoring tool! + +## Supported go versions + +Go >= 1.18 is required to use version >= 2 of this library, as it uses generics. + +If you're running go < 1.18, you can use [version 1](https://github.com/wk8/go-ordered-map/tree/v1) instead. + +## Example / usage + +```go +package main + +import ( + "fmt" + + "github.com/wk8/go-ordered-map/v2" +) + +func main() { + om := orderedmap.New[string, string]() + + om.Set("foo", "bar") + om.Set("bar", "baz") + om.Set("coucou", "toi") + + fmt.Println(om.Get("foo")) // => "bar", true + fmt.Println(om.Get("i dont exist")) // => "", false + + // iterating pairs from oldest to newest: + for pair := om.Oldest(); pair != nil; pair = pair.Next() { + fmt.Printf("%s => %s\n", pair.Key, pair.Value) + } // prints: + // foo => bar + // bar => baz + // coucou => toi + + // iterating over the 2 newest pairs: + i := 0 + for pair := om.Newest(); pair != nil; pair = pair.Prev() { + fmt.Printf("%s => %s\n", pair.Key, pair.Value) + i++ + if i >= 2 { + break + } + } // prints: + // coucou => toi + // bar => baz +} +``` + +An `OrderedMap`'s keys must implement `comparable`, and its values can be anything, for example: + +```go +type myStruct struct { + payload string +} + +func main() { + om := orderedmap.New[int, *myStruct]() + + om.Set(12, &myStruct{"foo"}) + om.Set(1, &myStruct{"bar"}) + + value, present := om.Get(12) + if !present { + panic("should be there!") + } + fmt.Println(value.payload) // => foo + + for pair := om.Oldest(); pair != nil; pair = pair.Next() { + fmt.Printf("%d => %s\n", pair.Key, pair.Value.payload) + } // prints: + // 12 => foo + // 1 => bar +} +``` + +Also worth noting that you can provision ordered maps with a capacity hint, as you would do by passing an optional hint to `make(map[K]V, capacity`): +```go +om := orderedmap.New[int, *myStruct](28) +``` + +You can also pass in some initial data to store in the map: +```go +om := orderedmap.New[int, string](orderedmap.WithInitialData[int, string]( + orderedmap.Pair[int, string]{ + Key: 12, + Value: "foo", + }, + orderedmap.Pair[int, string]{ + Key: 28, + Value: "bar", + }, +)) +``` + +`OrderedMap`s also support JSON serialization/deserialization, and preserves order: + +```go +// serialization +data, err := json.Marshal(om) +... + +// deserialization +om := orderedmap.New[string, string]() // or orderedmap.New[int, any](), or any type you expect +err := json.Unmarshal(data, &om) +... +``` + +Similarly, it also supports YAML serialization/deserialization using the yaml.v3 package, which also preserves order: + +```go +// serialization +data, err := yaml.Marshal(om) +... + +// deserialization +om := orderedmap.New[string, string]() // or orderedmap.New[int, any](), or any type you expect +err := yaml.Unmarshal(data, &om) +... +``` + +## Alternatives + +There are several other ordered map golang implementations out there, but I believe that at the time of writing none of them offer the same functionality as this library; more specifically: +* [iancoleman/orderedmap](https://github.com/iancoleman/orderedmap) only accepts `string` keys, its `Delete` operations are linear +* [cevaris/ordered_map](https://github.com/cevaris/ordered_map) uses a channel for iterations, and leaks goroutines if the iteration is interrupted before fully traversing the map +* [mantyr/iterator](https://github.com/mantyr/iterator) also uses a channel for iterations, and its `Delete` operations are linear +* [samdolan/go-ordered-map](https://github.com/samdolan/go-ordered-map) adds unnecessary locking (users should add their own locking instead if they need it), its `Delete` and `Get` operations are linear, iterations trigger a linear memory allocation diff --git a/vendor/github.com/wk8/go-ordered-map/v2/json.go b/vendor/github.com/wk8/go-ordered-map/v2/json.go new file mode 100644 index 000000000..a545b536b --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/json.go @@ -0,0 +1,182 @@ +package orderedmap + +import ( + "bytes" + "encoding" + "encoding/json" + "fmt" + "reflect" + "unicode/utf8" + + "github.com/buger/jsonparser" + "github.com/mailru/easyjson/jwriter" +) + +var ( + _ json.Marshaler = &OrderedMap[int, any]{} + _ json.Unmarshaler = &OrderedMap[int, any]{} +) + +// MarshalJSON implements the json.Marshaler interface. +func (om *OrderedMap[K, V]) MarshalJSON() ([]byte, error) { //nolint:funlen + if om == nil || om.list == nil { + return []byte("null"), nil + } + + writer := jwriter.Writer{} + writer.RawByte('{') + + for pair, firstIteration := om.Oldest(), true; pair != nil; pair = pair.Next() { + if firstIteration { + firstIteration = false + } else { + writer.RawByte(',') + } + + switch key := any(pair.Key).(type) { + case string: + writer.String(key) + case encoding.TextMarshaler: + writer.RawByte('"') + writer.Raw(key.MarshalText()) + writer.RawByte('"') + case int: + writer.IntStr(key) + case int8: + writer.Int8Str(key) + case int16: + writer.Int16Str(key) + case int32: + writer.Int32Str(key) + case int64: + writer.Int64Str(key) + case uint: + writer.UintStr(key) + case uint8: + writer.Uint8Str(key) + case uint16: + writer.Uint16Str(key) + case uint32: + writer.Uint32Str(key) + case uint64: + writer.Uint64Str(key) + default: + + // this switch takes care of wrapper types around primitive types, such as + // type myType string + switch keyValue := reflect.ValueOf(key); keyValue.Type().Kind() { + case reflect.String: + writer.String(keyValue.String()) + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: + writer.Int64Str(keyValue.Int()) + case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: + writer.Uint64Str(keyValue.Uint()) + default: + return nil, fmt.Errorf("unsupported key type: %T", key) + } + } + + writer.RawByte(':') + // the error is checked at the end of the function + writer.Raw(json.Marshal(pair.Value)) //nolint:errchkjson + } + + writer.RawByte('}') + + return dumpWriter(&writer) +} + +func dumpWriter(writer *jwriter.Writer) ([]byte, error) { + if writer.Error != nil { + return nil, writer.Error + } + + var buf bytes.Buffer + buf.Grow(writer.Size()) + if _, err := writer.DumpTo(&buf); err != nil { + return nil, err + } + + return buf.Bytes(), nil +} + +// UnmarshalJSON implements the json.Unmarshaler interface. +func (om *OrderedMap[K, V]) UnmarshalJSON(data []byte) error { + if om.list == nil { + om.initialize(0) + } + + return jsonparser.ObjectEach( + data, + func(keyData []byte, valueData []byte, dataType jsonparser.ValueType, offset int) error { + if dataType == jsonparser.String { + // jsonparser removes the enclosing quotes; we need to restore them to make a valid JSON + valueData = data[offset-len(valueData)-2 : offset] + } + + var key K + var value V + + switch typedKey := any(&key).(type) { + case *string: + s, err := decodeUTF8(keyData) + if err != nil { + return err + } + *typedKey = s + case encoding.TextUnmarshaler: + if err := typedKey.UnmarshalText(keyData); err != nil { + return err + } + case *int, *int8, *int16, *int32, *int64, *uint, *uint8, *uint16, *uint32, *uint64: + if err := json.Unmarshal(keyData, typedKey); err != nil { + return err + } + default: + // this switch takes care of wrapper types around primitive types, such as + // type myType string + switch reflect.TypeOf(key).Kind() { + case reflect.String: + s, err := decodeUTF8(keyData) + if err != nil { + return err + } + + convertedKeyData := reflect.ValueOf(s).Convert(reflect.TypeOf(key)) + reflect.ValueOf(&key).Elem().Set(convertedKeyData) + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, + reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: + if err := json.Unmarshal(keyData, &key); err != nil { + return err + } + default: + return fmt.Errorf("unsupported key type: %T", key) + } + } + + if err := json.Unmarshal(valueData, &value); err != nil { + return err + } + + om.Set(key, value) + return nil + }) +} + +func decodeUTF8(input []byte) (string, error) { + remaining, offset := input, 0 + runes := make([]rune, 0, len(remaining)) + + for len(remaining) > 0 { + r, size := utf8.DecodeRune(remaining) + if r == utf8.RuneError && size <= 1 { + return "", fmt.Errorf("not a valid UTF-8 string (at position %d): %s", offset, string(input)) + } + + runes = append(runes, r) + remaining = remaining[size:] + offset += size + } + + return string(runes), nil +} diff --git a/vendor/github.com/wk8/go-ordered-map/v2/orderedmap.go b/vendor/github.com/wk8/go-ordered-map/v2/orderedmap.go new file mode 100644 index 000000000..064714191 --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/orderedmap.go @@ -0,0 +1,296 @@ +// Package orderedmap implements an ordered map, i.e. a map that also keeps track of +// the order in which keys were inserted. +// +// All operations are constant-time. +// +// Github repo: https://github.com/wk8/go-ordered-map +// +package orderedmap + +import ( + "fmt" + + list "github.com/bahlo/generic-list-go" +) + +type Pair[K comparable, V any] struct { + Key K + Value V + + element *list.Element[*Pair[K, V]] +} + +type OrderedMap[K comparable, V any] struct { + pairs map[K]*Pair[K, V] + list *list.List[*Pair[K, V]] +} + +type initConfig[K comparable, V any] struct { + capacity int + initialData []Pair[K, V] +} + +type InitOption[K comparable, V any] func(config *initConfig[K, V]) + +// WithCapacity allows giving a capacity hint for the map, akin to the standard make(map[K]V, capacity). +func WithCapacity[K comparable, V any](capacity int) InitOption[K, V] { + return func(c *initConfig[K, V]) { + c.capacity = capacity + } +} + +// WithInitialData allows passing in initial data for the map. +func WithInitialData[K comparable, V any](initialData ...Pair[K, V]) InitOption[K, V] { + return func(c *initConfig[K, V]) { + c.initialData = initialData + if c.capacity < len(initialData) { + c.capacity = len(initialData) + } + } +} + +// New creates a new OrderedMap. +// options can either be one or several InitOption[K, V], or a single integer, +// which is then interpreted as a capacity hint, à la make(map[K]V, capacity). +func New[K comparable, V any](options ...any) *OrderedMap[K, V] { //nolint:varnamelen + orderedMap := &OrderedMap[K, V]{} + + var config initConfig[K, V] + for _, untypedOption := range options { + switch option := untypedOption.(type) { + case int: + if len(options) != 1 { + invalidOption() + } + config.capacity = option + + case InitOption[K, V]: + option(&config) + + default: + invalidOption() + } + } + + orderedMap.initialize(config.capacity) + orderedMap.AddPairs(config.initialData...) + + return orderedMap +} + +const invalidOptionMessage = `when using orderedmap.New[K,V]() with options, either provide one or several InitOption[K, V]; or a single integer which is then interpreted as a capacity hint, à la make(map[K]V, capacity).` //nolint:lll + +func invalidOption() { panic(invalidOptionMessage) } + +func (om *OrderedMap[K, V]) initialize(capacity int) { + om.pairs = make(map[K]*Pair[K, V], capacity) + om.list = list.New[*Pair[K, V]]() +} + +// Get looks for the given key, and returns the value associated with it, +// or V's nil value if not found. The boolean it returns says whether the key is present in the map. +func (om *OrderedMap[K, V]) Get(key K) (val V, present bool) { + if pair, present := om.pairs[key]; present { + return pair.Value, true + } + + return +} + +// Load is an alias for Get, mostly to present an API similar to `sync.Map`'s. +func (om *OrderedMap[K, V]) Load(key K) (V, bool) { + return om.Get(key) +} + +// Value returns the value associated with the given key or the zero value. +func (om *OrderedMap[K, V]) Value(key K) (val V) { + if pair, present := om.pairs[key]; present { + val = pair.Value + } + return +} + +// GetPair looks for the given key, and returns the pair associated with it, +// or nil if not found. The Pair struct can then be used to iterate over the ordered map +// from that point, either forward or backward. +func (om *OrderedMap[K, V]) GetPair(key K) *Pair[K, V] { + return om.pairs[key] +} + +// Set sets the key-value pair, and returns what `Get` would have returned +// on that key prior to the call to `Set`. +func (om *OrderedMap[K, V]) Set(key K, value V) (val V, present bool) { + if pair, present := om.pairs[key]; present { + oldValue := pair.Value + pair.Value = value + return oldValue, true + } + + pair := &Pair[K, V]{ + Key: key, + Value: value, + } + pair.element = om.list.PushBack(pair) + om.pairs[key] = pair + + return +} + +// AddPairs allows setting multiple pairs at a time. It's equivalent to calling +// Set on each pair sequentially. +func (om *OrderedMap[K, V]) AddPairs(pairs ...Pair[K, V]) { + for _, pair := range pairs { + om.Set(pair.Key, pair.Value) + } +} + +// Store is an alias for Set, mostly to present an API similar to `sync.Map`'s. +func (om *OrderedMap[K, V]) Store(key K, value V) (V, bool) { + return om.Set(key, value) +} + +// Delete removes the key-value pair, and returns what `Get` would have returned +// on that key prior to the call to `Delete`. +func (om *OrderedMap[K, V]) Delete(key K) (val V, present bool) { + if pair, present := om.pairs[key]; present { + om.list.Remove(pair.element) + delete(om.pairs, key) + return pair.Value, true + } + return +} + +// Len returns the length of the ordered map. +func (om *OrderedMap[K, V]) Len() int { + if om == nil || om.pairs == nil { + return 0 + } + return len(om.pairs) +} + +// Oldest returns a pointer to the oldest pair. It's meant to be used to iterate on the ordered map's +// pairs from the oldest to the newest, e.g.: +// for pair := orderedMap.Oldest(); pair != nil; pair = pair.Next() { fmt.Printf("%v => %v\n", pair.Key, pair.Value) } +func (om *OrderedMap[K, V]) Oldest() *Pair[K, V] { + if om == nil || om.list == nil { + return nil + } + return listElementToPair(om.list.Front()) +} + +// Newest returns a pointer to the newest pair. It's meant to be used to iterate on the ordered map's +// pairs from the newest to the oldest, e.g.: +// for pair := orderedMap.Oldest(); pair != nil; pair = pair.Next() { fmt.Printf("%v => %v\n", pair.Key, pair.Value) } +func (om *OrderedMap[K, V]) Newest() *Pair[K, V] { + if om == nil || om.list == nil { + return nil + } + return listElementToPair(om.list.Back()) +} + +// Next returns a pointer to the next pair. +func (p *Pair[K, V]) Next() *Pair[K, V] { + return listElementToPair(p.element.Next()) +} + +// Prev returns a pointer to the previous pair. +func (p *Pair[K, V]) Prev() *Pair[K, V] { + return listElementToPair(p.element.Prev()) +} + +func listElementToPair[K comparable, V any](element *list.Element[*Pair[K, V]]) *Pair[K, V] { + if element == nil { + return nil + } + return element.Value +} + +// KeyNotFoundError may be returned by functions in this package when they're called with keys that are not present +// in the map. +type KeyNotFoundError[K comparable] struct { + MissingKey K +} + +func (e *KeyNotFoundError[K]) Error() string { + return fmt.Sprintf("missing key: %v", e.MissingKey) +} + +// MoveAfter moves the value associated with key to its new position after the one associated with markKey. +// Returns an error iff key or markKey are not present in the map. If an error is returned, +// it will be a KeyNotFoundError. +func (om *OrderedMap[K, V]) MoveAfter(key, markKey K) error { + elements, err := om.getElements(key, markKey) + if err != nil { + return err + } + om.list.MoveAfter(elements[0], elements[1]) + return nil +} + +// MoveBefore moves the value associated with key to its new position before the one associated with markKey. +// Returns an error iff key or markKey are not present in the map. If an error is returned, +// it will be a KeyNotFoundError. +func (om *OrderedMap[K, V]) MoveBefore(key, markKey K) error { + elements, err := om.getElements(key, markKey) + if err != nil { + return err + } + om.list.MoveBefore(elements[0], elements[1]) + return nil +} + +func (om *OrderedMap[K, V]) getElements(keys ...K) ([]*list.Element[*Pair[K, V]], error) { + elements := make([]*list.Element[*Pair[K, V]], len(keys)) + for i, k := range keys { + pair, present := om.pairs[k] + if !present { + return nil, &KeyNotFoundError[K]{k} + } + elements[i] = pair.element + } + return elements, nil +} + +// MoveToBack moves the value associated with key to the back of the ordered map, +// i.e. makes it the newest pair in the map. +// Returns an error iff key is not present in the map. If an error is returned, +// it will be a KeyNotFoundError. +func (om *OrderedMap[K, V]) MoveToBack(key K) error { + _, err := om.GetAndMoveToBack(key) + return err +} + +// MoveToFront moves the value associated with key to the front of the ordered map, +// i.e. makes it the oldest pair in the map. +// Returns an error iff key is not present in the map. If an error is returned, +// it will be a KeyNotFoundError. +func (om *OrderedMap[K, V]) MoveToFront(key K) error { + _, err := om.GetAndMoveToFront(key) + return err +} + +// GetAndMoveToBack combines Get and MoveToBack in the same call. If an error is returned, +// it will be a KeyNotFoundError. +func (om *OrderedMap[K, V]) GetAndMoveToBack(key K) (val V, err error) { + if pair, present := om.pairs[key]; present { + val = pair.Value + om.list.MoveToBack(pair.element) + } else { + err = &KeyNotFoundError[K]{key} + } + + return +} + +// GetAndMoveToFront combines Get and MoveToFront in the same call. If an error is returned, +// it will be a KeyNotFoundError. +func (om *OrderedMap[K, V]) GetAndMoveToFront(key K) (val V, err error) { + if pair, present := om.pairs[key]; present { + val = pair.Value + om.list.MoveToFront(pair.element) + } else { + err = &KeyNotFoundError[K]{key} + } + + return +} diff --git a/vendor/github.com/wk8/go-ordered-map/v2/yaml.go b/vendor/github.com/wk8/go-ordered-map/v2/yaml.go new file mode 100644 index 000000000..602247128 --- /dev/null +++ b/vendor/github.com/wk8/go-ordered-map/v2/yaml.go @@ -0,0 +1,71 @@ +package orderedmap + +import ( + "fmt" + + "gopkg.in/yaml.v3" +) + +var ( + _ yaml.Marshaler = &OrderedMap[int, any]{} + _ yaml.Unmarshaler = &OrderedMap[int, any]{} +) + +// MarshalYAML implements the yaml.Marshaler interface. +func (om *OrderedMap[K, V]) MarshalYAML() (interface{}, error) { + if om == nil { + return []byte("null"), nil + } + + node := yaml.Node{ + Kind: yaml.MappingNode, + } + + for pair := om.Oldest(); pair != nil; pair = pair.Next() { + key, value := pair.Key, pair.Value + + keyNode := &yaml.Node{} + + // serialize key to yaml, then deserialize it back into the node + // this is a hack to get the correct tag for the key + if err := keyNode.Encode(key); err != nil { + return nil, err + } + + valueNode := &yaml.Node{} + if err := valueNode.Encode(value); err != nil { + return nil, err + } + + node.Content = append(node.Content, keyNode, valueNode) + } + + return &node, nil +} + +// UnmarshalYAML implements the yaml.Unmarshaler interface. +func (om *OrderedMap[K, V]) UnmarshalYAML(value *yaml.Node) error { + if value.Kind != yaml.MappingNode { + return fmt.Errorf("pipeline must contain YAML mapping, has %v", value.Kind) + } + + if om.list == nil { + om.initialize(0) + } + + for index := 0; index < len(value.Content); index += 2 { + var key K + var val V + + if err := value.Content[index].Decode(&key); err != nil { + return err + } + if err := value.Content[index+1].Decode(&val); err != nil { + return err + } + + om.Set(key, val) + } + + return nil +} diff --git a/vendor/modules.txt b/vendor/modules.txt index 2a0aa92e2..846761a82 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -45,6 +45,9 @@ github.com/antlr/antlr4/runtime/Go/antlr/v4 # github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 ## explicit; go 1.13 github.com/asaskevich/govalidator +# github.com/bahlo/generic-list-go v0.2.0 +## explicit; go 1.18 +github.com/bahlo/generic-list-go # github.com/beorn7/perks v1.0.1 ## explicit; go 1.11 github.com/beorn7/perks/quantile @@ -54,6 +57,9 @@ github.com/blang/semver # github.com/blang/semver/v4 v4.0.0 ## explicit; go 1.14 github.com/blang/semver/v4 +# github.com/buger/jsonparser v1.1.1 +## explicit; go 1.13 +github.com/buger/jsonparser # github.com/cenkalti/backoff/v4 v4.2.1 ## explicit; go 1.18 github.com/cenkalti/backoff/v4 @@ -90,6 +96,9 @@ github.com/coreos/go-systemd/v22/journal # github.com/cpuguy83/go-md2man/v2 v2.0.3 ## explicit; go 1.11 github.com/cpuguy83/go-md2man/v2/md2man +# github.com/creasty/defaults v1.7.0 +## explicit; go 1.14 +github.com/creasty/defaults # github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc ## explicit github.com/davecgh/go-spew/spew @@ -141,6 +150,9 @@ github.com/fsnotify/fsnotify # github.com/fvbommel/sortorder v1.1.0 ## explicit; go 1.13 github.com/fvbommel/sortorder +# github.com/gertd/go-pluralize v0.2.1 +## explicit; go 1.17 +github.com/gertd/go-pluralize # github.com/ghodss/yaml v1.0.0 ## explicit github.com/ghodss/yaml @@ -185,8 +197,6 @@ github.com/go-openapi/strfmt # github.com/go-openapi/swag v0.22.7 ## explicit; go 1.19 github.com/go-openapi/swag -# github.com/go-spectest/markdown v0.0.7 -## explicit; go 1.18 # github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 ## explicit; go 1.13 github.com/go-task/slim-sprig @@ -313,6 +323,9 @@ github.com/inconshreveable/go-update/internal/osext # github.com/inconshreveable/mousetrap v1.1.0 ## explicit; go 1.18 github.com/inconshreveable/mousetrap +# github.com/invopop/jsonschema v0.12.0 +## explicit; go 1.18 +github.com/invopop/jsonschema # github.com/jonboulle/clockwork v0.4.0 ## explicit; go 1.15 github.com/jonboulle/clockwork @@ -325,8 +338,6 @@ github.com/json-iterator/go # github.com/k0kubun/go-ansi v0.0.0-20180517002512-3bf9e2903213 ## explicit github.com/k0kubun/go-ansi -# github.com/karrick/godirwalk v1.17.0 -## explicit; go 1.13 # github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 ## explicit github.com/kballard/go-shellquote @@ -608,6 +619,9 @@ github.com/ulikunitz/xz/lzma # github.com/vmware-labs/yaml-jsonpath v0.3.2 ## explicit; go 1.13 github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath +# github.com/wk8/go-ordered-map/v2 v2.1.8 +## explicit; go 1.18 +github.com/wk8/go-ordered-map/v2 # github.com/xlab/treeprint v1.2.0 ## explicit; go 1.13 github.com/xlab/treeprint