mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Update APIs
This commit is contained in:
Jason Boxman
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
52978a5891
commit
9af7f567de
@@ -1656,6 +1656,8 @@ Topics:
|
||||
File: prometheusrule-monitoring-coreos-com-v1
|
||||
- Name: 'ServiceMonitor [monitoring.coreos.com/v1]'
|
||||
File: servicemonitor-monitoring-coreos-com-v1
|
||||
- Name: 'ThanosRuler [monitoring.coreos.com/v1]'
|
||||
File: thanosruler-monitoring-coreos-com-v1
|
||||
- Name: Network APIs
|
||||
Dir: network_apis
|
||||
Topics:
|
||||
@@ -1673,6 +1675,8 @@ Topics:
|
||||
File: hostsubnet-network-openshift-io-v1
|
||||
- Name: 'Ingress [networking.k8s.io/v1beta1]'
|
||||
File: ingress-networking-k8s-io-v1beta1
|
||||
- Name: 'IngressClass [networking.k8s.io/v1beta1]'
|
||||
File: ingressclass-networking-k8s-io-v1beta1
|
||||
- Name: 'NetNamespace [network.openshift.io/v1]'
|
||||
File: netnamespace-network-openshift-io-v1
|
||||
- Name: 'NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]'
|
||||
@@ -1718,6 +1722,8 @@ Topics:
|
||||
File: authentication-operator-openshift-io-v1
|
||||
- Name: 'Console [operator.openshift.io/v1]'
|
||||
File: console-operator-openshift-io-v1
|
||||
- Name: 'Config [operator.openshift.io/v1]'
|
||||
File: config-operator-openshift-io-v1
|
||||
- Name: 'Config [imageregistry.operator.openshift.io/v1]'
|
||||
File: config-imageregistry-operator-openshift-io-v1
|
||||
- Name: 'Config [samples.operator.openshift.io/v1]'
|
||||
@@ -1752,17 +1758,11 @@ Topics:
|
||||
File: openshiftcontrollermanager-operator-openshift-io-v1
|
||||
- Name: 'ServiceCA [operator.openshift.io/v1]'
|
||||
File: serviceca-operator-openshift-io-v1
|
||||
- Name: 'ServiceCatalogAPIServer [operator.openshift.io/v1]'
|
||||
File: servicecatalogapiserver-operator-openshift-io-v1
|
||||
- Name: 'ServiceCatalogControllerManager [operator.openshift.io/v1]'
|
||||
File: servicecatalogcontrollermanager-operator-openshift-io-v1
|
||||
- Name: OperatorHub APIs
|
||||
Dir: operatorhub_apis
|
||||
Topics:
|
||||
- Name: About OperatorHub APIs
|
||||
File: operatorhub-apis-index
|
||||
- Name: 'CatalogSourceConfig [operators.coreos.com/v1]'
|
||||
File: catalogsourceconfig-operators-coreos-com-v1
|
||||
- Name: 'CatalogSource [operators.coreos.com/v1alpha1]'
|
||||
File: catalogsource-operators-coreos-com-v1alpha1
|
||||
- Name: 'ClusterServiceVersion [operators.coreos.com/v1alpha1]'
|
||||
@@ -1866,8 +1866,8 @@ Topics:
|
||||
Topics:
|
||||
- Name: About Storage APIs
|
||||
File: storage-apis-index
|
||||
- Name: 'CSIDriver [storage.k8s.io/v1beta1]'
|
||||
File: csidriver-storage-k8s-io-v1beta1
|
||||
- Name: 'CSIDriver [storage.k8s.io/v1]'
|
||||
File: csidriver-storage-k8s-io-v1
|
||||
- Name: 'CSINode [storage.k8s.io/v1]'
|
||||
File: csinode-storage-k8s-io-v1
|
||||
- Name: 'PersistentVolumeClaim [core/v1]'
|
||||
|
||||
@@ -109,7 +109,6 @@ Type::
|
||||
|
||||
Required::
|
||||
- `verbs`
|
||||
- `apiGroups`
|
||||
- `resources`
|
||||
|
||||
|
||||
|
||||
@@ -119,7 +119,6 @@ Type::
|
||||
|
||||
Required::
|
||||
- `verbs`
|
||||
- `apiGroups`
|
||||
- `resources`
|
||||
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ toc::[]
|
||||
== ClusterAutoscaler [autoscaling.openshift.io/v1]
|
||||
|
||||
Description::
|
||||
|
||||
ClusterAutoscaler is the Schema for the clusterautoscalers API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -17,7 +17,7 @@ Type::
|
||||
== MachineAutoscaler [autoscaling.openshift.io/v1beta1]
|
||||
|
||||
Description::
|
||||
|
||||
MachineAutoscaler is the Schema for the machineautoscalers API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
|
||||
ClusterAutoscaler is the Schema for the clusterautoscalers API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -17,3 +17,246 @@ Type::
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| Desired state of ClusterAutoscaler resource
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
| Most recently observed status of ClusterAutoscaler resource
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
Desired state of ClusterAutoscaler resource
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `balanceSimilarNodeGroups`
|
||||
| `boolean`
|
||||
| BalanceSimilarNodeGroups enables/disables the `--balance-similar-node-groups` cluster-autocaler feature. This feature will automatically identify node groups with the same instance type and the same set of labels and try to keep the respective sizes of those node groups balanced.
|
||||
|
||||
| `ignoreDaemonsetsUtilization`
|
||||
| `boolean`
|
||||
| Enables/Disables `--ignore-daemonsets-utilization` CA feature flag. Should CA ignore DaemonSet pods when calculating resource utilization for scaling down. false by default
|
||||
|
||||
| `maxPodGracePeriod`
|
||||
| `integer`
|
||||
| Gives pods graceful termination time before scaling down
|
||||
|
||||
| `podPriorityThreshold`
|
||||
| `integer`
|
||||
| To allow users to schedule "best-effort" pods, which shouldn't trigger Cluster Autoscaler actions, but only run when there are spare resources available, More info: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption
|
||||
|
||||
| `resourceLimits`
|
||||
| `object`
|
||||
| Constraints of autoscaling resources
|
||||
|
||||
| `scaleDown`
|
||||
| `object`
|
||||
| Configuration of scale down operation
|
||||
|
||||
| `skipNodesWithLocalStorage`
|
||||
| `boolean`
|
||||
| Enables/Disables `--skip-nodes-with-local-storage` CA feature flag. If true cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath. true by default at autoscaler
|
||||
|
||||
|===
|
||||
..spec.resourceLimits
|
||||
Description::
|
||||
Constraints of autoscaling resources
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `cores`
|
||||
| `object`
|
||||
| Minimum and maximum number of cores in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
|
||||
| `gpus`
|
||||
| `array`
|
||||
| Minimum and maximum number of different GPUs in cluster, in the format <gpu_type>:<min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers. Can be passed multiple times.
|
||||
|
||||
| `gpus[]`
|
||||
| `object`
|
||||
|
|
||||
|
||||
| `maxNodesTotal`
|
||||
| `integer`
|
||||
| Maximum number of nodes in all node groups. Cluster autoscaler will not grow the cluster beyond this number.
|
||||
|
||||
| `memory`
|
||||
| `object`
|
||||
| Minimum and maximum number of gigabytes of memory in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
|
||||
|===
|
||||
..spec.resourceLimits.cores
|
||||
Description::
|
||||
Minimum and maximum number of cores in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `max`
|
||||
- `min`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `max`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
| `min`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
|===
|
||||
..spec.resourceLimits.gpus
|
||||
Description::
|
||||
Minimum and maximum number of different GPUs in cluster, in the format <gpu_type>:<min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers. Can be passed multiple times.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.resourceLimits.gpus[]
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `max`
|
||||
- `min`
|
||||
- `type`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `max`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
| `min`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..spec.resourceLimits.memory
|
||||
Description::
|
||||
Minimum and maximum number of gigabytes of memory in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `max`
|
||||
- `min`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `max`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
| `min`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
|===
|
||||
..spec.scaleDown
|
||||
Description::
|
||||
Configuration of scale down operation
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `enabled`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `delayAfterAdd`
|
||||
| `string`
|
||||
| How long after scale up that scale down evaluation resumes
|
||||
|
||||
| `delayAfterDelete`
|
||||
| `string`
|
||||
| How long after node deletion that scale down evaluation resumes, defaults to scan-interval
|
||||
|
||||
| `delayAfterFailure`
|
||||
| `string`
|
||||
| How long after scale down failure that scale down evaluation resumes
|
||||
|
||||
| `enabled`
|
||||
| `boolean`
|
||||
| Should CA scale down the cluster
|
||||
|
||||
| `unneededTime`
|
||||
| `string`
|
||||
| How long a node should be unneeded before it is eligible for scale down
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
Most recently observed status of ClusterAutoscaler resource
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
|
||||
MachineAutoscaler is the Schema for the machineautoscalers API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -17,3 +17,138 @@ Type::
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| Specification of constraints of a scalable resource
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
| Most recently observed status of a scalable resource
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
Specification of constraints of a scalable resource
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `maxReplicas`
|
||||
- `minReplicas`
|
||||
- `scaleTargetRef`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `maxReplicas`
|
||||
| `integer`
|
||||
| MaxReplicas constrains the maximal number of replicas of a scalable resource
|
||||
|
||||
| `minReplicas`
|
||||
| `integer`
|
||||
| MinReplicas constrains the minimal number of replicas of a scalable resource
|
||||
|
||||
| `scaleTargetRef`
|
||||
| `object`
|
||||
| ScaleTargetRef holds reference to a scalable resource
|
||||
|
||||
|===
|
||||
..spec.scaleTargetRef
|
||||
Description::
|
||||
ScaleTargetRef holds reference to a scalable resource
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `kind`
|
||||
- `name`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name specifies a name of an object, e.g. worker-us-east-1a. Scalable resources are expected to exist under a single namespace.
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
Most recently observed status of a scalable resource
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `lastTargetRef`
|
||||
| `object`
|
||||
| LastTargetRef holds reference to the recently observed scalable resource
|
||||
|
||||
|===
|
||||
..status.lastTargetRef
|
||||
Description::
|
||||
LastTargetRef holds reference to the recently observed scalable resource
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `kind`
|
||||
- `name`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name specifies a name of an object, e.g. worker-us-east-1a. Scalable resources are expected to exist under a single namespace.
|
||||
|
||||
|===
|
||||
|
||||
@@ -37,16 +37,16 @@ Required::
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
|
|
||||
| spec holds user settable values for configuration
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
|
|
||||
| status holds observed values from the cluster. They may not be overridden.
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
|
||||
spec holds user settable values for configuration
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -251,7 +251,7 @@ Type::
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
|
||||
status holds observed values from the cluster. They may not be overridden.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
@@ -64,7 +64,7 @@ Type::
|
||||
|
||||
| `serviceAccountIssuer`
|
||||
| `string`
|
||||
| serviceAccountIssuer is the identifier of the bound service account token issuer. The default is auth.openshift.io.
|
||||
| serviceAccountIssuer is the identifier of the bound service account token issuer. The default is https://kubernetes.default.svc
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
|
||||
@@ -60,12 +60,18 @@ Type::
|
||||
|
||||
| `cloudConfig`
|
||||
| `object`
|
||||
| cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
|
||||
| cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
|
||||
cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace with the kube cloud config is stored in `cloud.conf` key. All the clients are expected to use the generated ConfigMap only.
|
||||
|
||||
| `platformSpec`
|
||||
| `object`
|
||||
| platformSpec holds desired information specific to the underlying infrastructure provider.
|
||||
|
||||
|===
|
||||
..spec.cloudConfig
|
||||
Description::
|
||||
cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
|
||||
cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
|
||||
cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace with the kube cloud config is stored in `cloud.conf` key. All the clients are expected to use the generated ConfigMap only.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -86,6 +92,183 @@ Type::
|
||||
|
|
||||
|
||||
|===
|
||||
..spec.platformSpec
|
||||
Description::
|
||||
platformSpec holds desired information specific to the underlying infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `aws`
|
||||
| `object`
|
||||
| AWS contains settings specific to the Amazon Web Services infrastructure provider.
|
||||
|
||||
| `azure`
|
||||
| `object`
|
||||
| Azure contains settings specific to the Azure infrastructure provider.
|
||||
|
||||
| `baremetal`
|
||||
| `object`
|
||||
| BareMetal contains settings specific to the BareMetal platform.
|
||||
|
||||
| `gcp`
|
||||
| `object`
|
||||
| GCP contains settings specific to the Google Cloud Platform infrastructure provider.
|
||||
|
||||
| `ibmcloud`
|
||||
| `object`
|
||||
| IBMCloud contains settings specific to the IBMCloud infrastructure provider.
|
||||
|
||||
| `openstack`
|
||||
| `object`
|
||||
| OpenStack contains settings specific to the OpenStack infrastructure provider.
|
||||
|
||||
| `ovirt`
|
||||
| `object`
|
||||
| Ovirt contains settings specific to the oVirt infrastructure provider.
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
| type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.
|
||||
|
||||
| `vsphere`
|
||||
| `object`
|
||||
| VSphere contains settings specific to the VSphere infrastructure provider.
|
||||
|
||||
|===
|
||||
..spec.platformSpec.aws
|
||||
Description::
|
||||
AWS contains settings specific to the Amazon Web Services infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `serviceEndpoints`
|
||||
| `array`
|
||||
| serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
|
||||
|
||||
| `serviceEndpoints[]`
|
||||
| `object`
|
||||
| AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
|
||||
|
||||
|===
|
||||
..spec.platformSpec.aws.serviceEndpoints
|
||||
Description::
|
||||
serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.platformSpec.aws.serviceEndpoints[]
|
||||
Description::
|
||||
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.
|
||||
|
||||
| `url`
|
||||
| `string`
|
||||
| url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.
|
||||
|
||||
|===
|
||||
..spec.platformSpec.azure
|
||||
Description::
|
||||
Azure contains settings specific to the Azure infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.platformSpec.baremetal
|
||||
Description::
|
||||
BareMetal contains settings specific to the BareMetal platform.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.platformSpec.gcp
|
||||
Description::
|
||||
GCP contains settings specific to the Google Cloud Platform infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.platformSpec.ibmcloud
|
||||
Description::
|
||||
IBMCloud contains settings specific to the IBMCloud infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.platformSpec.openstack
|
||||
Description::
|
||||
OpenStack contains settings specific to the OpenStack infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.platformSpec.ovirt
|
||||
Description::
|
||||
Ovirt contains settings specific to the oVirt infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.platformSpec.vsphere
|
||||
Description::
|
||||
VSphere contains settings specific to the VSphere infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..status
|
||||
Description::
|
||||
status holds observed values from the cluster. They may not be overridden.
|
||||
@@ -156,6 +339,10 @@ Type::
|
||||
| `object`
|
||||
| GCP contains settings specific to the Google Cloud Platform infrastructure provider.
|
||||
|
||||
| `ibmcloud`
|
||||
| `object`
|
||||
| IBMCloud contains settings specific to the IBMCloud infrastructure provider.
|
||||
|
||||
| `openstack`
|
||||
| `object`
|
||||
| OpenStack contains settings specific to the OpenStack infrastructure provider.
|
||||
@@ -166,7 +353,8 @@ Type::
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
| type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.
|
||||
| type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.
|
||||
This value will be synced with to the `status.platform` and `status.platformStatus.type`. Currently this value cannot be changed once set.
|
||||
|
||||
| `vsphere`
|
||||
| `object`
|
||||
@@ -191,6 +379,47 @@ Type::
|
||||
| `string`
|
||||
| region holds the default AWS region for new AWS resources created by the cluster.
|
||||
|
||||
| `serviceEndpoints`
|
||||
| `array`
|
||||
| ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
|
||||
|
||||
| `serviceEndpoints[]`
|
||||
| `object`
|
||||
| AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
|
||||
|
||||
|===
|
||||
..status.platformStatus.aws.serviceEndpoints
|
||||
Description::
|
||||
ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.platformStatus.aws.serviceEndpoints[]
|
||||
Description::
|
||||
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.
|
||||
|
||||
| `url`
|
||||
| `string`
|
||||
| url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.
|
||||
|
||||
|===
|
||||
..status.platformStatus.azure
|
||||
Description::
|
||||
@@ -264,6 +493,33 @@ Type::
|
||||
| `string`
|
||||
| region holds the region for new GCP resources created for the cluster.
|
||||
|
||||
|===
|
||||
..status.platformStatus.ibmcloud
|
||||
Description::
|
||||
IBMCloud contains settings specific to the IBMCloud infrastructure provider.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `location`
|
||||
| `string`
|
||||
| Location is where the cluster has been deployed
|
||||
|
||||
| `providerType`
|
||||
| `string`
|
||||
| ProviderType indicates the type of cluster that was created
|
||||
|
||||
| `resourceGroupName`
|
||||
| `string`
|
||||
| ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.
|
||||
|
||||
|===
|
||||
..status.platformStatus.openstack
|
||||
Description::
|
||||
|
||||
@@ -37,16 +37,16 @@ Required::
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| OAuthSpec contains desired cluster auth configuration
|
||||
| spec holds user settable values for configuration
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
| OAuthStatus shows current known state of OAuth server in the cluster
|
||||
| status holds observed values from the cluster. They may not be overridden.
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
OAuthSpec contains desired cluster auth configuration
|
||||
spec holds user settable values for configuration
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -980,7 +980,7 @@ Type::
|
||||
|
||||
| `accessTokenInactivityTimeoutSeconds`
|
||||
| `integer`
|
||||
| accessTokenInactivityTimeoutSeconds defines the default token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Valid values are integer values: x < 0 Tokens time out is enabled but tokens never timeout unless configured per client (e.g. `-1`) x = 0 Tokens time out is disabled (default) x > 0 Tokens time out if there is no activity for x seconds The current minimum allowed value for X is 300 (5 minutes)
|
||||
| accessTokenInactivityTimeoutSeconds - DEPRECATED: setting this field has no effect.
|
||||
|
||||
| `accessTokenMaxAgeSeconds`
|
||||
| `integer`
|
||||
@@ -989,7 +989,7 @@ Type::
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
OAuthStatus shows current known state of OAuth server in the cluster
|
||||
status holds observed values from the cluster. They may not be overridden.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
@@ -50,7 +50,6 @@ Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `service`
|
||||
- `groupPriorityMinimum`
|
||||
- `versionPriority`
|
||||
|
||||
|
||||
@@ -455,9 +455,6 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `acceptedNames`
|
||||
- `storedVersions`
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -49,7 +49,7 @@ Type::
|
||||
== MachineHealthCheck [machine.openshift.io/v1beta1]
|
||||
|
||||
Description::
|
||||
|
||||
MachineHealthCheck is the Schema for the machinehealthchecks API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -57,7 +57,7 @@ Type::
|
||||
== Machine [machine.openshift.io/v1beta1]
|
||||
|
||||
Description::
|
||||
|
||||
/ [Machine] Machine is the Schema for the machines API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -65,7 +65,7 @@ Type::
|
||||
== MachineSet [machine.openshift.io/v1beta1]
|
||||
|
||||
Description::
|
||||
|
||||
/ [MachineSet] MachineSet ensures that a specified number of machines replicas are running at any given time.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
|
||||
/ [Machine] Machine is the Schema for the machines API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -17,3 +17,411 @@ Type::
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| / [MachineSpec] MachineSpec defines the desired state of Machine
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
| / [MachineStatus] MachineStatus defines the observed state of Machine
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
/ [MachineSpec] MachineSpec defines the desired state of Machine
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `metadata`
|
||||
| `object`
|
||||
| ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.
|
||||
|
||||
| `providerID`
|
||||
| `string`
|
||||
| ProviderID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.
|
||||
|
||||
| `providerSpec`
|
||||
| `object`
|
||||
| ProviderSpec details Provider-specific configuration to use during node creation.
|
||||
|
||||
| `taints`
|
||||
| `array`
|
||||
| The list of the taints to be applied to the corresponding Node in additive manner. This list will not overwrite any other taints added to the Node on an ongoing basis by other entities. These taints should be actively reconciled e.g. if you ask the machine controller to apply a taint and then manually remove the taint the machine controller will put it back) but not have the machine controller remove any taints
|
||||
|
||||
| `taints[]`
|
||||
| `object`
|
||||
| The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
|
||||
|
||||
|===
|
||||
..spec.metadata
|
||||
Description::
|
||||
ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `generateName`
|
||||
| `string`
|
||||
| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
|
||||
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
|
||||
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
|
||||
|
||||
| `labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
| `namespace`
|
||||
| `string`
|
||||
| Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
|
||||
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
|
||||
|
||||
| `ownerReferences`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `ownerReferences[]`
|
||||
| `object`
|
||||
| OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
|
||||
|
||||
|===
|
||||
..spec.metadata.ownerReferences
|
||||
Description::
|
||||
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.metadata.ownerReferences[]
|
||||
Description::
|
||||
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `apiVersion`
|
||||
- `kind`
|
||||
- `name`
|
||||
- `uid`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| API version of the referent.
|
||||
|
||||
| `blockOwnerDeletion`
|
||||
| `boolean`
|
||||
| If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
|
||||
|
||||
| `controller`
|
||||
| `boolean`
|
||||
| If true, this reference points to the managing controller.
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
| `uid`
|
||||
| `string`
|
||||
| UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
|
||||
|===
|
||||
..spec.providerSpec
|
||||
Description::
|
||||
ProviderSpec details Provider-specific configuration to use during node creation.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `value`
|
||||
| `object`
|
||||
| Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.
|
||||
|
||||
|===
|
||||
..spec.providerSpec.value
|
||||
Description::
|
||||
Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.taints
|
||||
Description::
|
||||
The list of the taints to be applied to the corresponding Node in additive manner. This list will not overwrite any other taints added to the Node on an ongoing basis by other entities. These taints should be actively reconciled e.g. if you ask the machine controller to apply a taint and then manually remove the taint the machine controller will put it back) but not have the machine controller remove any taints
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.taints[]
|
||||
Description::
|
||||
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `effect`
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `effect`
|
||||
| `string`
|
||||
| Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| Required. The taint key to be applied to a node.
|
||||
|
||||
| `timeAdded`
|
||||
| `string`
|
||||
| TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
|
||||
|
||||
| `value`
|
||||
| `string`
|
||||
| The taint value corresponding to the taint key.
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
/ [MachineStatus] MachineStatus defines the observed state of Machine
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `addresses`
|
||||
| `array`
|
||||
| Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.
|
||||
|
||||
| `addresses[]`
|
||||
| `object`
|
||||
| NodeAddress contains information for the node's address.
|
||||
|
||||
| `errorMessage`
|
||||
| `string`
|
||||
| ErrorMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.
|
||||
This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.
|
||||
Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.
|
||||
|
||||
| `errorReason`
|
||||
| `string`
|
||||
| ErrorReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.
|
||||
This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.
|
||||
Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.
|
||||
|
||||
| `lastOperation`
|
||||
| `object`
|
||||
| LastOperation describes the last-operation performed by the machine-controller. This API should be useful as a history in terms of the latest operation performed on the specific machine. It should also convey the state of the latest-operation for example if it is still on-going, failed or completed successfully.
|
||||
|
||||
| `lastUpdated`
|
||||
| `string`
|
||||
| LastUpdated identifies when this status was last observed.
|
||||
|
||||
| `nodeRef`
|
||||
| `object`
|
||||
| NodeRef will point to the corresponding Node if it exists.
|
||||
|
||||
| `phase`
|
||||
| `string`
|
||||
| Phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting
|
||||
|
||||
| `providerStatus`
|
||||
| `object`
|
||||
| ProviderStatus details a Provider-specific status. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field.
|
||||
|
||||
|===
|
||||
..status.addresses
|
||||
Description::
|
||||
Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.addresses[]
|
||||
Description::
|
||||
NodeAddress contains information for the node's address.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `address`
|
||||
- `type`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `address`
|
||||
| `string`
|
||||
| The node address.
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
| Node address type, one of Hostname, ExternalIP or InternalIP.
|
||||
|
||||
|===
|
||||
..status.lastOperation
|
||||
Description::
|
||||
LastOperation describes the last-operation performed by the machine-controller. This API should be useful as a history in terms of the latest operation performed on the specific machine. It should also convey the state of the latest-operation for example if it is still on-going, failed or completed successfully.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `description`
|
||||
| `string`
|
||||
| Description is the human-readable description of the last operation.
|
||||
|
||||
| `lastUpdated`
|
||||
| `string`
|
||||
| LastUpdated is the timestamp at which LastOperation API was last-updated.
|
||||
|
||||
| `state`
|
||||
| `string`
|
||||
| State is the current status of the last performed operation. E.g. Processing, Failed, Successful etc
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
| Type is the type of operation which was last performed. E.g. Create, Delete, Update etc
|
||||
|
||||
|===
|
||||
..status.nodeRef
|
||||
Description::
|
||||
NodeRef will point to the corresponding Node if it exists.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| API version of the referent.
|
||||
|
||||
| `fieldPath`
|
||||
| `string`
|
||||
| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
|
||||
| `namespace`
|
||||
| `string`
|
||||
| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
||||
|
||||
| `resourceVersion`
|
||||
| `string`
|
||||
| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
|
||||
|
||||
| `uid`
|
||||
| `string`
|
||||
| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
|
||||
|
||||
|===
|
||||
..status.providerStatus
|
||||
Description::
|
||||
ProviderStatus details a Provider-specific status. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
|
||||
MachineHealthCheck is the Schema for the machinehealthchecks API
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -17,3 +17,200 @@ Type::
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| Specification of machine health check policy
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
| Most recently observed status of MachineHealthCheck resource
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
Specification of machine health check policy
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `selector`
|
||||
- `unhealthyConditions`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `maxUnhealthy`
|
||||
| `integer-or-string`
|
||||
| Any farther remediation is only allowed if at most "MaxUnhealthy" machines selected by "selector" are not healthy.
|
||||
|
||||
| `nodeStartupTimeout`
|
||||
| `string`
|
||||
| Machines older than this duration without a node will be considered to have failed and will be remediated.
|
||||
|
||||
| `selector`
|
||||
| `object`
|
||||
| Label selector to match machines whose health will be exercised. Note: An empty selector will match all machines.
|
||||
|
||||
| `unhealthyConditions`
|
||||
| `array`
|
||||
| UnhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.
|
||||
|
||||
| `unhealthyConditions[]`
|
||||
| `object`
|
||||
| UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.
|
||||
|
||||
|===
|
||||
..spec.selector
|
||||
Description::
|
||||
Label selector to match machines whose health will be exercised. Note: An empty selector will match all machines.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchLabels`
|
||||
| `object (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.selector.matchExpressions
|
||||
Description::
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.selector.matchExpressions[]
|
||||
Description::
|
||||
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| key is the label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.unhealthyConditions
|
||||
Description::
|
||||
UnhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.unhealthyConditions[]
|
||||
Description::
|
||||
UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `status`
|
||||
- `timeout`
|
||||
- `type`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `status`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `timeout`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
Most recently observed status of MachineHealthCheck resource
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `currentHealthy`
|
||||
- `expectedMachines`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `currentHealthy`
|
||||
| `integer`
|
||||
| total number of machines counted by this machine health check
|
||||
|
||||
| `expectedMachines`
|
||||
| `integer`
|
||||
| total number of machines counted by this machine health check
|
||||
|
||||
|===
|
||||
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
|
||||
/ [MachineSet] MachineSet ensures that a specified number of machines replicas are running at any given time.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -17,3 +17,510 @@ Type::
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| / [MachineSetSpec] MachineSetSpec defines the desired state of MachineSet
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
| / [MachineSetStatus] MachineSetStatus defines the observed state of MachineSet
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
/ [MachineSetSpec] MachineSetSpec defines the desired state of MachineSet
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `selector`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `deletePolicy`
|
||||
| `string`
|
||||
| DeletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to "Random". Valid values are "Random, "Newest", "Oldest"
|
||||
|
||||
| `minReadySeconds`
|
||||
| `integer`
|
||||
| MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. Defaults to 0 (machine will be considered available as soon as it is ready)
|
||||
|
||||
| `replicas`
|
||||
| `integer`
|
||||
| Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.
|
||||
|
||||
| `selector`
|
||||
| `object`
|
||||
| Selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
|
||||
|
||||
| `template`
|
||||
| `object`
|
||||
| Template is the object that describes the machine that will be created if insufficient replicas are detected.
|
||||
|
||||
|===
|
||||
..spec.selector
|
||||
Description::
|
||||
Selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchLabels`
|
||||
| `object (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.selector.matchExpressions
|
||||
Description::
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.selector.matchExpressions[]
|
||||
Description::
|
||||
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| key is the label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.template
|
||||
Description::
|
||||
Template is the object that describes the machine that will be created if insufficient replicas are detected.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `metadata`
|
||||
| `object`
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
|
||||
|
||||
| `spec`
|
||||
| `object`
|
||||
| Specification of the desired behavior of the machine. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
|
||||
|
||||
|===
|
||||
..spec.template.metadata
|
||||
Description::
|
||||
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `generateName`
|
||||
| `string`
|
||||
| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
|
||||
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
|
||||
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
|
||||
|
||||
| `labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
| `namespace`
|
||||
| `string`
|
||||
| Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
|
||||
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
|
||||
|
||||
| `ownerReferences`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `ownerReferences[]`
|
||||
| `object`
|
||||
| OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
|
||||
|
||||
|===
|
||||
..spec.template.metadata.ownerReferences
|
||||
Description::
|
||||
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.template.metadata.ownerReferences[]
|
||||
Description::
|
||||
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `apiVersion`
|
||||
- `kind`
|
||||
- `name`
|
||||
- `uid`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| API version of the referent.
|
||||
|
||||
| `blockOwnerDeletion`
|
||||
| `boolean`
|
||||
| If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
|
||||
|
||||
| `controller`
|
||||
| `boolean`
|
||||
| If true, this reference points to the managing controller.
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
| `uid`
|
||||
| `string`
|
||||
| UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
|
||||
|===
|
||||
..spec.template.spec
|
||||
Description::
|
||||
Specification of the desired behavior of the machine. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `metadata`
|
||||
| `object`
|
||||
| ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.
|
||||
|
||||
| `providerID`
|
||||
| `string`
|
||||
| ProviderID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.
|
||||
|
||||
| `providerSpec`
|
||||
| `object`
|
||||
| ProviderSpec details Provider-specific configuration to use during node creation.
|
||||
|
||||
| `taints`
|
||||
| `array`
|
||||
| The list of the taints to be applied to the corresponding Node in additive manner. This list will not overwrite any other taints added to the Node on an ongoing basis by other entities. These taints should be actively reconciled e.g. if you ask the machine controller to apply a taint and then manually remove the taint the machine controller will put it back) but not have the machine controller remove any taints
|
||||
|
||||
| `taints[]`
|
||||
| `object`
|
||||
| The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
|
||||
|
||||
|===
|
||||
..spec.template.spec.metadata
|
||||
Description::
|
||||
ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `generateName`
|
||||
| `string`
|
||||
| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
|
||||
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
|
||||
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
|
||||
|
||||
| `labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
| `namespace`
|
||||
| `string`
|
||||
| Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
|
||||
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
|
||||
|
||||
| `ownerReferences`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `ownerReferences[]`
|
||||
| `object`
|
||||
| OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
|
||||
|
||||
|===
|
||||
..spec.template.spec.metadata.ownerReferences
|
||||
Description::
|
||||
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.template.spec.metadata.ownerReferences[]
|
||||
Description::
|
||||
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `apiVersion`
|
||||
- `kind`
|
||||
- `name`
|
||||
- `uid`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| API version of the referent.
|
||||
|
||||
| `blockOwnerDeletion`
|
||||
| `boolean`
|
||||
| If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
|
||||
|
||||
| `controller`
|
||||
| `boolean`
|
||||
| If true, this reference points to the managing controller.
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
| `uid`
|
||||
| `string`
|
||||
| UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
|
||||
|===
|
||||
..spec.template.spec.providerSpec
|
||||
Description::
|
||||
ProviderSpec details Provider-specific configuration to use during node creation.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `value`
|
||||
| `object`
|
||||
| Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.
|
||||
|
||||
|===
|
||||
..spec.template.spec.providerSpec.value
|
||||
Description::
|
||||
Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.template.spec.taints
|
||||
Description::
|
||||
The list of the taints to be applied to the corresponding Node in additive manner. This list will not overwrite any other taints added to the Node on an ongoing basis by other entities. These taints should be actively reconciled e.g. if you ask the machine controller to apply a taint and then manually remove the taint the machine controller will put it back) but not have the machine controller remove any taints
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.template.spec.taints[]
|
||||
Description::
|
||||
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `effect`
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `effect`
|
||||
| `string`
|
||||
| Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| Required. The taint key to be applied to a node.
|
||||
|
||||
| `timeAdded`
|
||||
| `string`
|
||||
| TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
|
||||
|
||||
| `value`
|
||||
| `string`
|
||||
| The taint value corresponding to the taint key.
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
/ [MachineSetStatus] MachineSetStatus defines the observed state of MachineSet
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `replicas`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `availableReplicas`
|
||||
| `integer`
|
||||
| The number of available replicas (ready for at least minReadySeconds) for this MachineSet.
|
||||
|
||||
| `errorMessage`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `errorReason`
|
||||
| `string`
|
||||
| In the event that there is a terminal problem reconciling the replicas, both ErrorReason and ErrorMessage will be set. ErrorReason will be populated with a succinct value suitable for machine interpretation, while ErrorMessage will contain a more verbose string suitable for logging and human consumption.
|
||||
These fields should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachineTemplate's spec or the configuration of the machine controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the machine controller, or the responsible machine controller itself being critically misconfigured.
|
||||
Any transient errors that occur during the reconciliation of Machines can be added as events to the MachineSet object and/or logged in the controller's output.
|
||||
|
||||
| `fullyLabeledReplicas`
|
||||
| `integer`
|
||||
| The number of replicas that have labels matching the labels of the machine template of the MachineSet.
|
||||
|
||||
| `observedGeneration`
|
||||
| `integer`
|
||||
| ObservedGeneration reflects the generation of the most recently observed MachineSet.
|
||||
|
||||
| `readyReplicas`
|
||||
| `integer`
|
||||
| The number of ready replicas for this MachineSet. A machine is considered ready when the node has been created and is "Ready".
|
||||
|
||||
| `replicas`
|
||||
| `integer`
|
||||
| Replicas is the most recently observed number of replicas.
|
||||
|
||||
|===
|
||||
|
||||
@@ -33,6 +33,10 @@ Type::
|
||||
| `object (string)`
|
||||
| Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
|
||||
|
||||
| `.immutable`
|
||||
| `boolean`
|
||||
| Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is an alpha field enabled by ImmutableEphemeralVolumes feature gate.
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
@@ -132,7 +132,7 @@ Type::
|
||||
|
||||
| `podMetadata`
|
||||
| `object`
|
||||
| Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata Labels and Annotations gets propagated to the prometheus pods.
|
||||
| PodMetadata configures Labels and Annotations which are propagated to the alertmanager pods.
|
||||
|
||||
| `portName`
|
||||
| `string`
|
||||
@@ -1290,7 +1290,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -1332,7 +1332,7 @@ Required::
|
||||
|===
|
||||
..spec.containers[].env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -2354,7 +2354,7 @@ Type::
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.
|
||||
|
||||
|===
|
||||
..spec.containers[].startupProbe
|
||||
@@ -2610,7 +2610,7 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.imagePullSecrets
|
||||
@@ -2836,7 +2836,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -2878,7 +2878,7 @@ Required::
|
||||
|===
|
||||
..spec.initContainers[].env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -3900,7 +3900,7 @@ Type::
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.
|
||||
|
||||
|===
|
||||
..spec.initContainers[].startupProbe
|
||||
@@ -4156,12 +4156,12 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.podMetadata
|
||||
Description::
|
||||
Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata Labels and Annotations gets propagated to the prometheus pods.
|
||||
PodMetadata configures Labels and Annotations which are propagated to the alertmanager pods.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -4169,6 +4169,23 @@ Type::
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|===
|
||||
..spec.resources
|
||||
Description::
|
||||
Define resources requests and limits for single Pods.
|
||||
@@ -4336,7 +4353,7 @@ Type::
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.
|
||||
|
||||
|===
|
||||
..spec.storage
|
||||
@@ -4409,7 +4426,7 @@ Type::
|
||||
|
||||
| `metadata`
|
||||
| `object`
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
| EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
|
||||
|
||||
| `spec`
|
||||
| `object`
|
||||
@@ -4422,7 +4439,7 @@ Type::
|
||||
|===
|
||||
..spec.storage.volumeClaimTemplate.metadata
|
||||
Description::
|
||||
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -4430,6 +4447,23 @@ Type::
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|===
|
||||
..spec.storage.volumeClaimTemplate.spec
|
||||
Description::
|
||||
Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
@@ -4774,7 +4808,7 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.volumes
|
||||
|
||||
@@ -46,3 +46,11 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== ThanosRuler [monitoring.coreos.com/v1]
|
||||
|
||||
Description::
|
||||
ThanosRuler defines a ThanosRuler deployment.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
@@ -167,7 +167,7 @@ Type::
|
||||
|
||||
| `port`
|
||||
| `string`
|
||||
| Name of the port this endpoint refers to. Mutually exclusive with targetPort.
|
||||
| Name of the pod port this endpoint refers to. Mutually exclusive with targetPort.
|
||||
|
||||
| `proxyUrl`
|
||||
| `string`
|
||||
@@ -191,7 +191,7 @@ Type::
|
||||
|
||||
| `targetPort`
|
||||
| `integer-or-string`
|
||||
| Name or number of the target port of the endpoint. Mutually exclusive with port.
|
||||
| Deprecated: Use 'port' instead.
|
||||
|
||||
|===
|
||||
..spec.podMetricsEndpoints[].metricRelabelings
|
||||
|
||||
@@ -180,7 +180,7 @@ Type::
|
||||
|
||||
| `podMetadata`
|
||||
| `object`
|
||||
| Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata Labels and Annotations gets propagated to the prometheus pods.
|
||||
| PodMetadata configures Labels and Annotations which are propagated to the prometheus pods.
|
||||
|
||||
| `podMonitorNamespaceSelector`
|
||||
| `object`
|
||||
@@ -280,7 +280,7 @@ Type::
|
||||
|
||||
| `serviceMonitorSelector`
|
||||
| `object`
|
||||
| ServiceMonitors to be selected for target discovery.
|
||||
| ServiceMonitors to be selected for target discovery. *Deprecated:* if neither this nor podMonitorSelector are specified, configuration is unmanaged.
|
||||
|
||||
| `sha`
|
||||
| `string`
|
||||
@@ -312,6 +312,14 @@ Type::
|
||||
| `string`
|
||||
| Version of Prometheus to be deployed.
|
||||
|
||||
| `volumeMounts`
|
||||
| `array`
|
||||
| VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects.
|
||||
|
||||
| `volumeMounts[]`
|
||||
| `object`
|
||||
| VolumeMount describes a mounting of a Volume within a container.
|
||||
|
||||
| `volumes`
|
||||
| `array`
|
||||
| Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.
|
||||
@@ -2190,7 +2198,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -2232,7 +2240,7 @@ Required::
|
||||
|===
|
||||
..spec.containers[].env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -3254,7 +3262,7 @@ Type::
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.
|
||||
|
||||
|===
|
||||
..spec.containers[].startupProbe
|
||||
@@ -3510,7 +3518,7 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.imagePullSecrets
|
||||
@@ -3736,7 +3744,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -3778,7 +3786,7 @@ Required::
|
||||
|===
|
||||
..spec.initContainers[].env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -4800,7 +4808,7 @@ Type::
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.
|
||||
|
||||
|===
|
||||
..spec.initContainers[].startupProbe
|
||||
@@ -5056,12 +5064,12 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.podMetadata
|
||||
Description::
|
||||
Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata Labels and Annotations gets propagated to the prometheus pods.
|
||||
PodMetadata configures Labels and Annotations which are propagated to the prometheus pods.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -5069,6 +5077,23 @@ Type::
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|===
|
||||
..spec.podMonitorNamespaceSelector
|
||||
Description::
|
||||
Namespaces to be selected for PodMonitor discovery. If nil, only check own namespace.
|
||||
@@ -6449,7 +6474,7 @@ Type::
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.
|
||||
|
||||
|===
|
||||
..spec.serviceMonitorNamespaceSelector
|
||||
@@ -6521,7 +6546,7 @@ Required::
|
||||
|===
|
||||
..spec.serviceMonitorSelector
|
||||
Description::
|
||||
ServiceMonitors to be selected for target discovery.
|
||||
ServiceMonitors to be selected for target discovery. *Deprecated:* if neither this nor podMonitorSelector are specified, configuration is unmanaged.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -6656,7 +6681,7 @@ Type::
|
||||
|
||||
| `metadata`
|
||||
| `object`
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
| EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
|
||||
|
||||
| `spec`
|
||||
| `object`
|
||||
@@ -6669,7 +6694,7 @@ Type::
|
||||
|===
|
||||
..spec.storage.volumeClaimTemplate.metadata
|
||||
Description::
|
||||
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -6677,6 +6702,23 @@ Type::
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|===
|
||||
..spec.storage.volumeClaimTemplate.spec
|
||||
Description::
|
||||
Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
@@ -6947,6 +6989,10 @@ Type::
|
||||
| `string`
|
||||
| Thanos base image if other than default.
|
||||
|
||||
| `grpcServerTlsConfig`
|
||||
| `object`
|
||||
| GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the '--grpc-server-tls-*' CLI args.
|
||||
|
||||
| `image`
|
||||
| `string`
|
||||
| Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Thanos is being configured.
|
||||
@@ -6971,10 +7017,252 @@ Type::
|
||||
| `string`
|
||||
| Tag of Thanos sidecar container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set.
|
||||
|
||||
| `tracingConfig`
|
||||
| `object`
|
||||
| TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way.
|
||||
|
||||
| `version`
|
||||
| `string`
|
||||
| Version describes the version of Thanos to use.
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig
|
||||
Description::
|
||||
GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the '--grpc-server-tls-*' CLI args.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `ca`
|
||||
| `object`
|
||||
| Stuct containing the CA cert to use for the targets.
|
||||
|
||||
| `caFile`
|
||||
| `string`
|
||||
| Path to the CA cert in the Prometheus container to use for the targets.
|
||||
|
||||
| `cert`
|
||||
| `object`
|
||||
| Struct containing the client cert file for the targets.
|
||||
|
||||
| `certFile`
|
||||
| `string`
|
||||
| Path to the client cert file in the Prometheus container for the targets.
|
||||
|
||||
| `insecureSkipVerify`
|
||||
| `boolean`
|
||||
| Disable target certificate validation.
|
||||
|
||||
| `keyFile`
|
||||
| `string`
|
||||
| Path to the client key file in the Prometheus container for the targets.
|
||||
|
||||
| `keySecret`
|
||||
| `object`
|
||||
| Secret containing the client key file for the targets.
|
||||
|
||||
| `serverName`
|
||||
| `string`
|
||||
| Used to verify the hostname for the targets.
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig.ca
|
||||
Description::
|
||||
Stuct containing the CA cert to use for the targets.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `configMap`
|
||||
| `object`
|
||||
| ConfigMap containing data to use for the targets.
|
||||
|
||||
| `secret`
|
||||
| `object`
|
||||
| Secret containing data to use for the targets.
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig.ca.configMap
|
||||
Description::
|
||||
ConfigMap containing data to use for the targets.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The key to select.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
|
||||
|
||||
| `optional`
|
||||
| `boolean`
|
||||
| Specify whether the ConfigMap or its key must be defined
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig.ca.secret
|
||||
Description::
|
||||
Secret containing data to use for the targets.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The key of the secret to select from. Must be a valid secret key.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
|
||||
|
||||
| `optional`
|
||||
| `boolean`
|
||||
| Specify whether the Secret or its key must be defined
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig.cert
|
||||
Description::
|
||||
Struct containing the client cert file for the targets.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `configMap`
|
||||
| `object`
|
||||
| ConfigMap containing data to use for the targets.
|
||||
|
||||
| `secret`
|
||||
| `object`
|
||||
| Secret containing data to use for the targets.
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig.cert.configMap
|
||||
Description::
|
||||
ConfigMap containing data to use for the targets.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The key to select.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
|
||||
|
||||
| `optional`
|
||||
| `boolean`
|
||||
| Specify whether the ConfigMap or its key must be defined
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig.cert.secret
|
||||
Description::
|
||||
Secret containing data to use for the targets.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The key of the secret to select from. Must be a valid secret key.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
|
||||
|
||||
| `optional`
|
||||
| `boolean`
|
||||
| Specify whether the Secret or its key must be defined
|
||||
|
||||
|===
|
||||
..spec.thanos.grpcServerTlsConfig.keySecret
|
||||
Description::
|
||||
Secret containing the client key file for the targets.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The key of the secret to select from. Must be a valid secret key.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
|
||||
|
||||
| `optional`
|
||||
| `boolean`
|
||||
| Specify whether the Secret or its key must be defined
|
||||
|
||||
|===
|
||||
..spec.thanos.objectStorageConfig
|
||||
Description::
|
||||
@@ -7027,6 +7315,35 @@ Type::
|
||||
| `object (string)`
|
||||
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
|===
|
||||
..spec.thanos.tracingConfig
|
||||
Description::
|
||||
TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The key of the secret to select from. Must be a valid secret key.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
|
||||
|
||||
| `optional`
|
||||
| `boolean`
|
||||
| Specify whether the Secret or its key must be defined
|
||||
|
||||
|===
|
||||
..spec.tolerations
|
||||
Description::
|
||||
@@ -7072,6 +7389,58 @@ Type::
|
||||
| `string`
|
||||
| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
|
||||
|
||||
|===
|
||||
..spec.volumeMounts
|
||||
Description::
|
||||
VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.volumeMounts[]
|
||||
Description::
|
||||
VolumeMount describes a mounting of a Volume within a container.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `mountPath`
|
||||
- `name`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `mountPath`
|
||||
| `string`
|
||||
| Path within the container at which the volume should be mounted. Must not contain ':'.
|
||||
|
||||
| `mountPropagation`
|
||||
| `string`
|
||||
| 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.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| This must match the Name of a Volume.
|
||||
|
||||
| `readOnly`
|
||||
| `boolean`
|
||||
| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
|
||||
|
||||
| `subPath`
|
||||
| `string`
|
||||
| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.volumes
|
||||
Description::
|
||||
|
||||
@@ -60,7 +60,7 @@ Type::
|
||||
|
||||
| `groups[]`
|
||||
| `object`
|
||||
| RuleGroup is a list of sequentially evaluated recording and alerting rules.
|
||||
| RuleGroup is a list of sequentially evaluated recording and alerting rules. Note: PartialResponseStrategy is only used by ThanosRuler and will be ignored by Prometheus instances. Valid values for this field are 'warn' or 'abort'. More info: https://github.com/thanos-io/thanos/blob/master/docs/components/rule.md#partial-response
|
||||
|
||||
|===
|
||||
..spec.groups
|
||||
@@ -75,7 +75,7 @@ Type::
|
||||
|
||||
..spec.groups[]
|
||||
Description::
|
||||
RuleGroup is a list of sequentially evaluated recording and alerting rules.
|
||||
RuleGroup is a list of sequentially evaluated recording and alerting rules. Note: PartialResponseStrategy is only used by ThanosRuler and will be ignored by Prometheus instances. Valid values for this field are 'warn' or 'abort'. More info: https://github.com/thanos-io/thanos/blob/master/docs/components/rule.md#partial-response
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -98,6 +98,10 @@ Required::
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `partial_response_strategy`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `rules`
|
||||
| `array`
|
||||
|
|
||||
|
||||
@@ -184,7 +184,7 @@ Type::
|
||||
|
||||
| `targetPort`
|
||||
| `integer-or-string`
|
||||
| Name or number of the target port of the endpoint. Mutually exclusive with port.
|
||||
| Name or number of the pod port this endpoint refers to. Mutually exclusive with port.
|
||||
|
||||
| `tlsConfig`
|
||||
| `object`
|
||||
|
||||
7078
rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc
Normal file
7078
rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc
Normal file
File diff suppressed because it is too large
Load Diff
@@ -155,7 +155,7 @@ Type::
|
||||
|
||||
| `appProtocol`
|
||||
| `string`
|
||||
| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names. Default is empty string.
|
||||
| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
|
||||
@@ -60,6 +60,10 @@ Type::
|
||||
| `object`
|
||||
| IngressBackend describes all endpoints for a given service and port.
|
||||
|
||||
| `ingressClassName`
|
||||
| `string`
|
||||
| IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
|
||||
|
||||
| `rules`
|
||||
| `array`
|
||||
| A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
|
||||
@@ -84,9 +88,6 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `serviceName`
|
||||
- `servicePort`
|
||||
|
||||
|
||||
|
||||
@@ -94,6 +95,10 @@ Required::
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `resource`
|
||||
| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`]
|
||||
| Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.
|
||||
|
||||
| `serviceName`
|
||||
| `string`
|
||||
| Specifies the name of the referenced service.
|
||||
@@ -129,13 +134,15 @@ Type::
|
||||
|
||||
| `host`
|
||||
| `string`
|
||||
| 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 the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
|
||||
IP in the Spec of the parent Ingress.
|
||||
| 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.
|
||||
|
||||
| `http`
|
||||
| `object`
|
||||
| HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.
|
||||
@@ -163,7 +170,7 @@ Required::
|
||||
|
||||
| `paths[]`
|
||||
| `object`
|
||||
| HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
|
||||
| HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.
|
||||
|
||||
|===
|
||||
..spec.rules[].http.paths
|
||||
@@ -178,7 +185,7 @@ Type::
|
||||
|
||||
..spec.rules[].http.paths[]
|
||||
Description::
|
||||
HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
|
||||
HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -198,7 +205,21 @@ Required::
|
||||
|
||||
| `path`
|
||||
| `string`
|
||||
| Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) 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 '/'. If unspecified, the path defaults to a catch all sending traffic to the backend.
|
||||
| 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 '/'. When unspecified, all paths from incoming requests are matched.
|
||||
|
||||
| `pathType`
|
||||
| `string`
|
||||
| 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. Defaults to ImplementationSpecific.
|
||||
|
||||
|===
|
||||
..spec.rules[].http.paths[].backend
|
||||
@@ -208,9 +229,6 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `serviceName`
|
||||
- `servicePort`
|
||||
|
||||
|
||||
|
||||
@@ -218,6 +236,10 @@ Required::
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `resource`
|
||||
| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`]
|
||||
| Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.
|
||||
|
||||
| `serviceName`
|
||||
| `string`
|
||||
| Specifies the name of the referenced service.
|
||||
@@ -257,7 +279,7 @@ Type::
|
||||
|
||||
| `secretName`
|
||||
| `string`
|
||||
| SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL 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.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..status
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
[id="ingressclass-networking-k8s-io-v1beta1"]
|
||||
= IngressClass [networking.k8s.io/v1beta1]
|
||||
ifdef::product-title[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| IngressClassSpec provides information about the class of an Ingress.
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
IngressClassSpec provides information about the class of an Ingress.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `controller`
|
||||
| `string`
|
||||
| Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.
|
||||
|
||||
| `parameters`
|
||||
| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`]
|
||||
| Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.
|
||||
|
||||
|===
|
||||
@@ -65,6 +65,14 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== IngressClass [networking.k8s.io/v1beta1]
|
||||
|
||||
Description::
|
||||
IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== NetNamespace [network.openshift.io/v1]
|
||||
|
||||
Description::
|
||||
|
||||
@@ -179,7 +179,7 @@ Type::
|
||||
|
||||
| `ipBlock`
|
||||
| `object`
|
||||
| IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
| IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
|
||||
| `namespaceSelector`
|
||||
| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`]
|
||||
@@ -196,7 +196,7 @@ If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
|
||||
|===
|
||||
..spec.egress[].to[].ipBlock
|
||||
Description::
|
||||
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -212,11 +212,11 @@ Required::
|
||||
|
||||
| `cidr`
|
||||
| `string`
|
||||
| CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
|
||||
| CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
|
||||
|
||||
| `except`
|
||||
| `array (string)`
|
||||
| Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
|
||||
| Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
|
||||
|
||||
|===
|
||||
..spec.ingress
|
||||
@@ -286,7 +286,7 @@ Type::
|
||||
|
||||
| `ipBlock`
|
||||
| `object`
|
||||
| IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
| IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
|
||||
| `namespaceSelector`
|
||||
| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`]
|
||||
@@ -303,7 +303,7 @@ If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
|
||||
|===
|
||||
..spec.ingress[].from[].ipBlock
|
||||
Description::
|
||||
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -319,11 +319,11 @@ Required::
|
||||
|
||||
| `cidr`
|
||||
| `string`
|
||||
| CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
|
||||
| CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
|
||||
|
||||
| `except`
|
||||
| `array (string)`
|
||||
| Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
|
||||
| Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
|
||||
|
||||
|===
|
||||
..spec.ingress[].ports
|
||||
|
||||
@@ -250,8 +250,6 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `ingress`
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -81,7 +81,7 @@ Required::
|
||||
|
||||
| `tunedProfile`
|
||||
| `string`
|
||||
|
|
||||
| tuned profile to apply
|
||||
|
||||
|===
|
||||
..status
|
||||
@@ -94,3 +94,12 @@ Type::
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `bootcmdline`
|
||||
| `string`
|
||||
| kernel parameters calculated by tuned for the active tuned profile
|
||||
|
||||
|===
|
||||
|
||||
@@ -139,6 +139,10 @@ Required::
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `machineConfigLabels`
|
||||
| `object (string)`
|
||||
| MachineConfigLabels specifies the labels for a MachineConfig. The MachineConfig is created automatically to apply additional host settings (e.g. kernel boot parameters) profile 'Profile' needs and can only be applied by creating a MachineConfig. This involves finding all MachineConfigPools with machineConfigSelector matching the MachineConfigLabels and setting the profile 'Profile' on all nodes that match the MachineConfigPools' nodeSelectors.
|
||||
|
||||
| `match`
|
||||
| `array`
|
||||
| Rules governing application of a tuned profile connected by logical OR operator.
|
||||
|
||||
@@ -844,7 +844,7 @@ Required::
|
||||
|
||||
| `.startupProbe`
|
||||
| xref:../objects/index.adoc#probe-core-v1[`Probe core/v1`]
|
||||
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
|
||||
| `.stdin`
|
||||
| `boolean`
|
||||
@@ -868,7 +868,7 @@ Required::
|
||||
|
||||
| `.volumeDevices`
|
||||
| xref:../objects/index.adoc#volumedevice-core-v1[`array (VolumeDevice core/v1)`]
|
||||
| volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
| volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
| `.volumeMounts`
|
||||
| xref:../objects/index.adoc#volumemount-core-v1[`array (VolumeMount core/v1)`]
|
||||
@@ -1288,6 +1288,10 @@ Required::
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.appProtocol`
|
||||
| `string`
|
||||
| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. Field can be enabled with ServiceAppProtocol feature gate.
|
||||
|
||||
| `.name`
|
||||
| `string`
|
||||
| The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
|
||||
@@ -1545,7 +1549,7 @@ Required::
|
||||
|
||||
| `.volumeDevices`
|
||||
| xref:../objects/index.adoc#volumedevice-core-v1[`array (VolumeDevice core/v1)`]
|
||||
| volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
| volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
| `.volumeMounts`
|
||||
| xref:../objects/index.adoc#volumemount-core-v1[`array (VolumeMount core/v1)`]
|
||||
@@ -2315,6 +2319,8 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `type`
|
||||
|
||||
[discrete]
|
||||
=== Specification
|
||||
@@ -2983,7 +2989,7 @@ Type::
|
||||
|
||||
| `dataSource`
|
||||
| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`]
|
||||
| This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.
|
||||
| This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) 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. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.
|
||||
|
||||
| `resources`
|
||||
| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`]
|
||||
@@ -2999,7 +3005,7 @@ Type::
|
||||
|
||||
| `volumeMode`
|
||||
| `string`
|
||||
| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature.
|
||||
| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
|
||||
|
||||
| `volumeName`
|
||||
| `string`
|
||||
@@ -3246,7 +3252,7 @@ Type::
|
||||
|
||||
| `.volumeMode`
|
||||
| `string`
|
||||
| volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is a beta feature.
|
||||
| volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.
|
||||
|
||||
| `.vsphereVolume`
|
||||
| xref:../objects/index.adoc#vspherevirtualdiskvolumesource-core-v1[`VsphereVirtualDiskVolumeSource core/v1`]
|
||||
@@ -3558,6 +3564,10 @@ Type::
|
||||
|
||||
If unset, the Kubelet will not modify the ownership and permissions of any volume.
|
||||
|
||||
| `.fsGroupChangePolicy`
|
||||
| `string`
|
||||
| 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 defaults to "Always".
|
||||
|
||||
| `.runAsGroup`
|
||||
| `integer`
|
||||
| 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.
|
||||
@@ -3738,7 +3748,7 @@ Required::
|
||||
|
||||
| `.topologySpreadConstraints`
|
||||
| xref:../objects/index.adoc#topologyspreadconstraint-core-v1[`array (TopologySpreadConstraint core/v1)`]
|
||||
| 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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
| 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. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
|
||||
| `.volumes`
|
||||
| xref:../objects/index.adoc#volume-core-v1[`array (Volume core/v1)`]
|
||||
@@ -4744,6 +4754,10 @@ Required::
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.appProtocol`
|
||||
| `string`
|
||||
| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. Field can be enabled with ServiceAppProtocol feature gate.
|
||||
|
||||
| `.name`
|
||||
| `string`
|
||||
| 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.
|
||||
@@ -4966,7 +4980,7 @@ Required::
|
||||
|
||||
| `.value`
|
||||
| `string`
|
||||
| Required. The taint value corresponding to the taint key.
|
||||
| The taint value corresponding to the taint key.
|
||||
|
||||
|===
|
||||
|
||||
@@ -5505,15 +5519,15 @@ Type::
|
||||
|
||||
| `.gmsaCredentialSpec`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| 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.
|
||||
|
||||
| `.gmsaCredentialSpecName`
|
||||
| `string`
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use.
|
||||
|
||||
| `.runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
|
||||
@@ -5599,6 +5613,42 @@ Type::
|
||||
|
||||
|
||||
|
||||
[id="groupversionkind-meta-v1"]
|
||||
== GroupVersionKind [meta/v1]
|
||||
|
||||
|
||||
Description::
|
||||
GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `group`
|
||||
- `version`
|
||||
- `kind`
|
||||
|
||||
[discrete]
|
||||
=== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.group`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `.version`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
|
||||
[id="labelselector-meta-v1"]
|
||||
== LabelSelector [meta/v1]
|
||||
|
||||
@@ -5856,106 +5906,6 @@ Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-gu
|
||||
|
||||
|===
|
||||
|
||||
[id="objectmeta_v2-meta-v1"]
|
||||
== ObjectMeta_v2 [meta/v1]
|
||||
|
||||
|
||||
Description::
|
||||
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.annotations`
|
||||
| `object (string)`
|
||||
| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
|
||||
| `.clusterName`
|
||||
| `string`
|
||||
| The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
|
||||
|
||||
| `.creationTimestamp`
|
||||
| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`]
|
||||
| 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
|
||||
|
||||
| `.deletionGracePeriodSeconds`
|
||||
| `integer`
|
||||
| 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.
|
||||
|
||||
| `.deletionTimestamp`
|
||||
| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`]
|
||||
| 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
|
||||
|
||||
| `.finalizers`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
| `.generateName`
|
||||
| `string`
|
||||
| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
|
||||
|
||||
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
|
||||
|
||||
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
|
||||
|
||||
| `.generation`
|
||||
| `integer`
|
||||
| A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
|
||||
|
||||
| `.labels`
|
||||
| `object (string)`
|
||||
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
|
||||
|
||||
| `.managedFields`
|
||||
| xref:../objects/index.adoc#managedfieldsentry-meta-v1[`array (ManagedFieldsEntry meta/v1)`]
|
||||
| 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.
|
||||
|
||||
| `.name`
|
||||
| `string`
|
||||
| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
| `.namespace`
|
||||
| `string`
|
||||
| Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
|
||||
|
||||
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
|
||||
|
||||
| `.ownerReferences`
|
||||
| xref:../objects/index.adoc#ownerreference-meta-v1[`array (OwnerReference meta/v1)`]
|
||||
| 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.
|
||||
|
||||
| `.resourceVersion`
|
||||
| `string`
|
||||
| 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
|
||||
|
||||
| `.selfLink`
|
||||
| `string`
|
||||
| SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
|
||||
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
|
||||
|
||||
| `.uid`
|
||||
| `string`
|
||||
| UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
|
||||
|
||||
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
|
||||
|===
|
||||
|
||||
[id="ownerreference-meta-v1"]
|
||||
== OwnerReference [meta/v1]
|
||||
|
||||
|
||||
@@ -113,6 +113,10 @@ Type::
|
||||
| `boolean`
|
||||
| ManagingOAuthAPIServer indicates whether this operator is managing OAuth related APIs. Setting this field to true will cause OAS-O to step down. Note that this field will be removed in the future releases, once https://github.com/openshift/enhancements/blob/master/enhancements/authentication/separate-oauth-resources.md is fully implemented
|
||||
|
||||
| `oauthAPIServer`
|
||||
| `object`
|
||||
| OAuthAPIServer holds status specific only to oauth-apiserver
|
||||
|
||||
| `observedGeneration`
|
||||
| `integer`
|
||||
| observedGeneration is the last generation change you've dealt with
|
||||
@@ -220,3 +224,22 @@ Type::
|
||||
| resource is the resource type of the thing you're tracking
|
||||
|
||||
|===
|
||||
..status.oauthAPIServer
|
||||
Description::
|
||||
OAuthAPIServer holds status specific only to oauth-apiserver
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `latestAvailableRevision`
|
||||
| `integer`
|
||||
| LatestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.
|
||||
|
||||
|===
|
||||
|
||||
@@ -63,6 +63,10 @@ Required::
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `affinity`
|
||||
| `object`
|
||||
| affinity is a group of node affinity scheduling rules for the image registry pod(s).
|
||||
|
||||
| `defaultRoute`
|
||||
| `boolean`
|
||||
| defaultRoute indicates whether an external facing route for the registry should be created using the default generated hostname.
|
||||
@@ -131,6 +135,891 @@ Required::
|
||||
| `object`
|
||||
| The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
|
||||
|
||||
|===
|
||||
..spec.affinity
|
||||
Description::
|
||||
affinity is a group of node affinity scheduling rules for the image registry pod(s).
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `nodeAffinity`
|
||||
| `object`
|
||||
| Describes node affinity scheduling rules for the pod.
|
||||
|
||||
| `podAffinity`
|
||||
| `object`
|
||||
| Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
|
||||
|
||||
| `podAntiAffinity`
|
||||
| `object`
|
||||
| Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity
|
||||
Description::
|
||||
Describes node affinity scheduling rules for the pod.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `preferredDuringSchedulingIgnoredDuringExecution`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `preferredDuringSchedulingIgnoredDuringExecution[]`
|
||||
| `object`
|
||||
| An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
|
||||
|
||||
| `requiredDuringSchedulingIgnoredDuringExecution`
|
||||
| `object`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
|
||||
Description::
|
||||
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
|
||||
Description::
|
||||
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `preference`
|
||||
- `weight`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `preference`
|
||||
| `object`
|
||||
| A node selector term, associated with the corresponding weight.
|
||||
|
||||
| `weight`
|
||||
| `integer`
|
||||
| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
|
||||
Description::
|
||||
A node selector term, associated with the corresponding weight.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| A list of node selector requirements by node's labels.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchFields`
|
||||
| `array`
|
||||
| A list of node selector requirements by node's fields.
|
||||
|
||||
| `matchFields[]`
|
||||
| `object`
|
||||
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
|
||||
Description::
|
||||
A list of node selector requirements by node's labels.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
|
||||
Description::
|
||||
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
|
||||
Description::
|
||||
A list of node selector requirements by node's fields.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
|
||||
Description::
|
||||
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
|
||||
Description::
|
||||
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `nodeSelectorTerms`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `nodeSelectorTerms`
|
||||
| `array`
|
||||
| Required. A list of node selector terms. The terms are ORed.
|
||||
|
||||
| `nodeSelectorTerms[]`
|
||||
| `object`
|
||||
| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
|
||||
Description::
|
||||
Required. A list of node selector terms. The terms are ORed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]
|
||||
Description::
|
||||
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| A list of node selector requirements by node's labels.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchFields`
|
||||
| `array`
|
||||
| A list of node selector requirements by node's fields.
|
||||
|
||||
| `matchFields[]`
|
||||
| `object`
|
||||
| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
|
||||
Description::
|
||||
A list of node selector requirements by node's labels.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
|
||||
Description::
|
||||
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
|
||||
Description::
|
||||
A list of node selector requirements by node's fields.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
|
||||
Description::
|
||||
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| The label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity
|
||||
Description::
|
||||
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `preferredDuringSchedulingIgnoredDuringExecution`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `preferredDuringSchedulingIgnoredDuringExecution[]`
|
||||
| `object`
|
||||
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
|
||||
|
||||
| `requiredDuringSchedulingIgnoredDuringExecution`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `requiredDuringSchedulingIgnoredDuringExecution[]`
|
||||
| `object`
|
||||
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
|
||||
Description::
|
||||
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
|
||||
Description::
|
||||
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `podAffinityTerm`
|
||||
- `weight`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `podAffinityTerm`
|
||||
| `object`
|
||||
| Required. A pod affinity term, associated with the corresponding weight.
|
||||
|
||||
| `weight`
|
||||
| `integer`
|
||||
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
|
||||
Description::
|
||||
Required. A pod affinity term, associated with the corresponding weight.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `topologyKey`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `labelSelector`
|
||||
| `object`
|
||||
| A label query over a set of resources, in this case pods.
|
||||
|
||||
| `namespaces`
|
||||
| `array (string)`
|
||||
| namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
| `topologyKey`
|
||||
| `string`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
|
||||
Description::
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchLabels`
|
||||
| `object (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
|
||||
Description::
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
|
||||
Description::
|
||||
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| key is the label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
|
||||
Description::
|
||||
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
|
||||
Description::
|
||||
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `topologyKey`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `labelSelector`
|
||||
| `object`
|
||||
| A label query over a set of resources, in this case pods.
|
||||
|
||||
| `namespaces`
|
||||
| `array (string)`
|
||||
| namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
| `topologyKey`
|
||||
| `string`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
|
||||
Description::
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchLabels`
|
||||
| `object (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
|
||||
Description::
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
|
||||
Description::
|
||||
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| key is the label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.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)).
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `preferredDuringSchedulingIgnoredDuringExecution`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `preferredDuringSchedulingIgnoredDuringExecution[]`
|
||||
| `object`
|
||||
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
|
||||
|
||||
| `requiredDuringSchedulingIgnoredDuringExecution`
|
||||
| `array`
|
||||
| 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.
|
||||
|
||||
| `requiredDuringSchedulingIgnoredDuringExecution[]`
|
||||
| `object`
|
||||
| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
|
||||
|
||||
|===
|
||||
..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
|
||||
Description::
|
||||
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
|
||||
Description::
|
||||
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `podAffinityTerm`
|
||||
- `weight`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `podAffinityTerm`
|
||||
| `object`
|
||||
| Required. A pod affinity term, associated with the corresponding weight.
|
||||
|
||||
| `weight`
|
||||
| `integer`
|
||||
| weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
|
||||
Description::
|
||||
Required. A pod affinity term, associated with the corresponding weight.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `topologyKey`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `labelSelector`
|
||||
| `object`
|
||||
| A label query over a set of resources, in this case pods.
|
||||
|
||||
| `namespaces`
|
||||
| `array (string)`
|
||||
| namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
| `topologyKey`
|
||||
| `string`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
|
||||
Description::
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchLabels`
|
||||
| `object (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
|
||||
Description::
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
|
||||
Description::
|
||||
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| key is the label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
|
||||
Description::
|
||||
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
|
||||
Description::
|
||||
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `topologyKey`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `labelSelector`
|
||||
| `object`
|
||||
| A label query over a set of resources, in this case pods.
|
||||
|
||||
| `namespaces`
|
||||
| `array (string)`
|
||||
| namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
|
||||
|
||||
| `topologyKey`
|
||||
| `string`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
|
||||
Description::
|
||||
A label query over a set of resources, in this case pods.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchLabels`
|
||||
| `object (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
|
||||
Description::
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
|
||||
Description::
|
||||
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| key is the label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.proxy
|
||||
Description::
|
||||
@@ -458,6 +1347,10 @@ Type::
|
||||
| `string`
|
||||
| regionEndpoint is the endpoint for S3 compatible storage services. Optional, defaults based on the Region that is provided.
|
||||
|
||||
| `virtualHostedStyle`
|
||||
| `boolean`
|
||||
| virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false.
|
||||
|
||||
|===
|
||||
..spec.storage.s3.cloudFront
|
||||
Description::
|
||||
@@ -923,6 +1816,10 @@ Type::
|
||||
| `string`
|
||||
| regionEndpoint is the endpoint for S3 compatible storage services. Optional, defaults based on the Region that is provided.
|
||||
|
||||
| `virtualHostedStyle`
|
||||
| `boolean`
|
||||
| virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false.
|
||||
|
||||
|===
|
||||
..status.storage.s3.cloudFront
|
||||
Description::
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
[id="servicecatalogapiserver-operator-openshift-io-v1"]
|
||||
= ServiceCatalogAPIServer [operator.openshift.io/v1]
|
||||
[id="config-operator-openshift-io-v1"]
|
||||
= Config [operator.openshift.io/v1]
|
||||
ifdef::product-title[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
endif::[]
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
ServiceCatalogAPIServer provides information to configure an operator to manage Service Catalog API Server
|
||||
Config provides information to configure the config operator.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -37,16 +37,16 @@ Required::
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
|
|
||||
| spec is the specification of the desired behavior of the Config Operator.
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
|
|
||||
| status defines the observed status of the Config Operator.
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
|
||||
spec is the specification of the desired behavior of the Config Operator.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -81,7 +81,7 @@ Type::
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
|
||||
status defines the observed status of the Config Operator.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -82,6 +82,10 @@ Type::
|
||||
| `object`
|
||||
| providers contains configuration for using specific service providers.
|
||||
|
||||
| `route`
|
||||
| `object`
|
||||
| route contains hostname and secret reference that contains the serving certificate. If a custom route is specified, a new route will be created with the provided hostname, under which console will be available. In case of custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed. In case of custom hostname points to an arbitrary domain, manual DNS configurations steps are necessary. The default console route will be maintained to reserve the default hostname for console if the custom route is removed. If not specified, default route will be used.
|
||||
|
||||
| `unsupportedConfigOverrides`
|
||||
| ``
|
||||
| unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides
|
||||
@@ -178,6 +182,50 @@ Type::
|
||||
| `string`
|
||||
| pageID is the unique ID assigned by Statuspage for your page. This must be a public page.
|
||||
|
||||
|===
|
||||
..spec.route
|
||||
Description::
|
||||
route contains hostname and secret reference that contains the serving certificate. If a custom route is specified, a new route will be created with the provided hostname, under which console will be available. In case of custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed. In case of custom hostname points to an arbitrary domain, manual DNS configurations steps are necessary. The default console route will be maintained to reserve the default hostname for console if the custom route is removed. If not specified, default route will be used.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `hostname`
|
||||
| `string`
|
||||
| hostname is the desired custom domain under which console will be available.
|
||||
|
||||
| `secret`
|
||||
| `object`
|
||||
| secret points to secret in the openshift-config namespace that contains custom certificate and key and needs to be created manually by the cluster admin. Referenced Secret is required to contain following key value pairs: - "tls.crt" - to specifies custom certificate - "tls.key" - to specifies private key of the custom certificate If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed.
|
||||
|
||||
|===
|
||||
..spec.route.secret
|
||||
Description::
|
||||
secret points to secret in the openshift-config namespace that contains custom certificate and key and needs to be created manually by the cluster admin. Referenced Secret is required to contain following key value pairs: - "tls.crt" - to specifies custom certificate - "tls.key" - to specifies private key of the custom certificate If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `name`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| name is the metadata.name of the referenced secret
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
|
||||
@@ -93,6 +93,10 @@ Type::
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `observedGeneration`
|
||||
| `integer`
|
||||
| observedGeneration is the most recently observed generation of the DNSRecord. When the DNSRecord is updated, the controller updates the corresponding record in each managed zone. If an update for a particular zone fails, that failure is recorded in the status condition for the zone so that the controller can determine that it needs to retry the update for that specific zone.
|
||||
|
||||
| `zones`
|
||||
| `array`
|
||||
| zones are the status of the record in each zone.
|
||||
|
||||
@@ -7,6 +7,44 @@ endif::[]
|
||||
toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
Etcd provides information to configure an operator to manage kube-apiserver.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `spec`
|
||||
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
|
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
|
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
|
||||
|
||||
@@ -15,5 +53,239 @@ Type::
|
||||
|
||||
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `failedRevisionLimit`
|
||||
| `integer`
|
||||
| failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)
|
||||
|
||||
| `forceRedeploymentReason`
|
||||
| `string`
|
||||
| forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.
|
||||
|
||||
| `logLevel`
|
||||
| `string`
|
||||
| logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.
|
||||
|
||||
| `managementState`
|
||||
| `string`
|
||||
| managementState indicates whether and how the operator should manage the component
|
||||
|
||||
| `observedConfig`
|
||||
| ``
|
||||
| observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator
|
||||
|
||||
| `operatorLogLevel`
|
||||
| `string`
|
||||
| operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.
|
||||
|
||||
| `succeededRevisionLimit`
|
||||
| `integer`
|
||||
| succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)
|
||||
|
||||
| `unsupportedConfigOverrides`
|
||||
| ``
|
||||
| unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `conditions`
|
||||
| `array`
|
||||
| conditions is a list of conditions and their status
|
||||
|
||||
| `conditions[]`
|
||||
| `object`
|
||||
| OperatorCondition is just the standard condition fields.
|
||||
|
||||
| `generations`
|
||||
| `array`
|
||||
| generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
|
||||
|
||||
| `generations[]`
|
||||
| `object`
|
||||
| GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
|
||||
|
||||
| `latestAvailableRevision`
|
||||
| `integer`
|
||||
| latestAvailableRevision is the deploymentID of the most recent deployment
|
||||
|
||||
| `latestAvailableRevisionReason`
|
||||
| `string`
|
||||
| latestAvailableRevisionReason describe the detailed reason for the most recent deployment
|
||||
|
||||
| `nodeStatuses`
|
||||
| `array`
|
||||
| nodeStatuses track the deployment values and errors across individual nodes
|
||||
|
||||
| `nodeStatuses[]`
|
||||
| `object`
|
||||
| NodeStatus provides information about the current state of a particular node managed by this operator.
|
||||
|
||||
| `observedGeneration`
|
||||
| `integer`
|
||||
| observedGeneration is the last generation change you've dealt with
|
||||
|
||||
| `readyReplicas`
|
||||
| `integer`
|
||||
| readyReplicas indicates how many replicas are ready and at the desired state
|
||||
|
||||
| `version`
|
||||
| `string`
|
||||
| version is the level this availability applies to
|
||||
|
||||
|===
|
||||
..status.conditions
|
||||
Description::
|
||||
conditions is a list of conditions and their status
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.conditions[]
|
||||
Description::
|
||||
OperatorCondition is just the standard condition fields.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `lastTransitionTime`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `message`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `reason`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `status`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..status.generations
|
||||
Description::
|
||||
generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.generations[]
|
||||
Description::
|
||||
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `group`
|
||||
| `string`
|
||||
| group is the group of the thing you're tracking
|
||||
|
||||
| `hash`
|
||||
| `string`
|
||||
| hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps
|
||||
|
||||
| `lastGeneration`
|
||||
| `integer`
|
||||
| lastGeneration is the last generation of the workload controller involved
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| name is the name of the thing you're tracking
|
||||
|
||||
| `namespace`
|
||||
| `string`
|
||||
| namespace is where the thing you're tracking is
|
||||
|
||||
| `resource`
|
||||
| `string`
|
||||
| resource is the resource type of the thing you're tracking
|
||||
|
||||
|===
|
||||
..status.nodeStatuses
|
||||
Description::
|
||||
nodeStatuses track the deployment values and errors across individual nodes
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.nodeStatuses[]
|
||||
Description::
|
||||
NodeStatus provides information about the current state of a particular node managed by this operator.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `currentRevision`
|
||||
| `integer`
|
||||
| currentRevision is the generation of the most recently successful deployment
|
||||
|
||||
| `lastFailedRevision`
|
||||
| `integer`
|
||||
| lastFailedRevision is the generation of the deployment we tried and failed to deploy.
|
||||
|
||||
| `lastFailedRevisionErrors`
|
||||
| `array (string)`
|
||||
| lastFailedRevisionErrors is a list of the errors during the failed deployment referenced in lastFailedRevision
|
||||
|
||||
| `nodeName`
|
||||
| `string`
|
||||
| nodeName is the name of the node
|
||||
|
||||
| `targetRevision`
|
||||
| `integer`
|
||||
| targetRevision is the generation of the deployment we're trying to apply
|
||||
|
||||
|===
|
||||
|
||||
@@ -69,11 +69,15 @@ Type::
|
||||
|
||||
| `keepTagRevisions`
|
||||
| `integer`
|
||||
| keepTagRevisions specifies the number of image revisions for a tag in an image stream that will be preserved. Defaults to 5.
|
||||
| keepTagRevisions specifies the number of image revisions for a tag in an image stream that will be preserved. Defaults to 3.
|
||||
|
||||
| `keepYoungerThan`
|
||||
| `integer`
|
||||
| keepYoungerThan specifies the minimum age of an image and its referrers for it to be considered a candidate for pruning. Defaults to 96h (96 hours).
|
||||
| keepYoungerThan specifies the minimum age in nanoseconds of an image and its referrers for it to be considered a candidate for pruning. DEPRECATED: This field is deprecated in favor of keepYoungerThanDuration. If both are set, this field is ignored and keepYoungerThanDuration takes precedence.
|
||||
|
||||
| `keepYoungerThanDuration`
|
||||
| `string`
|
||||
| keepYoungerThanDuration specifies the minimum age of an image and its referrers for it to be considered a candidate for pruning. Defaults to 60m (60 minutes).
|
||||
|
||||
| `nodeSelector`
|
||||
| `object (string)`
|
||||
|
||||
@@ -84,6 +84,10 @@ Type::
|
||||
Any other platform types (including None) default to HostNetwork.
|
||||
endpointPublishingStrategy cannot be updated.
|
||||
|
||||
| `logging`
|
||||
| `object`
|
||||
| logging defines parameters for what should be logged where. If this field is empty, operational logs are enabled but access logs are disabled.
|
||||
|
||||
| `namespaceSelector`
|
||||
| `object`
|
||||
| namespaceSelector is used to filter the set of namespaces serviced by the ingress controller. This is useful for implementing shards.
|
||||
@@ -246,6 +250,127 @@ Type::
|
||||
|
||||
|
||||
|
||||
..spec.logging
|
||||
Description::
|
||||
logging defines parameters for what should be logged where. If this field is empty, operational logs are enabled but access logs are disabled.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `access`
|
||||
| `object`
|
||||
| access describes how the client requests should be logged.
|
||||
If this field is empty, access logging is disabled.
|
||||
|
||||
|===
|
||||
..spec.logging.access
|
||||
Description::
|
||||
access describes how the client requests should be logged.
|
||||
If this field is empty, access logging is disabled.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `destination`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `destination`
|
||||
| `object`
|
||||
| destination is where access logs go.
|
||||
|
||||
| `httpLogFormat`
|
||||
| `string`
|
||||
| httpLogFormat specifies the format of the log message for an HTTP request.
|
||||
If this field is empty, log messages use the implementation's default HTTP log format. For HAProxy's default HTTP log format, see the HAProxy documentation: http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3
|
||||
|
||||
|===
|
||||
..spec.logging.access.destination
|
||||
Description::
|
||||
destination is where access logs go.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `type`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `container`
|
||||
| `object`
|
||||
| container holds parameters for the Container logging destination. Present only if type is Container.
|
||||
|
||||
| `syslog`
|
||||
| `object`
|
||||
| syslog holds parameters for a syslog endpoint. Present only if type is Syslog.
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
| type is the type of destination for logs. It must be one of the following:
|
||||
* Container
|
||||
The ingress operator configures the sidecar container named "logs" on the ingress controller pod and configures the ingress controller to write logs to the sidecar. The logs are then available as container logs. The expectation is that the administrator configures a custom logging solution that reads logs from this sidecar. Note that using container logs means that logs may be dropped if the rate of logs exceeds the container runtime's or the custom logging solution's capacity.
|
||||
* Syslog
|
||||
Logs are sent to a syslog endpoint. The administrator must specify an endpoint that can receive syslog messages. The expectation is that the administrator has configured a custom syslog instance.
|
||||
|
||||
|===
|
||||
..spec.logging.access.destination.container
|
||||
Description::
|
||||
container holds parameters for the Container logging destination. Present only if type is Container.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.logging.access.destination.syslog
|
||||
Description::
|
||||
syslog holds parameters for a syslog endpoint. Present only if type is Syslog.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `address`
|
||||
- `port`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `address`
|
||||
| `string`
|
||||
| address is the IP address of the syslog endpoint that receives log messages.
|
||||
|
||||
| `facility`
|
||||
| `string`
|
||||
| facility specifies the syslog facility of log messages.
|
||||
If this field is empty, the facility is "local1".
|
||||
|
||||
| `port`
|
||||
| `integer`
|
||||
| port is the UDP port number of the syslog endpoint that receives log messages.
|
||||
|
||||
|===
|
||||
..spec.namespaceSelector
|
||||
Description::
|
||||
namespaceSelector is used to filter the set of namespaces serviced by the ingress controller. This is useful for implementing shards.
|
||||
@@ -487,6 +612,14 @@ Type::
|
||||
- InterNamespaceAllowed: Allow routes to claim different paths of the same host name across namespaces.
|
||||
If empty, the default is Strict.
|
||||
|
||||
| `wildcardPolicy`
|
||||
| `string`
|
||||
| wildcardPolicy describes how routes with wildcard policies should be handled for the ingress controller. WildcardPolicy controls use of routes [1] exposed by the ingress controller based on the route's wildcard policy.
|
||||
[1] https://github.com/openshift/api/blob/master/route/v1/types.go
|
||||
Note: Updating WildcardPolicy from WildcardsAllowed to WildcardsDisallowed will cause admitted routes with a wildcard policy of Subdomain to stop working. These routes must be updated to a wildcard policy of None to be readmitted by the ingress controller.
|
||||
WildcardPolicy supports WildcardsAllowed and WildcardsDisallowed values.
|
||||
If empty, defaults to "WildcardsDisallowed".
|
||||
|
||||
|===
|
||||
..spec.routeSelector
|
||||
Description::
|
||||
|
||||
@@ -22,6 +22,14 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== Config [operator.openshift.io/v1]
|
||||
|
||||
Description::
|
||||
Config provides information to configure the config operator.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== Config [imageregistry.operator.openshift.io/v1]
|
||||
|
||||
Description::
|
||||
@@ -68,7 +76,7 @@ Type::
|
||||
== Etcd [operator.openshift.io/v1]
|
||||
|
||||
Description::
|
||||
|
||||
Etcd provides information to configure an operator to manage kube-apiserver.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -164,19 +172,3 @@ Description::
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== ServiceCatalogAPIServer [operator.openshift.io/v1]
|
||||
|
||||
Description::
|
||||
ServiceCatalogAPIServer provides information to configure an operator to manage Service Catalog API Server
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== ServiceCatalogControllerManager [operator.openshift.io/v1]
|
||||
|
||||
Description::
|
||||
ServiceCatalogControllerManager provides information to configure an operator to manage Service Catalog Controller Manager
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
@@ -1,218 +0,0 @@
|
||||
[id="servicecatalogcontrollermanager-operator-openshift-io-v1"]
|
||||
= ServiceCatalogControllerManager [operator.openshift.io/v1]
|
||||
ifdef::product-title[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
ServiceCatalogControllerManager provides information to configure an operator to manage Service Catalog Controller Manager
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `spec`
|
||||
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
|
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
|
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `logLevel`
|
||||
| `string`
|
||||
| logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.
|
||||
|
||||
| `managementState`
|
||||
| `string`
|
||||
| managementState indicates whether and how the operator should manage the component
|
||||
|
||||
| `observedConfig`
|
||||
| ``
|
||||
| observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator
|
||||
|
||||
| `operatorLogLevel`
|
||||
| `string`
|
||||
| operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.
|
||||
|
||||
| `unsupportedConfigOverrides`
|
||||
| ``
|
||||
| unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `conditions`
|
||||
| `array`
|
||||
| conditions is a list of conditions and their status
|
||||
|
||||
| `conditions[]`
|
||||
| `object`
|
||||
| OperatorCondition is just the standard condition fields.
|
||||
|
||||
| `generations`
|
||||
| `array`
|
||||
| generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
|
||||
|
||||
| `generations[]`
|
||||
| `object`
|
||||
| GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
|
||||
|
||||
| `observedGeneration`
|
||||
| `integer`
|
||||
| observedGeneration is the last generation change you've dealt with
|
||||
|
||||
| `readyReplicas`
|
||||
| `integer`
|
||||
| readyReplicas indicates how many replicas are ready and at the desired state
|
||||
|
||||
| `version`
|
||||
| `string`
|
||||
| version is the level this availability applies to
|
||||
|
||||
|===
|
||||
..status.conditions
|
||||
Description::
|
||||
conditions is a list of conditions and their status
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.conditions[]
|
||||
Description::
|
||||
OperatorCondition is just the standard condition fields.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `lastTransitionTime`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `message`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `reason`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `status`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..status.generations
|
||||
Description::
|
||||
generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.generations[]
|
||||
Description::
|
||||
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `group`
|
||||
| `string`
|
||||
| group is the group of the thing you're tracking
|
||||
|
||||
| `hash`
|
||||
| `string`
|
||||
| hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps
|
||||
|
||||
| `lastGeneration`
|
||||
| `integer`
|
||||
| lastGeneration is the last generation of the workload controller involved
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| name is the name of the thing you're tracking
|
||||
|
||||
| `namespace`
|
||||
| `string`
|
||||
| namespace is where the thing you're tracking is
|
||||
|
||||
| `resource`
|
||||
| `string`
|
||||
| resource is the resource type of the thing you're tracking
|
||||
|
||||
|===
|
||||
@@ -194,11 +194,11 @@ Type::
|
||||
|
||||
| `message`
|
||||
| `string`
|
||||
| A human readable message indicating details about why the ClusterServiceVersion is in this condition.
|
||||
| A human readable message indicating details about why the CatalogSource is in this condition.
|
||||
|
||||
| `reason`
|
||||
| `string`
|
||||
| Reason is the reason the Subscription was transitioned to its current state.
|
||||
| Reason is the reason the CatalogSource was transitioned to its current state.
|
||||
|
||||
| `registryService`
|
||||
| `object`
|
||||
|
||||
@@ -1,156 +0,0 @@
|
||||
[id="catalogsourceconfig-operators-coreos-com-v1"]
|
||||
= CatalogSourceConfig [operators.coreos.com/v1]
|
||||
ifdef::product-title[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
CatalogSourceConfig is used to enable an operator present in the OperatorSource to your cluster. Behind the scenes, it will configure an OLM CatalogSource so that the operator can then be managed by OLM.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| CatalogSourceConfigSpec defines the desired state of CatalogSourceConfig
|
||||
|
||||
| `.status`
|
||||
| `object`
|
||||
| CatalogSourceConfigStatus defines the observed state of CatalogSourceConfig
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
CatalogSourceConfigSpec defines the desired state of CatalogSourceConfig
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `packages`
|
||||
- `source`
|
||||
- `targetNamespace`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `csDisplayName`
|
||||
| `string`
|
||||
| DisplayName is passed along to the CatalogSource to be used as a pretty name.
|
||||
|
||||
| `csPublisher`
|
||||
| `string`
|
||||
| Publisher is passed along to the CatalogSource to be used to define what entity published the artifacts from the OperatorSource.
|
||||
|
||||
| `packages`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `source`
|
||||
| `string`
|
||||
| The name of the OperatorSource that the packages originate from
|
||||
|
||||
| `targetNamespace`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
CatalogSourceConfigStatus defines the observed state of CatalogSourceConfig
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `currentPhase`
|
||||
| `object`
|
||||
| Current phase of the CatalogSourceConfig object.
|
||||
|
||||
| `packageRepositioryVersions`
|
||||
| `object (string)`
|
||||
| Map of packages (key) and their app registry package version (value)
|
||||
|
||||
|===
|
||||
..status.currentPhase
|
||||
Description::
|
||||
Current phase of the CatalogSourceConfig object.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `lastTransitionTime`
|
||||
| `string`
|
||||
| Last time the object has transitioned from one phase to another
|
||||
|
||||
| `lastUpdateTime`
|
||||
| `string`
|
||||
| Last time the status of the object was updated
|
||||
|
||||
| `phase`
|
||||
| `object`
|
||||
| Current phase of the object
|
||||
|
||||
|===
|
||||
..status.currentPhase.phase
|
||||
Description::
|
||||
Current phase of the object
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `message`
|
||||
| `string`
|
||||
| A human readable message indicating why the object is in this phase
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name of the phase
|
||||
|
||||
|===
|
||||
@@ -159,6 +159,14 @@ Required::
|
||||
| `string`
|
||||
| OperatorVersion is a wrapper around semver.Version which supports correct marshaling to YAML and JSON.
|
||||
|
||||
| `webhookdefinitions`
|
||||
| `array`
|
||||
|
|
||||
|
||||
| `webhookdefinitions[]`
|
||||
| `object`
|
||||
| WebhookDescription provides details to OLM about required webhooks
|
||||
|
||||
|===
|
||||
..spec.apiservicedefinitions
|
||||
Description::
|
||||
@@ -1827,7 +1835,7 @@ Required::
|
||||
| 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/
|
||||
|
||||
| `overhead`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| 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/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
|
||||
|
||||
| `preemptionPolicy`
|
||||
@@ -1876,7 +1884,7 @@ Required::
|
||||
|
||||
| `shareProcessNamespace`
|
||||
| `boolean`
|
||||
| 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. This field is beta-level and may be disabled with the PodShareProcessNamespace feature.
|
||||
| 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.
|
||||
|
||||
| `subdomain`
|
||||
| `string`
|
||||
@@ -1896,7 +1904,7 @@ Required::
|
||||
|
||||
| `topologySpreadConstraints`
|
||||
| `array`
|
||||
| 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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
| 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. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
|
||||
| `topologySpreadConstraints[]`
|
||||
| `object`
|
||||
@@ -2888,7 +2896,7 @@ Required::
|
||||
|
||||
| `startupProbe`
|
||||
| `object`
|
||||
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
|
||||
| `stdin`
|
||||
| `boolean`
|
||||
@@ -2912,7 +2920,7 @@ Required::
|
||||
|
||||
| `volumeDevices`
|
||||
| `array`
|
||||
| volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
| volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
| `volumeDevices[]`
|
||||
| `object`
|
||||
@@ -2990,7 +2998,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -3032,7 +3040,7 @@ Required::
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -3076,7 +3084,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
@@ -3913,11 +3921,11 @@ Type::
|
||||
| Property | Type | Description
|
||||
|
||||
| `limits`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
| `requests`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
|===
|
||||
@@ -4046,20 +4054,20 @@ Type::
|
||||
|
||||
| `gmsaCredentialSpec`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| 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.
|
||||
|
||||
| `gmsaCredentialSpecName`
|
||||
| `string`
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use.
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe
|
||||
Description::
|
||||
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -4227,7 +4235,7 @@ Required::
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices
|
||||
Description::
|
||||
volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
@@ -4310,7 +4318,7 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.dnsConfig
|
||||
@@ -4497,7 +4505,7 @@ Required::
|
||||
|
||||
| `volumeDevices`
|
||||
| `array`
|
||||
| volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
| volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
| `volumeDevices[]`
|
||||
| `object`
|
||||
@@ -4575,7 +4583,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -4617,7 +4625,7 @@ Required::
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -4661,7 +4669,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
@@ -5498,11 +5506,11 @@ Type::
|
||||
| Property | Type | Description
|
||||
|
||||
| `limits`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
| `requests`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
|===
|
||||
@@ -5631,15 +5639,15 @@ Type::
|
||||
|
||||
| `gmsaCredentialSpec`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| 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.
|
||||
|
||||
| `gmsaCredentialSpecName`
|
||||
| `string`
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use.
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe
|
||||
@@ -5812,7 +5820,7 @@ Required::
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices
|
||||
Description::
|
||||
volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
@@ -5895,7 +5903,7 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.hostAliases
|
||||
@@ -6052,7 +6060,7 @@ Required::
|
||||
|
||||
| `startupProbe`
|
||||
| `object`
|
||||
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
|
||||
| `stdin`
|
||||
| `boolean`
|
||||
@@ -6076,7 +6084,7 @@ Required::
|
||||
|
||||
| `volumeDevices`
|
||||
| `array`
|
||||
| volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
| volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
| `volumeDevices[]`
|
||||
| `object`
|
||||
@@ -6154,7 +6162,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -6196,7 +6204,7 @@ Required::
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -6240,7 +6248,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
@@ -7077,11 +7085,11 @@ Type::
|
||||
| Property | Type | Description
|
||||
|
||||
| `limits`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
| `requests`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
|===
|
||||
@@ -7210,20 +7218,20 @@ Type::
|
||||
|
||||
| `gmsaCredentialSpec`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| 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.
|
||||
|
||||
| `gmsaCredentialSpecName`
|
||||
| `string`
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use.
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe
|
||||
Description::
|
||||
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is an alpha feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -7391,7 +7399,7 @@ Required::
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices
|
||||
Description::
|
||||
volumeDevices is the list of block devices to be used by the container. This is a beta feature.
|
||||
volumeDevices is the list of block devices to be used by the container.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
@@ -7474,7 +7482,7 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.readinessGates
|
||||
@@ -7528,6 +7536,10 @@ Type::
|
||||
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.
|
||||
|
||||
| `fsGroupChangePolicy`
|
||||
| `string`
|
||||
| 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 defaults to "Always".
|
||||
|
||||
| `runAsGroup`
|
||||
| `integer`
|
||||
| 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.
|
||||
@@ -7644,15 +7656,15 @@ Type::
|
||||
|
||||
| `gmsaCredentialSpec`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| 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.
|
||||
|
||||
| `gmsaCredentialSpecName`
|
||||
| `string`
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.
|
||||
| GMSACredentialSpecName is the name of the GMSA credential spec to use.
|
||||
|
||||
| `runAsUserName`
|
||||
| `string`
|
||||
| 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. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.tolerations
|
||||
@@ -7702,7 +7714,7 @@ Type::
|
||||
|===
|
||||
..spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints
|
||||
Description::
|
||||
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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
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. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
@@ -8419,7 +8431,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
@@ -8446,7 +8458,7 @@ Type::
|
||||
| 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
|
||||
|
||||
| `sizeLimit`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
|
||||
|===
|
||||
@@ -9125,7 +9137,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
@@ -9903,6 +9915,207 @@ Required::
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.webhookdefinitions
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.webhookdefinitions[]
|
||||
Description::
|
||||
WebhookDescription provides details to OLM about required webhooks
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `admissionReviewVersions`
|
||||
- `generateName`
|
||||
- `sideEffects`
|
||||
- `type`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `admissionReviewVersions`
|
||||
| `array (string)`
|
||||
|
|
||||
|
||||
| `containerPort`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
| `deploymentName`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `failurePolicy`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `generateName`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `matchPolicy`
|
||||
| `string`
|
||||
| MatchPolicyType specifies the type of match policy
|
||||
|
||||
| `objectSelector`
|
||||
| `object`
|
||||
| A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
|
||||
|
||||
| `reinvocationPolicy`
|
||||
| `string`
|
||||
| ReinvocationPolicyType specifies what type of policy the admission hook uses.
|
||||
|
||||
| `rules`
|
||||
| `array`
|
||||
|
|
||||
|
||||
| `rules[]`
|
||||
| `object`
|
||||
| RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
|
||||
|
||||
| `sideEffects`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `timeoutSeconds`
|
||||
| `integer`
|
||||
|
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
| WebhookAdmissionType is the type of admission webhooks supported by OLM
|
||||
|
||||
| `webhookPath`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..spec.webhookdefinitions[].objectSelector
|
||||
Description::
|
||||
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `matchExpressions`
|
||||
| `array`
|
||||
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
| `matchExpressions[]`
|
||||
| `object`
|
||||
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
| `matchLabels`
|
||||
| `object (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.webhookdefinitions[].objectSelector.matchExpressions
|
||||
Description::
|
||||
matchExpressions is a list of label selector requirements. The requirements are ANDed.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.webhookdefinitions[].objectSelector.matchExpressions[]
|
||||
Description::
|
||||
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `key`
|
||||
- `operator`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `key`
|
||||
| `string`
|
||||
| key is the label key that the selector applies to.
|
||||
|
||||
| `operator`
|
||||
| `string`
|
||||
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
|
||||
|
||||
| `values`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.webhookdefinitions[].rules
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.webhookdefinitions[].rules[]
|
||||
Description::
|
||||
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `apiGroups`
|
||||
| `array (string)`
|
||||
| APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
|
||||
|
||||
| `apiVersions`
|
||||
| `array (string)`
|
||||
| APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
|
||||
|
||||
| `operations`
|
||||
| `array (string)`
|
||||
| Operations is the operations the admission hook cares about - CREATE, UPDATE, or * for all operations. If '*' is present, the length of the slice must be one. Required.
|
||||
|
||||
| `resources`
|
||||
| `array (string)`
|
||||
| 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.
|
||||
|
||||
| `scope`
|
||||
| `string`
|
||||
| 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 "*".
|
||||
|
||||
|===
|
||||
..status
|
||||
Description::
|
||||
|
||||
@@ -6,14 +6,6 @@ endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
== CatalogSourceConfig [operators.coreos.com/v1]
|
||||
|
||||
Description::
|
||||
CatalogSourceConfig is used to enable an operator present in the OperatorSource to your cluster. Behind the scenes, it will configure an OLM CatalogSource so that the operator can then be managed by OLM.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
== CatalogSource [operators.coreos.com/v1alpha1]
|
||||
|
||||
Description::
|
||||
|
||||
@@ -66,7 +66,7 @@ Required::
|
||||
|
||||
| `displayName`
|
||||
| `string`
|
||||
| DisplayName is passed along to the CatalogSourceConfig to be used by the resulting CatalogSource to be used as a pretty name.
|
||||
| DisplayName is passed along to the resulting CatalogSource to be used as a pretty name.
|
||||
|
||||
| `endpoint`
|
||||
| `string`
|
||||
@@ -74,7 +74,7 @@ Required::
|
||||
|
||||
| `publisher`
|
||||
| `string`
|
||||
| Publisher is passed along to the CatalogSourceConfig to be used by the resulting CatalogSource that defines what entity published the artifacts from the OperatorSource.
|
||||
| Publisher is passed along to the resulting CatalogSource that defines what entity published the artifacts from the OperatorSource.
|
||||
|
||||
| `registryNamespace`
|
||||
| `string`
|
||||
|
||||
@@ -30,7 +30,7 @@ Type::
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`]
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
|
|
||||
|
||||
| `.spec`
|
||||
@@ -204,10 +204,46 @@ If the CRD is present in the Owned list, it is implicitly required.
|
||||
| `object`
|
||||
| InstallMode associates an InstallModeType with a flag representing if the CSV supports it
|
||||
|
||||
| `keywords`
|
||||
| `array (string)`
|
||||
|
|
||||
|
||||
| `links`
|
||||
| `array`
|
||||
|
|
||||
|
||||
| `links[]`
|
||||
| `object`
|
||||
| AppLink defines a link to an application
|
||||
|
||||
| `maintainers`
|
||||
| `array`
|
||||
|
|
||||
|
||||
| `maintainers[]`
|
||||
| `object`
|
||||
| Maintainer defines a project maintainer
|
||||
|
||||
| `maturity`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `minKubeVersion`
|
||||
| `string`
|
||||
| Minimum Kubernetes version for operator installation
|
||||
|
||||
| `nativeApis`
|
||||
| xref:../objects/index.adoc#groupversionkind-meta-v1[`array (GroupVersionKind meta/v1)`]
|
||||
|
|
||||
|
||||
| `provider`
|
||||
| `object`
|
||||
| AppLink defines a link to an application
|
||||
|
||||
| `relatedImages`
|
||||
| `array (string)`
|
||||
| List of related images
|
||||
|
||||
| `version`
|
||||
| `string`
|
||||
| OperatorVersion is a wrapper around semver.Version which supports correct marshaling to YAML and JSON.
|
||||
@@ -1423,6 +1459,72 @@ Required::
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..status.channels[].currentCSVDesc.links
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.channels[].currentCSVDesc.links[]
|
||||
Description::
|
||||
AppLink defines a link to an application
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `url`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..status.channels[].currentCSVDesc.maintainers
|
||||
Description::
|
||||
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..status.channels[].currentCSVDesc.maintainers[]
|
||||
Description::
|
||||
Maintainer defines a project maintainer
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `email`
|
||||
| `string`
|
||||
|
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
|
|
||||
|
||||
|===
|
||||
..status.channels[].currentCSVDesc.provider
|
||||
Description::
|
||||
|
||||
@@ -218,7 +218,7 @@ Type::
|
||||
|
||||
| `fieldRef`
|
||||
| `object`
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
| Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
| `resourceFieldRef`
|
||||
| `object`
|
||||
@@ -260,7 +260,7 @@ Required::
|
||||
|===
|
||||
..spec.config.env[].valueFrom.fieldRef
|
||||
Description::
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
|
||||
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -304,7 +304,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
@@ -439,11 +439,11 @@ Type::
|
||||
| Property | Type | Description
|
||||
|
||||
| `limits`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
| `requests`
|
||||
| `object (string)`
|
||||
| `integer-or-string`
|
||||
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
|
||||
|===
|
||||
@@ -608,7 +608,7 @@ Required::
|
||||
|
||||
| `subPathExpr`
|
||||
| `string`
|
||||
| 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. This field is beta in 1.15.
|
||||
| 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.
|
||||
|
||||
|===
|
||||
..spec.config.volumes
|
||||
@@ -1218,7 +1218,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
@@ -1245,7 +1245,7 @@ Type::
|
||||
| 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
|
||||
|
||||
| `sizeLimit`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
|
||||
|===
|
||||
@@ -1924,7 +1924,7 @@ Required::
|
||||
| Container name: required for volumes, optional for env vars
|
||||
|
||||
| `divisor`
|
||||
| `string`
|
||||
| `integer-or-string`
|
||||
| Specifies the output format of the exposed resources, defaults to "1"
|
||||
|
||||
| `resource`
|
||||
|
||||
@@ -110,6 +110,6 @@ Required::
|
||||
|
||||
| `observedGeneration`
|
||||
| `integer`
|
||||
| Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.
|
||||
| Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.
|
||||
|
||||
|===
|
||||
|
||||
@@ -67,7 +67,6 @@ Type::
|
||||
|
||||
Required::
|
||||
- `verbs`
|
||||
- `apiGroups`
|
||||
- `resources`
|
||||
|
||||
|
||||
|
||||
@@ -63,7 +63,6 @@ Type::
|
||||
|
||||
Required::
|
||||
- `verbs`
|
||||
- `apiGroups`
|
||||
- `resources`
|
||||
|
||||
|
||||
|
||||
@@ -74,6 +74,16 @@ Required::
|
||||
| `string`
|
||||
| Base64-encoded PKCS#10 CSR data
|
||||
|
||||
| `signerName`
|
||||
| `string`
|
||||
| Requested signer for the request. It is a qualified name in the form: `scope-hostname.io/name`. If empty, it will be defaulted:
|
||||
1. If it's a kubelet client certificate, it is assigned
|
||||
"kubernetes.io/kube-apiserver-client-kubelet".
|
||||
2. If it's a kubelet serving certificate, it is assigned
|
||||
"kubernetes.io/kubelet-serving".
|
||||
3. Otherwise, it is assigned "kubernetes.io/legacy-unknown".
|
||||
Distribution of trust for signers happens out of band. You can select on this field using `spec.signerName`.
|
||||
|
||||
| `uid`
|
||||
| `string`
|
||||
| UID information about the requesting user. See user.Info interface for details.
|
||||
|
||||
@@ -29,6 +29,10 @@ Type::
|
||||
| `object (string)`
|
||||
| Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
|
||||
|
||||
| `.immutable`
|
||||
| `boolean`
|
||||
| Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is an alpha field enabled by ImmutableEphemeralVolumes feature gate.
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
[id="csidriver-storage-k8s-io-v1beta1"]
|
||||
= CSIDriver [storage.k8s.io/v1beta1]
|
||||
[id="csidriver-storage-k8s-io-v1"]
|
||||
= CSIDriver [storage.k8s.io/v1]
|
||||
ifdef::product-title[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
endif::[]
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
|
||||
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
@@ -67,6 +67,6 @@ Type::
|
||||
|
||||
| `volumeLifecycleModes`
|
||||
| `array (string)`
|
||||
| VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future.
|
||||
| volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta.
|
||||
|
||||
|===
|
||||
@@ -1,130 +0,0 @@
|
||||
[id="csinode-storage-k8s-io-v1beta1"]
|
||||
= CSINode [storage.k8s.io/v1beta1]
|
||||
ifdef::product-title[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
Description::
|
||||
DEPRECATED - This group version of CSINode is deprecated by storage/v1/CSINode. See the release notes for more information. CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `spec`
|
||||
|
||||
|
||||
== Specification
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `.apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `.kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `.metadata`
|
||||
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
|
||||
| metadata.name must be the Kubernetes node name.
|
||||
|
||||
| `.spec`
|
||||
| `object`
|
||||
| CSINodeSpec holds information about the specification of all CSI drivers installed on a node
|
||||
|
||||
|===
|
||||
..spec
|
||||
Description::
|
||||
CSINodeSpec holds information about the specification of all CSI drivers installed on a node
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `drivers`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `drivers`
|
||||
| `array`
|
||||
| drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.
|
||||
|
||||
| `drivers[]`
|
||||
| `object`
|
||||
| CSINodeDriver holds information about the specification of one CSI driver installed on a node
|
||||
|
||||
|===
|
||||
..spec.drivers
|
||||
Description::
|
||||
drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.
|
||||
|
||||
Type::
|
||||
`array`
|
||||
|
||||
|
||||
|
||||
|
||||
..spec.drivers[]
|
||||
Description::
|
||||
CSINodeDriver holds information about the specification of one CSI driver installed on a node
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `name`
|
||||
- `nodeID`
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `allocatable`
|
||||
| `object`
|
||||
| VolumeNodeResources is a set of resource limits for scheduling of volumes.
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
|
||||
|
||||
| `nodeID`
|
||||
| `string`
|
||||
| nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
|
||||
|
||||
| `topologyKeys`
|
||||
| `array (string)`
|
||||
| topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.
|
||||
|
||||
|===
|
||||
..spec.drivers[].allocatable
|
||||
Description::
|
||||
VolumeNodeResources is a set of resource limits for scheduling of volumes.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
|
||||
|
||||
|
||||
[cols="1,1,1",options="header"]
|
||||
|===
|
||||
| Property | Type | Description
|
||||
|
||||
| `count`
|
||||
| `integer`
|
||||
| Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is nil, then the supported number of volumes on this node is unbounded.
|
||||
|
||||
|===
|
||||
@@ -62,7 +62,7 @@ Type::
|
||||
|
||||
| `dataSource`
|
||||
| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`]
|
||||
| This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.
|
||||
| This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) 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. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.
|
||||
|
||||
| `resources`
|
||||
| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`]
|
||||
@@ -78,7 +78,7 @@ Type::
|
||||
|
||||
| `volumeMode`
|
||||
| `string`
|
||||
| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature.
|
||||
| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
|
||||
|
||||
| `volumeName`
|
||||
| `string`
|
||||
|
||||
@@ -6,10 +6,10 @@ endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
== CSIDriver [storage.k8s.io/v1beta1]
|
||||
== CSIDriver [storage.k8s.io/v1]
|
||||
|
||||
Description::
|
||||
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
|
||||
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
@@ -207,7 +207,7 @@ Required::
|
||||
|
||||
| `topologySpreadConstraints`
|
||||
| xref:../objects/index.adoc#topologyspreadconstraint-core-v1[`array (TopologySpreadConstraint core/v1)`]
|
||||
| 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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
| 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. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
|
||||
| `volumes`
|
||||
| xref:../objects/index.adoc#volume-core-v1[`array (Volume core/v1)`]
|
||||
|
||||
@@ -51,7 +51,6 @@ Type::
|
||||
|
||||
Required::
|
||||
- `strategy`
|
||||
- `triggeredBy`
|
||||
|
||||
|
||||
|
||||
@@ -711,7 +710,7 @@ Required::
|
||||
|
||||
| `jenkinsPipelineStrategy`
|
||||
| `object`
|
||||
| JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.
|
||||
| JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines
|
||||
|
||||
| `sourceStrategy`
|
||||
| `object`
|
||||
@@ -839,7 +838,7 @@ Type::
|
||||
|
||||
| `from`
|
||||
| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`]
|
||||
| from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled the resulting image will be used in the FROM line of the Dockerfile for this build.
|
||||
| from is a reference to an DockerImage, ImageStreamTag, or ImageStreamImage which overrides the FROM image in the Dockerfile for the build. If the Dockerfile uses multi-stage builds, this will replace the image in the last FROM directive of the file.
|
||||
|
||||
| `imageOptimizationPolicy`
|
||||
| `string`
|
||||
@@ -856,7 +855,7 @@ Type::
|
||||
|===
|
||||
..spec.strategy.jenkinsPipelineStrategy
|
||||
Description::
|
||||
JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.
|
||||
JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
@@ -54,7 +54,6 @@ Type::
|
||||
`object`
|
||||
|
||||
Required::
|
||||
- `triggers`
|
||||
- `strategy`
|
||||
|
||||
|
||||
@@ -727,7 +726,7 @@ Required::
|
||||
|
||||
| `jenkinsPipelineStrategy`
|
||||
| `object`
|
||||
| JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.
|
||||
| JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines
|
||||
|
||||
| `sourceStrategy`
|
||||
| `object`
|
||||
@@ -855,7 +854,7 @@ Type::
|
||||
|
||||
| `from`
|
||||
| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`]
|
||||
| from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled the resulting image will be used in the FROM line of the Dockerfile for this build.
|
||||
| from is a reference to an DockerImage, ImageStreamTag, or ImageStreamImage which overrides the FROM image in the Dockerfile for the build. If the Dockerfile uses multi-stage builds, this will replace the image in the last FROM directive of the file.
|
||||
|
||||
| `imageOptimizationPolicy`
|
||||
| `string`
|
||||
@@ -872,7 +871,7 @@ Type::
|
||||
|===
|
||||
..spec.strategy.jenkinsPipelineStrategy
|
||||
Description::
|
||||
JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.
|
||||
JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines
|
||||
|
||||
Type::
|
||||
`object`
|
||||
|
||||
@@ -170,7 +170,7 @@ Type::
|
||||
|
||||
| `volumeMode`
|
||||
| `string`
|
||||
| volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is a beta feature.
|
||||
| volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.
|
||||
|
||||
| `vsphereVolume`
|
||||
| xref:../objects/index.adoc#vspherevirtualdiskvolumesource-core-v1[`VsphereVirtualDiskVolumeSource core/v1`]
|
||||
|
||||
@@ -188,7 +188,7 @@ Required::
|
||||
|
||||
| `topologySpreadConstraints`
|
||||
| xref:../objects/index.adoc#topologyspreadconstraint-core-v1[`array (TopologySpreadConstraint core/v1)`]
|
||||
| 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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
| 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. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
|
||||
| `volumes`
|
||||
| xref:../objects/index.adoc#volume-core-v1[`array (Volume core/v1)`]
|
||||
|
||||
@@ -242,7 +242,7 @@ Required::
|
||||
|
||||
| `topologySpreadConstraints`
|
||||
| xref:../objects/index.adoc#topologyspreadconstraint-core-v1[`array (TopologySpreadConstraint core/v1)`]
|
||||
| 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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
| 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. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.
|
||||
|
||||
| `volumes`
|
||||
| xref:../objects/index.adoc#volume-core-v1[`array (Volume core/v1)`]
|
||||
|
||||
Reference in New Issue
Block a user