openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

Build OpenShift 4.19 APIs

Browse Source 
- openshift-openapi-4.19rc1
This commit is contained in:
Jason Boxman
2025-05-28 16:50:29 -04:00
parent 40991b7f51
commit cf96747b4f
97 changed files with 22138 additions and 1578 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
rest_api/autoscale_apis/horizontalpodautoscaler-autoscaling-v2.adoc
View File

@@ -333,7 +333,7 @@ Required::
| `type`
| `string`
| type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
| type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object.
|===
=== .spec.metrics[].containerResource
@@ -981,7 +981,7 @@ Required::
| `type`
| `string`
| type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
| type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object.
|===
=== .status.currentMetrics[].containerResource

16
rest_api/cluster_apis/ipaddress-ipam-cluster-x-k8s-io-v1beta1.adoc
View File

@@ -66,30 +66,30 @@ Required::
| `address`
| `string`
| Address is the IP address.
| address is the IP address.
| `claimRef`
| `object`
| ClaimRef is a reference to the claim this IPAddress was created for.
| claimRef is a reference to the claim this IPAddress was created for.
| `gateway`
| `string`
| Gateway is the network gateway of the network the address is from.
| gateway is the network gateway of the network the address is from.
| `poolRef`
| `object`
| PoolRef is a reference to the pool that this IPAddress was created from.
| poolRef is a reference to the pool that this IPAddress was created from.
| `prefix`
| `integer`
| Prefix is the prefix of the address.
| prefix is the prefix of the address.
|===
=== .spec.claimRef
Description::
+
--
ClaimRef is a reference to the claim this IPAddress was created for.
claimRef is a reference to the claim this IPAddress was created for.
--
Type::
@@ -108,16 +108,14 @@ Type::
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
|===
=== .spec.poolRef
Description::
+
--
PoolRef is a reference to the pool that this IPAddress was created from.
poolRef is a reference to the pool that this IPAddress was created from.
--
Type::

24
rest_api/cluster_apis/ipaddressclaim-ipam-cluster-x-k8s-io-v1beta1.adoc
View File

@@ -67,18 +67,18 @@ Required::
| `clusterName`
| `string`
| ClusterName is the name of the Cluster this object belongs to.
| clusterName is the name of the Cluster this object belongs to.
| `poolRef`
| `object`
| PoolRef is a reference to the pool from which an IP address should be created.
| poolRef is a reference to the pool from which an IP address should be created.
|===
=== .spec.poolRef
Description::
+
--
PoolRef is a reference to the pool from which an IP address should be created.
poolRef is a reference to the pool from which an IP address should be created.
--
Type::
@@ -128,11 +128,11 @@ Type::
| `addressRef`
| `object`
| AddressRef is a reference to the address that was created for this claim.
| addressRef is a reference to the address that was created for this claim.
| `conditions`
| `array`
| Conditions summarises the current state of the IPAddressClaim
| conditions summarises the current state of the IPAddressClaim
| `conditions[]`
| `object`
@@ -143,7 +143,7 @@ Type::
Description::
+
--
AddressRef is a reference to the address that was created for this claim.
addressRef is a reference to the address that was created for this claim.
--
Type::
@@ -162,16 +162,14 @@ Type::
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
|===
=== .status.conditions
Description::
+
--
Conditions summarises the current state of the IPAddressClaim
conditions summarises the current state of the IPAddressClaim
--
Type::
@@ -216,21 +214,21 @@ This field may be empty.
| `string`
| The reason for the condition's last transition in CamelCase.
The specific API may choose whether or not this field is considered a guaranteed API.
This field may not be empty.
This field may be empty.
| `severity`
| `string`
| Severity provides an explicit classification of Reason code, so the users or machines can immediately
| severity provides an explicit classification of Reason code, so the users or machines can immediately
understand the current situation and act accordingly.
The Severity field MUST be set only when Status=False.
| `status`
| `string`
| Status of the condition, one of True, False, Unknown.
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| Type of condition in CamelCase or in foo.example.com/CamelCase.
| type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability to deconflict is important.

56
rest_api/config_apis/build-config-openshift-io-v1.adoc
View File

@@ -46,14 +46,14 @@ Required::
| `spec`
| `object`
| Spec holds user-settable values for the build controller configuration
| spec holds user-settable values for the build controller configuration
|===
=== .spec
Description::
+
--
Spec holds user-settable values for the build controller configuration
spec holds user-settable values for the build controller configuration
--
Type::
@@ -68,7 +68,7 @@ Type::
| `additionalTrustedCA`
| `object`
| AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that
| additionalTrustedCA is a reference to a ConfigMap containing additional CAs that
should be trusted for image pushes and pulls during builds.
The namespace for this config map is openshift-config.
@@ -77,18 +77,18 @@ image.config.openshift.io/cluster instead.
| `buildDefaults`
| `object`
| BuildDefaults controls the default information for Builds
| buildDefaults controls the default information for Builds
| `buildOverrides`
| `object`
| BuildOverrides controls override settings for builds
| buildOverrides controls override settings for builds
|===
=== .spec.additionalTrustedCA
Description::
+
--
AdditionalTrustedCA is a reference to a ConfigMap containing additional CAs that
additionalTrustedCA is a reference to a ConfigMap containing additional CAs that
should be trusted for image pushes and pulls during builds.
The namespace for this config map is openshift-config.
@@ -117,7 +117,7 @@ Required::
Description::
+
--
BuildDefaults controls the default information for Builds
buildDefaults controls the default information for Builds
--
Type::
@@ -132,7 +132,7 @@ Type::
| `defaultProxy`
| `object`
| DefaultProxy contains the default proxy settings for all build operations, including image pull/push
| defaultProxy contains the default proxy settings for all build operations, including image pull/push
and source download.
Values can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables
@@ -140,7 +140,7 @@ in the build config's strategy.
| `env`
| `array`
| Env is a set of default environment variables that will be applied to the
| env is a set of default environment variables that will be applied to the
build if the specified variables do not exist on the build
| `env[]`
@@ -149,14 +149,14 @@ build if the specified variables do not exist on the build
| `gitProxy`
| `object`
| GitProxy contains the proxy settings for git operations only. If set, this will override
| gitProxy contains the proxy settings for git operations only. If set, this will override
any Proxy settings for all git commands, such as git clone.
Values that are not set here will be inherited from DefaultProxy.
| `imageLabels`
| `array`
| ImageLabels is a list of docker labels that are applied to the resulting image.
| imageLabels is a list of docker labels that are applied to the resulting image.
User can override a default label by providing a label with the same name in their
Build/BuildConfig.
@@ -166,14 +166,14 @@ Build/BuildConfig.
| `resources`
| `object`
| Resources defines resource requirements to execute the build.
| resources defines resource requirements to execute the build.
|===
=== .spec.buildDefaults.defaultProxy
Description::
+
--
DefaultProxy contains the default proxy settings for all build operations, including image pull/push
defaultProxy contains the default proxy settings for all build operations, including image pull/push
and source download.
Values can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables
@@ -284,7 +284,7 @@ Required::
Description::
+
--
Env is a set of default environment variables that will be applied to the
env is a set of default environment variables that will be applied to the
build if the specified variables do not exist on the build
--
@@ -508,7 +508,7 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
Description::
+
--
GitProxy contains the proxy settings for git operations only. If set, this will override
gitProxy contains the proxy settings for git operations only. If set, this will override
any Proxy settings for all git commands, such as git clone.
Values that are not set here will be inherited from DefaultProxy.
@@ -618,7 +618,7 @@ Required::
Description::
+
--
ImageLabels is a list of docker labels that are applied to the resulting image.
imageLabels is a list of docker labels that are applied to the resulting image.
User can override a default label by providing a label with the same name in their
Build/BuildConfig.
--
@@ -648,18 +648,18 @@ Type::
| `name`
| `string`
| Name defines the name of the label. It must have non-zero length.
| name defines the name of the label. It must have non-zero length.
| `value`
| `string`
| Value defines the literal value of the label.
| value defines the literal value of the label.
|===
=== .spec.buildDefaults.resources
Description::
+
--
Resources defines resource requirements to execute the build.
resources defines resource requirements to execute the build.
--
Type::
@@ -754,7 +754,7 @@ only the result of this request.
Description::
+
--
BuildOverrides controls override settings for builds
buildOverrides controls override settings for builds
--
Type::
@@ -769,14 +769,14 @@ Type::
| `forcePull`
| `boolean`
| ForcePull overrides, if set, the equivalent value in the builds,
| forcePull overrides, if set, the equivalent value in the builds,
i.e. false disables force pull for all builds,
true enables force pull for all builds,
independently of what each build specifies itself
| `imageLabels`
| `array`
| ImageLabels is a list of docker labels that are applied to the resulting image.
| imageLabels is a list of docker labels that are applied to the resulting image.
If user provided a label in their Build/BuildConfig with the same name as one in this
list, the user's label will be overwritten.
@@ -786,11 +786,11 @@ list, the user's label will be overwritten.
| `nodeSelector`
| `object (string)`
| NodeSelector is a selector which must be true for the build pod to fit on a node
| nodeSelector is a selector which must be true for the build pod to fit on a node
| `tolerations`
| `array`
| Tolerations is a list of Tolerations that will override any existing
| tolerations is a list of Tolerations that will override any existing
tolerations set on a build pod.
| `tolerations[]`
@@ -803,7 +803,7 @@ the triple <key,value,effect> using the matching operator <operator>.
Description::
+
--
ImageLabels is a list of docker labels that are applied to the resulting image.
imageLabels is a list of docker labels that are applied to the resulting image.
If user provided a label in their Build/BuildConfig with the same name as one in this
list, the user's label will be overwritten.
--
@@ -833,18 +833,18 @@ Type::
| `name`
| `string`
| Name defines the name of the label. It must have non-zero length.
| name defines the name of the label. It must have non-zero length.
| `value`
| `string`
| Value defines the literal value of the label.
| value defines the literal value of the label.
|===
=== .spec.buildOverrides.tolerations
Description::
+
--
Tolerations is a list of Tolerations that will override any existing
tolerations is a list of Tolerations that will override any existing
tolerations set on a build pod.
--

6
rest_api/config_apis/clusterversion-config-openshift-io-v1.adoc
View File

@@ -726,7 +726,7 @@ Required::
| `promql`
| `object`
| promQL represents a cluster condition based on PromQL.
| promql represents a cluster condition based on PromQL.
| `type`
| `string`
@@ -738,7 +738,7 @@ the members and semantics of any additional properties.
Description::
+
--
promQL represents a cluster condition based on PromQL.
promql represents a cluster condition based on PromQL.
--
Type::
@@ -755,7 +755,7 @@ Required::
| `promql`
| `string`
| PromQL is a PromQL query classifying clusters. This query
| promql is a PromQL query classifying clusters. This query
query should return a 1 in the match case and a 0 in the
does-not-match case. Queries which return no time
series, or which return values besides 0 or 1, are

286
rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc
View File

@@ -118,7 +118,7 @@ Type::
| `key`
| `string`
| Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.
| key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.
| `name`
| `string`
@@ -145,23 +145,23 @@ Type::
| `alibabaCloud`
| `object`
| AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
| alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
| `aws`
| `object`
| AWS contains settings specific to the Amazon Web Services infrastructure provider.
| aws contains settings specific to the Amazon Web Services infrastructure provider.
| `azure`
| `object`
| Azure contains settings specific to the Azure infrastructure provider.
| azure contains settings specific to the Azure infrastructure provider.
| `baremetal`
| `object`
| BareMetal contains settings specific to the BareMetal platform.
| baremetal contains settings specific to the BareMetal platform.
| `equinixMetal`
| `object`
| EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
| equinixMetal contains settings specific to the Equinix Metal infrastructure provider.
| `external`
| `object`
@@ -170,31 +170,31 @@ Platform-specific components should be supplemented separately.
| `gcp`
| `object`
| GCP contains settings specific to the Google Cloud Platform infrastructure provider.
| gcp contains settings specific to the Google Cloud Platform infrastructure provider.
| `ibmcloud`
| `object`
| IBMCloud contains settings specific to the IBMCloud infrastructure provider.
| ibmcloud contains settings specific to the IBMCloud infrastructure provider.
| `kubevirt`
| `object`
| Kubevirt contains settings specific to the kubevirt infrastructure provider.
| kubevirt contains settings specific to the kubevirt infrastructure provider.
| `nutanix`
| `object`
| Nutanix contains settings specific to the Nutanix infrastructure provider.
| nutanix contains settings specific to the Nutanix infrastructure provider.
| `openstack`
| `object`
| OpenStack contains settings specific to the OpenStack infrastructure provider.
| openstack contains settings specific to the OpenStack infrastructure provider.
| `ovirt`
| `object`
| Ovirt contains settings specific to the oVirt infrastructure provider.
| ovirt contains settings specific to the oVirt infrastructure provider.
| `powervs`
| `object`
| PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.
| powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.
| `type`
| `string`
@@ -209,14 +209,14 @@ and must handle unrecognized platforms as None if they do not support that platf
| `vsphere`
| `object`
| VSphere contains settings specific to the VSphere infrastructure provider.
| vsphere contains settings specific to the VSphere infrastructure provider.
|===
=== .spec.platformSpec.alibabaCloud
Description::
+
--
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
--
Type::
@@ -229,7 +229,7 @@ Type::
Description::
+
--
AWS contains settings specific to the Amazon Web Services infrastructure provider.
aws contains settings specific to the Amazon Web Services infrastructure provider.
--
Type::
@@ -304,7 +304,7 @@ This must be provided and cannot be empty.
Description::
+
--
Azure contains settings specific to the Azure infrastructure provider.
azure contains settings specific to the Azure infrastructure provider.
--
Type::
@@ -317,7 +317,7 @@ Type::
Description::
+
--
BareMetal contains settings specific to the BareMetal platform.
baremetal contains settings specific to the BareMetal platform.
--
Type::
@@ -364,7 +364,7 @@ for example "10.0.0.0/8" or "fd00::/8".
Description::
+
--
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
equinixMetal contains settings specific to the Equinix Metal infrastructure provider.
--
Type::
@@ -393,7 +393,7 @@ Type::
| `platformName`
| `string`
| PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time.
| platformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time.
This field is solely for informational and reporting purposes and is not expected to be used for decision-making.
|===
@@ -401,7 +401,7 @@ This field is solely for informational and reporting purposes and is not expecte
Description::
+
--
GCP contains settings specific to the Google Cloud Platform infrastructure provider.
gcp contains settings specific to the Google Cloud Platform infrastructure provider.
--
Type::
@@ -414,7 +414,7 @@ Type::
Description::
+
--
IBMCloud contains settings specific to the IBMCloud infrastructure provider.
ibmcloud contains settings specific to the IBMCloud infrastructure provider.
--
Type::
@@ -427,7 +427,7 @@ Type::
Description::
+
--
Kubevirt contains settings specific to the kubevirt infrastructure provider.
kubevirt contains settings specific to the kubevirt infrastructure provider.
--
Type::
@@ -440,7 +440,7 @@ Type::
Description::
+
--
Nutanix contains settings specific to the Nutanix infrastructure provider.
nutanix contains settings specific to the Nutanix infrastructure provider.
--
Type::
@@ -748,7 +748,7 @@ Required::
Description::
+
--
OpenStack contains settings specific to the OpenStack infrastructure provider.
openstack contains settings specific to the OpenStack infrastructure provider.
--
Type::
@@ -795,7 +795,7 @@ for example "10.0.0.0/8" or "fd00::/8".
Description::
+
--
Ovirt contains settings specific to the oVirt infrastructure provider.
ovirt contains settings specific to the oVirt infrastructure provider.
--
Type::
@@ -808,7 +808,7 @@ Type::
Description::
+
--
PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.
powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.
--
Type::
@@ -886,7 +886,7 @@ This must be provided and cannot be empty.
Description::
+
--
VSphere contains settings specific to the VSphere infrastructure provider.
vsphere contains settings specific to the VSphere infrastructure provider.
--
Type::
@@ -918,8 +918,7 @@ If this is omitted failure domains (regions and zones) will not be used.
| `failureDomains[]`
| `object`
| VSpherePlatformFailureDomainSpec holds the region and zone failure domain and
the vCenter topology of that failure domain.
| VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain.
| `ingressIPs`
| `array (string)`
@@ -980,8 +979,7 @@ Type::
Description::
+
--
VSpherePlatformFailureDomainSpec holds the region and zone failure domain and
the vCenter topology of that failure domain.
VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain.
--
Type::
@@ -1011,13 +1009,19 @@ of a failure domain.
be attached to a vCenter datacenter. The tag
category in vCenter must be named openshift-region.
| `regionAffinity`
| `object`
| regionAffinity holds the type of region, Datacenter or ComputeCluster.
When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology.
When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology.
| `server`
| `string`
| server is the fully-qualified domain name or the IP address of the vCenter server.
| `topology`
| `object`
| Topology describes a given failure domain using vSphere constructs
| topology describes a given failure domain using vSphere constructs
| `zone`
| `string`
@@ -1025,12 +1029,48 @@ category in vCenter must be named openshift-region.
be attached to a vCenter cluster. The tag
category in vCenter must be named openshift-zone.
| `zoneAffinity`
| `object`
| zoneAffinity holds the type of the zone and the hostGroup which
vmGroup and the hostGroup names in vCenter corresponds to
a vm-host group of type Virtual Machine and Host respectively. Is also
contains the vmHostRule which is an affinity vm-host rule in vCenter.
|===
=== .spec.platformSpec.vsphere.failureDomains[].regionAffinity
Description::
+
--
regionAffinity holds the type of region, Datacenter or ComputeCluster.
When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology.
When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology.
--
Type::
`object`
Required::
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `type`
| `string`
| type determines the vSphere object type for a region within this failure domain.
Available types are Datacenter and ComputeCluster.
When set to Datacenter, this means the vCenter Datacenter defined is the region.
When set to ComputeCluster, this means the vCenter cluster defined is the region.
|===
=== .spec.platformSpec.vsphere.failureDomains[].topology
Description::
+
--
Topology describes a given failure domain using vSphere constructs
topology describes a given failure domain using vSphere constructs
--
Type::
@@ -1103,6 +1143,85 @@ VSpherePlatformFailureDomainSpec.
For example, for zone=zonea, region=region1, and infrastructure name=test,
the template path would be calculated as /<datacenter>/vm/test-rhcos-region1-zonea.
|===
=== .spec.platformSpec.vsphere.failureDomains[].zoneAffinity
Description::
+
--
zoneAffinity holds the type of the zone and the hostGroup which
vmGroup and the hostGroup names in vCenter corresponds to
a vm-host group of type Virtual Machine and Host respectively. Is also
contains the vmHostRule which is an affinity vm-host rule in vCenter.
--
Type::
`object`
Required::
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `hostGroup`
| `object`
| hostGroup holds the vmGroup and the hostGroup names in vCenter
corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also
contains the vmHostRule which is an affinity vm-host rule in vCenter.
| `type`
| `string`
| type determines the vSphere object type for a zone within this failure domain.
Available types are ComputeCluster and HostGroup.
When set to ComputeCluster, this means the vCenter cluster defined is the zone.
When set to HostGroup, hostGroup must be configured with hostGroup, vmGroup and vmHostRule and
this means the zone is defined by the grouping of those fields.
|===
=== .spec.platformSpec.vsphere.failureDomains[].zoneAffinity.hostGroup
Description::
+
--
hostGroup holds the vmGroup and the hostGroup names in vCenter
corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also
contains the vmHostRule which is an affinity vm-host rule in vCenter.
--
Type::
`object`
Required::
- `hostGroup`
- `vmGroup`
- `vmHostRule`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `hostGroup`
| `string`
| hostGroup is the name of the vm-host group of type host within vCenter for this failure domain.
hostGroup is limited to 80 characters.
This field is required when the VSphereFailureDomain ZoneType is HostGroup
| `vmGroup`
| `string`
| vmGroup is the name of the vm-host group of type virtual machine within vCenter for this failure domain.
vmGroup is limited to 80 characters.
This field is required when the VSphereFailureDomain ZoneType is HostGroup
| `vmHostRule`
| `string`
| vmHostRule is the name of the affinity vm-host rule within vCenter for this failure domain.
vmHostRule is limited to 80 characters.
This field is required when the VSphereFailureDomain ZoneType is HostGroup
|===
=== .spec.platformSpec.vsphere.nodeNetworking
Description::
@@ -1372,55 +1491,55 @@ Type::
| `alibabaCloud`
| `object`
| AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
| alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
| `aws`
| `object`
| AWS contains settings specific to the Amazon Web Services infrastructure provider.
| aws contains settings specific to the Amazon Web Services infrastructure provider.
| `azure`
| `object`
| Azure contains settings specific to the Azure infrastructure provider.
| azure contains settings specific to the Azure infrastructure provider.
| `baremetal`
| `object`
| BareMetal contains settings specific to the BareMetal platform.
| baremetal contains settings specific to the BareMetal platform.
| `equinixMetal`
| `object`
| EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
| equinixMetal contains settings specific to the Equinix Metal infrastructure provider.
| `external`
| `object`
| External contains settings specific to the generic External infrastructure provider.
| external contains settings specific to the generic External infrastructure provider.
| `gcp`
| `object`
| GCP contains settings specific to the Google Cloud Platform infrastructure provider.
| gcp contains settings specific to the Google Cloud Platform infrastructure provider.
| `ibmcloud`
| `object`
| IBMCloud contains settings specific to the IBMCloud infrastructure provider.
| ibmcloud contains settings specific to the IBMCloud infrastructure provider.
| `kubevirt`
| `object`
| Kubevirt contains settings specific to the kubevirt infrastructure provider.
| kubevirt contains settings specific to the kubevirt infrastructure provider.
| `nutanix`
| `object`
| Nutanix contains settings specific to the Nutanix infrastructure provider.
| nutanix contains settings specific to the Nutanix infrastructure provider.
| `openstack`
| `object`
| OpenStack contains settings specific to the OpenStack infrastructure provider.
| openstack contains settings specific to the OpenStack infrastructure provider.
| `ovirt`
| `object`
| Ovirt contains settings specific to the oVirt infrastructure provider.
| ovirt contains settings specific to the oVirt infrastructure provider.
| `powervs`
| `object`
| PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider.
| powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.
| `type`
| `string`
@@ -1438,14 +1557,14 @@ Currently this value cannot be changed once set.
| `vsphere`
| `object`
| VSphere contains settings specific to the VSphere infrastructure provider.
| vsphere contains settings specific to the VSphere infrastructure provider.
|===
=== .status.platformStatus.alibabaCloud
Description::
+
--
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
--
Type::
@@ -1523,7 +1642,7 @@ Required::
Description::
+
--
AWS contains settings specific to the Amazon Web Services infrastructure provider.
aws contains settings specific to the Amazon Web Services infrastructure provider.
--
Type::
@@ -1553,7 +1672,7 @@ available for the user.
| `serviceEndpoints`
| `array`
| ServiceEndpoints list contains custom endpoints which will override default
| serviceEndpoints list contains custom endpoints which will override default
service endpoint of AWS Services.
There must be only one ServiceEndpoint for a service.
@@ -1601,11 +1720,15 @@ Required::
| `key`
| `string`
| key is the key of the tag
| key sets the key of the AWS resource tag key-value pair. Key is required when defining an AWS resource tag.
Key should consist of between 1 and 128 characters, and may
contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'.
| `value`
| `string`
| value is the value of the tag.
| value sets the value of the AWS resource tag key-value pair. Value is required when defining an AWS resource tag.
Value should consist of between 1 and 256 characters, and may
contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'.
Some AWS service do not support empty values. Since tags are added to resources in many services, the
length of the tag value must meet the requirements of all services.
@@ -1614,7 +1737,7 @@ length of the tag value must meet the requirements of all services.
Description::
+
--
ServiceEndpoints list contains custom endpoints which will override default
serviceEndpoints list contains custom endpoints which will override default
service endpoint of AWS Services.
There must be only one ServiceEndpoint for a service.
--
@@ -1660,7 +1783,7 @@ This must be provided and cannot be empty.
Description::
+
--
Azure contains settings specific to the Azure infrastructure provider.
azure contains settings specific to the Azure infrastructure provider.
--
Type::
@@ -1756,7 +1879,7 @@ must contain only alphanumeric characters and the following special characters `
Description::
+
--
BareMetal contains settings specific to the BareMetal platform.
baremetal contains settings specific to the BareMetal platform.
--
Type::
@@ -1852,7 +1975,7 @@ The default value is OpenShiftManagedDefault.
Description::
+
--
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
equinixMetal contains settings specific to the Equinix Metal infrastructure provider.
--
Type::
@@ -1882,7 +2005,7 @@ The IP is a suitable target of a wildcard DNS record used to resolve default rou
Description::
+
--
External contains settings specific to the generic External infrastructure provider.
external contains settings specific to the generic External infrastructure provider.
--
Type::
@@ -1938,7 +2061,7 @@ and no extra initialization from the cloud controller manager is expected.
Description::
+
--
GCP contains settings specific to the Google Cloud Platform infrastructure provider.
gcp contains settings specific to the Google Cloud Platform infrastructure provider.
--
Type::
@@ -2093,7 +2216,7 @@ alphanumeric characters, and the following special characters `_-.@%=+:,*#&(){}[
Description::
+
--
IBMCloud contains settings specific to the IBMCloud infrastructure provider.
ibmcloud contains settings specific to the IBMCloud infrastructure provider.
--
Type::
@@ -2108,31 +2231,34 @@ Type::
| `cisInstanceCRN`
| `string`
| CISInstanceCRN is the CRN of the Cloud Internet Services instance managing
| cisInstanceCRN is the CRN of the Cloud Internet Services instance managing
the DNS zone for the cluster's base domain
| `dnsInstanceCRN`
| `string`
| DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone
| dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone
for the cluster's base domain
| `location`
| `string`
| Location is where the cluster has been deployed
| location is where the cluster has been deployed
| `providerType`
| `string`
| ProviderType indicates the type of cluster that was created
| providerType indicates the type of cluster that was created
| `resourceGroupName`
| `string`
| ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.
| resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.
| `serviceEndpoints`
| `array`
| serviceEndpoints is a list of custom endpoints which will override the default
service endpoints of an IBM Cloud service. These endpoints are consumed by
components within the cluster to reach the respective IBM Cloud Services.
service endpoints of an IBM service. These endpoints are used by components
within the cluster when trying to reach the IBM Cloud Services that have been
overriden. The CCCMO reads in the IBMCloudPlatformSpec and validates each
endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus
are updated to reflect the same custom endpoints.
| `serviceEndpoints[]`
| `object`
@@ -2145,8 +2271,11 @@ Description::
+
--
serviceEndpoints is a list of custom endpoints which will override the default
service endpoints of an IBM Cloud service. These endpoints are consumed by
components within the cluster to reach the respective IBM Cloud Services.
service endpoints of an IBM service. These endpoints are used by components
within the cluster when trying to reach the IBM Cloud Services that have been
overriden. The CCCMO reads in the IBMCloudPlatformSpec and validates each
endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus
are updated to reflect the same custom endpoints.
--
Type::
@@ -2189,14 +2318,15 @@ with the service `name` of `VPC` and `url` of `https://us.south.private.iaas.clo
| `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.
This must be provided and cannot be empty. The path must follow the pattern
/v[0,9]+ or /api/v[0,9]+
|===
=== .status.platformStatus.kubevirt
Description::
+
--
Kubevirt contains settings specific to the kubevirt infrastructure provider.
kubevirt contains settings specific to the kubevirt infrastructure provider.
--
Type::
@@ -2226,7 +2356,7 @@ The IP is a suitable target of a wildcard DNS record used to resolve default rou
Description::
+
--
Nutanix contains settings specific to the Nutanix infrastructure provider.
nutanix contains settings specific to the Nutanix infrastructure provider.
--
Type::
@@ -2309,7 +2439,7 @@ The default value is OpenShiftManagedDefault.
Description::
+
--
OpenStack contains settings specific to the OpenStack infrastructure provider.
openstack contains settings specific to the OpenStack infrastructure provider.
--
Type::
@@ -2410,7 +2540,7 @@ The default value is OpenShiftManagedDefault.
Description::
+
--
Ovirt contains settings specific to the oVirt infrastructure provider.
ovirt contains settings specific to the oVirt infrastructure provider.
--
Type::
@@ -2497,7 +2627,7 @@ The default value is OpenShiftManagedDefault.
Description::
+
--
PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider.
powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.
--
Type::
@@ -2512,12 +2642,12 @@ Type::
| `cisInstanceCRN`
| `string`
| CISInstanceCRN is the CRN of the Cloud Internet Services instance managing
| cisInstanceCRN is the CRN of the Cloud Internet Services instance managing
the DNS zone for the cluster's base domain
| `dnsInstanceCRN`
| `string`
| DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone
| dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone
for the cluster's base domain
| `region`
@@ -2602,7 +2732,7 @@ This must be provided and cannot be empty.
Description::
+
--
VSphere contains settings specific to the VSphere infrastructure provider.
vsphere contains settings specific to the VSphere infrastructure provider.
--
Type::

32
rest_api/config_apis/network-config-openshift-io-v1.adoc
View File

@@ -101,7 +101,7 @@ the network diagnostics feature will be disabled.
| `networkType`
| `string`
| NetworkType is the plugin that is to be deployed (e.g. OVNKubernetes).
| networkType is the plugin that is to be deployed (e.g. OVNKubernetes).
This should match a value that the cluster-network-operator understands,
or else no networking will be installed.
Currently supported values are:
@@ -512,7 +512,7 @@ are allocated.
| `clusterNetworkMTU`
| `integer`
| ClusterNetworkMTU is the MTU for inter-pod networking.
| clusterNetworkMTU is the MTU for inter-pod networking.
| `conditions`
| `array`
@@ -525,11 +525,11 @@ Known .status.conditions.type are: "NetworkDiagnosticsAvailable"
| `migration`
| `object`
| Migration contains the cluster network migration configuration.
| migration contains the cluster network migration configuration.
| `networkType`
| `string`
| NetworkType is the plugin that is deployed (e.g. OVNKubernetes).
| networkType is the plugin that is deployed (e.g. OVNKubernetes).
| `serviceNetwork`
| `array (string)`
@@ -652,7 +652,7 @@ This field may not be empty.
Description::
+
--
Migration contains the cluster network migration configuration.
migration contains the cluster network migration configuration.
--
Type::
@@ -667,11 +667,11 @@ Type::
| `mtu`
| `object`
| MTU is the MTU configuration that is being deployed.
| mtu is the MTU configuration that is being deployed.
| `networkType`
| `string`
| NetworkType is the target plugin that is being deployed.
| networkType is the target plugin that is being deployed.
DEPRECATED: network type migration is no longer supported,
so this should always be unset.
@@ -680,7 +680,7 @@ so this should always be unset.
Description::
+
--
MTU is the MTU configuration that is being deployed.
mtu is the MTU configuration that is being deployed.
--
Type::
@@ -695,18 +695,18 @@ Type::
| `machine`
| `object`
| Machine contains MTU migration configuration for the machine's uplink.
| machine contains MTU migration configuration for the machine's uplink.
| `network`
| `object`
| Network contains MTU migration configuration for the default network.
| network contains MTU migration configuration for the default network.
|===
=== .status.migration.mtu.machine
Description::
+
--
Machine contains MTU migration configuration for the machine's uplink.
machine contains MTU migration configuration for the machine's uplink.
--
Type::
@@ -721,18 +721,18 @@ Type::
| `from`
| `integer`
| From is the MTU to migrate from.
| from is the MTU to migrate from.
| `to`
| `integer`
| To is the MTU to migrate to.
| to is the MTU to migrate to.
|===
=== .status.migration.mtu.network
Description::
+
--
Network contains MTU migration configuration for the default network.
network contains MTU migration configuration for the default network.
--
Type::
@@ -747,11 +747,11 @@ Type::
| `from`
| `integer`
| From is the MTU to migrate from.
| from is the MTU to migrate from.
| `to`
| `integer`
| To is the MTU to migrate to.
| to is the MTU to migrate to.
|===

4
rest_api/config_apis/node-config-openshift-io-v1.adoc
View File

@@ -69,11 +69,11 @@ Type::
| `cgroupMode`
| `string`
| CgroupMode determines the cgroups version on the node
| cgroupMode determines the cgroups version on the node
| `workerLatencyProfile`
| `string`
| WorkerLatencyProfile determins the how fast the kubelet is updating
| workerLatencyProfile determins the how fast the kubelet is updating
the status and corresponding reaction of the cluster
|===

4
rest_api/config_apis/proxy-config-openshift-io-v1.adoc
View File

@@ -43,7 +43,7 @@ Required::
| `spec`
| `object`
| Spec holds user-settable values for the proxy configuration
| spec holds user-settable values for the proxy configuration
| `status`
| `object`
@@ -54,7 +54,7 @@ Required::
Description::
+
--
Spec holds user-settable values for the proxy configuration
spec holds user-settable values for the proxy configuration
--
Type::

2
rest_api/config_apis/scheduler-config-openshift-io-v1.adoc
View File

@@ -93,7 +93,7 @@ would not be applied.
| `mastersSchedulable`
| `boolean`
| MastersSchedulable allows masters nodes to be schedulable. When this flag is
| mastersSchedulable allows masters nodes to be schedulable. When this flag is
turned on, all the master nodes in the cluster will be made schedulable,
so that workload pods can run on them. The default value for this field is false,
meaning none of the master nodes are schedulable.

2
rest_api/console_apis/consolelink-console-openshift-io-v1.adoc
View File

@@ -113,7 +113,7 @@ Required::
| `imageURL`
| `string`
| imageUrl is the URL for the icon used in front of the link in the application menu.
| imageURL is the URL for the icon used in front of the link in the application menu.
The URL must be an HTTPS URL or a Data URI. The image should be square and will be shown at 24x24 pixels.
| `section`

4
rest_api/console_apis/consoleplugin-console-openshift-io-v1.adoc
View File

@@ -45,14 +45,14 @@ Required::
| `spec`
| `object`
| ConsolePluginSpec is the desired plugin configuration.
| spec contains the desired configuration for the console plugin.
|===
=== .spec
Description::
+
--
ConsolePluginSpec is the desired plugin configuration.
spec contains the desired configuration for the console plugin.
--
Type::

4
rest_api/extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc
View File

@@ -179,8 +179,8 @@ IfNeeded: the webhook will be called at least one additional time as part of the
Defaults to "Never".
Possible enum values:
- `"IfNeeded"` indicates that the webhook may be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call.
- `"Never"` indicates that the webhook must not be called more than once in a single admission evaluation.
- `"IfNeeded"` indicates that the mutation may be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial mutation call.
- `"Never"` indicates that the mutation must not be called more than once in a single admission evaluation.
| `rules`
| `array`

2
rest_api/extension_apis/validatingadmissionpolicybinding-admissionregistration-k8s-io-v1.adoc
View File

@@ -89,7 +89,7 @@ The supported actions values are:
"Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses.
"Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{"message": "Invalid value", {"policy": "policy.example.com", {"binding": "policybinding.example.com", {"expressionIndex": "1", {"validationActions": ["Audit"]}]"`
"Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{\"message\": \"Invalid value\", {\"policy\": \"policy.example.com\", {\"binding\": \"policybinding.example.com\", {\"expressionIndex\": \"1\", {\"validationActions\": [\"Audit\"]}]"`
Clients should expect to handle additional values by ignoring any values not recognized.

16
rest_api/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc
View File

@@ -43,18 +43,18 @@ Required::
| `spec`
| `object`
| ContainerRuntimeConfigSpec defines the desired state of ContainerRuntimeConfig
| spec contains the desired container runtime configuration.
| `status`
| `object`
| ContainerRuntimeConfigStatus defines the observed state of a ContainerRuntimeConfig
| status contains observed information about the container runtime configuration.
|===
=== .spec
Description::
+
--
ContainerRuntimeConfigSpec defines the desired state of ContainerRuntimeConfig
spec contains the desired container runtime configuration.
--
Type::
@@ -71,11 +71,11 @@ Required::
| `containerRuntimeConfig`
| `object`
| ContainerRuntimeConfiguration defines the tuneables of the container runtime
| containerRuntimeConfig defines the tuneables of the container runtime.
| `machineConfigPoolSelector`
| `object`
| MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to.
| machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to.
A nil selector will result in no pools being selected.
|===
@@ -83,7 +83,7 @@ A nil selector will result in no pools being selected.
Description::
+
--
ContainerRuntimeConfiguration defines the tuneables of the container runtime
containerRuntimeConfig defines the tuneables of the container runtime.
--
Type::
@@ -125,7 +125,7 @@ This flag can be used to set quota on the size of container images. (default: 10
Description::
+
--
MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to.
machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to.
A nil selector will result in no pools being selected.
--
@@ -210,7 +210,7 @@ merge patch.
Description::
+
--
ContainerRuntimeConfigStatus defines the observed state of a ContainerRuntimeConfig
status contains observed information about the container runtime configuration.
--
Type::

18
rest_api/machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc
View File

@@ -44,18 +44,18 @@ Required::
| `spec`
| `object`
| ControllerConfigSpec is the spec for ControllerConfig resource.
| spec contains the desired controller config configuration.
| `status`
| `object`
| ControllerConfigStatus is the status for ControllerConfig
| status contains observed information about the controller config.
|===
=== .spec
Description::
+
--
ControllerConfigSpec is the spec for ControllerConfig resource.
spec contains the desired controller config configuration.
--
Type::
@@ -84,15 +84,15 @@ trusted certificate store.
| `baseOSContainerImage`
| `string`
| BaseOSContainerImage is the new-format container image for operating system updates.
| baseOSContainerImage is the new-format container image for operating system updates.
| `baseOSExtensionsContainerImage`
| `string`
| BaseOSExtensionsContainerImage is the matching extensions container for the new-format container
| baseOSExtensionsContainerImage is the matching extensions container for the new-format container
| `cloudProviderCAData`
| ``
| cloudProvider specifies the cloud provider CA data
| cloudProviderCAData specifies the cloud provider CA data
| `cloudProviderConfig`
| `string`
@@ -149,7 +149,7 @@ rpm-ostree to pull images from the internal registry if present
| `network`
| ``
| Network contains additional network related information
| network contains additional network related information
| `networkType`
| `string`
@@ -161,7 +161,7 @@ regeneration if this changes.
| `osImageURL`
| `string`
| OSImageURL is the old-format container image that contains the OS update payload.
| osImageURL is the old-format container image that contains the OS update payload.
| `platform`
| `string`
@@ -399,7 +399,7 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
Description::
+
--
ControllerConfigStatus is the status for ControllerConfig
status contains observed information about the controller config.
--
Type::

134
rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc
View File

@@ -68,9 +68,23 @@ Required::
|===
| Property | Type | Description
| `machineNamePrefix`
| `string`
| machineNamePrefix is the prefix used when creating machine names.
Each machine name will consist of this prefix, followed by
a randomly generated string of 5 characters, and the index of the machine.
It must be a lowercase RFC 1123 subdomain, consisting of lowercase
alphanumeric characters, hyphens ('-'), and periods ('.').
Each block, separated by periods, must start and end with an alphanumeric character.
Hyphens are not allowed at the start or end of a block, and consecutive periods are not permitted.
The prefix must be between 1 and 245 characters in length.
For example, if machineNamePrefix is set to 'control-plane',
and three machines are created, their names might be:
control-plane-abcde-0, control-plane-fghij-1, control-plane-klmno-2
| `replicas`
| `integer`
| Replicas defines how many Control Plane Machines should be
| replicas defines how many Control Plane Machines should be
created by this ControlPlaneMachineSet.
This field is immutable and cannot be changed after cluster
installation.
@@ -86,7 +100,7 @@ This field is considered immutable after creation of the resource.
| `state`
| `string`
| State defines whether the ControlPlaneMachineSet is Active or Inactive.
| state defines whether the ControlPlaneMachineSet is Active or Inactive.
When Inactive, the ControlPlaneMachineSet will not take any action on the
state of the Machines within the cluster.
When Active, the ControlPlaneMachineSet will reconcile the Machines and
@@ -96,12 +110,12 @@ further action please remove the ControlPlaneMachineSet.
| `strategy`
| `object`
| Strategy defines how the ControlPlaneMachineSet will update
| strategy defines how the ControlPlaneMachineSet will update
Machines when it detects a change to the ProviderSpec.
| `template`
| `object`
| Template describes the Control Plane Machines that will be created
| template describes the Control Plane Machines that will be created
by this ControlPlaneMachineSet.
|===
@@ -196,7 +210,7 @@ merge patch.
Description::
+
--
Strategy defines how the ControlPlaneMachineSet will update
strategy defines how the ControlPlaneMachineSet will update
Machines when it detects a change to the ProviderSpec.
--
@@ -212,7 +226,7 @@ Type::
| `type`
| `string`
| Type defines the type of update strategy that should be
| type defines the type of update strategy that should be
used when updating Machines owned by the ControlPlaneMachineSet.
Valid values are "RollingUpdate" and "OnDelete".
The current default value is "RollingUpdate".
@@ -222,7 +236,7 @@ The current default value is "RollingUpdate".
Description::
+
--
Template describes the Control Plane Machines that will be created
template describes the Control Plane Machines that will be created
by this ControlPlaneMachineSet.
--
@@ -240,7 +254,7 @@ Required::
| `machineType`
| `string`
| MachineType determines the type of Machines that should be managed by the ControlPlaneMachineSet.
| machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet.
Currently, the only valid value is machines_v1beta1_machine_openshift_io.
| `machines_v1beta1_machine_openshift_io`
@@ -272,7 +286,7 @@ Required::
| `failureDomains`
| `object`
| FailureDomains is the list of failure domains (sometimes called
| failureDomains is the list of failure domains (sometimes called
availability zones) in which the ControlPlaneMachineSet should balance
the Control Plane Machines.
This will be merged into the ProviderSpec given in the template.
@@ -286,7 +300,7 @@ Labels are required to match the ControlPlaneMachineSet selector.
| `spec`
| `object`
| Spec contains the desired configuration of the Control Plane Machines.
| spec contains the desired configuration of the Control Plane Machines.
The ProviderSpec within contains platform specific details
for creating the Control Plane Machines.
The ProviderSe should be complete apart from the platform specific
@@ -298,7 +312,7 @@ are created based on the FailureDomains field.
Description::
+
--
FailureDomains is the list of failure domains (sometimes called
failureDomains is the list of failure domains (sometimes called
availability zones) in which the ControlPlaneMachineSet should balance
the Control Plane Machines.
This will be merged into the ProviderSpec given in the template.
@@ -319,7 +333,7 @@ Required::
| `aws`
| `array`
| AWS configures failure domain information for the AWS platform.
| aws configures failure domain information for the AWS platform.
| `aws[]`
| `object`
@@ -327,7 +341,7 @@ Required::
| `azure`
| `array`
| Azure configures failure domain information for the Azure platform.
| azure configures failure domain information for the Azure platform.
| `azure[]`
| `object`
@@ -335,7 +349,7 @@ Required::
| `gcp`
| `array`
| GCP configures failure domain information for the GCP platform.
| gcp configures failure domain information for the GCP platform.
| `gcp[]`
| `object`
@@ -351,7 +365,7 @@ Required::
| `openstack`
| `array`
| OpenStack configures failure domain information for the OpenStack platform.
| openstack configures failure domain information for the OpenStack platform.
| `openstack[]`
| `object`
@@ -359,7 +373,7 @@ Required::
| `platform`
| `string`
| Platform identifies the platform for which the FailureDomain represents.
| platform identifies the platform for which the FailureDomain represents.
Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.
| `vsphere`
@@ -375,7 +389,7 @@ Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.
Description::
+
--
AWS configures failure domain information for the AWS platform.
aws configures failure domain information for the AWS platform.
--
Type::
@@ -403,18 +417,18 @@ Type::
| `placement`
| `object`
| Placement configures the placement information for this instance.
| placement configures the placement information for this instance.
| `subnet`
| `object`
| Subnet is a reference to the subnet to use for this instance.
| subnet is a reference to the subnet to use for this instance.
|===
=== .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].placement
Description::
+
--
Placement configures the placement information for this instance.
placement configures the placement information for this instance.
--
Type::
@@ -431,14 +445,14 @@ Required::
| `availabilityZone`
| `string`
| AvailabilityZone is the availability zone of the instance.
| availabilityZone is the availability zone of the instance.
|===
=== .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet
Description::
+
--
Subnet is a reference to the subnet to use for this instance.
subnet is a reference to the subnet to use for this instance.
--
Type::
@@ -455,11 +469,11 @@ Required::
| `arn`
| `string`
| ARN of resource.
| arn of resource.
| `filters`
| `array`
| Filters is a set of filters used to identify a resource.
| filters is a set of filters used to identify a resource.
| `filters[]`
| `object`
@@ -467,18 +481,18 @@ Required::
| `id`
| `string`
| ID of resource.
| id of resource.
| `type`
| `string`
| Type determines how the reference will fetch the AWS resource.
| type determines how the reference will fetch the AWS resource.
|===
=== .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.aws[].subnet.filters
Description::
+
--
Filters is a set of filters used to identify a resource.
filters is a set of filters used to identify a resource.
--
Type::
@@ -508,18 +522,18 @@ Required::
| `name`
| `string`
| Name of the filter. Filter names are case-sensitive.
| name of the filter. Filter names are case-sensitive.
| `values`
| `array (string)`
| Values includes one or more filter values. Filter values are case-sensitive.
| values includes one or more filter values. Filter values are case-sensitive.
|===
=== .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.azure
Description::
+
--
Azure configures failure domain information for the Azure platform.
azure configures failure domain information for the Azure platform.
--
Type::
@@ -562,7 +576,7 @@ If nil, the virtual machine should be deployed to no zone.
Description::
+
--
GCP configures failure domain information for the GCP platform.
gcp configures failure domain information for the GCP platform.
--
Type::
@@ -592,7 +606,7 @@ Required::
| `zone`
| `string`
| Zone is the zone in which the GCP machine provider will create the VM.
| zone is the zone in which the GCP machine provider will create the VM.
|===
=== .spec.template.machines_v1beta1_machine_openshift_io.failureDomains.nutanix
@@ -637,7 +651,7 @@ Failure domains are defined in a cluster's config.openshift.io/Infrastructure re
Description::
+
--
OpenStack configures failure domain information for the OpenStack platform.
openstack configures failure domain information for the OpenStack platform.
--
Type::
@@ -779,7 +793,7 @@ Required::
| `annotations`
| `object (string)`
| Annotations is an unstructured key value map stored with a resource that may be
| 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
@@ -798,7 +812,7 @@ It must also contain a label with the key 'machine.openshift.io/cluster-api-clus
Description::
+
--
Spec contains the desired configuration of the Control Plane Machines.
spec contains the desired configuration of the Control Plane Machines.
The ProviderSpec within contains platform specific details
for creating the Control Plane Machines.
The ProviderSe should be complete apart from the platform specific
@@ -818,7 +832,7 @@ Type::
| `lifecycleHooks`
| `object`
| LifecycleHooks allow users to pause operations on the machine at
| lifecycleHooks allow users to pause operations on the machine at
certain predefined points within the machine lifecycle.
| `metadata`
@@ -829,7 +843,7 @@ when creating the Node.
| `providerID`
| `string`
| ProviderID is the identification ID of the machine provided by the provider.
| 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
@@ -842,7 +856,7 @@ be interfacing with cluster-api as generic provider.
| `providerSpec`
| `object`
| ProviderSpec details Provider-specific configuration to use during node creation.
| providerSpec details Provider-specific configuration to use during node creation.
| `taints`
| `array`
@@ -863,7 +877,7 @@ any pod that does not tolerate the Taint.
Description::
+
--
LifecycleHooks allow users to pause operations on the machine at
lifecycleHooks allow users to pause operations on the machine at
certain predefined points within the machine lifecycle.
--
@@ -879,7 +893,7 @@ Type::
| `preDrain`
| `array`
| PreDrain hooks prevent the machine from being drained.
| preDrain hooks prevent the machine from being drained.
This also blocks further lifecycle events, such as termination.
| `preDrain[]`
@@ -888,7 +902,7 @@ This also blocks further lifecycle events, such as termination.
| `preTerminate`
| `array`
| PreTerminate hooks prevent the machine from being terminated.
| preTerminate hooks prevent the machine from being terminated.
PreTerminate hooks be actioned after the Machine has been drained.
| `preTerminate[]`
@@ -900,7 +914,7 @@ PreTerminate hooks be actioned after the Machine has been drained.
Description::
+
--
PreDrain hooks prevent the machine from being drained.
preDrain hooks prevent the machine from being drained.
This also blocks further lifecycle events, such as termination.
--
@@ -932,14 +946,14 @@ Required::
| `name`
| `string`
| Name defines a unique name for the lifcycle hook.
| name defines a unique name for the lifcycle hook.
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
it may be namespaced, eg. foo.example.com/CamelCase.
Names must be unique and should only be managed by a single entity.
| `owner`
| `string`
| Owner defines the owner of the lifecycle hook.
| owner defines the owner of the lifecycle hook.
This should be descriptive enough so that users can identify
who/what is responsible for blocking the lifecycle.
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -950,7 +964,7 @@ or an administrator managing the hook.
Description::
+
--
PreTerminate hooks prevent the machine from being terminated.
preTerminate hooks prevent the machine from being terminated.
PreTerminate hooks be actioned after the Machine has been drained.
--
@@ -982,14 +996,14 @@ Required::
| `name`
| `string`
| Name defines a unique name for the lifcycle hook.
| name defines a unique name for the lifcycle hook.
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
it may be namespaced, eg. foo.example.com/CamelCase.
Names must be unique and should only be managed by a single entity.
| `owner`
| `string`
| Owner defines the owner of the lifecycle hook.
| owner defines the owner of the lifecycle hook.
This should be descriptive enough so that users can identify
who/what is responsible for blocking the lifecycle.
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -1017,14 +1031,14 @@ Type::
| `annotations`
| `object (string)`
| Annotations is an unstructured key value map stored with a resource that may be
| 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
| 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.
@@ -1049,7 +1063,7 @@ More info: http://kubernetes.io/docs/user-guide/labels
| `name`
| `string`
| Name must be unique within a namespace. Is required when creating resources, although
| 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.
@@ -1058,7 +1072,7 @@ 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
| 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.
@@ -1160,7 +1174,7 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
Description::
+
--
ProviderSpec details Provider-specific configuration to use during node creation.
providerSpec details Provider-specific configuration to use during node creation.
--
Type::
@@ -1175,7 +1189,7 @@ Type::
| `value`
| ``
| Value is an inlined, serialized representation of the resource
| 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.
@@ -1259,7 +1273,7 @@ Type::
| `conditions`
| `array`
| Conditions represents the observations of the ControlPlaneMachineSet's current state.
| conditions represents the observations of the ControlPlaneMachineSet's current state.
Known .status.conditions.type are: Available, Degraded and Progressing.
| `conditions[]`
@@ -1268,34 +1282,34 @@ Known .status.conditions.type are: Available, Degraded and Progressing.
| `observedGeneration`
| `integer`
| ObservedGeneration is the most recent generation observed for this
| observedGeneration is the most recent generation observed for this
ControlPlaneMachineSet. It corresponds to the ControlPlaneMachineSets's generation,
which is updated on mutation by the API Server.
| `readyReplicas`
| `integer`
| ReadyReplicas is the number of Control Plane Machines created by the
| readyReplicas is the number of Control Plane Machines created by the
ControlPlaneMachineSet controller which are ready.
Note that this value may be higher than the desired number of replicas
while rolling updates are in-progress.
| `replicas`
| `integer`
| Replicas is the number of Control Plane Machines created by the
| replicas is the number of Control Plane Machines created by the
ControlPlaneMachineSet controller.
Note that during update operations this value may differ from the
desired replica count.
| `unavailableReplicas`
| `integer`
| UnavailableReplicas is the number of Control Plane Machines that are
| unavailableReplicas is the number of Control Plane Machines that are
still required before the ControlPlaneMachineSet reaches the desired
available capacity. When this value is non-zero, the number of
ReadyReplicas is less than the desired Replicas.
| `updatedReplicas`
| `integer`
| UpdatedReplicas is the number of non-terminated Control Plane Machines
| updatedReplicas is the number of non-terminated Control Plane Machines
created by the ControlPlaneMachineSet controller that have the desired
provider spec and are ready.
This value is set to 0 when a change is detected to the desired spec.
@@ -1309,7 +1323,7 @@ a user deletes an existing replica and its replacement has become ready.
Description::
+
--
Conditions represents the observations of the ControlPlaneMachineSet's current state.
conditions represents the observations of the ControlPlaneMachineSet's current state.
Known .status.conditions.type are: Available, Degraded and Progressing.
--

12
rest_api/machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc
View File

@@ -43,18 +43,18 @@ Required::
| `spec`
| `object`
| KubeletConfigSpec defines the desired state of KubeletConfig
| spec contains the desired kubelet configuration.
| `status`
| `object`
| KubeletConfigStatus defines the observed state of a KubeletConfig
| status contains observed information about the kubelet configuration.
|===
=== .spec
Description::
+
--
KubeletConfigSpec defines the desired state of KubeletConfig
spec contains the desired kubelet configuration.
--
Type::
@@ -84,7 +84,7 @@ for the valid values of these fields. Invalid values of the kubelet configuratio
| `machineConfigPoolSelector`
| `object`
| MachineConfigPoolSelector selects which pools the KubeletConfig shoud apply to.
| machineConfigPoolSelector selects which pools the KubeletConfig shoud apply to.
A nil selector will result in no pools being selected.
| `tlsSecurityProfile`
@@ -98,7 +98,7 @@ the maximum available minTLSVersion is VersionTLS12.
Description::
+
--
MachineConfigPoolSelector selects which pools the KubeletConfig shoud apply to.
machineConfigPoolSelector selects which pools the KubeletConfig shoud apply to.
A nil selector will result in no pools being selected.
--
@@ -358,7 +358,7 @@ yet well adopted by common software libraries.
Description::
+
--
KubeletConfigStatus defines the observed state of a KubeletConfig
status contains observed information about the kubelet configuration.
--
Type::

24
rest_api/machine_apis/machine-apis-index.adoc
View File

@@ -121,3 +121,27 @@ Compatibility level 2: Stable within a major release for a minimum of 9 months o
Type::
`object`
== MachineOSBuild [machineconfiguration.openshift.io/v1]
Description::
+
--
MachineOSBuild describes a build process managed and deployed by the MCO
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
Type::
`object`
== MachineOSConfig [machineconfiguration.openshift.io/v1]
Description::
+
--
MachineOSConfig describes the configuration for a build process managed by the MCO
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
Type::
`object`

76
rest_api/machine_apis/machine-machine-openshift-io-v1beta1.adoc
View File

@@ -66,7 +66,7 @@ Type::
| `lifecycleHooks`
| `object`
| LifecycleHooks allow users to pause operations on the machine at
| lifecycleHooks allow users to pause operations on the machine at
certain predefined points within the machine lifecycle.
| `metadata`
@@ -77,7 +77,7 @@ when creating the Node.
| `providerID`
| `string`
| ProviderID is the identification ID of the machine provided by the provider.
| 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
@@ -90,7 +90,7 @@ be interfacing with cluster-api as generic provider.
| `providerSpec`
| `object`
| ProviderSpec details Provider-specific configuration to use during node creation.
| providerSpec details Provider-specific configuration to use during node creation.
| `taints`
| `array`
@@ -111,7 +111,7 @@ any pod that does not tolerate the Taint.
Description::
+
--
LifecycleHooks allow users to pause operations on the machine at
lifecycleHooks allow users to pause operations on the machine at
certain predefined points within the machine lifecycle.
--
@@ -127,7 +127,7 @@ Type::
| `preDrain`
| `array`
| PreDrain hooks prevent the machine from being drained.
| preDrain hooks prevent the machine from being drained.
This also blocks further lifecycle events, such as termination.
| `preDrain[]`
@@ -136,7 +136,7 @@ This also blocks further lifecycle events, such as termination.
| `preTerminate`
| `array`
| PreTerminate hooks prevent the machine from being terminated.
| preTerminate hooks prevent the machine from being terminated.
PreTerminate hooks be actioned after the Machine has been drained.
| `preTerminate[]`
@@ -148,7 +148,7 @@ PreTerminate hooks be actioned after the Machine has been drained.
Description::
+
--
PreDrain hooks prevent the machine from being drained.
preDrain hooks prevent the machine from being drained.
This also blocks further lifecycle events, such as termination.
--
@@ -180,14 +180,14 @@ Required::
| `name`
| `string`
| Name defines a unique name for the lifcycle hook.
| name defines a unique name for the lifcycle hook.
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
it may be namespaced, eg. foo.example.com/CamelCase.
Names must be unique and should only be managed by a single entity.
| `owner`
| `string`
| Owner defines the owner of the lifecycle hook.
| owner defines the owner of the lifecycle hook.
This should be descriptive enough so that users can identify
who/what is responsible for blocking the lifecycle.
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -198,7 +198,7 @@ or an administrator managing the hook.
Description::
+
--
PreTerminate hooks prevent the machine from being terminated.
preTerminate hooks prevent the machine from being terminated.
PreTerminate hooks be actioned after the Machine has been drained.
--
@@ -230,14 +230,14 @@ Required::
| `name`
| `string`
| Name defines a unique name for the lifcycle hook.
| name defines a unique name for the lifcycle hook.
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
it may be namespaced, eg. foo.example.com/CamelCase.
Names must be unique and should only be managed by a single entity.
| `owner`
| `string`
| Owner defines the owner of the lifecycle hook.
| owner defines the owner of the lifecycle hook.
This should be descriptive enough so that users can identify
who/what is responsible for blocking the lifecycle.
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -265,14 +265,14 @@ Type::
| `annotations`
| `object (string)`
| Annotations is an unstructured key value map stored with a resource that may be
| 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
| 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.
@@ -297,7 +297,7 @@ More info: http://kubernetes.io/docs/user-guide/labels
| `name`
| `string`
| Name must be unique within a namespace. Is required when creating resources, although
| 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.
@@ -306,7 +306,7 @@ 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
| 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.
@@ -408,7 +408,7 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
Description::
+
--
ProviderSpec details Provider-specific configuration to use during node creation.
providerSpec details Provider-specific configuration to use during node creation.
--
Type::
@@ -423,7 +423,7 @@ Type::
| `value`
| ``
| Value is an inlined, serialized representation of the resource
| 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.
@@ -507,7 +507,7 @@ Type::
| `addresses`
| `array`
| Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.
| addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.
| `addresses[]`
| `object`
@@ -515,7 +515,7 @@ Type::
| `conditions`
| `array`
| Conditions defines the current state of the Machine
| conditions defines the current state of the Machine
| `conditions[]`
| `object`
@@ -523,7 +523,7 @@ Type::
| `errorMessage`
| `string`
| ErrorMessage will be set in the event that there is a terminal problem
| 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.
@@ -542,7 +542,7 @@ controller's output.
| `errorReason`
| `string`
| ErrorReason will be set in the event that there is a terminal problem
| 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.
@@ -561,27 +561,27 @@ controller's output.
| `lastOperation`
| `object`
| LastOperation describes the last-operation performed by the machine-controller.
| 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.
| lastUpdated identifies when this status was last observed.
| `nodeRef`
| `object`
| NodeRef will point to the corresponding Node if it exists.
| nodeRef will point to the corresponding Node if it exists.
| `phase`
| `string`
| Phase represents the current phase of machine actuation.
| phase represents the current phase of machine actuation.
One of: Failed, Provisioning, Provisioned, Running, Deleting
| `providerStatus`
| ``
| ProviderStatus details a Provider-specific status.
| 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.
@@ -591,7 +591,7 @@ serialized/deserialized from this field.
Description::
+
--
Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.
addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.
--
Type::
@@ -633,7 +633,7 @@ Required::
Description::
+
--
Conditions defines the current state of the Machine
conditions defines the current state of the Machine
--
Type::
@@ -682,17 +682,17 @@ This field may not be empty.
| `severity`
| `string`
| Severity provides an explicit classification of Reason code, so the users or machines can immediately
| severity provides an explicit classification of Reason code, so the users or machines can immediately
understand the current situation and act accordingly.
The Severity field MUST be set only when Status=False.
| `status`
| `string`
| Status of the condition, one of True, False, Unknown.
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| Type of condition in CamelCase or in foo.example.com/CamelCase.
| type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability to deconflict is important.
@@ -701,7 +701,7 @@ can be useful (see .node.status.conditions), the ability to deconflict is import
Description::
+
--
LastOperation describes the last-operation performed by the machine-controller.
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.
@@ -719,20 +719,20 @@ Type::
| `description`
| `string`
| Description is the human-readable description of the last operation.
| description is the human-readable description of the last operation.
| `lastUpdated`
| `string`
| LastUpdated is the timestamp at which LastOperation API was last-updated.
| lastUpdated is the timestamp at which LastOperation API was last-updated.
| `state`
| `string`
| State is the current status of the last performed operation.
| 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.
| type is the type of operation which was last performed.
E.g. Create, Delete, Update etc
|===
@@ -740,7 +740,7 @@ E.g. Create, Delete, Update etc
Description::
+
--
NodeRef will point to the corresponding Node if it exists.
nodeRef will point to the corresponding Node if it exists.
--
Type::

6
rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc
View File

@@ -63,12 +63,12 @@ Type::
| `baseOSExtensionsContainerImage`
| `string`
| BaseOSExtensionsContainerImage specifies the remote location that will be used
| baseOSExtensionsContainerImage specifies the remote location that will be used
to fetch the extensions container matching a new-format OS image
| `config`
| ``
| Config is a Ignition Config object.
| config is a Ignition Config object.
| `extensions`
| `array (string)`
@@ -89,7 +89,7 @@ to fetch the extensions container matching a new-format OS image
| `osImageURL`
| `string`
| OSImageURL specifies the remote location that will be used to
| osImageURL specifies the remote location that will be used to
fetch the OS.
|===

8
rest_api/machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc
View File

@@ -43,18 +43,18 @@ Required::
| `spec`
| `object`
| MachineConfigPoolSpec is the spec for MachineConfigPool resource.
| spec contains the desired machine config pool configuration.
| `status`
| `object`
| MachineConfigPoolStatus is the status for MachineConfigPool resource.
| status contains observed information about the machine config pool.
|===
=== .spec
Description::
+
--
MachineConfigPoolSpec is the spec for MachineConfigPool resource.
spec contains the desired machine config pool configuration.
--
Type::
@@ -408,7 +408,7 @@ merge patch.
Description::
+
--
MachineConfigPoolStatus is the status for MachineConfigPool resource.
status contains observed information about the machine config pool.
--
Type::

20
rest_api/machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc
View File

@@ -84,7 +84,7 @@ Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
| `remediationTemplate`
| `object`
| RemediationTemplate is a reference to a remediation template
| remediationTemplate is a reference to a remediation template
provided by an infrastructure provider.
This field is completely optional, when filled, the MachineHealthCheck controller
@@ -98,7 +98,7 @@ Note: An empty selector will match all machines.
| `unhealthyConditions`
| `array`
| UnhealthyConditions contains a list of the conditions that determine
| 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.
@@ -113,7 +113,7 @@ status for at least the timeout value, a node is considered unhealthy.
Description::
+
--
RemediationTemplate is a reference to a remediation template
remediationTemplate is a reference to a remediation template
provided by an infrastructure provider.
This field is completely optional, when filled, the MachineHealthCheck controller
@@ -260,7 +260,7 @@ merge patch.
Description::
+
--
UnhealthyConditions contains a list of the conditions that determine
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.
--
@@ -324,7 +324,7 @@ Type::
| `conditions`
| `array`
| Conditions defines the current state of the MachineHealthCheck
| conditions defines the current state of the MachineHealthCheck
| `conditions[]`
| `object`
@@ -340,7 +340,7 @@ Type::
| `remediationsAllowed`
| `integer`
| RemediationsAllowed is the number of further remediations allowed by this machine health check before
| remediationsAllowed is the number of further remediations allowed by this machine health check before
maxUnhealthy short circuiting will be applied
|===
@@ -348,7 +348,7 @@ maxUnhealthy short circuiting will be applied
Description::
+
--
Conditions defines the current state of the MachineHealthCheck
conditions defines the current state of the MachineHealthCheck
--
Type::
@@ -397,17 +397,17 @@ This field may not be empty.
| `severity`
| `string`
| Severity provides an explicit classification of Reason code, so the users or machines can immediately
| severity provides an explicit classification of Reason code, so the users or machines can immediately
understand the current situation and act accordingly.
The Severity field MUST be set only when Status=False.
| `status`
| `string`
| Status of the condition, one of True, False, Unknown.
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| Type of condition in CamelCase or in foo.example.com/CamelCase.
| type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability to deconflict is important.

748
rest_api/machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc Normal file
View File

@@ -0,0 +1,748 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="machineosbuild-machineconfiguration-openshift-io-v1"]
= MachineOSBuild [machineconfiguration.openshift.io/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
MachineOSBuild describes a build process managed and deployed by the MCO
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| spec describes the configuration of the machine os build.
It is immutable once set.
| `status`
| `object`
| status describes the last observed state of this machine os build.
|===
=== .spec
Description::
+
--
spec describes the configuration of the machine os build.
It is immutable once set.
--
Type::
`object`
Required::
- `machineConfig`
- `machineOSConfig`
- `renderedImagePushSpec`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `machineConfig`
| `object`
| machineConfig points to the rendered MachineConfig resource to be included in this image build.
| `machineOSConfig`
| `object`
| machineOSConfig references the MachineOSConfig resource that this image build extends.
| `renderedImagePushSpec`
| `string`
| renderedImagePushSpec is set by the Machine Config Operator from the MachineOSConfig object this build is attached to.
This field describes the location of the final image, which will be pushed by the build once complete.
The format of the image push spec is: host[:port][/namespace]/name:<tag> or svc_name.namespace.svc[:port]/repository/name:<tag>.
The length of the push spec must be between 1 to 447 characters.
|===
=== .spec.machineConfig
Description::
+
--
machineConfig points to the rendered MachineConfig resource to be included in this image build.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| name is the name of the rendered MachineConfig object.
This value should be between 10 and 253 characters, and must contain only lowercase
alphanumeric characters, hyphens and periods, and should start and end with an alphanumeric character.
|===
=== .spec.machineOSConfig
Description::
+
--
machineOSConfig references the MachineOSConfig resource that this image build extends.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| name of the MachineOSConfig.
The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
|===
=== .status
Description::
+
--
status describes the last observed state of this machine os build.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `buildEnd`
| `string`
| buildEnd is the timestamp corresponding to completion of the builder backend.
When omitted the build has either not been started, or is in progress.
It will be populated once the build completes, fails or is interrupted.
| `buildStart`
| `string`
| buildStart is the timestamp corresponding to the build controller initiating the build backend for this MachineOSBuild.
| `builder`
| `object`
| builder describes the image builder backend used for this build.
| `conditions`
| `array`
| conditions are state related conditions for the build. Valid types are:
Prepared, Building, Failed, Interrupted, and Succeeded.
Once a Build is marked as Failed, Interrupted or Succeeded, no future conditions can be set.
| `conditions[]`
| `object`
| Condition contains details for one aspect of the current state of this API Resource.
| `digestedImagePushSpec`
| `string`
| digestedImagePushSpec describes the fully qualified push spec produced by this build.
The format of the push spec is: host[:port][/namespace]/name@sha256:<digest>,
where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9.
The length of the whole spec must be between 1 to 447 characters.
| `relatedObjects`
| `array`
| relatedObjects is a list of references to ephemeral objects such as ConfigMaps or Secrets that are meant to be consumed while the build process runs.
After a successful build or when this MachineOSBuild is deleted, these ephemeral objects will be removed.
In the event of a failed build, the objects will remain until the build is removed to allow for inspection.
| `relatedObjects[]`
| `object`
| ObjectReference contains enough information to let you inspect or modify the referred object.
|===
=== .status.builder
Description::
+
--
builder describes the image builder backend used for this build.
--
Type::
`object`
Required::
- `imageBuilderType`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `imageBuilderType`
| `string`
| imageBuilderType describes the type of image builder used to build this image.
Valid values are Job only.
When set to Job, a pod based builder, using buildah, is launched to build the specified image.
| `job`
| `object`
| job is a reference to the job object that is managing the image build.
This is required if the imageBuilderType is Job, and forbidden otherwise.
|===
=== .status.builder.job
Description::
+
--
job is a reference to the job object that is managing the image build.
This is required if the imageBuilderType is Job, and forbidden otherwise.
--
Type::
`object`
Required::
- `group`
- `name`
- `resource`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `group`
| `string`
| group of the referent.
The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
Example: "", "apps", "build.openshift.io", etc.
| `name`
| `string`
| name of the referent.
The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
| `namespace`
| `string`
| namespace of the referent.
This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens,
and should start and end with an alphanumeric character.
| `resource`
| `string`
| resource of the referent.
This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens,
and should start and end with an alphanumeric character.
Example: "deployments", "deploymentconfigs", "pods", etc.
|===
=== .status.conditions
Description::
+
--
conditions are state related conditions for the build. Valid types are:
Prepared, Building, Failed, Interrupted, and Succeeded.
Once a Build is marked as Failed, Interrupted or Succeeded, no future conditions can be set.
--
Type::
`array`
=== .status.conditions[]
Description::
+
--
Condition contains details for one aspect of the current state of this API Resource.
--
Type::
`object`
Required::
- `lastTransitionTime`
- `message`
- `reason`
- `status`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `lastTransitionTime`
| `string`
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
| `message`
| `string`
| message is a human readable message indicating details about the transition.
This may be an empty string.
| `observedGeneration`
| `integer`
| observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
| `reason`
| `string`
| reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
| `status`
| `string`
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
=== .status.relatedObjects
Description::
+
--
relatedObjects is a list of references to ephemeral objects such as ConfigMaps or Secrets that are meant to be consumed while the build process runs.
After a successful build or when this MachineOSBuild is deleted, these ephemeral objects will be removed.
In the event of a failed build, the objects will remain until the build is removed to allow for inspection.
--
Type::
`array`
=== .status.relatedObjects[]
Description::
+
--
ObjectReference contains enough information to let you inspect or modify the referred object.
--
Type::
`object`
Required::
- `group`
- `name`
- `resource`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `group`
| `string`
| group of the referent.
The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
Example: "", "apps", "build.openshift.io", etc.
| `name`
| `string`
| name of the referent.
The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
| `namespace`
| `string`
| namespace of the referent.
This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens,
and should start and end with an alphanumeric character.
| `resource`
| `string`
| resource of the referent.
This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens,
and should start and end with an alphanumeric character.
Example: "deployments", "deploymentconfigs", "pods", etc.
|===
== API endpoints
The following API endpoints are available:
* `/apis/machineconfiguration.openshift.io/v1/machineosbuilds`
- `DELETE`: delete collection of MachineOSBuild
- `GET`: list objects of kind MachineOSBuild
- `POST`: create a MachineOSBuild
* `/apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}`
- `DELETE`: delete a MachineOSBuild
- `GET`: read the specified MachineOSBuild
- `PATCH`: partially update the specified MachineOSBuild
- `PUT`: replace the specified MachineOSBuild
* `/apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}/status`
- `GET`: read status of the specified MachineOSBuild
- `PATCH`: partially update status of the specified MachineOSBuild
- `PUT`: replace status of the specified MachineOSBuild
=== /apis/machineconfiguration.openshift.io/v1/machineosbuilds
HTTP method::
`DELETE`
Description::
delete collection of MachineOSBuild
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind MachineOSBuild
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-machineconfiguration-v1-MachineOSBuildList[`MachineOSBuildList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a MachineOSBuild
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 201 - Created
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 202 - Accepted
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the MachineOSBuild
|===
HTTP method::
`DELETE`
Description::
delete a MachineOSBuild
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified MachineOSBuild
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified MachineOSBuild
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified MachineOSBuild
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 201 - Created
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the MachineOSBuild
|===
HTTP method::
`GET`
Description::
read status of the specified MachineOSBuild
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified MachineOSBuild
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified MachineOSBuild
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 201 - Created
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[`MachineOSBuild`] schema
| 401 - Unauthorized
| Empty
|===

777
rest_api/machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc Normal file
View File

@@ -0,0 +1,777 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="machineosconfig-machineconfiguration-openshift-io-v1"]
= MachineOSConfig [machineconfiguration.openshift.io/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
MachineOSConfig describes the configuration for a build process managed by the MCO
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| spec describes the configuration of the machineosconfig
| `status`
| `object`
| status describes the status of the machineosconfig
|===
=== .spec
Description::
+
--
spec describes the configuration of the machineosconfig
--
Type::
`object`
Required::
- `imageBuilder`
- `machineConfigPool`
- `renderedImagePushSecret`
- `renderedImagePushSpec`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `baseImagePullSecret`
| `object`
| baseImagePullSecret is the secret used to pull the base image.
Must live in the openshift-machine-config-operator namespace if provided.
Defaults to using the cluster-wide pull secret if not specified. This is provided during install time of the cluster, and lives in the openshift-config namespace as a secret.
| `containerFile`
| `array`
| containerFile describes the custom data the user has specified to build into the image.
This is also commonly called a Dockerfile and you can treat it as such. The content is the content of your Dockerfile.
See https://github.com/containers/common/blob/main/docs/Containerfile.5.md for the spec reference.
This is a list indexed by architecture name (e.g. AMD64), and allows specifying one containerFile per arch, up to 4.
| `containerFile[]`
| `object`
| MachineOSContainerfile contains all custom content the user wants built into the image
| `imageBuilder`
| `object`
| imageBuilder describes which image builder will be used in each build triggered by this MachineOSConfig.
Currently supported type(s): Job
| `machineConfigPool`
| `object`
| machineConfigPool is the pool which the build is for.
The Machine Config Operator will perform the build and roll out the built image to the specified pool.
| `renderedImagePushSecret`
| `object`
| renderedImagePushSecret is the secret used to connect to a user registry.
The final image push and pull secrets should be separate and assume the principal of least privilege.
The push secret with write privilege is only required to be present on the node hosting the MachineConfigController pod.
The pull secret with read only privileges is required on all nodes.
By separating the two secrets, the risk of write credentials becoming compromised is reduced.
| `renderedImagePushSpec`
| `string`
| renderedImagePushSpec describes the location of the final image.
The MachineOSConfig object will use the in cluster image registry configuration.
If you wish to use a mirror or any other settings specific to registries.conf, please specify those in the cluster wide registries.conf via the cluster image.config, ImageContentSourcePolicies, ImageDigestMirrorSet, or ImageTagMirrorSet objects.
The format of the image push spec is: host[:port][/namespace]/name:<tag> or svc_name.namespace.svc[:port]/repository/name:<tag>.
The length of the push spec must be between 1 to 447 characters.
|===
=== .spec.baseImagePullSecret
Description::
+
--
baseImagePullSecret is the secret used to pull the base image.
Must live in the openshift-machine-config-operator namespace if provided.
Defaults to using the cluster-wide pull secret if not specified. This is provided during install time of the cluster, and lives in the openshift-config namespace as a secret.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| name is the name of the secret used to push or pull this MachineOSConfig object.
Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
This secret must be in the openshift-machine-config-operator namespace.
|===
=== .spec.containerFile
Description::
+
--
containerFile describes the custom data the user has specified to build into the image.
This is also commonly called a Dockerfile and you can treat it as such. The content is the content of your Dockerfile.
See https://github.com/containers/common/blob/main/docs/Containerfile.5.md for the spec reference.
This is a list indexed by architecture name (e.g. AMD64), and allows specifying one containerFile per arch, up to 4.
--
Type::
`array`
=== .spec.containerFile[]
Description::
+
--
MachineOSContainerfile contains all custom content the user wants built into the image
--
Type::
`object`
Required::
- `content`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `containerfileArch`
| `string`
| containerfileArch describes the architecture this containerfile is to be built for.
This arch is optional. If the user does not specify an architecture, it is assumed
that the content can be applied to all architectures, or in a single arch cluster: the only architecture.
| `content`
| `string`
| content is an embedded Containerfile/Dockerfile that defines the contents to be built into your image.
See https://github.com/containers/common/blob/main/docs/Containerfile.5.md for the spec reference.
for example, this would add the tree package to your hosts:
FROM configs AS final
RUN rpm-ostree install tree && \
ostree container commit
This is a required field and can have a maximum length of **4096** characters.
|===
=== .spec.imageBuilder
Description::
+
--
imageBuilder describes which image builder will be used in each build triggered by this MachineOSConfig.
Currently supported type(s): Job
--
Type::
`object`
Required::
- `imageBuilderType`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `imageBuilderType`
| `string`
| imageBuilderType specifies the backend to be used to build the image.
Valid options are: Job
|===
=== .spec.machineConfigPool
Description::
+
--
machineConfigPool is the pool which the build is for.
The Machine Config Operator will perform the build and roll out the built image to the specified pool.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| name of the MachineConfigPool object.
This value should be at most 253 characters, and must contain only lowercase
alphanumeric characters, hyphens and periods, and should start and end with an alphanumeric character.
|===
=== .spec.renderedImagePushSecret
Description::
+
--
renderedImagePushSecret is the secret used to connect to a user registry.
The final image push and pull secrets should be separate and assume the principal of least privilege.
The push secret with write privilege is only required to be present on the node hosting the MachineConfigController pod.
The pull secret with read only privileges is required on all nodes.
By separating the two secrets, the risk of write credentials becoming compromised is reduced.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| name is the name of the secret used to push or pull this MachineOSConfig object.
Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
This secret must be in the openshift-machine-config-operator namespace.
|===
=== .status
Description::
+
--
status describes the status of the machineosconfig
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `conditions`
| `array`
| conditions are state related conditions for the object.
| `conditions[]`
| `object`
| Condition contains details for one aspect of the current state of this API Resource.
| `currentImagePullSpec`
| `string`
| currentImagePullSpec is the fully qualified image pull spec used by the MCO to pull down the new OSImage. This includes the sha256 image digest.
This is generated when the Machine Config Operator's build controller successfully completes the build, and is populated from the corresponding
MachineOSBuild object's FinalImagePushSpec. This may change after completion in reaction to spec changes that would cause a new image build,
but will not be removed.
The format of the image pull spec is: host[:port][/namespace]/name@sha256:<digest>,
where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9.
The length of the whole spec must be between 1 to 447 characters.
| `machineOSBuild`
| `object`
| machineOSBuild is a reference to the MachineOSBuild object for this MachineOSConfig, which contains the status for the image build.
| `observedGeneration`
| `integer`
| observedGeneration represents the generation of the MachineOSConfig object observed by the Machine Config Operator's build controller.
|===
=== .status.conditions
Description::
+
--
conditions are state related conditions for the object.
--
Type::
`array`
=== .status.conditions[]
Description::
+
--
Condition contains details for one aspect of the current state of this API Resource.
--
Type::
`object`
Required::
- `lastTransitionTime`
- `message`
- `reason`
- `status`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `lastTransitionTime`
| `string`
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
| `message`
| `string`
| message is a human readable message indicating details about the transition.
This may be an empty string.
| `observedGeneration`
| `integer`
| observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
| `reason`
| `string`
| reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
| `status`
| `string`
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
=== .status.machineOSBuild
Description::
+
--
machineOSBuild is a reference to the MachineOSBuild object for this MachineOSConfig, which contains the status for the image build.
--
Type::
`object`
Required::
- `group`
- `name`
- `resource`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `group`
| `string`
| group of the referent.
The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
Example: "", "apps", "build.openshift.io", etc.
| `name`
| `string`
| name of the referent.
The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
| `namespace`
| `string`
| namespace of the referent.
This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens,
and should start and end with an alphanumeric character.
| `resource`
| `string`
| resource of the referent.
This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens,
and should start and end with an alphanumeric character.
Example: "deployments", "deploymentconfigs", "pods", etc.
|===
== API endpoints
The following API endpoints are available:
* `/apis/machineconfiguration.openshift.io/v1/machineosconfigs`
- `DELETE`: delete collection of MachineOSConfig
- `GET`: list objects of kind MachineOSConfig
- `POST`: create a MachineOSConfig
* `/apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name}`
- `DELETE`: delete a MachineOSConfig
- `GET`: read the specified MachineOSConfig
- `PATCH`: partially update the specified MachineOSConfig
- `PUT`: replace the specified MachineOSConfig
* `/apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name}/status`
- `GET`: read status of the specified MachineOSConfig
- `PATCH`: partially update status of the specified MachineOSConfig
- `PUT`: replace status of the specified MachineOSConfig
=== /apis/machineconfiguration.openshift.io/v1/machineosconfigs
HTTP method::
`DELETE`
Description::
delete collection of MachineOSConfig
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind MachineOSConfig
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-machineconfiguration-v1-MachineOSConfigList[`MachineOSConfigList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a MachineOSConfig
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 201 - Created
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 202 - Accepted
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the MachineOSConfig
|===
HTTP method::
`DELETE`
Description::
delete a MachineOSConfig
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified MachineOSConfig
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified MachineOSConfig
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified MachineOSConfig
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 201 - Created
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/machineconfiguration.openshift.io/v1/machineosconfigs/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the MachineOSConfig
|===
HTTP method::
`GET`
Description::
read status of the specified MachineOSConfig
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified MachineOSConfig
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified MachineOSConfig
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 201 - Created
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[`MachineOSConfig`] schema
| 401 - Unauthorized
| Empty
|===

72
rest_api/machine_apis/machineset-machine-openshift-io-v1beta1.adoc
View File

@@ -66,30 +66,30 @@ Type::
| `deletePolicy`
| `string`
| DeletePolicy defines the policy used to identify nodes to delete when downscaling.
| 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.
| 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.
| 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.
| 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
| template is the object that describes the machine that will be created if
insufficient replicas are detected.
|===
@@ -97,7 +97,7 @@ insufficient replicas are detected.
Description::
+
--
Selector is a label query over machines that should match the replica count.
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
@@ -184,7 +184,7 @@ merge patch.
Description::
+
--
Template is the object that describes the machine that will be created if
template is the object that describes the machine that will be created if
insufficient replicas are detected.
--
@@ -229,14 +229,14 @@ Type::
| `annotations`
| `object (string)`
| Annotations is an unstructured key value map stored with a resource that may be
| 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
| 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.
@@ -261,7 +261,7 @@ More info: http://kubernetes.io/docs/user-guide/labels
| `name`
| `string`
| Name must be unique within a namespace. Is required when creating resources, although
| 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.
@@ -270,7 +270,7 @@ 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
| 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.
@@ -388,7 +388,7 @@ Type::
| `lifecycleHooks`
| `object`
| LifecycleHooks allow users to pause operations on the machine at
| lifecycleHooks allow users to pause operations on the machine at
certain predefined points within the machine lifecycle.
| `metadata`
@@ -399,7 +399,7 @@ when creating the Node.
| `providerID`
| `string`
| ProviderID is the identification ID of the machine provided by the provider.
| 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
@@ -412,7 +412,7 @@ be interfacing with cluster-api as generic provider.
| `providerSpec`
| `object`
| ProviderSpec details Provider-specific configuration to use during node creation.
| providerSpec details Provider-specific configuration to use during node creation.
| `taints`
| `array`
@@ -433,7 +433,7 @@ any pod that does not tolerate the Taint.
Description::
+
--
LifecycleHooks allow users to pause operations on the machine at
lifecycleHooks allow users to pause operations on the machine at
certain predefined points within the machine lifecycle.
--
@@ -449,7 +449,7 @@ Type::
| `preDrain`
| `array`
| PreDrain hooks prevent the machine from being drained.
| preDrain hooks prevent the machine from being drained.
This also blocks further lifecycle events, such as termination.
| `preDrain[]`
@@ -458,7 +458,7 @@ This also blocks further lifecycle events, such as termination.
| `preTerminate`
| `array`
| PreTerminate hooks prevent the machine from being terminated.
| preTerminate hooks prevent the machine from being terminated.
PreTerminate hooks be actioned after the Machine has been drained.
| `preTerminate[]`
@@ -470,7 +470,7 @@ PreTerminate hooks be actioned after the Machine has been drained.
Description::
+
--
PreDrain hooks prevent the machine from being drained.
preDrain hooks prevent the machine from being drained.
This also blocks further lifecycle events, such as termination.
--
@@ -502,14 +502,14 @@ Required::
| `name`
| `string`
| Name defines a unique name for the lifcycle hook.
| name defines a unique name for the lifcycle hook.
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
it may be namespaced, eg. foo.example.com/CamelCase.
Names must be unique and should only be managed by a single entity.
| `owner`
| `string`
| Owner defines the owner of the lifecycle hook.
| owner defines the owner of the lifecycle hook.
This should be descriptive enough so that users can identify
who/what is responsible for blocking the lifecycle.
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -520,7 +520,7 @@ or an administrator managing the hook.
Description::
+
--
PreTerminate hooks prevent the machine from being terminated.
preTerminate hooks prevent the machine from being terminated.
PreTerminate hooks be actioned after the Machine has been drained.
--
@@ -552,14 +552,14 @@ Required::
| `name`
| `string`
| Name defines a unique name for the lifcycle hook.
| name defines a unique name for the lifcycle hook.
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
it may be namespaced, eg. foo.example.com/CamelCase.
Names must be unique and should only be managed by a single entity.
| `owner`
| `string`
| Owner defines the owner of the lifecycle hook.
| owner defines the owner of the lifecycle hook.
This should be descriptive enough so that users can identify
who/what is responsible for blocking the lifecycle.
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -587,14 +587,14 @@ Type::
| `annotations`
| `object (string)`
| Annotations is an unstructured key value map stored with a resource that may be
| 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
| 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.
@@ -619,7 +619,7 @@ More info: http://kubernetes.io/docs/user-guide/labels
| `name`
| `string`
| Name must be unique within a namespace. Is required when creating resources, although
| 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.
@@ -628,7 +628,7 @@ 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
| 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.
@@ -730,7 +730,7 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
Description::
+
--
ProviderSpec details Provider-specific configuration to use during node creation.
providerSpec details Provider-specific configuration to use during node creation.
--
Type::
@@ -745,7 +745,7 @@ Type::
| `value`
| ``
| Value is an inlined, serialized representation of the resource
| 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.
@@ -833,7 +833,7 @@ Type::
| `conditions`
| `array`
| Conditions defines the current state of the MachineSet
| conditions defines the current state of the MachineSet
| `conditions[]`
| `object`
@@ -870,7 +870,7 @@ controller's output.
| `observedGeneration`
| `integer`
| ObservedGeneration reflects the generation of the most recently observed MachineSet.
| observedGeneration reflects the generation of the most recently observed MachineSet.
| `readyReplicas`
| `integer`
@@ -878,14 +878,14 @@ controller's output.
| `replicas`
| `integer`
| Replicas is the most recently observed number of replicas.
| replicas is the most recently observed number of replicas.
|===
=== .status.conditions
Description::
+
--
Conditions defines the current state of the MachineSet
conditions defines the current state of the MachineSet
--
Type::
@@ -934,17 +934,17 @@ This field may not be empty.
| `severity`
| `string`
| Severity provides an explicit classification of Reason code, so the users or machines can immediately
| severity provides an explicit classification of Reason code, so the users or machines can immediately
understand the current situation and act accordingly.
The Severity field MUST be set only when Status=False.
| `status`
| `string`
| Status of the condition, one of True, False, Unknown.
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| Type of condition in CamelCase or in foo.example.com/CamelCase.
| type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability to deconflict is important.

2
rest_api/metadata_apis/binding-v1.adoc
View File

@@ -11,7 +11,7 @@ toc::[]
Description::
+
--
Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
Binding ties one object to another; for example, a pod is bound to a node by a scheduler.
--
Type::

2
rest_api/metadata_apis/metadata-apis-index.adoc
View File

@@ -24,7 +24,7 @@ Type::
Description::
+
--
Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
Binding ties one object to another; for example, a pod is bound to a node by a scheduler.
--
Type::

6
rest_api/metadata_apis/namespace-v1.adoc
View File

@@ -137,15 +137,15 @@ Required::
| `lastTransitionTime`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Time[`Time`]
|
| Last time the condition transitioned from one status to another.
| `message`
| `string`
|
| Human-readable message indicating details about last transition.
| `reason`
| `string`
|
| Unique, one-word, CamelCase reason for the condition's last transition.
| `status`
| `string`

1099
rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc
View File

File diff suppressed because it is too large Load Diff

77
rest_api/monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1beta1.adoc
View File

@@ -575,6 +575,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -2315,6 +2321,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -3719,6 +3731,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -5122,6 +5140,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -6577,6 +6601,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -8162,6 +8192,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -9434,6 +9470,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -10742,6 +10784,11 @@ It requires Alertmanager >= v0.26.0.
| `string`
| Message template
| `messageThreadID`
| `integer`
| The Telegram Group Topic ID.
It requires Alertmanager >= 0.26.0.
| `parseMode`
| `string`
| Parse mode for telegram message
@@ -10855,6 +10902,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -12202,6 +12255,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -13454,6 +13513,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -14707,6 +14772,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.
@@ -16045,6 +16116,12 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyURL`
| `string`
| Optional proxy URL.
If defined, this field takes precedence over `proxyUrl`.
| `proxyUrl`
| `string`
| `proxyURL` defines the HTTP proxy server to use.

38
rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc
View File

@@ -84,6 +84,12 @@ of uncompressed response body that will be accepted by Prometheus.
It requires Prometheus >= v2.28.0.
| `fallbackScrapeProtocol`
| `string`
| The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
It requires Prometheus >= v3.0.0.
| `jobLabel`
| `string`
| The label to use to retrieve the job name from.
@@ -180,6 +186,15 @@ It requires Prometheus >= v2.49.0.
| `object`
| Label selector to select the Kubernetes `Pod` objects to scrape metrics from.
| `selectorMechanism`
| `string`
| Mechanism used to select the endpoints to scrape.
By default, the selection process relies on relabel configurations to filter the discovered targets.
Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters.
Which strategy is best for your use case needs to be carefully evaluated.
It requires Prometheus >= v2.17.0.
| `targetLimit`
| `integer`
| `targetLimit` defines a limit on the number of scraped targets that will
@@ -356,7 +371,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.
| `params{}`
| `array (string)`
|
|
| `path`
| `string`
@@ -366,9 +381,13 @@ If empty, Prometheus uses the default value (e.g. `/metrics`).
| `port`
| `string`
| Name of the Pod port which this endpoint refers to.
| The `Pod` port name which exposes the endpoint.
It takes precedence over `targetPort`.
It takes precedence over the `portNumber` and `targetPort` fields.
| `portNumber`
| `integer`
| The `Pod` port number which exposes the endpoint.
| `proxyUrl`
| `string`
@@ -382,7 +401,7 @@ metadata labels.
The Operator automatically adds relabelings for a few standard Kubernetes fields.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
@@ -408,13 +427,14 @@ If empty, Prometheus uses the default value `http`.
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
| `targetPort`
| `integer-or-string`
| Name or number of the target port of the `Pod` object behind the Service, the
port must be specified with container port property.
Deprecated: use 'port' instead.
Deprecated: use 'port' or 'portNumber' instead.
| `tlsConfig`
| `object`
@@ -780,7 +800,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -1316,7 +1336,7 @@ metadata labels.
The Operator automatically adds relabelings for a few standard Kubernetes fields.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
--
@@ -1866,7 +1886,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema
|
|
|===
.HTTP responses
@@ -1999,7 +2019,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema
|
|
|===
.HTTP responses

21
rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc
View File

@@ -82,6 +82,12 @@ More info: https://prometheus.io/docs/operating/configuration/#endpoint
needs to be in the same namespace as the probe and accessible by
the Prometheus Operator.
| `fallbackScrapeProtocol`
| `string`
| The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
It requires Prometheus >= v3.0.0.
| `interval`
| `string`
| Interval at which targets are probed using the configured prober.
@@ -177,6 +183,7 @@ It requires Prometheus >= v2.49.0.
| `string`
| Timeout for scraping metrics from the Prometheus exporter.
If not specified, the Prometheus global scrape timeout is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
| `targetLimit`
| `integer`
@@ -530,7 +537,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -1143,9 +1150,9 @@ Type::
| RelabelConfigs to apply to the label set of the target before it gets
scraped.
The original ingress address is available via the
`\__tmp_prometheus_ingress_address` label. It can be used to customize the
`__tmp_prometheus_ingress_address` label. It can be used to customize the
probed URL.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
| `relabelingConfigs[]`
@@ -1194,9 +1201,9 @@ Description::
RelabelConfigs to apply to the label set of the target before it gets
scraped.
The original ingress address is available via the
`\__tmp_prometheus_ingress_address` label. It can be used to customize the
`__tmp_prometheus_ingress_address` label. It can be used to customize the
probed URL.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
--
@@ -1868,7 +1875,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema
|
|
|===
.HTTP responses
@@ -2001,7 +2008,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema
|
|
|===
.HTTP responses

723
rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc
View File

File diff suppressed because it is too large Load Diff

8
rest_api/monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc
View File

@@ -108,6 +108,14 @@ Required::
| `string`
| Interval determines how often rules in the group are evaluated.
| `labels`
| `object (string)`
| Labels to add or overwrite before storing the result for its rules.
The labels defined at the rule level take precedence.
It requires Prometheus >= 3.0.0.
The field is ignored for Thanos Ruler.
| `limit`
| `integer`
| Limit the number of alerts an alerting rule and series a recording

28
rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc
View File

@@ -98,6 +98,12 @@ In most cases, an Endpoints object is backed by a Kubernetes [Service](https://k
| Endpoint defines an endpoint serving Prometheus metrics to be scraped by
Prometheus.
| `fallbackScrapeProtocol`
| `string`
| The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
It requires Prometheus >= v3.0.0.
| `jobLabel`
| `string`
| `jobLabel` selects the label from the associated Kubernetes `Service`
@@ -185,6 +191,15 @@ It requires Prometheus >= v2.49.0.
| `object`
| Label selector to select the Kubernetes `Endpoints` objects to scrape metrics from.
| `selectorMechanism`
| `string`
| Mechanism used to select the endpoints to scrape.
By default, the selection process relies on relabel configurations to filter the discovered targets.
Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters.
Which strategy is best for your use case needs to be carefully evaluated.
It requires Prometheus >= v2.17.0.
| `targetLabels`
| `array (string)`
| `targetLabels` defines the labels which are transferred from the
@@ -346,7 +361,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.
| `params{}`
| `array (string)`
|
|
| `path`
| `string`
@@ -372,7 +387,7 @@ metadata labels.
The Operator automatically adds relabelings for a few standard Kubernetes fields.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
@@ -398,6 +413,7 @@ If empty, Prometheus uses the default value `http`.
If empty, Prometheus uses the global scrape timeout unless it is less
than the target's scrape interval value in which the latter is used.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
| `targetPort`
| `integer-or-string`
@@ -768,7 +784,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -1304,7 +1320,7 @@ metadata labels.
The Operator automatically adds relabelings for a few standard Kubernetes fields.
The original scrape job's name is available via the `\__tmp_prometheus_job_name` label.
The original scrape job's name is available via the `__tmp_prometheus_job_name` label.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
--
@@ -1894,7 +1910,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema
|
|
|===
.HTTP responses
@@ -2027,7 +2043,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema
|
|
|===
.HTTP responses

563
rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc
View File

File diff suppressed because it is too large Load Diff

1037
rest_api/network_apis/clusteruserdefinednetwork-k8s-ovn-org-v1.adoc Normal file
View File

File diff suppressed because it is too large Load Diff

28
rest_api/network_apis/egressrouter-network-operator-openshift-io-v1.adoc
View File

@@ -92,7 +92,7 @@ Required::
| `mode`
| `string`
| Mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently.
| mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently.
| `networkInterface`
| `object`
@@ -101,7 +101,7 @@ Currently only macvlan is supported.
| `redirect`
| `object`
| Redirect represents the configuration parameters specific to redirect mode.
| redirect represents the configuration parameters specific to redirect mode.
|===
=== .spec.addresses
@@ -142,7 +142,7 @@ Required::
| `ip`
| `string`
| IP is the address to configure on the router's interface. Can be IPv4 or IPv6.
| ip is the address to configure on the router's interface. Can be IPv4 or IPv6.
|===
=== .spec.networkInterface
@@ -193,14 +193,14 @@ Required::
| `mode`
| `string`
| Mode depicts the mode that is used for the macvlan interface; one of Bridge\|Private\|VEPA\|Passthru. The default mode is "Bridge".
| mode depicts the mode that is used for the macvlan interface; one of Bridge\|Private\|VEPA\|Passthru. The default mode is "Bridge".
|===
=== .spec.redirect
Description::
+
--
Redirect represents the configuration parameters specific to redirect mode.
redirect represents the configuration parameters specific to redirect mode.
--
Type::
@@ -215,7 +215,7 @@ Type::
| `fallbackIP`
| `string`
| FallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6.
| fallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6.
If no redirect rules are specified, all traffic from the router are redirected to this IP.
If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP.
If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected.
@@ -269,15 +269,15 @@ Required::
| `port`
| `integer`
| Port is the port number to which clients should send traffic to be redirected.
| port is the port number to which clients should send traffic to be redirected.
| `protocol`
| `string`
| Protocol can be TCP, SCTP or UDP.
| protocol can be TCP, SCTP or UDP.
| `targetPort`
| `integer`
| TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to.
| targetPort allows specifying the port number on the remote destination to which the traffic gets redirected to.
If unspecified, the value from "Port" is used.
|===
@@ -346,25 +346,25 @@ Required::
| `lastTransitionTime`
| ``
| LastTransitionTime is the time of the last update to the current status property.
| lastTransitionTime is the time of the last update to the current status property.
| `message`
| `string`
| Message provides additional information about the current condition.
| message provides additional information about the current condition.
This is only to be consumed by humans. It may contain Line Feed
characters (U+000A), which should be rendered as new lines.
| `reason`
| `string`
| Reason is the CamelCase reason for the condition's current status.
| reason is the CamelCase reason for the condition's current status.
| `status`
| `string`
| Status of the condition, one of True, False, Unknown.
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| Type specifies the aspect reported by this condition; one of Available, Progressing, Degraded
| type specifies the aspect reported by this condition; one of Available, Progressing, Degraded
|===

49
rest_api/network_apis/egressservice-k8s-ovn-org-v1.adoc
View File

@@ -11,7 +11,12 @@ toc::[]
Description::
+
--
EgressService is a CRD that allows the user to request that the source IP of egress packets originating from all of the pods that are endpoints of the corresponding LoadBalancer Service would be its ingress IP. In addition, it allows the user to request that egress packets originating from all of the pods that are endpoints of the LoadBalancer service would use a different network than the main one.
EgressService is a CRD that allows the user to request that the source
IP of egress packets originating from all of the pods that are endpoints
of the corresponding LoadBalancer Service would be its ingress IP.
In addition, it allows the user to request that egress packets originating from
all of the pods that are endpoints of the LoadBalancer service would use a different
network than the main one.
--
Type::
@@ -65,22 +70,35 @@ Type::
| `network`
| `string`
| The network which this service should send egress and corresponding ingress replies to. This is typically implemented as VRF mapping, representing a numeric id or string name of a routing table which by omission uses the default host routing.
| The network which this service should send egress and corresponding ingress replies to.
This is typically implemented as VRF mapping, representing a numeric id or string name
of a routing table which by omission uses the default host routing.
| `nodeSelector`
| `object`
| Allows limiting the nodes that can be selected to handle the service's traffic when sourceIPBy=LoadBalancerIP. When present only a node whose labels match the specified selectors can be selected for handling the service's traffic. When it is not specified any node in the cluster can be chosen to manage the service's traffic.
| Allows limiting the nodes that can be selected to handle the service's traffic when sourceIPBy=LoadBalancerIP.
When present only a node whose labels match the specified selectors can be selected
for handling the service's traffic.
When it is not specified any node in the cluster can be chosen to manage the service's traffic.
| `sourceIPBy`
| `string`
| Determines the source IP of egress traffic originating from the pods backing the LoadBalancer Service. When `LoadBalancerIP` the source IP is set to its LoadBalancer ingress IP. When `Network` the source IP is set according to the interface of the Network, leveraging the masquerade rules that are already in place. Typically these rules specify SNAT to the IP of the outgoing interface, which means the packet will typically leave with the IP of the node.
| Determines the source IP of egress traffic originating from the pods backing the LoadBalancer Service.
When `LoadBalancerIP` the source IP is set to its LoadBalancer ingress IP.
When `Network` the source IP is set according to the interface of the Network,
leveraging the masquerade rules that are already in place.
Typically these rules specify SNAT to the IP of the outgoing interface,
which means the packet will typically leave with the IP of the node.
|===
=== .spec.nodeSelector
Description::
+
--
Allows limiting the nodes that can be selected to handle the service's traffic when sourceIPBy=LoadBalancerIP. When present only a node whose labels match the specified selectors can be selected for handling the service's traffic. When it is not specified any node in the cluster can be chosen to manage the service's traffic.
Allows limiting the nodes that can be selected to handle the service's traffic when sourceIPBy=LoadBalancerIP.
When present only a node whose labels match the specified selectors can be selected
for handling the service's traffic.
When it is not specified any node in the cluster can be chosen to manage the service's traffic.
--
Type::
@@ -99,11 +117,14 @@ Type::
| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
| 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.
| 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.nodeSelector.matchExpressions
@@ -123,7 +144,8 @@ Type::
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--
Type::
@@ -145,11 +167,15 @@ Required::
| `operator`
| `string`
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
| 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.
| 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.
|===
=== .status
@@ -173,7 +199,8 @@ Required::
| `host`
| `string`
| The name of the node selected to handle the service's traffic. In case sourceIPBy=Network the field will be set to "ALL".
| The name of the node selected to handle the service's traffic.
In case sourceIPBy=Network the field will be set to "ALL".
|===

1950
rest_api/network_apis/gateway-gateway-networking-k8s-io-v1.adoc Normal file
View File

File diff suppressed because it is too large Load Diff

626
rest_api/network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc Normal file
View File

@@ -0,0 +1,626 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="gatewayclass-gateway-networking-k8s-io-v1"]
= GatewayClass [gateway.networking.k8s.io/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
GatewayClass describes a class of Gateways available to the user for creating
Gateway resources.
It is recommended that this resource be used as a template for Gateways. This
means that a Gateway is based on the state of the GatewayClass at the time it
was created and changes to the GatewayClass or associated parameters are not
propagated down to existing Gateways. This recommendation is intended to
limit the blast radius of changes to GatewayClass or associated parameters.
If implementations choose to propagate GatewayClass changes to existing
Gateways, that MUST be clearly documented by the implementation.
Whenever one or more Gateways are using a GatewayClass, implementations SHOULD
add the `gateway-exists-finalizer.gateway.networking.k8s.io` finalizer on the
associated GatewayClass. This ensures that a GatewayClass associated with a
Gateway is not deleted while in use.
GatewayClass is a Cluster level resource.
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| Spec defines the desired state of GatewayClass.
| `status`
| `object`
| Status defines the current state of GatewayClass.
Implementations MUST populate status on all GatewayClass resources which
specify their controller name.
|===
=== .spec
Description::
+
--
Spec defines the desired state of GatewayClass.
--
Type::
`object`
Required::
- `controllerName`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `controllerName`
| `string`
| ControllerName is the name of the controller that is managing Gateways of
this class. The value of this field MUST be a domain prefixed path.
Example: "example.net/gateway-controller".
This field is not mutable and cannot be empty.
Support: Core
| `description`
| `string`
| Description helps describe a GatewayClass with more details.
| `parametersRef`
| `object`
| ParametersRef is a reference to a resource that contains the configuration
parameters corresponding to the GatewayClass. This is optional if the
controller does not require any additional configuration.
ParametersRef can reference a standard Kubernetes resource, i.e. ConfigMap,
or an implementation-specific custom resource. The resource can be
cluster-scoped or namespace-scoped.
If the referent cannot be found, refers to an unsupported kind, or when
the data within that resource is malformed, the GatewayClass SHOULD be
rejected with the "Accepted" status condition set to "False" and an
"InvalidParameters" reason.
A Gateway for this GatewayClass may provide its own `parametersRef`. When both are specified,
the merging behavior is implementation specific.
It is generally recommended that GatewayClass provides defaults that can be overridden by a Gateway.
Support: Implementation-specific
|===
=== .spec.parametersRef
Description::
+
--
ParametersRef is a reference to a resource that contains the configuration
parameters corresponding to the GatewayClass. This is optional if the
controller does not require any additional configuration.
ParametersRef can reference a standard Kubernetes resource, i.e. ConfigMap,
or an implementation-specific custom resource. The resource can be
cluster-scoped or namespace-scoped.
If the referent cannot be found, refers to an unsupported kind, or when
the data within that resource is malformed, the GatewayClass SHOULD be
rejected with the "Accepted" status condition set to "False" and an
"InvalidParameters" reason.
A Gateway for this GatewayClass may provide its own `parametersRef`. When both are specified,
the merging behavior is implementation specific.
It is generally recommended that GatewayClass provides defaults that can be overridden by a Gateway.
Support: Implementation-specific
--
Type::
`object`
Required::
- `group`
- `kind`
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `group`
| `string`
| Group is the group of the referent.
| `kind`
| `string`
| Kind is kind of the referent.
| `name`
| `string`
| Name is the name of the referent.
| `namespace`
| `string`
| Namespace is the namespace of the referent.
This field is required when referring to a Namespace-scoped resource and
MUST be unset when referring to a Cluster-scoped resource.
|===
=== .status
Description::
+
--
Status defines the current state of GatewayClass.
Implementations MUST populate status on all GatewayClass resources which
specify their controller name.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `conditions`
| `array`
| Conditions is the current status from the controller for
this GatewayClass.
Controllers should prefer to publish conditions using values
of GatewayClassConditionType for the type of each Condition.
| `conditions[]`
| `object`
| Condition contains details for one aspect of the current state of this API Resource.
|===
=== .status.conditions
Description::
+
--
Conditions is the current status from the controller for
this GatewayClass.
Controllers should prefer to publish conditions using values
of GatewayClassConditionType for the type of each Condition.
--
Type::
`array`
=== .status.conditions[]
Description::
+
--
Condition contains details for one aspect of the current state of this API Resource.
--
Type::
`object`
Required::
- `lastTransitionTime`
- `message`
- `reason`
- `status`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `lastTransitionTime`
| `string`
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
| `message`
| `string`
| message is a human readable message indicating details about the transition.
This may be an empty string.
| `observedGeneration`
| `integer`
| observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
| `reason`
| `string`
| reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
| `status`
| `string`
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
== API endpoints
The following API endpoints are available:
* `/apis/gateway.networking.k8s.io/v1/gatewayclasses`
- `DELETE`: delete collection of GatewayClass
- `GET`: list objects of kind GatewayClass
- `POST`: create a GatewayClass
* `/apis/gateway.networking.k8s.io/v1/gatewayclasses/{name}`
- `DELETE`: delete a GatewayClass
- `GET`: read the specified GatewayClass
- `PATCH`: partially update the specified GatewayClass
- `PUT`: replace the specified GatewayClass
* `/apis/gateway.networking.k8s.io/v1/gatewayclasses/{name}/status`
- `GET`: read status of the specified GatewayClass
- `PATCH`: partially update status of the specified GatewayClass
- `PUT`: replace status of the specified GatewayClass
=== /apis/gateway.networking.k8s.io/v1/gatewayclasses
HTTP method::
`DELETE`
Description::
delete collection of GatewayClass
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind GatewayClass
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-networking-gateway-v1-GatewayClassList[`GatewayClassList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a GatewayClass
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 201 - Created
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 202 - Accepted
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/gateway.networking.k8s.io/v1/gatewayclasses/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the GatewayClass
|===
HTTP method::
`DELETE`
Description::
delete a GatewayClass
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified GatewayClass
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified GatewayClass
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified GatewayClass
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 201 - Created
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/gateway.networking.k8s.io/v1/gatewayclasses/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the GatewayClass
|===
HTTP method::
`GET`
Description::
read status of the specified GatewayClass
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified GatewayClass
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified GatewayClass
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 201 - Created
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[`GatewayClass`] schema
| 401 - Unauthorized
| Empty
|===

3191
rest_api/network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc Normal file
View File

File diff suppressed because it is too large Load Diff

3928
rest_api/network_apis/httproute-gateway-networking-k8s-io-v1.adoc Normal file
View File

File diff suppressed because it is too large Load Diff

463
rest_api/network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc Normal file
View File

@@ -0,0 +1,463 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="ipamclaim-k8s-cni-cncf-io-v1alpha1"]
= IPAMClaim [k8s.cni.cncf.io/v1alpha1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
IPAMClaim is the Schema for the IPAMClaim API
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| 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`
Required::
- `interface`
- `network`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `interface`
| `string`
| The pod interface name for which this allocation was created
| `network`
| `string`
| The network name for which this persistent allocation was created
|===
=== .status
Description::
+
--
--
Type::
`object`
Required::
- `ips`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `ips`
| `array (string)`
| The list of IP addresses (v4, v6) that were allocated for the pod interface
|===
== API endpoints
The following API endpoints are available:
* `/apis/k8s.cni.cncf.io/v1alpha1/ipamclaims`
- `GET`: list objects of kind IPAMClaim
* `/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims`
- `DELETE`: delete collection of IPAMClaim
- `GET`: list objects of kind IPAMClaim
- `POST`: create an IPAMClaim
* `/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}`
- `DELETE`: delete an IPAMClaim
- `GET`: read the specified IPAMClaim
- `PATCH`: partially update the specified IPAMClaim
- `PUT`: replace the specified IPAMClaim
* `/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}/status`
- `GET`: read status of the specified IPAMClaim
- `PATCH`: partially update status of the specified IPAMClaim
- `PUT`: replace status of the specified IPAMClaim
=== /apis/k8s.cni.cncf.io/v1alpha1/ipamclaims
HTTP method::
`GET`
Description::
list objects of kind IPAMClaim
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-cncf-cni-k8s-v1alpha1-IPAMClaimList[`IPAMClaimList`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims
HTTP method::
`DELETE`
Description::
delete collection of IPAMClaim
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind IPAMClaim
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-cncf-cni-k8s-v1alpha1-IPAMClaimList[`IPAMClaimList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create an IPAMClaim
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 201 - Created
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 202 - Accepted
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the IPAMClaim
|===
HTTP method::
`DELETE`
Description::
delete an IPAMClaim
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified IPAMClaim
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified IPAMClaim
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified IPAMClaim
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 201 - Created
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the IPAMClaim
|===
HTTP method::
`GET`
Description::
read status of the specified IPAMClaim
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified IPAMClaim
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified IPAMClaim
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 201 - Created
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[`IPAMClaim`] schema
| 401 - Unauthorized
| Empty
|===

8
rest_api/network_apis/multinetworkpolicy-k8s-cni-cncf-io-v1beta1.adoc
View File

@@ -164,6 +164,10 @@ Type::
|===
| Property | Type | Description
| `endPort`
| `integer`
| If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.
| `port`
| `integer-or-string`
| The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers.
@@ -704,6 +708,10 @@ Type::
|===
| Property | Type | Description
| `endPort`
| `integer`
| If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.
| `port`
| `integer-or-string`
| The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers.

167
rest_api/network_apis/network-apis-index.adoc
View File

@@ -7,6 +7,17 @@
toc::[]
== ClusterUserDefinedNetwork [k8s.ovn.org/v1]
Description::
+
--
ClusterUserDefinedNetwork describe network request for a shared network across namespaces.
--
Type::
`object`
== AdminNetworkPolicy [policy.networking.k8s.io/v1alpha1]
Description::
@@ -110,7 +121,12 @@ Type::
Description::
+
--
EgressService is a CRD that allows the user to request that the source IP of egress packets originating from all of the pods that are endpoints of the corresponding LoadBalancer Service would be its ingress IP. In addition, it allows the user to request that egress packets originating from all of the pods that are endpoints of the LoadBalancer service would use a different network than the main one.
EgressService is a CRD that allows the user to request that the source
IP of egress packets originating from all of the pods that are endpoints
of the corresponding LoadBalancer Service would be its ingress IP.
In addition, it allows the user to request that egress packets originating from
all of the pods that are endpoints of the LoadBalancer service would use a different
network than the main one.
--
Type::
@@ -171,6 +187,96 @@ Compatibility level 1: Stable within a major release for a minimum of 12 months
EgressRouter is a single egressrouter pod configuration object.
--
Type::
`object`
== GRPCRoute [gateway.networking.k8s.io/v1]
Description::
+
--
GRPCRoute provides a way to route gRPC requests. This includes the capability
to match requests by hostname, gRPC service, gRPC method, or HTTP/2 header.
Filters can be used to specify additional processing steps. Backends specify
where matching requests will be routed.
GRPCRoute falls under extended support within the Gateway API. Within the
following specification, the word "MUST" indicates that an implementation
supporting GRPCRoute must conform to the indicated requirement, but an
implementation not supporting this route type need not follow the requirement
unless explicitly indicated.
Implementations supporting `GRPCRoute` with the `HTTPS` `ProtocolType` MUST
accept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. via
ALPN. If the implementation does not support this, then it MUST set the
"Accepted" condition to "False" for the affected listener with a reason of
"UnsupportedProtocol". Implementations MAY also accept HTTP/2 connections
with an upgrade from HTTP/1.
Implementations supporting `GRPCRoute` with the `HTTP` `ProtocolType` MUST
support HTTP/2 over cleartext TCP (h2c,
https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initial
upgrade from HTTP/1.1, i.e. with prior knowledge
(https://www.rfc-editor.org/rfc/rfc7540#section-3.4). If the implementation
does not support this, then it MUST set the "Accepted" condition to "False"
for the affected listener with a reason of "UnsupportedProtocol".
Implementations MAY also accept HTTP/2 connections with an upgrade from
HTTP/1, i.e. without prior knowledge.
--
Type::
`object`
== Gateway [gateway.networking.k8s.io/v1]
Description::
+
--
Gateway represents an instance of a service-traffic handling infrastructure
by binding Listeners to a set of IP addresses.
--
Type::
`object`
== GatewayClass [gateway.networking.k8s.io/v1]
Description::
+
--
GatewayClass describes a class of Gateways available to the user for creating
Gateway resources.
It is recommended that this resource be used as a template for Gateways. This
means that a Gateway is based on the state of the GatewayClass at the time it
was created and changes to the GatewayClass or associated parameters are not
propagated down to existing Gateways. This recommendation is intended to
limit the blast radius of changes to GatewayClass or associated parameters.
If implementations choose to propagate GatewayClass changes to existing
Gateways, that MUST be clearly documented by the implementation.
Whenever one or more Gateways are using a GatewayClass, implementations SHOULD
add the `gateway-exists-finalizer.gateway.networking.k8s.io` finalizer on the
associated GatewayClass. This ensures that a GatewayClass associated with a
Gateway is not deleted while in use.
GatewayClass is a Cluster level resource.
--
Type::
`object`
== HTTPRoute [gateway.networking.k8s.io/v1]
Description::
+
--
HTTPRoute provides a way to route HTTP requests. This includes the capability
to match requests by hostname, path, header, or query param. Filters can be
used to specify additional processing steps. Backends specify where matching
requests should be routed.
--
Type::
`object`
@@ -193,6 +299,17 @@ 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`
== IPAMClaim [k8s.cni.cncf.io/v1alpha1]
Description::
+
--
IPAMClaim is the Schema for the IPAMClaim API
--
Type::
`object`
@@ -237,6 +354,17 @@ Description::
NetworkPolicy describes what network traffic is allowed for a set of Pods
--
Type::
`object`
== NodeSlicePool [whereabouts.cni.cncf.io/v1alpha1]
Description::
+
--
NodeSlicePool is the Schema for the nodesliceippools API
--
Type::
`object`
@@ -261,6 +389,32 @@ PodNetworkConnectivityCheck
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.
--
Type::
`object`
== ReferenceGrant [gateway.networking.k8s.io/v1beta1]
Description::
+
--
ReferenceGrant identifies kinds of resources in other namespaces that are
trusted to reference the specified kinds of resources in the same namespace
as the policy.
Each ReferenceGrant can be used to represent a unique trust relationship.
Additional Reference Grants can be used to add to the set of trusted
sources of inbound references for the namespace they are defined within.
All cross-namespace references in Gateway API (with the exception of cross-namespace
Gateway-route attachment) require a ReferenceGrant.
ReferenceGrant is a form of runtime verification allowing users to assert
which cross-namespace object references are permitted. Implementations that
support ReferenceGrant MUST NOT permit cross-namespace references which have
no grant, and MUST respond to the removal of a grant by revoking the access
that the grant allowed.
--
Type::
`object`
@@ -296,3 +450,14 @@ Service is a named abstraction of software service (for example, mysql) consisti
Type::
`object`
== UserDefinedNetwork [k8s.ovn.org/v1]
Description::
+
--
UserDefinedNetwork describe network request for a Namespace.
--
Type::
`object`

404
rest_api/network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc Normal file
View File

@@ -0,0 +1,404 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="nodeslicepool-whereabouts-cni-cncf-io-v1alpha1"]
= NodeSlicePool [whereabouts.cni.cncf.io/v1alpha1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
NodeSlicePool is the Schema for the nodesliceippools API
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| NodeSlicePoolSpec defines the desired state of NodeSlicePool
| `status`
| `object`
| NodeSlicePoolStatus defines the desired state of NodeSlicePool
|===
=== .spec
Description::
+
--
NodeSlicePoolSpec defines the desired state of NodeSlicePool
--
Type::
`object`
Required::
- `range`
- `sliceSize`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `range`
| `string`
| Range is a RFC 4632/4291-style string that represents an IP address and prefix length in CIDR notation
this refers to the entire range where the node is allocated a subset
| `sliceSize`
| `string`
| SliceSize is the size of subnets or slices of the range that each node will be assigned
|===
=== .status
Description::
+
--
NodeSlicePoolStatus defines the desired state of NodeSlicePool
--
Type::
`object`
Required::
- `allocations`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `allocations`
| `array`
| Allocations holds the allocations of nodes to slices
| `allocations[]`
| `object`
|
|===
=== .status.allocations
Description::
+
--
Allocations holds the allocations of nodes to slices
--
Type::
`array`
=== .status.allocations[]
Description::
+
--
--
Type::
`object`
Required::
- `nodeName`
- `sliceRange`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `nodeName`
| `string`
| NodeName is the name of the node assigned to this slice, empty node name is an available slice for assignment
| `sliceRange`
| `string`
| SliceRange is the subnet of this slice
|===
== API endpoints
The following API endpoints are available:
* `/apis/whereabouts.cni.cncf.io/v1alpha1/nodeslicepools`
- `GET`: list objects of kind NodeSlicePool
* `/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/nodeslicepools`
- `DELETE`: delete collection of NodeSlicePool
- `GET`: list objects of kind NodeSlicePool
- `POST`: create a NodeSlicePool
* `/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/nodeslicepools/{name}`
- `DELETE`: delete a NodeSlicePool
- `GET`: read the specified NodeSlicePool
- `PATCH`: partially update the specified NodeSlicePool
- `PUT`: replace the specified NodeSlicePool
=== /apis/whereabouts.cni.cncf.io/v1alpha1/nodeslicepools
HTTP method::
`GET`
Description::
list objects of kind NodeSlicePool
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-cncf-cni-whereabouts-v1alpha1-NodeSlicePoolList[`NodeSlicePoolList`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/nodeslicepools
HTTP method::
`DELETE`
Description::
delete collection of NodeSlicePool
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind NodeSlicePool
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-cncf-cni-whereabouts-v1alpha1-NodeSlicePoolList[`NodeSlicePoolList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a NodeSlicePool
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
| 201 - Created
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
| 202 - Accepted
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/nodeslicepools/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the NodeSlicePool
|===
HTTP method::
`DELETE`
Description::
delete a NodeSlicePool
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified NodeSlicePool
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified NodeSlicePool
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified NodeSlicePool
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
| 201 - Created
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[`NodeSlicePool`] schema
| 401 - Unauthorized
| Empty
|===

80
rest_api/network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc
View File

@@ -43,18 +43,18 @@ Required::
| `spec`
| `object`
| Spec defines the source and target of the connectivity check
| spec defines the source and target of the connectivity check
| `status`
| `object`
| Status contains the observed status of the connectivity check
| status contains the observed status of the connectivity check
|===
=== .spec
Description::
+
--
Spec defines the source and target of the connectivity check
spec defines the source and target of the connectivity check
--
Type::
@@ -72,7 +72,7 @@ Required::
| `sourcePod`
| `string`
| SourcePod names the pod from which the condition will be checked
| sourcePod names the pod from which the condition will be checked
| `targetEndpoint`
| `string`
@@ -121,7 +121,7 @@ Required::
Description::
+
--
Status contains the observed status of the connectivity check
status contains the observed status of the connectivity check
--
Type::
@@ -136,7 +136,7 @@ Type::
| `conditions`
| `array`
| Conditions summarize the status of the check
| conditions summarize the status of the check
| `conditions[]`
| `object`
@@ -144,7 +144,7 @@ Type::
| `failures`
| `array`
| Failures contains logs of unsuccessful check actions
| failures contains logs of unsuccessful check actions
| `failures[]`
| `object`
@@ -152,7 +152,7 @@ Type::
| `outages`
| `array`
| Outages contains logs of time periods of outages
| outages contains logs of time periods of outages
| `outages[]`
| `object`
@@ -160,7 +160,7 @@ Type::
| `successes`
| `array`
| Successes contains logs successful check actions
| successes contains logs successful check actions
| `successes[]`
| `object`
@@ -171,7 +171,7 @@ Type::
Description::
+
--
Conditions summarize the status of the check
conditions summarize the status of the check
--
Type::
@@ -206,26 +206,26 @@ Required::
| `message`
| `string`
| Message indicating details about last transition in a human readable format.
| message indicating details about last transition in a human readable format.
| `reason`
| `string`
| Reason for the condition's last status transition in a machine readable format.
| reason for the condition's last status transition in a machine readable format.
| `status`
| `string`
| Status of the condition
| status of the condition
| `type`
| `string`
| Type of the condition
| type of the condition
|===
=== .status.failures
Description::
+
--
Failures contains logs of unsuccessful check actions
failures contains logs of unsuccessful check actions
--
Type::
@@ -255,19 +255,19 @@ Required::
| `latency`
| ``
| Latency records how long the action mentioned in the entry took.
| latency records how long the action mentioned in the entry took.
| `message`
| `string`
| Message explaining status in a human readable format.
| message explaining status in a human readable format.
| `reason`
| `string`
| Reason for status in a machine readable format.
| reason for status in a machine readable format.
| `success`
| `boolean`
| Success indicates if the log entry indicates a success or failure.
| success indicates if the log entry indicates a success or failure.
| `time`
| ``
@@ -278,7 +278,7 @@ Required::
Description::
+
--
Outages contains logs of time periods of outages
outages contains logs of time periods of outages
--
Type::
@@ -306,11 +306,11 @@ Type::
| `end`
| ``
| End of outage detected
| end of outage detected
| `endLogs`
| `array`
| EndLogs contains log entries related to the end of this outage. Should contain the success
| endLogs contains log entries related to the end of this outage. Should contain the success
entry that resolved the outage and possibly a few of the failure log entries that preceded it.
| `endLogs[]`
@@ -319,15 +319,15 @@ entry that resolved the outage and possibly a few of the failure log entries tha
| `message`
| `string`
| Message summarizes outage details in a human readable format.
| message summarizes outage details in a human readable format.
| `start`
| ``
| Start of outage detected
| start of outage detected
| `startLogs`
| `array`
| StartLogs contains log entries related to the start of this outage. Should contain
| startLogs contains log entries related to the start of this outage. Should contain
the original failure, any entries where the failure mode changed.
| `startLogs[]`
@@ -339,7 +339,7 @@ the original failure, any entries where the failure mode changed.
Description::
+
--
EndLogs contains log entries related to the end of this outage. Should contain the success
endLogs contains log entries related to the end of this outage. Should contain the success
entry that resolved the outage and possibly a few of the failure log entries that preceded it.
--
@@ -370,19 +370,19 @@ Required::
| `latency`
| ``
| Latency records how long the action mentioned in the entry took.
| latency records how long the action mentioned in the entry took.
| `message`
| `string`
| Message explaining status in a human readable format.
| message explaining status in a human readable format.
| `reason`
| `string`
| Reason for status in a machine readable format.
| reason for status in a machine readable format.
| `success`
| `boolean`
| Success indicates if the log entry indicates a success or failure.
| success indicates if the log entry indicates a success or failure.
| `time`
| ``
@@ -393,7 +393,7 @@ Required::
Description::
+
--
StartLogs contains log entries related to the start of this outage. Should contain
startLogs contains log entries related to the start of this outage. Should contain
the original failure, any entries where the failure mode changed.
--
@@ -424,19 +424,19 @@ Required::
| `latency`
| ``
| Latency records how long the action mentioned in the entry took.
| latency records how long the action mentioned in the entry took.
| `message`
| `string`
| Message explaining status in a human readable format.
| message explaining status in a human readable format.
| `reason`
| `string`
| Reason for status in a machine readable format.
| reason for status in a machine readable format.
| `success`
| `boolean`
| Success indicates if the log entry indicates a success or failure.
| success indicates if the log entry indicates a success or failure.
| `time`
| ``
@@ -447,7 +447,7 @@ Required::
Description::
+
--
Successes contains logs successful check actions
successes contains logs successful check actions
--
Type::
@@ -477,19 +477,19 @@ Required::
| `latency`
| ``
| Latency records how long the action mentioned in the entry took.
| latency records how long the action mentioned in the entry took.
| `message`
| `string`
| Message explaining status in a human readable format.
| message explaining status in a human readable format.
| `reason`
| `string`
| Reason for status in a machine readable format.
| reason for status in a machine readable format.
| `success`
| `boolean`
| Success indicates if the log entry indicates a success or failure.
| success indicates if the log entry indicates a success or failure.
| `time`
| ``

496
rest_api/network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc Normal file
View File

@@ -0,0 +1,496 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="referencegrant-gateway-networking-k8s-io-v1beta1"]
= ReferenceGrant [gateway.networking.k8s.io/v1beta1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
ReferenceGrant identifies kinds of resources in other namespaces that are
trusted to reference the specified kinds of resources in the same namespace
as the policy.
Each ReferenceGrant can be used to represent a unique trust relationship.
Additional Reference Grants can be used to add to the set of trusted
sources of inbound references for the namespace they are defined within.
All cross-namespace references in Gateway API (with the exception of cross-namespace
Gateway-route attachment) require a ReferenceGrant.
ReferenceGrant is a form of runtime verification allowing users to assert
which cross-namespace object references are permitted. Implementations that
support ReferenceGrant MUST NOT permit cross-namespace references which have
no grant, and MUST respond to the removal of a grant by revoking the access
that the grant allowed.
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| Spec defines the desired state of ReferenceGrant.
|===
=== .spec
Description::
+
--
Spec defines the desired state of ReferenceGrant.
--
Type::
`object`
Required::
- `from`
- `to`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `from`
| `array`
| From describes the trusted namespaces and kinds that can reference the
resources described in "To". Each entry in this list MUST be considered
to be an additional place that references can be valid from, or to put
this another way, entries MUST be combined using OR.
Support: Core
| `from[]`
| `object`
| ReferenceGrantFrom describes trusted namespaces and kinds.
| `to`
| `array`
| To describes the resources that may be referenced by the resources
described in "From". Each entry in this list MUST be considered to be an
additional place that references can be valid to, or to put this another
way, entries MUST be combined using OR.
Support: Core
| `to[]`
| `object`
| ReferenceGrantTo describes what Kinds are allowed as targets of the
references.
|===
=== .spec.from
Description::
+
--
From describes the trusted namespaces and kinds that can reference the
resources described in "To". Each entry in this list MUST be considered
to be an additional place that references can be valid from, or to put
this another way, entries MUST be combined using OR.
Support: Core
--
Type::
`array`
=== .spec.from[]
Description::
+
--
ReferenceGrantFrom describes trusted namespaces and kinds.
--
Type::
`object`
Required::
- `group`
- `kind`
- `namespace`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `group`
| `string`
| Group is the group of the referent.
When empty, the Kubernetes core API group is inferred.
Support: Core
| `kind`
| `string`
| Kind is the kind of the referent. Although implementations may support
additional resources, the following types are part of the "Core"
support level for this field.
When used to permit a SecretObjectReference:
* Gateway
When used to permit a BackendObjectReference:
* GRPCRoute
* HTTPRoute
* TCPRoute
* TLSRoute
* UDPRoute
| `namespace`
| `string`
| Namespace is the namespace of the referent.
Support: Core
|===
=== .spec.to
Description::
+
--
To describes the resources that may be referenced by the resources
described in "From". Each entry in this list MUST be considered to be an
additional place that references can be valid to, or to put this another
way, entries MUST be combined using OR.
Support: Core
--
Type::
`array`
=== .spec.to[]
Description::
+
--
ReferenceGrantTo describes what Kinds are allowed as targets of the
references.
--
Type::
`object`
Required::
- `group`
- `kind`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `group`
| `string`
| Group is the group of the referent.
When empty, the Kubernetes core API group is inferred.
Support: Core
| `kind`
| `string`
| Kind is the kind of the referent. Although implementations may support
additional resources, the following types are part of the "Core"
support level for this field:
* Secret when used to permit a SecretObjectReference
* Service when used to permit a BackendObjectReference
| `name`
| `string`
| Name is the name of the referent. When unspecified, this policy
refers to all resources of the specified Group and Kind in the local
namespace.
|===
== API endpoints
The following API endpoints are available:
* `/apis/gateway.networking.k8s.io/v1beta1/referencegrants`
- `GET`: list objects of kind ReferenceGrant
* `/apis/gateway.networking.k8s.io/v1beta1/namespaces/{namespace}/referencegrants`
- `DELETE`: delete collection of ReferenceGrant
- `GET`: list objects of kind ReferenceGrant
- `POST`: create a ReferenceGrant
* `/apis/gateway.networking.k8s.io/v1beta1/namespaces/{namespace}/referencegrants/{name}`
- `DELETE`: delete a ReferenceGrant
- `GET`: read the specified ReferenceGrant
- `PATCH`: partially update the specified ReferenceGrant
- `PUT`: replace the specified ReferenceGrant
=== /apis/gateway.networking.k8s.io/v1beta1/referencegrants
HTTP method::
`GET`
Description::
list objects of kind ReferenceGrant
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-networking-gateway-v1beta1-ReferenceGrantList[`ReferenceGrantList`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/gateway.networking.k8s.io/v1beta1/namespaces/{namespace}/referencegrants
HTTP method::
`DELETE`
Description::
delete collection of ReferenceGrant
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind ReferenceGrant
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-networking-gateway-v1beta1-ReferenceGrantList[`ReferenceGrantList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a ReferenceGrant
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
| 201 - Created
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
| 202 - Accepted
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/gateway.networking.k8s.io/v1beta1/namespaces/{namespace}/referencegrants/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ReferenceGrant
|===
HTTP method::
`DELETE`
Description::
delete a ReferenceGrant
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified ReferenceGrant
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified ReferenceGrant
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified ReferenceGrant
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
| 201 - Created
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[`ReferenceGrant`] schema
| 401 - Unauthorized
| Empty
|===

6
rest_api/network_apis/service-v1.adoc
View File

@@ -162,7 +162,7 @@ Possible enum values:
| `trafficDistribution`
| `string`
| TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to "PreferClose", implementations should prioritize endpoints that are topologically close (e.g., same zone). This is an alpha field and requires enabling ServiceTrafficDistribution feature.
| TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to "PreferClose", implementations should prioritize endpoints that are topologically close (e.g., same zone). This is a beta field and requires enabling ServiceTrafficDistribution feature.
| `type`
| `string`
@@ -390,7 +390,7 @@ Type::
| `ports[]`
| `object`
|
| PortStatus represents the error condition of a service port
|===
=== .status.loadBalancer.ingress[].ports
@@ -410,7 +410,7 @@ Type::
Description::
+
--
PortStatus represents the error condition of a service port
--
Type::

735
rest_api/network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc Normal file
View File

@@ -0,0 +1,735 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="userdefinednetwork-k8s-ovn-org-v1"]
= UserDefinedNetwork [k8s.ovn.org/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
UserDefinedNetwork describe network request for a Namespace.
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| UserDefinedNetworkSpec defines the desired state of UserDefinedNetworkSpec.
| `status`
| `object`
| UserDefinedNetworkStatus contains the observed status of the UserDefinedNetwork.
|===
=== .spec
Description::
+
--
UserDefinedNetworkSpec defines the desired state of UserDefinedNetworkSpec.
--
Type::
`object`
Required::
- `topology`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `layer2`
| `object`
| Layer2 is the Layer2 topology configuration.
| `layer3`
| `object`
| Layer3 is the Layer3 topology configuration.
| `topology`
| `string`
| Topology describes network configuration.
Allowed values are "Layer3", "Layer2".
Layer3 topology creates a layer 2 segment per node, each with a different subnet. Layer 3 routing is used to interconnect node subnets.
Layer2 topology creates one logical switch shared by all nodes.
|===
=== .spec.layer2
Description::
+
--
Layer2 is the Layer2 topology configuration.
--
Type::
`object`
Required::
- `role`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `ipam`
| `object`
| IPAM section contains IPAM-related configuration for the network.
| `joinSubnets`
| `array (string)`
| JoinSubnets are used inside the OVN network topology.
Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed.
This field is only allowed for "Primary" network.
It is not recommended to set this field without explicit need and understanding of the OVN network topology.
When omitted, the platform will choose a reasonable default which is subject to change over time.
| `mtu`
| `integer`
| MTU is the maximum transmission unit for a network.
MTU is optional, if not provided, the globally configured value in OVN-Kubernetes (defaults to 1400) is used for the network.
| `role`
| `string`
| Role describes the network role in the pod.
Allowed value is "Secondary".
Secondary network is only assigned to pods that use `k8s.v1.cni.cncf.io/networks` annotation to select given network.
| `subnets`
| `array (string)`
| Subnets are used for the pod network across the cluster.
Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed.
The format should match standard CIDR notation (for example, "10.128.0.0/16").
This field must be omitted if `ipam.mode` is `Disabled`.
|===
=== .spec.layer2.ipam
Description::
+
--
IPAM section contains IPAM-related configuration for the network.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `lifecycle`
| `string`
| Lifecycle controls IP addresses management lifecycle.
The only allowed value is Persistent. When set, OVN Kubernetes assigned IP addresses will be persisted in an
`ipamclaims.k8s.cni.cncf.io` object. These IP addresses will be reused by other pods if requested.
Only supported when mode is `Enabled`.
| `mode`
| `string`
| Mode controls how much of the IP configuration will be managed by OVN.
`Enabled` means OVN-Kubernetes will apply IP configuration to the SDN infrastructure and it will also assign IPs
from the selected subnet to the individual pods.
`Disabled` means OVN-Kubernetes will only assign MAC addresses and provide layer 2 communication, letting users
configure IP addresses for the pods.
`Disabled` is only available for Secondary networks.
By disabling IPAM, any Kubernetes features that rely on selecting pods by IP will no longer function
(such as network policy, services, etc). Additionally, IP port security will also be disabled for interfaces attached to this network.
Defaults to `Enabled`.
|===
=== .spec.layer3
Description::
+
--
Layer3 is the Layer3 topology configuration.
--
Type::
`object`
Required::
- `role`
- `subnets`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `joinSubnets`
| `array (string)`
| JoinSubnets are used inside the OVN network topology.
Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed.
This field is only allowed for "Primary" network.
It is not recommended to set this field without explicit need and understanding of the OVN network topology.
When omitted, the platform will choose a reasonable default which is subject to change over time.
| `mtu`
| `integer`
| MTU is the maximum transmission unit for a network.
MTU is optional, if not provided, the globally configured value in OVN-Kubernetes (defaults to 1400) is used for the network.
| `role`
| `string`
| Role describes the network role in the pod.
Allowed values are "Primary" and "Secondary".
Primary network is automatically assigned to every pod created in the same namespace.
Secondary network is only assigned to pods that use `k8s.v1.cni.cncf.io/networks` annotation to select given network.
| `subnets`
| `array`
| Subnets are used for the pod network across the cluster.
Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed.
Given subnet is split into smaller subnets for every node.
| `subnets[]`
| `object`
|
|===
=== .spec.layer3.subnets
Description::
+
--
Subnets are used for the pod network across the cluster.
Dual-stack clusters may set 2 subnets (one for each IP family), otherwise only 1 subnet is allowed.
Given subnet is split into smaller subnets for every node.
--
Type::
`array`
=== .spec.layer3.subnets[]
Description::
+
--
--
Type::
`object`
Required::
- `cidr`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `cidr`
| `string`
| CIDR specifies L3Subnet, which is split into smaller subnets for every node.
| `hostSubnet`
| `integer`
| HostSubnet specifies the subnet size for every node.
When not set, it will be assigned automatically.
|===
=== .status
Description::
+
--
UserDefinedNetworkStatus contains the observed status of the UserDefinedNetwork.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `conditions`
| `array`
|
| `conditions[]`
| `object`
| Condition contains details for one aspect of the current state of this API Resource.
|===
=== .status.conditions
Description::
+
--
--
Type::
`array`
=== .status.conditions[]
Description::
+
--
Condition contains details for one aspect of the current state of this API Resource.
--
Type::
`object`
Required::
- `lastTransitionTime`
- `message`
- `reason`
- `status`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `lastTransitionTime`
| `string`
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
| `message`
| `string`
| message is a human readable message indicating details about the transition.
This may be an empty string.
| `observedGeneration`
| `integer`
| observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
| `reason`
| `string`
| reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
| `status`
| `string`
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
== API endpoints
The following API endpoints are available:
* `/apis/k8s.ovn.org/v1/userdefinednetworks`
- `GET`: list objects of kind UserDefinedNetwork
* `/apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks`
- `DELETE`: delete collection of UserDefinedNetwork
- `GET`: list objects of kind UserDefinedNetwork
- `POST`: create an UserDefinedNetwork
* `/apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}`
- `DELETE`: delete an UserDefinedNetwork
- `GET`: read the specified UserDefinedNetwork
- `PATCH`: partially update the specified UserDefinedNetwork
- `PUT`: replace the specified UserDefinedNetwork
* `/apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}/status`
- `GET`: read status of the specified UserDefinedNetwork
- `PATCH`: partially update status of the specified UserDefinedNetwork
- `PUT`: replace status of the specified UserDefinedNetwork
=== /apis/k8s.ovn.org/v1/userdefinednetworks
HTTP method::
`GET`
Description::
list objects of kind UserDefinedNetwork
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#org-ovn-k8s-v1-UserDefinedNetworkList[`UserDefinedNetworkList`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks
HTTP method::
`DELETE`
Description::
delete collection of UserDefinedNetwork
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind UserDefinedNetwork
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#org-ovn-k8s-v1-UserDefinedNetworkList[`UserDefinedNetworkList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create an UserDefinedNetwork
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 201 - Created
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 202 - Accepted
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the UserDefinedNetwork
|===
HTTP method::
`DELETE`
Description::
delete an UserDefinedNetwork
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified UserDefinedNetwork
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified UserDefinedNetwork
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified UserDefinedNetwork
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 201 - Created
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/k8s.ovn.org/v1/namespaces/{namespace}/userdefinednetworks/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the UserDefinedNetwork
|===
HTTP method::
`GET`
Description::
read status of the specified UserDefinedNetwork
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified UserDefinedNetwork
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified UserDefinedNetwork
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 201 - Created
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[`UserDefinedNetwork`] schema
| 401 - Unauthorized
| Empty
|===

8
rest_api/node_apis/node-v1.adoc
View File

@@ -234,7 +234,7 @@ Type::
| `addresses`
| `array`
| List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
| List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/reference/node/node-status/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
| `addresses[]`
| `object`
@@ -250,7 +250,7 @@ Type::
| `conditions`
| `array`
| Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
| Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition
| `conditions[]`
| `object`
@@ -314,7 +314,7 @@ Possible enum values:
Description::
+
--
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/reference/node/node-status/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
--
Type::
@@ -356,7 +356,7 @@ Required::
Description::
+
--
Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition
--
Type::

4
rest_api/node_apis/performanceprofile-performance-openshift-io-v2.adoc
View File

@@ -94,6 +94,10 @@ For example, hugepages can be set with 1G and 2M, both values will be set on the
It is important to notice that setting hugepages default size to 1G will remove all 2M related
folders from the node and it will be impossible to configure 2M hugepages under the node.
| `kernelPageSize`
| `string`
| KernelPageSize defines the kernel page size. 4k is the default, 64k is only supported on aarch64
| `machineConfigLabel`
| `object (string)`
| MachineConfigLabel defines the label to add to the MachineConfigs the operator creates. It has to be

8
rest_api/node_apis/profile-tuned-openshift-io-v1.adoc
View File

@@ -209,7 +209,11 @@ Required::
| `conditions[]`
| `object`
| ProfileStatusCondition represents a partial state of the per-node Profile application.
| StatusCondition represents a partial state of the per-node Profile application.
| `observedGeneration`
| `integer`
| If set, this represents the .metadata.generation that the conditions were set based upon.
| `tunedProfile`
| `string`
@@ -233,7 +237,7 @@ Type::
Description::
+
--
ProfileStatusCondition represents a partial state of the per-node Profile application.
StatusCondition represents a partial state of the per-node Profile application.
--
Type::

175
rest_api/node_apis/tuned-tuned-openshift-io-v1.adoc
View File

@@ -312,6 +312,75 @@ Type::
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `conditions`
| `array`
| conditions represents the state of the Tuned profile
| `conditions[]`
| `object`
| StatusCondition represents a partial state of the per-node Profile application.
|===
=== .status.conditions
Description::
+
--
conditions represents the state of the Tuned profile
--
Type::
`array`
=== .status.conditions[]
Description::
+
--
StatusCondition represents a partial state of the per-node Profile application.
--
Type::
`object`
Required::
- `lastTransitionTime`
- `status`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `lastTransitionTime`
| `string`
| lastTransitionTime is the time of the last update to the current status property.
| `message`
| `string`
| message provides additional information about the current condition.
This is only to be consumed by humans.
| `reason`
| `string`
| reason is the CamelCase reason for the condition's current status.
| `status`
| `string`
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| type specifies the aspect reported by this condition.
|===
== API endpoints
@@ -328,6 +397,10 @@ The following API endpoints are available:
- `GET`: read the specified Tuned
- `PATCH`: partially update the specified Tuned
- `PUT`: replace the specified Tuned
* `/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}/status`
- `GET`: read status of the specified Tuned
- `PATCH`: partially update status of the specified Tuned
- `PUT`: replace status of the specified Tuned
=== /apis/tuned.openshift.io/v1/tuneds
@@ -568,3 +641,105 @@ Description::
|===
=== /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the Tuned
|===
HTTP method::
`GET`
Description::
read status of the specified Tuned
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified Tuned
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified Tuned
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema
| 201 - Created
| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema
| 401 - Unauthorized
| Empty
|===

866
rest_api/objects/index.adoc
View File

File diff suppressed because it is too large Load Diff

6
rest_api/operator_apis/authentication-operator-openshift-io-v1.adoc
View File

@@ -140,7 +140,7 @@ Type::
| `oauthAPIServer`
| `object`
| OAuthAPIServer holds status specific only to oauth-apiserver
| oauthAPIServer holds status specific only to oauth-apiserver
| `observedGeneration`
| `integer`
@@ -275,7 +275,7 @@ Required::
Description::
+
--
OAuthAPIServer holds status specific only to oauth-apiserver
oauthAPIServer holds status specific only to oauth-apiserver
--
Type::
@@ -290,7 +290,7 @@ Type::
| `latestAvailableRevision`
| `integer`
| LatestAvailableRevision is the latest revision used as suffix of revisioned
| latestAvailableRevision is the latest revision used as suffix of revisioned
secrets like encryption-config. A new revision causes a new deployment of pods.
|===

51
rest_api/operator_apis/cloudcredential-operator-openshift-io-v1.adoc
View File

@@ -11,8 +11,9 @@ toc::[]
Description::
+
--
CloudCredential provides a means to configure an operator to manage CredentialsRequests.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
CloudCredential provides a means to configure an operator to manage CredentialsRequests.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
Type::
@@ -68,12 +69,23 @@ Type::
| `credentialsMode`
| `string`
| CredentialsMode allows informing CCO that it should not attempt to dynamically determine the root cloud credentials capabilities, and it should just run in the specified mode. It also allows putting the operator into "manual" mode if desired. Leaving the field in default mode runs CCO so that the cluster's cloud credentials will be dynamically probed for capabilities (on supported clouds/platforms). Supported modes: AWS/Azure/GCP: "" (Default), "Mint", "Passthrough", "Manual" Others: Do not set value as other platforms only support running in "Passthrough"
| credentialsMode allows informing CCO that it should not attempt to dynamically
determine the root cloud credentials capabilities, and it should just run in
the specified mode.
It also allows putting the operator into "manual" mode if desired.
Leaving the field in default mode runs CCO so that the cluster's cloud credentials
will be dynamically probed for capabilities (on supported clouds/platforms).
Supported modes:
AWS/Azure/GCP: "" (Default), "Mint", "Passthrough", "Manual"
Others: Do not set value as other platforms only support running in "Passthrough"
| `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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
| 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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll".
Defaults to "Normal".
| `managementState`
| `string`
@@ -81,16 +93,24 @@ Type::
| `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
| 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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
| 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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll".
Defaults to "Normal".
| `unsupportedConfigOverrides`
| ``
| unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.
| unsupportedConfigOverrides overrides the final configuration that was computed by the operator.
Red Hat does not support the use of this field.
Misuse of this field could lead to unexpected behavior or conflict with other configuration options.
Seek guidance from the Red Hat support before using this field.
Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.
|===
=== .status
@@ -126,6 +146,10 @@ Type::
| `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
| `observedGeneration`
| `integer`
| observedGeneration is the last generation change you've dealt with
@@ -163,6 +187,8 @@ Type::
`object`
Required::
- `lastTransitionTime`
- `status`
- `type`
@@ -173,7 +199,8 @@ Required::
| `lastTransitionTime`
| `string`
|
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
| `message`
| `string`
@@ -185,11 +212,11 @@ Required::
| `status`
| `string`
|
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
|
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
=== .status.generations

6
rest_api/operator_apis/clustercsidriver-operator-openshift-io-v1.adoc
View File

@@ -102,7 +102,7 @@ Defaults to "Normal".
| `storageClassState`
| `string`
| StorageClassState determines if CSI operator should create and manage storage classes.
| storageClassState determines if CSI operator should create and manage storage classes.
If this field value is empty or Managed - CSI operator will continuously reconcile
storage class and create if necessary.
If this field value is Unmanaged - CSI operator will not reconcile any previously created
@@ -167,7 +167,7 @@ Consumers should treat unknown values as a NO-OP.
| `vSphere`
| `object`
| vsphere is used to configure the vsphere CSI driver.
| vSphere is used to configure the vsphere CSI driver.
|===
=== .spec.driverConfig.aws
@@ -437,7 +437,7 @@ for disk encryption of volumes for the default storage classes.
Description::
+
--
vsphere is used to configure the vsphere CSI driver.
vSphere is used to configure the vsphere CSI driver.
--
Type::

222
rest_api/operator_apis/console-operator-openshift-io-v1.adoc
View File

@@ -176,14 +176,14 @@ Each of the available capabilities may appear only once in the list.
| `customLogoFile`
| `object`
| customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a
Only one of customLogoFile or logos can be set at a time.
ConfigMap in the openshift-config namespace. This can be created with a command like
'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config'.
Image size must be less than 1 MB due to constraints on the ConfigMap size.
The ConfigMap key should include a file extension so that the console serves the file
with the correct MIME type.
Recommended logo specifications:
Dimensions: Max height of 68px and max width of 200px
SVG format preferred
The recommended file format for the logo is SVG, but other file formats are allowed if supported by the browser.
Deprecated: Use logos instead.
| `customProductName`
| `string`
@@ -201,6 +201,19 @@ of the web console. Providing documentationBaseURL will override the default
documentation URL.
Invalid value will prevent a console rollout.
| `logos`
| `array`
| logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos.
logos is an optional field that allows a list of logos.
Only one of logos or customLogoFile can be set at a time.
If logos is set, customLogoFile must be unset.
When specified, there must be at least one entry and no more than 2 entries.
Each type must appear only once in the list.
| `logos[]`
| `object`
| Logo defines a configuration based on theme modes for the console UI logo.
| `perspectives`
| `array`
| perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.
@@ -320,14 +333,14 @@ Description::
+
--
customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a
Only one of customLogoFile or logos can be set at a time.
ConfigMap in the openshift-config namespace. This can be created with a command like
'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config'.
Image size must be less than 1 MB due to constraints on the ConfigMap size.
The ConfigMap key should include a file extension so that the console serves the file
with the correct MIME type.
Recommended logo specifications:
Dimensions: Max height of 68px and max width of 200px
SVG format preferred
The recommended file format for the logo is SVG, but other file formats are allowed if supported by the browser.
Deprecated: Use logos instead.
--
Type::
@@ -342,7 +355,7 @@ Type::
| `key`
| `string`
| Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.
| key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.
| `name`
| `string`
@@ -415,7 +428,7 @@ Required::
| `id`
| `string`
| ID is an identifier used in the URL to enable deep linking in console.
| id is an identifier used in the URL to enable deep linking in console.
ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.
| `label`
@@ -471,7 +484,7 @@ Required::
| `id`
| `string`
| ID is an identifier used in the URL to enable deep linking in console.
| id is an identifier used in the URL to enable deep linking in console.
ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.
| `label`
@@ -525,6 +538,197 @@ If the list is empty the complete developer catalog will be shown.
| `string`
| state defines if a list of catalog types should be enabled or disabled.
|===
=== .spec.customization.logos
Description::
+
--
logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos.
logos is an optional field that allows a list of logos.
Only one of logos or customLogoFile can be set at a time.
If logos is set, customLogoFile must be unset.
When specified, there must be at least one entry and no more than 2 entries.
Each type must appear only once in the list.
--
Type::
`array`
=== .spec.customization.logos[]
Description::
+
--
Logo defines a configuration based on theme modes for the console UI logo.
--
Type::
`object`
Required::
- `themes`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `themes`
| `array`
| themes specifies the themes for the console UI logo.
themes is a required field that allows a list of themes. Each item in the themes list must have a unique mode and a source field.
Each mode determines whether the logo is for the dark or light mode of the console UI.
If a theme is not specified, the default OpenShift logo will be displayed for that theme.
There must be at least one entry and no more than 2 entries.
| `themes[]`
| `object`
| Theme defines a theme mode for the console UI.
| `type`
| `string`
| type specifies the type of the logo for the console UI. It determines whether the logo is for the masthead or favicon.
type is a required field that allows values of Masthead and Favicon.
When set to "Masthead", the logo will be used in the masthead and about modal of the console UI.
When set to "Favicon", the logo will be used as the favicon of the console UI.
|===
=== .spec.customization.logos[].themes
Description::
+
--
themes specifies the themes for the console UI logo.
themes is a required field that allows a list of themes. Each item in the themes list must have a unique mode and a source field.
Each mode determines whether the logo is for the dark or light mode of the console UI.
If a theme is not specified, the default OpenShift logo will be displayed for that theme.
There must be at least one entry and no more than 2 entries.
--
Type::
`array`
=== .spec.customization.logos[].themes[]
Description::
+
--
Theme defines a theme mode for the console UI.
--
Type::
`object`
Required::
- `mode`
- `source`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `mode`
| `string`
| mode is used to specify what theme mode a logo will apply to in the console UI.
mode is a required field that allows values of Dark and Light.
When set to Dark, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Dark mode.
When set to Light, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Light mode.
| `source`
| `object`
| source is used by the console to locate the specified file containing a custom logo.
source is a required field that references a ConfigMap name and key that contains the custom logo file in the openshift-config namespace.
You can create it with a command like:
- 'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file'
The ConfigMap key must include the file extension so that the console serves the file with the correct MIME type.
The recommended file format for the Masthead and Favicon logos is SVG, but other file formats are allowed if supported by the browser.
The logo image size must be less than 1 MB due to constraints on the ConfigMap size.
For more information, see the documentation: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console
|===
=== .spec.customization.logos[].themes[].source
Description::
+
--
source is used by the console to locate the specified file containing a custom logo.
source is a required field that references a ConfigMap name and key that contains the custom logo file in the openshift-config namespace.
You can create it with a command like:
- 'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file'
The ConfigMap key must include the file extension so that the console serves the file with the correct MIME type.
The recommended file format for the Masthead and Favicon logos is SVG, but other file formats are allowed if supported by the browser.
The logo image size must be less than 1 MB due to constraints on the ConfigMap size.
For more information, see the documentation: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console
--
Type::
`object`
Required::
- `from`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `configMap`
| `object`
| configMap specifies the ConfigMap sourcing details such as the name of the ConfigMap and the key for the file.
The ConfigMap must exist in the openshift-config namespace.
Required when from is "ConfigMap", and forbidden otherwise.
| `from`
| `string`
| from is a required field to specify the source type of the file reference.
Allowed values are ConfigMap.
When set to ConfigMap, the file will be sourced from a ConfigMap in the openshift-config namespace. The configMap field must be set when from is set to ConfigMap.
|===
=== .spec.customization.logos[].themes[].source.configMap
Description::
+
--
configMap specifies the ConfigMap sourcing details such as the name of the ConfigMap and the key for the file.
The ConfigMap must exist in the openshift-config namespace.
Required when from is "ConfigMap", and forbidden otherwise.
--
Type::
`object`
Required::
- `key`
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `key`
| `string`
| key is the logo key inside the referenced ConfigMap.
Must consist only of alphanumeric characters, dashes (-), underscores (_), and periods (.).
Must be at most 253 characters in length.
Must end in a valid file extension.
A valid file extension must consist of a period followed by 2 to 5 alpha characters.
| `name`
| `string`
| name is the name of the ConfigMap.
name is a required field.
Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
Must be at most 253 characters in length.
|===
=== .spec.customization.perspectives
Description::

6
rest_api/operator_apis/etcd-operator-openshift-io-v1.adoc
View File

@@ -342,7 +342,8 @@ Required::
| `currentRevision`
| `integer`
| currentRevision is the generation of the most recently successful deployment
| currentRevision is the generation of the most recently successful deployment.
Can not be set on creation of a nodeStatus. Updates must only increase the value.
| `lastFailedCount`
| `integer`
@@ -374,7 +375,8 @@ Required::
| `targetRevision`
| `integer`
| targetRevision is the generation of the deployment we're trying to apply
| targetRevision is the generation of the deployment we're trying to apply.
Can not be set on creation of a nodeStatus.
|===

84
rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc
View File

@@ -190,6 +190,72 @@ If this field is empty, the ingress controller uses the default error pages.
If this field is empty, the default values are used.
| `idleConnectionTerminationPolicy`
| `string`
| idleConnectionTerminationPolicy maps directly to HAProxy's
idle-close-on-response option and controls whether HAProxy
keeps idle frontend connections open during a soft stop
(router reload).
Allowed values for this field are "Immediate" and
"Deferred". The default value is "Immediate".
When set to "Immediate", idle connections are closed
immediately during router reloads. This ensures immediate
propagation of route changes but may impact clients
sensitive to connection resets.
When set to "Deferred", HAProxy will maintain idle
connections during a soft reload instead of closing them
immediately. These connections remain open until any of the
following occurs:
- A new request is received on the connection, in which
case HAProxy handles it in the old process and closes
the connection after sending the response.
- HAProxy's `timeout http-keep-alive` duration expires
(300 seconds in OpenShift's configuration, not
configurable).
- The client's keep-alive timeout expires, causing the
client to close the connection.
Setting Deferred can help prevent errors in clients or load
balancers that do not properly handle connection resets.
Additionally, this option allows you to retain the pre-2.4
HAProxy behaviour: in HAProxy version 2.2 (OpenShift
versions < 4.14), maintaining idle connections during a
soft reload was the default behaviour, but starting with
HAProxy 2.4, the default changed to closing idle
connections immediately.
Important Consideration:
- Using Deferred will result in temporary inconsistencies
for the first request on each persistent connection
after a route update and router reload. This request
will be processed by the old HAProxy process using its
old configuration. Subsequent requests will use the
updated configuration.
Operational Considerations:
- Keeping idle connections open during reloads may lead
to an accumulation of old HAProxy processes if
connections remain idle for extended periods,
especially in environments where frequent reloads
occur.
- Consider monitoring the number of HAProxy processes in
the router pods when Deferred is set.
- You may need to enable or adjust the
`ingress.operator.openshift.io/hard-stop-after`
duration (configured via an annotation on the
IngressController resource) in environments with
frequent reloads to prevent resource exhaustion.
| `logging`
| `object`
| logging defines parameters for what should be logged where. If this
@@ -993,7 +1059,7 @@ Type::
| `string`
| protocol specifies whether the load balancer uses PROXY protocol to forward connections to
the IngressController. See "service.kubernetes.io/ibm-load-balancer-cloud-provider-enable-features:
"proxy-protocol"" at https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas
"proxy-protocol"" at https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas"
PROXY protocol can be used with load balancers that support it to
communicate the source addresses of client connections when
@@ -2598,7 +2664,7 @@ If unset, the default timeout is 30s
| `connectTimeout`
| `string`
| ConnectTimeout defines the maximum time to wait for
| connectTimeout defines the maximum time to wait for
a connection attempt to a server/backend to succeed.
This field expects an unsigned duration string of decimal numbers, each with optional
@@ -2948,11 +3014,11 @@ This should be when the underlying condition changed. If that is not known, the
| `message`
| `string`
|
|
| `reason`
| `string`
|
|
| `status`
| `string`
@@ -3548,7 +3614,7 @@ Type::
| `string`
| protocol specifies whether the load balancer uses PROXY protocol to forward connections to
the IngressController. See "service.kubernetes.io/ibm-load-balancer-cloud-provider-enable-features:
"proxy-protocol"" at https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas
"proxy-protocol"" at https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas"
PROXY protocol can be used with load balancers that support it to
communicate the source addresses of client connections when
@@ -4012,7 +4078,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema
|
|
|===
.HTTP responses
@@ -4145,7 +4211,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema
|
|
|===
.HTTP responses
@@ -4247,7 +4313,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema
|
|
|===
.HTTP responses
@@ -4349,7 +4415,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema
|
|
|===
.HTTP responses

2
rest_api/operator_apis/insightsoperator-operator-openshift-io-v1.adoc
View File

@@ -472,7 +472,7 @@ Required::
| `state`
| `string`
| state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor service's user interface.
| state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor user interface.
| `totalRisk`
| `integer`

6
rest_api/operator_apis/kubeapiserver-operator-openshift-io-v1.adoc
View File

@@ -341,7 +341,8 @@ Required::
| `currentRevision`
| `integer`
| currentRevision is the generation of the most recently successful deployment
| currentRevision is the generation of the most recently successful deployment.
Can not be set on creation of a nodeStatus. Updates must only increase the value.
| `lastFailedCount`
| `integer`
@@ -373,7 +374,8 @@ Required::
| `targetRevision`
| `integer`
| targetRevision is the generation of the deployment we're trying to apply
| targetRevision is the generation of the deployment we're trying to apply.
Can not be set on creation of a nodeStatus.
|===
=== .status.serviceAccountIssuers

6
rest_api/operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc
View File

@@ -337,7 +337,8 @@ Required::
| `currentRevision`
| `integer`
| currentRevision is the generation of the most recently successful deployment
| currentRevision is the generation of the most recently successful deployment.
Can not be set on creation of a nodeStatus. Updates must only increase the value.
| `lastFailedCount`
| `integer`
@@ -369,7 +370,8 @@ Required::
| `targetRevision`
| `integer`
| targetRevision is the generation of the deployment we're trying to apply
| targetRevision is the generation of the deployment we're trying to apply.
Can not be set on creation of a nodeStatus.
|===

6
rest_api/operator_apis/kubescheduler-operator-openshift-io-v1.adoc
View File

@@ -329,7 +329,8 @@ Required::
| `currentRevision`
| `integer`
| currentRevision is the generation of the most recently successful deployment
| currentRevision is the generation of the most recently successful deployment.
Can not be set on creation of a nodeStatus. Updates must only increase the value.
| `lastFailedCount`
| `integer`
@@ -361,7 +362,8 @@ Required::
| `targetRevision`
| `integer`
| targetRevision is the generation of the deployment we're trying to apply
| targetRevision is the generation of the deployment we're trying to apply.
Can not be set on creation of a nodeStatus.
|===

242
rest_api/operator_apis/machineconfiguration-operator-openshift-io-v1.adoc
View File

@@ -91,8 +91,10 @@ Defaults to "Normal".
| managedBootImages allows configuration for the management of boot images for machine
resources within the cluster. This configuration allows users to select resources that should
be updated to the latest boot images during cluster upgrades, ensuring that new machines
always boot with the current cluster version's boot image. When omitted, no boot images
will be updated.
always boot with the current cluster version's boot image. When omitted, this means no opinion
and the platform is left to choose a reasonable default, which is subject to change over time.
The default for each machine manager mode is All for GCP and AWS platforms, and None for all
other platforms.
| `managementState`
| `string`
@@ -139,8 +141,10 @@ Description::
managedBootImages allows configuration for the management of boot images for machine
resources within the cluster. This configuration allows users to select resources that should
be updated to the latest boot images during cluster upgrades, ensuring that new machines
always boot with the current cluster version's boot image. When omitted, no boot images
will be updated.
always boot with the current cluster version's boot image. When omitted, this means no opinion
and the platform is left to choose a reasonable default, which is subject to change over time.
The default for each machine manager mode is All for GCP and AWS platforms, and None for all
other platforms.
--
Type::
@@ -242,6 +246,7 @@ Required::
Valid values are All and Partial.
All means that every resource matched by the machine manager will be updated.
Partial requires specified selector(s) and allows customisation of which resources matched by the machine manager will be updated.
None means that every resource matched by the machine manager will not be updated.
| `partial`
| `object`
@@ -897,6 +902,11 @@ Type::
| `object`
| Condition contains details for one aspect of the current state of this API Resource.
| `managedBootImagesStatus`
| `object`
| managedBootImagesStatus reflects what the latest cluster-validated boot image configuration is
and will be used by Machine Config Controller while performing boot image updates.
| `nodeDisruptionPolicyStatus`
| `object`
| nodeDisruptionPolicyStatus status reflects what the latest cluster-validated policies are,
@@ -975,6 +985,230 @@ This field may not be empty.
| `string`
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
=== .status.managedBootImagesStatus
Description::
+
--
managedBootImagesStatus reflects what the latest cluster-validated boot image configuration is
and will be used by Machine Config Controller while performing boot image updates.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `machineManagers`
| `array`
| machineManagers can be used to register machine management resources for boot image updates. The Machine Config Operator
will watch for changes to this list. Only one entry is permitted per type of machine management resource.
| `machineManagers[]`
| `object`
| MachineManager describes a target machine resource that is registered for boot image updates. It stores identifying information
such as the resource type and the API Group of the resource. It also provides granular control via the selection field.
|===
=== .status.managedBootImagesStatus.machineManagers
Description::
+
--
machineManagers can be used to register machine management resources for boot image updates. The Machine Config Operator
will watch for changes to this list. Only one entry is permitted per type of machine management resource.
--
Type::
`array`
=== .status.managedBootImagesStatus.machineManagers[]
Description::
+
--
MachineManager describes a target machine resource that is registered for boot image updates. It stores identifying information
such as the resource type and the API Group of the resource. It also provides granular control via the selection field.
--
Type::
`object`
Required::
- `apiGroup`
- `resource`
- `selection`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `apiGroup`
| `string`
| apiGroup is name of the APIGroup that the machine management resource belongs to.
The only current valid value is machine.openshift.io.
machine.openshift.io means that the machine manager will only register resources that belong to OpenShift machine API group.
| `resource`
| `string`
| resource is the machine management resource's type.
The only current valid value is machinesets.
machinesets means that the machine manager will only register resources of the kind MachineSet.
| `selection`
| `object`
| selection allows granular control of the machine management resources that will be registered for boot image updates.
|===
=== .status.managedBootImagesStatus.machineManagers[].selection
Description::
+
--
selection allows granular control of the machine management resources that will be registered for boot image updates.
--
Type::
`object`
Required::
- `mode`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `mode`
| `string`
| mode determines how machine managers will be selected for updates.
Valid values are All and Partial.
All means that every resource matched by the machine manager will be updated.
Partial requires specified selector(s) and allows customisation of which resources matched by the machine manager will be updated.
None means that every resource matched by the machine manager will not be updated.
| `partial`
| `object`
| partial provides label selector(s) that can be used to match machine management resources.
Only permitted when mode is set to "Partial".
|===
=== .status.managedBootImagesStatus.machineManagers[].selection.partial
Description::
+
--
partial provides label selector(s) that can be used to match machine management resources.
Only permitted when mode is set to "Partial".
--
Type::
`object`
Required::
- `machineResourceSelector`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `machineResourceSelector`
| `object`
| machineResourceSelector is a label selector that can be used to select machine resources like MachineSets.
|===
=== .status.managedBootImagesStatus.machineManagers[].selection.partial.machineResourceSelector
Description::
+
--
machineResourceSelector is a label selector that can be used to select machine resources like MachineSets.
--
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.
|===
=== .status.managedBootImagesStatus.machineManagers[].selection.partial.machineResourceSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--
Type::
`array`
=== .status.managedBootImagesStatus.machineManagers[].selection.partial.machineResourceSelector.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.
|===
=== .status.nodeDisruptionPolicyStatus
Description::

153
rest_api/operator_apis/network-operator-openshift-io-v1.adoc
View File

@@ -78,6 +78,18 @@ when multiple networks are enabled.
created by default. Instead, pods must request them by name.
type must be specified, along with exactly one "Config" that matches the type.
| `additionalRoutingCapabilities`
| `object`
| additionalRoutingCapabilities describes components and relevant
configuration providing additional routing capabilities. When set, it
enables such components and the usage of the routing capabilities they
provide for the machine network. Upstream operators, like MetalLB
operator, requiring these capabilities may rely on, or automatically set
this attribute. Network plugins may leverage advanced routing
capabilities acquired through the enablement of these components but may
require specific configuration on their side to do so; refer to their
respective documentation and configuration options.
| `clusterNetwork`
| `array`
| clusterNetwork is the IP address pool to use for pod IPs.
@@ -105,9 +117,10 @@ otherwise.
| `disableMultiNetwork`
| `boolean`
| disableMultiNetwork specifies whether or not multiple pod network
support should be disabled. If unset, this property defaults to
'false' and multiple network support is enabled.
| disableMultiNetwork defaults to 'false' and this setting enables the pod multi-networking capability.
disableMultiNetwork when set to 'true' at cluster install time does not install the components, typically the Multus CNI and the network-attachment-definition CRD,
that enable the pod multi-networking capability. Setting the parameter to 'true' might be useful when you need install third-party CNI plugins,
but these plugins are not supported by Red Hat. Changing the parameter value as a postinstallation cluster task has no effect.
| `disableNetworkDiagnostics`
| `boolean`
@@ -236,7 +249,7 @@ NetworkAttachmentDefinition CRD
| `simpleMacvlanConfig`
| `object`
| SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
| simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
| `type`
| `string`
@@ -248,7 +261,7 @@ The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan
Description::
+
--
SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
--
Type::
@@ -263,7 +276,7 @@ Type::
| `ipamConfig`
| `object`
| IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
| ipamConfig configures IPAM module will be used for IP Address Management (IPAM).
| `master`
| `string`
@@ -284,7 +297,7 @@ kernel will select the value.
Description::
+
--
IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
ipamConfig configures IPAM module will be used for IP Address Management (IPAM).
--
Type::
@@ -299,11 +312,11 @@ Type::
| `staticIPAMConfig`
| `object`
| StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
| staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
| `type`
| `string`
| Type is the type of IPAM module will be used for IP Address Management(IPAM).
| type is the type of IPAM module will be used for IP Address Management(IPAM).
The supported values are IPAMTypeDHCP, IPAMTypeStatic
|===
@@ -311,7 +324,7 @@ The supported values are IPAMTypeDHCP, IPAMTypeStatic
Description::
+
--
StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
--
Type::
@@ -326,7 +339,7 @@ Type::
| `addresses`
| `array`
| Addresses configures IP address for the interface
| addresses configures IP address for the interface
| `addresses[]`
| `object`
@@ -334,11 +347,11 @@ Type::
| `dns`
| `object`
| DNS configures DNS for the interface
| dns configures DNS for the interface
| `routes`
| `array`
| Routes configures IP routes for the interface
| routes configures IP routes for the interface
| `routes[]`
| `object`
@@ -349,7 +362,7 @@ Type::
Description::
+
--
Addresses configures IP address for the interface
addresses configures IP address for the interface
--
Type::
@@ -377,18 +390,18 @@ Type::
| `address`
| `string`
| Address is the IP address in CIDR format
| address is the IP address in CIDR format
| `gateway`
| `string`
| Gateway is IP inside of subnet to designate as the gateway
| gateway is IP inside of subnet to designate as the gateway
|===
=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.dns
Description::
+
--
DNS configures DNS for the interface
dns configures DNS for the interface
--
Type::
@@ -403,22 +416,22 @@ Type::
| `domain`
| `string`
| Domain configures the domainname the local domain used for short hostname lookups
| domain configures the domainname the local domain used for short hostname lookups
| `nameservers`
| `array (string)`
| Nameservers points DNS servers for IP lookup
| nameservers points DNS servers for IP lookup
| `search`
| `array (string)`
| Search configures priority ordered search domains for short hostname lookups
| search configures priority ordered search domains for short hostname lookups
|===
=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes
Description::
+
--
Routes configures IP routes for the interface
routes configures IP routes for the interface
--
Type::
@@ -446,13 +459,48 @@ Type::
| `destination`
| `string`
| Destination points the IP route destination
| destination points the IP route destination
| `gateway`
| `string`
| Gateway is the route's next-hop IP address
| gateway is the route's next-hop IP address
If unset, a default gateway is assumed (as determined by the CNI plugin).
|===
=== .spec.additionalRoutingCapabilities
Description::
+
--
additionalRoutingCapabilities describes components and relevant
configuration providing additional routing capabilities. When set, it
enables such components and the usage of the routing capabilities they
provide for the machine network. Upstream operators, like MetalLB
operator, requiring these capabilities may rely on, or automatically set
this attribute. Network plugins may leverage advanced routing
capabilities acquired through the enablement of these components but may
require specific configuration on their side to do so; refer to their
respective documentation and configuration options.
--
Type::
`object`
Required::
- `providers`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `providers`
| `array (string)`
| providers is a set of enabled components that provide additional routing
capabilities. Entries on this list must be unique. The only valid value
is currrently "FRR" which provides FRR routing capabilities through the
deployment of FRR.
|===
=== .spec.clusterNetwork
Description::
@@ -517,7 +565,7 @@ Type::
| `openshiftSDNConfig`
| `object`
| openShiftSDNConfig was previously used to configure the openshift-sdn plugin.
| openshiftSDNConfig was previously used to configure the openshift-sdn plugin.
DEPRECATED: OpenShift SDN is no longer supported.
| `ovnKubernetesConfig`
@@ -534,7 +582,7 @@ All NetworkTypes are supported except for NetworkTypeRaw
Description::
+
--
openShiftSDNConfig was previously used to configure the openshift-sdn plugin.
openshiftSDNConfig was previously used to configure the openshift-sdn plugin.
DEPRECATED: OpenShift SDN is no longer supported.
--
@@ -605,7 +653,7 @@ Default is 6081
| `hybridOverlayConfig`
| `object`
| HybridOverlayConfig configures an additional overlay network for peers that are
| hybridOverlayConfig configures an additional overlay network for peers that are
not using OVN.
| `ipsecConfig`
@@ -652,7 +700,7 @@ default one is being already used by something else. It must not overlap with
any other subnet being used by OpenShift or by the node network. The size of the
subnet must be larger than the number of nodes. The value cannot be changed
after installation.
Default is fd98::/48
Default is fd98::/64
|===
=== .spec.defaultNetwork.ovnKubernetesConfig.egressIPConfig
@@ -702,7 +750,7 @@ Type::
| `ipForwarding`
| `string`
| IPForwarding controls IP forwarding for all traffic on OVN-Kubernetes managed interfaces (such as br-ex).
| ipForwarding controls IP forwarding for all traffic on OVN-Kubernetes managed interfaces (such as br-ex).
By default this is set to Restricted, and Kubernetes related traffic is still forwarded appropriately, but other
IP traffic will not be routed by the OCP node. If there is a desire to allow the host to forward traffic across
OVN-Kubernetes managed interfaces, then set this field to "Global".
@@ -720,7 +768,7 @@ configuration is used. Check individual members fields within ipv6 for details o
| `routingViaHost`
| `boolean`
| RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port
| routingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port
into the host before sending it out. If this is not set, traffic will always egress directly
from OVN to outside without touching the host stack. Setting this to true means hardware
offload will not be supported. Default is false if GatewayConfig is specified.
@@ -792,7 +840,7 @@ Note that IPV6 dual addresses are not permitted
Description::
+
--
HybridOverlayConfig configures an additional overlay network for peers that are
hybridOverlayConfig configures an additional overlay network for peers that are
not using OVN.
--
@@ -808,7 +856,7 @@ Type::
| `hybridClusterNetwork`
| `array`
| HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
| hybridClusterNetwork defines a network space given to nodes on an additional overlay network.
| `hybridClusterNetwork[]`
| `object`
@@ -819,7 +867,7 @@ Not all network providers support multiple ClusterNetworks
| `hybridOverlayVXLANPort`
| `integer`
| HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network.
| hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network.
Default is 4789
|===
@@ -827,7 +875,7 @@ Default is 4789
Description::
+
--
HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
hybridClusterNetwork defines a network space given to nodes on an additional overlay network.
--
Type::
@@ -883,6 +931,12 @@ Type::
|===
| Property | Type | Description
| `full`
| `object`
| full defines configuration parameters for the IPsec `Full` mode.
This is permitted only when mode is configured with `Full`,
and forbidden otherwise.
| `mode`
| `string`
| mode defines the behaviour of the ipsec configuration within the platform.
@@ -894,6 +948,37 @@ When 'Full', ipsec is configured on the node level and inter-pod secure communic
Note with `Full`, if ipsec is desired for communication with external (to the cluster) entities (such as storage arrays),
this is left to the user to configure.
|===
=== .spec.defaultNetwork.ovnKubernetesConfig.ipsecConfig.full
Description::
+
--
full defines configuration parameters for the IPsec `Full` mode.
This is permitted only when mode is configured with `Full`,
and forbidden otherwise.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `encapsulation`
| `string`
| encapsulation option to configure libreswan on how inter-pod traffic across nodes
are encapsulated to handle NAT traversal. When configured it uses UDP port 4500
for the encapsulation.
Valid values are Always, Auto and omitted.
Always means enable UDP encapsulation regardless of whether NAT is detected.
Auto means enable UDP encapsulation based on the detection of NAT.
When omitted, this means no opinion and the platform is left to choose a reasonable
default, which is subject to change over time. The current default is Auto.
|===
=== .spec.defaultNetwork.ovnKubernetesConfig.ipv4
Description::
@@ -967,7 +1052,7 @@ any other subnet being used by OpenShift or by the node network. The size of the
subnet must be larger than the number of nodes. The value cannot be changed
after installation.
The subnet must be large enough to accomadate one IP per node in your cluster
The current default value is fd98::/48
The current default value is fd98::/64
The value must be in proper IPV6 CIDR format
Note that IPV6 dual addresses are not permitted

10
rest_api/operator_apis/operator-apis-index.adoc
View File

@@ -25,8 +25,9 @@ Type::
Description::
+
--
CloudCredential provides a means to configure an operator to manage CredentialsRequests.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
CloudCredential provides a means to configure an operator to manage CredentialsRequests.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
Type::
@@ -368,8 +369,9 @@ Type::
Description::
+
--
ServiceCA provides information to configure an operator to manage the service cert controllers
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
ServiceCA provides information to configure an operator to manage the service cert controllers
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
Type::

48
rest_api/operator_apis/serviceca-operator-openshift-io-v1.adoc
View File

@@ -11,8 +11,9 @@ toc::[]
Description::
+
--
ServiceCA provides information to configure an operator to manage the service cert controllers
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
ServiceCA provides information to configure an operator to manage the service cert controllers
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--
Type::
@@ -68,8 +69,11 @@ Type::
| `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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
| 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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll".
Defaults to "Normal".
| `managementState`
| `string`
@@ -77,16 +81,24 @@ Type::
| `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
| 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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
| 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.
Valid values are: "Normal", "Debug", "Trace", "TraceAll".
Defaults to "Normal".
| `unsupportedConfigOverrides`
| ``
| unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.
| unsupportedConfigOverrides overrides the final configuration that was computed by the operator.
Red Hat does not support the use of this field.
Misuse of this field could lead to unexpected behavior or conflict with other configuration options.
Seek guidance from the Red Hat support before using this field.
Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.
|===
=== .status
@@ -122,6 +134,10 @@ Type::
| `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
| `observedGeneration`
| `integer`
| observedGeneration is the last generation change you've dealt with
@@ -158,6 +174,10 @@ OperatorCondition is just the standard condition fields.
Type::
`object`
Required::
- `lastTransitionTime`
- `status`
- `type`
@@ -167,7 +187,8 @@ Type::
| `lastTransitionTime`
| `string`
|
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
| `message`
| `string`
@@ -179,11 +200,11 @@ Type::
| `status`
| `string`
|
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
|
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
=== .status.generations
@@ -209,6 +230,11 @@ GenerationStatus keeps track of the generation for a given resource so that deci
Type::
`object`
Required::
- `group`
- `name`
- `namespace`
- `resource`

2
rest_api/operator_apis/storage-operator-openshift-io-v1.adoc
View File

@@ -102,7 +102,7 @@ Use of this property blocks cluster upgrades, it must be removed before upgradin
| `vsphereStorageDriver`
| `string`
| VSphereStorageDriver indicates the storage driver to use on VSphere clusters.
| vsphereStorageDriver indicates the storage driver to use on VSphere clusters.
Once this field is set to CSIWithMigrationDriver, it can not be changed.
If this is empty, the platform will choose a good default,
which may change over time without notice.

2
rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc
View File

@@ -201,7 +201,7 @@ will be configured as if `restricted` was specified. Otherwise, it will be confi
specified. Specifying a value other than `legacy` or `restricted` result in a validation error. When using older
catalog images, which can not run in `restricted` mode, the SecurityContextConfig should be set to `legacy`.
More information about PSA can be found here: https://kubernetes.io/docs/concepts/security/pod-security-admission/'
More information about PSA can be found here: https://kubernetes.io/docs/concepts/security/pod-security-admission/
| `tolerations`
| `array`

840
rest_api/operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc Normal file
View File

@@ -0,0 +1,840 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="clustercatalog-olm-operatorframework-io-v1"]
= ClusterCatalog [olm.operatorframework.io/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster.
For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
--
Type::
`object`
Required::
- `metadata`
- `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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| spec is the desired state of the ClusterCatalog.
spec is required.
The controller will work to ensure that the desired
catalog is unpacked and served over the catalog content HTTP server.
| `status`
| `object`
| status contains information about the state of the ClusterCatalog such as:
- Whether or not the catalog contents are being served via the catalog content HTTP server
- Whether or not the ClusterCatalog is progressing to a new state
- A reference to the source from which the catalog contents were retrieved
|===
=== .spec
Description::
+
--
spec is the desired state of the ClusterCatalog.
spec is required.
The controller will work to ensure that the desired
catalog is unpacked and served over the catalog content HTTP server.
--
Type::
`object`
Required::
- `source`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `availabilityMode`
| `string`
| availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster.
availabilityMode is optional.
Allowed values are "Available" and "Unavailable" and omitted.
When omitted, the default value is "Available".
When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server.
Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog
and its contents as usable.
When set to "Unavailable", the catalog contents will no longer be served over the catalog content HTTP server.
When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing.
Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want
to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist.
| `priority`
| `integer`
| priority allows the user to define a priority for a ClusterCatalog.
priority is optional.
A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements.
A higher number means higher priority.
It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements.
When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input.
When omitted, the default priority is 0 because that is the zero value of integers.
Negative numbers can be used to specify a priority lower than the default.
Positive numbers can be used to specify a priority higher than the default.
The lowest possible value is -2147483648.
The highest possible value is 2147483647.
| `source`
| `object`
| source allows a user to define the source of a catalog.
A "catalog" contains information on content that can be installed on a cluster.
Providing a catalog source makes the contents of the catalog discoverable and usable by
other on-cluster components.
These on-cluster components may do a variety of things with this information, such as
presenting the content in a GUI dashboard or installing content from the catalog on the cluster.
The catalog source must contain catalog metadata in the File-Based Catalog (FBC) format.
For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs.
source is a required field.
Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image:
source:
type: Image
image:
ref: quay.io/operatorhubio/catalog:latest
|===
=== .spec.source
Description::
+
--
source allows a user to define the source of a catalog.
A "catalog" contains information on content that can be installed on a cluster.
Providing a catalog source makes the contents of the catalog discoverable and usable by
other on-cluster components.
These on-cluster components may do a variety of things with this information, such as
presenting the content in a GUI dashboard or installing content from the catalog on the cluster.
The catalog source must contain catalog metadata in the File-Based Catalog (FBC) format.
For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs.
source is a required field.
Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image:
source:
type: Image
image:
ref: quay.io/operatorhubio/catalog:latest
--
Type::
`object`
Required::
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `image`
| `object`
| image is used to configure how catalog contents are sourced from an OCI image.
This field is required when type is Image, and forbidden otherwise.
| `type`
| `string`
| type is a reference to the type of source the catalog is sourced from.
type is required.
The only allowed value is "Image".
When set to "Image", the ClusterCatalog content will be sourced from an OCI image.
When using an image source, the image field must be set and must be the only field defined for this type.
|===
=== .spec.source.image
Description::
+
--
image is used to configure how catalog contents are sourced from an OCI image.
This field is required when type is Image, and forbidden otherwise.
--
Type::
`object`
Required::
- `ref`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `pollIntervalMinutes`
| `integer`
| pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content.
pollIntervalMinutes is optional.
pollIntervalMinutes can not be specified when ref is a digest-based reference.
When omitted, the image will not be polled for new content.
| `ref`
| `string`
| ref allows users to define the reference to a container image containing Catalog contents.
ref is required.
ref can not be more than 1000 characters.
A reference can be broken down into 3 parts - the domain, name, and identifier.
The domain is typically the registry where an image is located.
It must be alphanumeric characters (lowercase and uppercase) separated by the "." character.
Hyphenation is allowed, but the domain must start and end with alphanumeric characters.
Specifying a port to use is also allowed by adding the ":" character followed by numeric values.
The port must be the last value in the domain.
Some examples of valid domain values are "registry.mydomain.io", "quay.io", "my-registry.io:8080".
The name is typically the repository in the registry where an image is located.
It must contain lowercase alphanumeric characters separated only by the ".", "_", "__", "-" characters.
Multiple names can be concatenated with the "/" character.
The domain and name are combined using the "/" character.
Some examples of valid name values are "operatorhubio/catalog", "catalog", "my-catalog.prod".
An example of the domain and name parts of a reference being combined is "quay.io/operatorhubio/catalog".
The identifier is typically the tag or digest for an image reference and is present at the end of the reference.
It starts with a separator character used to distinguish the end of the name and beginning of the identifier.
For a digest-based reference, the "@" character is the separator.
For a tag-based reference, the ":" character is the separator.
An identifier is required in the reference.
Digest-based references must contain an algorithm reference immediately after the "@" separator.
The algorithm reference must be followed by the ":" character and an encoded string.
The algorithm must start with an uppercase or lowercase alpha character followed by alphanumeric characters and may contain the "-", "_", "+", and "." characters.
Some examples of valid algorithm values are "sha256", "sha256+b64u", "multihash+base58".
The encoded string following the algorithm must be hex digits (a-f, A-F, 0-9) and must be a minimum of 32 characters.
Tag-based references must begin with a word character (alphanumeric + "_") followed by word characters or ".", and "-" characters.
The tag must not be longer than 127 characters.
An example of a valid digest-based image reference is "quay.io/operatorhubio/catalog@sha256:200d4ddb2a73594b91358fe6397424e975205bfbe44614f5846033cad64b3f05"
An example of a valid tag-based image reference is "quay.io/operatorhubio/catalog:latest"
|===
=== .status
Description::
+
--
status contains information about the state of the ClusterCatalog such as:
- Whether or not the catalog contents are being served via the catalog content HTTP server
- Whether or not the ClusterCatalog is progressing to a new state
- A reference to the source from which the catalog contents were retrieved
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `conditions`
| `array`
| conditions is a representation of the current state for this ClusterCatalog.
The current condition types are Serving and Progressing.
The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server.
When it has a status of True and a reason of Available, the contents of the catalog are being served.
When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available.
When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable.
The Progressing condition is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state.
When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts.
When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing.
When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery.
In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched
catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog
contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes
to the contents we identify that there are updates to the contents.
| `conditions[]`
| `object`
| Condition contains details for one aspect of the current state of this API Resource.
| `lastUnpacked`
| `string`
| lastUnpacked represents the last time the contents of the
catalog were extracted from their source format. As an example,
when using an Image source, the OCI image will be pulled and the
image layers written to a file-system backed cache. We refer to the
act of this extraction from the source format as "unpacking".
| `resolvedSource`
| `object`
| resolvedSource contains information about the resolved source based on the source type.
| `urls`
| `object`
| urls contains the URLs that can be used to access the catalog.
|===
=== .status.conditions
Description::
+
--
conditions is a representation of the current state for this ClusterCatalog.
The current condition types are Serving and Progressing.
The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server.
When it has a status of True and a reason of Available, the contents of the catalog are being served.
When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available.
When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable.
The Progressing condition is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state.
When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts.
When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing.
When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery.
In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched
catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog
contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes
to the contents we identify that there are updates to the contents.
--
Type::
`array`
=== .status.conditions[]
Description::
+
--
Condition contains details for one aspect of the current state of this API Resource.
--
Type::
`object`
Required::
- `lastTransitionTime`
- `message`
- `reason`
- `status`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `lastTransitionTime`
| `string`
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
| `message`
| `string`
| message is a human readable message indicating details about the transition.
This may be an empty string.
| `observedGeneration`
| `integer`
| observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
| `reason`
| `string`
| reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
| `status`
| `string`
| status of the condition, one of True, False, Unknown.
| `type`
| `string`
| type of condition in CamelCase or in foo.example.com/CamelCase.
|===
=== .status.resolvedSource
Description::
+
--
resolvedSource contains information about the resolved source based on the source type.
--
Type::
`object`
Required::
- `image`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `image`
| `object`
| image is a field containing resolution information for a catalog sourced from an image.
This field must be set when type is Image, and forbidden otherwise.
| `type`
| `string`
| type is a reference to the type of source the catalog is sourced from.
type is required.
The only allowed value is "Image".
When set to "Image", information about the resolved image source will be set in the 'image' field.
|===
=== .status.resolvedSource.image
Description::
+
--
image is a field containing resolution information for a catalog sourced from an image.
This field must be set when type is Image, and forbidden otherwise.
--
Type::
`object`
Required::
- `ref`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `ref`
| `string`
| ref contains the resolved image digest-based reference.
The digest format is used so users can use other tooling to fetch the exact
OCI manifests that were used to extract the catalog contents.
|===
=== .status.urls
Description::
+
--
urls contains the URLs that can be used to access the catalog.
--
Type::
`object`
Required::
- `base`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `base`
| `string`
| base is a cluster-internal URL that provides endpoints for
accessing the content of the catalog.
It is expected that clients append the path for the endpoint they wish
to access.
Currently, only a single endpoint is served and is accessible at the path
/api/v1.
The endpoints served for the v1 API are:
- /all - this endpoint returns the entirety of the catalog contents in the FBC format
As the needs of users and clients of the evolve, new endpoints may be added.
|===
== API endpoints
The following API endpoints are available:
* `/apis/olm.operatorframework.io/v1/clustercatalogs`
- `DELETE`: delete collection of ClusterCatalog
- `GET`: list objects of kind ClusterCatalog
- `POST`: create a ClusterCatalog
* `/apis/olm.operatorframework.io/v1/clustercatalogs/{name}`
- `DELETE`: delete a ClusterCatalog
- `GET`: read the specified ClusterCatalog
- `PATCH`: partially update the specified ClusterCatalog
- `PUT`: replace the specified ClusterCatalog
* `/apis/olm.operatorframework.io/v1/clustercatalogs/{name}/status`
- `GET`: read status of the specified ClusterCatalog
- `PATCH`: partially update status of the specified ClusterCatalog
- `PUT`: replace status of the specified ClusterCatalog
=== /apis/olm.operatorframework.io/v1/clustercatalogs
HTTP method::
`DELETE`
Description::
delete collection of ClusterCatalog
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind ClusterCatalog
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-operatorframework-olm-v1-ClusterCatalogList[`ClusterCatalogList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a ClusterCatalog
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 201 - Created
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 202 - Accepted
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/olm.operatorframework.io/v1/clustercatalogs/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ClusterCatalog
|===
HTTP method::
`DELETE`
Description::
delete a ClusterCatalog
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified ClusterCatalog
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified ClusterCatalog
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified ClusterCatalog
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 201 - Created
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/olm.operatorframework.io/v1/clustercatalogs/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ClusterCatalog
|===
HTTP method::
`GET`
Description::
read status of the specified ClusterCatalog
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified ClusterCatalog
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified ClusterCatalog
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 201 - Created
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema
| 401 - Unauthorized
| Empty
|===

1118
rest_api/operatorhub_apis/clusterextension-olm-operatorframework-io-v1.adoc Normal file
View File

File diff suppressed because it is too large Load Diff

490
rest_api/operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc
View File

File diff suppressed because it is too large Load Diff

23
rest_api/operatorhub_apis/operatorhub-apis-index.adoc
View File

@@ -15,6 +15,29 @@ Description::
CatalogSource is a repository of CSVs, CRDs, and operator packages.
--
Type::
`object`
== ClusterCatalog [olm.operatorframework.io/v1]
Description::
+
--
ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster.
For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
--
Type::
`object`
== ClusterExtension [olm.operatorframework.io/v1]
Description::
+
--
ClusterExtension is the Schema for the clusterextensions API
--
Type::
`object`

80
rest_api/operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc
View File

@@ -2589,23 +2589,32 @@ Required::
| `object`
| awsElasticBlockStore represents an AWS Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
| `azureDisk`
| `object`
| azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
are redirected to the disk.csi.azure.com CSI driver.
| `azureFile`
| `object`
| azureFile represents an Azure File Service mount on the host and bind mount to the pod.
Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
are redirected to the file.csi.azure.com CSI driver.
| `cephfs`
| `object`
| cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
| cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
| `cinder`
| `object`
| cinder represents a cinder volume attached and mounted on kubelets host machine.
Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
are redirected to the cinder.csi.openstack.org CSI driver.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md
| `configMap`
@@ -2614,7 +2623,7 @@ More info: https://examples.k8s.io/mysql-cinder-pd/README.md
| `csi`
| `object`
| csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
| csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
| `downwardAPI`
| `object`
@@ -2660,27 +2669,32 @@ persistent volumes at the same time.
| `object`
| flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
| `flocker`
| `object`
| flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
| flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
| `gcePersistentDisk`
| `object`
| gcePersistentDisk represents a GCE Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
| `gitRepo`
| `object`
| gitRepo represents a git repository at a particular revision.
DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
into the Pod's container.
| `glusterfs`
| `object`
| glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
More info: https://examples.k8s.io/volumes/glusterfs/README.md
| `hostPath`
@@ -2733,11 +2747,15 @@ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persis
| `photonPersistentDisk`
| `object`
| photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
| photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
| `portworxVolume`
| `object`
| portworxVolume represents a portworx volume attached and mounted on kubelets host machine
| portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
is on.
| `projected`
| `object`
@@ -2745,16 +2763,19 @@ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persis
| `quobyte`
| `object`
| quobyte represents a Quobyte mount on the host that shares a pod's lifetime
| quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
| `rbd`
| `object`
| rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
More info: https://examples.k8s.io/volumes/rbd/README.md
| `scaleIO`
| `object`
| scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
| `secret`
| `object`
@@ -2764,10 +2785,13 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
| `storageos`
| `object`
| storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
| `vsphereVolume`
| `object`
| vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
| vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
are redirected to the csi.vsphere.vmware.com CSI driver.
|===
=== .spec.config.volumes[].awsElasticBlockStore
@@ -2776,6 +2800,8 @@ Description::
--
awsElasticBlockStore represents an AWS Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
--
@@ -2821,6 +2847,8 @@ Description::
+
--
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
are redirected to the disk.csi.azure.com CSI driver.
--
Type::
@@ -2869,6 +2897,8 @@ Description::
+
--
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
are redirected to the file.csi.azure.com CSI driver.
--
Type::
@@ -2902,7 +2932,8 @@ the ReadOnly setting in VolumeMounts.
Description::
+
--
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
--
Type::
@@ -2980,6 +3011,8 @@ Description::
+
--
cinder represents a cinder volume attached and mounted on kubelets host machine.
Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
are redirected to the cinder.csi.openstack.org CSI driver.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md
--
@@ -3164,7 +3197,7 @@ May not start with the string '..'.
Description::
+
--
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
--
Type::
@@ -3935,6 +3968,7 @@ Description::
--
flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
--
Type::
@@ -4011,7 +4045,8 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
Description::
+
--
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
--
Type::
@@ -4040,6 +4075,8 @@ Description::
--
gcePersistentDisk represents a GCE Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
--
@@ -4087,7 +4124,7 @@ Description::
+
--
gitRepo represents a git repository at a particular revision.
DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
into the Pod's container.
--
@@ -4125,6 +4162,7 @@ Description::
+
--
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
More info: https://examples.k8s.io/volumes/glusterfs/README.md
--
@@ -4419,7 +4457,8 @@ Default false.
Description::
+
--
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
--
Type::
@@ -4449,7 +4488,10 @@ Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
Description::
+
--
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
is on.
--
Type::
@@ -5126,7 +5168,8 @@ token into.
Description::
+
--
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
--
Type::
@@ -5178,6 +5221,7 @@ Description::
+
--
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
More info: https://examples.k8s.io/volumes/rbd/README.md
--
@@ -5277,6 +5321,7 @@ Description::
+
--
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
--
Type::
@@ -5485,6 +5530,7 @@ Description::
+
--
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
--
Type::
@@ -5559,7 +5605,9 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
Description::
+
--
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
are redirected to the csi.vsphere.vmware.com CSI driver.
--
Type::

28
rest_api/overview/index.adoc
View File

@@ -60,8 +60,12 @@
| cloud.network.openshift.io/v1
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[ClusterAutoscaler]
| autoscaling.openshift.io/v1
| xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[ClusterCatalog]
| olm.operatorframework.io/v1
| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[ClusterCSIDriver]
| operator.openshift.io/v1
| xref:../operatorhub_apis/clusterextension-olm-operatorframework-io-v1.adoc#clusterextension-olm-operatorframework-io-v1[ClusterExtension]
| olm.operatorframework.io/v1
| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[ClusterOperator]
| config.openshift.io/v1
| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[ClusterResourceQuota]
@@ -76,6 +80,8 @@
| rbac.authorization.k8s.io/v1
| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[ClusterServiceVersion]
| operators.coreos.com/v1alpha1
| xref:../network_apis/clusteruserdefinednetwork-k8s-ovn-org-v1.adoc#clusteruserdefinednetwork-k8s-ovn-org-v1[ClusterUserDefinedNetwork]
| k8s.ovn.org/v1
| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[ClusterVersion]
| config.openshift.io/v1
| xref:../metadata_apis/componentstatus-v1.adoc#componentstatus-v1[ComponentStatus]
@@ -178,8 +184,14 @@
| metal3.io/v1alpha1
| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1[FlowSchema]
| flowcontrol.apiserver.k8s.io/v1
| xref:../network_apis/gateway-gateway-networking-k8s-io-v1.adoc#gateway-gateway-networking-k8s-io-v1[Gateway]
| gateway.networking.k8s.io/v1
| xref:../network_apis/gatewayclass-gateway-networking-k8s-io-v1.adoc#gatewayclass-gateway-networking-k8s-io-v1[GatewayClass]
| gateway.networking.k8s.io/v1
| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[Group]
| user.openshift.io/v1
| xref:../network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc#grpcroute-gateway-networking-k8s-io-v1[GRPCRoute]
| gateway.networking.k8s.io/v1
| xref:../provisioning_apis/hardwaredata-metal3-io-v1alpha1.adoc#hardwaredata-metal3-io-v1alpha1[HardwareData]
| metal3.io/v1alpha1
| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[HelmChartRepository]
@@ -190,6 +202,10 @@
| metal3.io/v1alpha1
| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[HostFirmwareSettings]
| metal3.io/v1alpha1
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[HostUpdatePolicy]
| metal3.io/v1alpha1
| xref:../network_apis/httproute-gateway-networking-k8s-io-v1.adoc#httproute-gateway-networking-k8s-io-v1[HTTPRoute]
| gateway.networking.k8s.io/v1
| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[Identity]
| user.openshift.io/v1
| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[Image]
@@ -240,6 +256,8 @@
| ipam.cluster.x-k8s.io/v1beta1
| xref:../cluster_apis/ipaddressclaim-ipam-cluster-x-k8s-io-v1beta1.adoc#ipaddressclaim-ipam-cluster-x-k8s-io-v1beta1[IPAddressClaim]
| ipam.cluster.x-k8s.io/v1beta1
| xref:../network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc#ipamclaim-k8s-cni-cncf-io-v1alpha1[IPAMClaim]
| k8s.cni.cncf.io/v1alpha1
| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[IPPool]
| whereabouts.cni.cncf.io/v1alpha1
| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[Job]
@@ -276,6 +294,10 @@
| operator.openshift.io/v1
| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[MachineHealthCheck]
| machine.openshift.io/v1beta1
| xref:../machine_apis/machineosbuild-machineconfiguration-openshift-io-v1.adoc#machineosbuild-machineconfiguration-openshift-io-v1[MachineOSBuild]
| machineconfiguration.openshift.io/v1
| xref:../machine_apis/machineosconfig-machineconfiguration-openshift-io-v1.adoc#machineosconfig-machineconfiguration-openshift-io-v1[MachineOSConfig]
| machineconfiguration.openshift.io/v1
| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[MachineSet]
| machine.openshift.io/v1beta1
| xref:../provisioning_apis/metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1.adoc#metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1[Metal3Remediation]
@@ -302,6 +324,8 @@
| config.openshift.io/v1
| xref:../monitoring_apis/nodemetrics-metrics-k8s-io-v1beta1.adoc#nodemetrics-metrics-k8s-io-v1beta1[NodeMetrics]
| metrics.k8s.io/v1beta1
| xref:../network_apis/nodeslicepool-whereabouts-cni-cncf-io-v1alpha1.adoc#nodeslicepool-whereabouts-cni-cncf-io-v1alpha1[NodeSlicePool]
| whereabouts.cni.cncf.io/v1alpha1
| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[OAuth]
| config.openshift.io/v1
| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[OAuthAccessToken]
@@ -384,6 +408,8 @@
| config.openshift.io/v1
| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[RangeAllocation]
| security.openshift.io/v1
| xref:../network_apis/referencegrant-gateway-networking-k8s-io-v1beta1.adoc#referencegrant-gateway-networking-k8s-io-v1beta1[ReferenceGrant]
| gateway.networking.k8s.io/v1beta1
| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[ReplicaSet]
| apps/v1
| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[ReplicationController]
@@ -464,6 +490,8 @@
| tuned.openshift.io/v1
| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[User]
| user.openshift.io/v1
| xref:../network_apis/userdefinednetwork-k8s-ovn-org-v1.adoc#userdefinednetwork-k8s-ovn-org-v1[UserDefinedNetwork]
| k8s.ovn.org/v1
| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[UserIdentityMapping]
| user.openshift.io/v1
| xref:../oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc#useroauthaccesstoken-oauth-openshift-io-v1[UserOAuthAccessToken]

2
rest_api/project_apis/project-project-openshift-io-v1.adoc
View File

@@ -92,7 +92,7 @@ Type::
| Property | Type | Description
| `conditions`
| xref:../objects/index.adoc#io-k8s-api-core-v1-NamespaceCondition[`array (NamespaceCondition)`]
| xref:../objects/index.adoc#io-k8s-api-core-v1-NamespaceCondition_v2[`array (NamespaceCondition_v2)`]
| Represents the latest available observations of the project current state.
| `phase`

5
rest_api/provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc
View File

@@ -111,6 +111,11 @@ field triggers provisioning.
| `string`
| Description is a human-entered text used to help identify the host.
| `disablePowerOff`
| `boolean`
| When set to true, power off of the node will be disabled,
instead, a reboot will be used in place of power on/off
| `externallyProvisioned`
| `boolean`
| ExternallyProvisioned means something else has provisioned the

343
rest_api/provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc Normal file
View File

@@ -0,0 +1,343 @@
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="hostupdatepolicy-metal3-io-v1alpha1"]
= HostUpdatePolicy [metal3.io/v1alpha1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
HostUpdatePolicy is the Schema for the hostupdatepolicy API.
--
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#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| HostUpdatePolicySpec defines the desired state of HostUpdatePolicy.
| `status`
| `object`
| HostUpdatePolicyStatus defines the observed state of HostUpdatePolicy.
|===
=== .spec
Description::
+
--
HostUpdatePolicySpec defines the desired state of HostUpdatePolicy.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `firmwareSettings`
| `string`
| Defines policy for changing firmware settings
| `firmwareUpdates`
| `string`
| Defines policy for updating firmware
|===
=== .status
Description::
+
--
HostUpdatePolicyStatus defines the observed state of HostUpdatePolicy.
--
Type::
`object`
== API endpoints
The following API endpoints are available:
* `/apis/metal3.io/v1alpha1/hostupdatepolicies`
- `GET`: list objects of kind HostUpdatePolicy
* `/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies`
- `DELETE`: delete collection of HostUpdatePolicy
- `GET`: list objects of kind HostUpdatePolicy
- `POST`: create a HostUpdatePolicy
* `/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies/{name}`
- `DELETE`: delete a HostUpdatePolicy
- `GET`: read the specified HostUpdatePolicy
- `PATCH`: partially update the specified HostUpdatePolicy
- `PUT`: replace the specified HostUpdatePolicy
=== /apis/metal3.io/v1alpha1/hostupdatepolicies
HTTP method::
`GET`
Description::
list objects of kind HostUpdatePolicy
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-metal3-v1alpha1-HostUpdatePolicyList[`HostUpdatePolicyList`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies
HTTP method::
`DELETE`
Description::
delete collection of HostUpdatePolicy
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind HostUpdatePolicy
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-metal3-v1alpha1-HostUpdatePolicyList[`HostUpdatePolicyList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a HostUpdatePolicy
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
| 201 - Created
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
| 202 - Accepted
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostupdatepolicies/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the HostUpdatePolicy
|===
HTTP method::
`DELETE`
Description::
delete a HostUpdatePolicy
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified HostUpdatePolicy
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified HostUpdatePolicy
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified HostUpdatePolicy
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
| 201 - Created
| xref:../provisioning_apis/hostupdatepolicy-metal3-io-v1alpha1.adoc#hostupdatepolicy-metal3-io-v1alpha1[`HostUpdatePolicy`] schema
| 401 - Unauthorized
| Empty
|===

11
rest_api/provisioning_apis/provisioning-apis-index.adoc
View File

@@ -81,6 +81,17 @@ Description::
HostFirmwareSettings is the Schema for the hostfirmwaresettings API.
--
Type::
`object`
== HostUpdatePolicy [metal3.io/v1alpha1]
Description::
+
--
HostUpdatePolicy is the Schema for the hostupdatepolicy API.
--
Type::
`object`

10
rest_api/role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc
View File

@@ -45,14 +45,14 @@ Type::
| `spec`
| `object`
| Spec defines the matcher.
| spec defines the matcher.
|===
=== .spec
Description::
+
--
Spec defines the matcher.
spec defines the matcher.
--
Type::
@@ -67,15 +67,15 @@ Type::
| `grouprestriction`
| ``
| GroupRestriction matches against group subjects.
| grouprestriction matches against group subjects.
| `serviceaccountrestriction`
| ``
| ServiceAccountRestriction matches against service-account subjects.
| serviceaccountrestriction matches against service-account subjects.
| `userrestriction`
| ``
| UserRestriction matches against user subjects.
| userrestriction matches against user subjects.
|===

22
rest_api/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc
View File

@@ -45,18 +45,18 @@ Required::
| `spec`
| `object`
| Spec defines the desired quota
| spec defines the desired quota
| `status`
| `object`
| Status defines the actual enforced quota and its current usage
| status defines the actual enforced quota and its current usage
|===
=== .spec
Description::
+
--
Spec defines the desired quota
spec defines the desired quota
--
Type::
@@ -74,11 +74,11 @@ Required::
| `quota`
| `object`
| Quota defines the desired quota
| quota defines the desired quota
| `selector`
| `object`
| Selector is the selector used to match projects.
| selector is the selector used to match projects.
It should only select active projects on the scale of dozens (though it can select
many more less active projects). These projects will contend on object creation through
this resource.
@@ -88,7 +88,7 @@ this resource.
Description::
+
--
Quota defines the desired quota
quota defines the desired quota
--
Type::
@@ -202,7 +202,7 @@ This array is replaced during a strategic merge patch.
Description::
+
--
Selector is the selector used to match projects.
selector is the selector used to match projects.
It should only select active projects on the scale of dozens (though it can select
many more less active projects). These projects will contend on object creation through
this resource.
@@ -231,7 +231,7 @@ Type::
Description::
+
--
Status defines the actual enforced quota and its current usage
status defines the actual enforced quota and its current usage
--
Type::
@@ -248,20 +248,20 @@ Required::
| `namespaces`
| ``
| Namespaces slices the usage by project. This division allows for quick resolution of
| namespaces slices the usage by project. This division allows for quick resolution of
deletion reconciliation inside of a single project without requiring a recalculation
across all projects. This can be used to pull the deltas for a given project.
| `total`
| `object`
| Total defines the actual enforced quota and its current usage across all projects
| total defines the actual enforced quota and its current usage across all projects
|===
=== .status.total
Description::
+
--
Total defines the actual enforced quota and its current usage across all projects
total defines the actual enforced quota and its current usage across all projects
--
Type::

56
rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc
View File

@@ -42,55 +42,55 @@ Required::
| `allowHostDirVolumePlugin`
| `boolean`
| AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin
| allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin
| `allowHostIPC`
| `boolean`
| AllowHostIPC determines if the policy allows host ipc in the containers.
| allowHostIPC determines if the policy allows host ipc in the containers.
| `allowHostNetwork`
| `boolean`
| AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
| allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
| `allowHostPID`
| `boolean`
| AllowHostPID determines if the policy allows host pid in the containers.
| allowHostPID determines if the policy allows host pid in the containers.
| `allowHostPorts`
| `boolean`
| AllowHostPorts determines if the policy allows host ports in the containers.
| allowHostPorts determines if the policy allows host ports in the containers.
| `allowPrivilegeEscalation`
| ``
| AllowPrivilegeEscalation determines if a pod can request to allow
| allowPrivilegeEscalation determines if a pod can request to allow
privilege escalation. If unspecified, defaults to true.
| `allowPrivilegedContainer`
| `boolean`
| AllowPrivilegedContainer determines if a container can request to be run as privileged.
| allowPrivilegedContainer determines if a container can request to be run as privileged.
| `allowedCapabilities`
| ``
| AllowedCapabilities is a list of capabilities that can be requested to add to the container.
| allowedCapabilities is a list of capabilities that can be requested to add to the container.
Capabilities in this field maybe added at the pod author's discretion.
You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.
To allow all capabilities you may use '*'.
| `allowedFlexVolumes`
| ``
| AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all
| allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all
Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes
is allowed in the "Volumes" field.
| `allowedUnsafeSysctls`
| ``
| AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none.
Each entry is either a plain sysctl name or ends in "\*" in which case it is considered
| allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none.
Each entry is either a plain sysctl name or ends in "*" in which case it is considered
as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed.
Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection.
Examples:
e.g. "foo/\*" allows "foo/bar", "foo/baz", etc.
e.g. "foo/*" allows "foo/bar", "foo/baz", etc.
e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
| `apiVersion`
@@ -99,28 +99,28 @@ e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
| `defaultAddCapabilities`
| ``
| DefaultAddCapabilities is the default set of capabilities that will be added to the container
| defaultAddCapabilities is the default set of capabilities that will be added to the container
unless the pod spec specifically drops the capability. You may not list a capabiility in both
DefaultAddCapabilities and RequiredDropCapabilities.
| `defaultAllowPrivilegeEscalation`
| ``
| DefaultAllowPrivilegeEscalation controls the default setting for whether a
| defaultAllowPrivilegeEscalation controls the default setting for whether a
process can gain more privileges than its parent process.
| `forbiddenSysctls`
| ``
| ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none.
Each entry is either a plain sysctl name or ends in "\*" in which case it is considered
| forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none.
Each entry is either a plain sysctl name or ends in "*" in which case it is considered
as a prefix of forbidden sysctls. Single * means all sysctls are forbidden.
Examples:
e.g. "foo/\*" forbids "foo/bar", "foo/baz", etc.
e.g. "foo/*" forbids "foo/bar", "foo/baz", etc.
e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.
| `fsGroup`
| ``
| FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.
| fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.
| `groups`
| ``
@@ -136,7 +136,7 @@ e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.
| `priority`
| ``
| Priority influences the sort order of SCCs when evaluating which SCCs to try first for
| priority influences the sort order of SCCs when evaluating which SCCs to try first for
a given pod request based on access in the Users and Groups fields. The higher the int, the
higher priority. An unset value is considered a 0 priority. If scores
for multiple SCCs are equal they will be sorted from most restrictive to
@@ -145,7 +145,7 @@ SCCs will be sorted by name.
| `readOnlyRootFilesystem`
| `boolean`
| ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file
| readOnlyRootFilesystem when set to true will force containers to run with a read only root file
system. If the container specifically requests to run with a non-read only root file system
the SCC should deny the pod.
If set to false the container may run with a read only root file system if it wishes but it
@@ -153,20 +153,20 @@ will not be forced to.
| `requiredDropCapabilities`
| ``
| RequiredDropCapabilities are the capabilities that will be dropped from the container. These
| requiredDropCapabilities are the capabilities that will be dropped from the container. These
are required to be dropped and cannot be added.
| `runAsUser`
| ``
| RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.
| runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.
| `seLinuxContext`
| ``
| SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.
| seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.
| `seccompProfiles`
| ``
| SeccompProfiles lists the allowed profiles that may be set for the pod or
| seccompProfiles lists the allowed profiles that may be set for the pod or
container's seccomp annotations. An unset (nil) or empty value means that no profiles may
be specifid by the pod or container. The wildcard '*' may be used to allow all profiles. When
used to generate a value for a pod the first non-wildcard profile will be used as
@@ -174,7 +174,7 @@ the default.
| `supplementalGroups`
| ``
| SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
| supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
| `users`
| ``
@@ -182,7 +182,7 @@ the default.
| `volumes`
| ``
| Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names
| volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names
of a VolumeSource (azureFile, configMap, emptyDir). To allow all volumes you may use "*".
To allow no volumes, set to ["none"].
@@ -274,7 +274,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema
|
|
|===
.HTTP responses
@@ -429,7 +429,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema
|
|
|===
.HTTP responses

4
rest_api/security_apis/serviceaccount-v1.adoc
View File

@@ -51,7 +51,7 @@ Type::
| `secrets`
| `array`
| Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
| Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". The "kubernetes.io/enforce-mountable-secrets" annotation is deprecated since v1.32. Prefer separate namespaces to isolate access to mounted secrets. This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
| `secrets[]`
| `object`
@@ -97,7 +97,7 @@ Type::
Description::
+
--
Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". The "kubernetes.io/enforce-mountable-secrets" annotation is deprecated since v1.32. Prefer separate namespaces to isolate access to mounted secrets. This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
--
Type::

8
rest_api/storage_apis/persistentvolume-v1.adoc
View File

@@ -99,7 +99,7 @@ An AWS EBS disk must exist before mounting to a container. The disk must also be
| `csi`
| `object`
| Represents storage that is managed by an external CSI volume driver (Beta feature)
| Represents storage that is managed by an external CSI volume driver
| `fc`
| `object`
@@ -133,7 +133,7 @@ A GCE PD must exist before mounting to a container. The disk must also be in the
| `local`
| `object`
| Local represents directly-attached storage with node affinity (Beta feature)
| Local represents directly-attached storage with node affinity
| `mountOptions`
| `array (string)`
@@ -513,7 +513,7 @@ Type::
Description::
+
--
Represents storage that is managed by an external CSI volume driver (Beta feature)
Represents storage that is managed by an external CSI volume driver
--
Type::
@@ -1039,7 +1039,7 @@ Type::
Description::
+
--
Local represents directly-attached storage with node affinity (Beta feature)
Local represents directly-attached storage with node affinity
--
Type::

22
rest_api/storage_apis/persistentvolumeclaim-v1.adoc
View File

@@ -73,14 +73,7 @@ Type::
| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
| TypedObjectReference contains enough information to let you locate the typed referenced object
| `resources`
| `object`
@@ -148,14 +141,7 @@ Required::
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
TypedObjectReference contains enough information to let you locate the typed referenced object
--
Type::
@@ -363,11 +349,11 @@ Required::
| `status`
| `string`
|
| Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required
| `type`
| `string`
|
| Type is the type of the condition. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about
|===
=== .status.modifyVolumeStatus

4
rest_api/storage_apis/volumeattachment-storage-k8s-io-v1.adoc
View File

@@ -81,14 +81,14 @@ Required::
| `source`
| `object`
| VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.
| VolumeAttachmentSource represents a volume that should be attached. Right now only PersistentVolumes can be attached via external attacher, in the future we may allow also inline volumes in pods. Exactly one member can be set.
|===
=== .spec.source
Description::
+
--
VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.
VolumeAttachmentSource represents a volume that should be attached. Right now only PersistentVolumes can be attached via external attacher, in the future we may allow also inline volumes in pods. Exactly one member can be set.
--
Type::

161
rest_api/template_apis/podtemplate-v1.adoc
View File

@@ -233,6 +233,10 @@ This field is immutable.
It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.
| `resources`
| `object`
| ResourceRequirements describes the compute resource requirements.
| `restartPolicy`
| `string`
| Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
@@ -274,7 +278,7 @@ SchedulingGates can only be set at pod creation time, and be removed only afterw
| `setHostnameAsFQDN`
| `boolean`
| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
| `shareProcessNamespace`
| `boolean`
@@ -2011,7 +2015,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2068,7 +2072,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -2297,7 +2301,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2354,7 +2358,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -2885,7 +2889,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2942,7 +2946,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -3269,11 +3273,11 @@ Type::
| `name`
| `string`
| Required.
| Name is this DNS resolver option's name. Required.
| `value`
| `string`
|
| Value is this DNS resolver option's value.
|===
=== .template.spec.ephemeralContainers
@@ -4201,7 +4205,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -4258,7 +4262,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -4487,7 +4491,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -4544,7 +4548,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -5075,7 +5079,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -5132,7 +5136,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -6386,7 +6390,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -6443,7 +6447,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -6672,7 +6676,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -6729,7 +6733,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -7260,7 +7264,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -7317,7 +7321,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -7697,6 +7701,89 @@ This field is immutable and no changes will be made to the corresponding Resourc
Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
|===
=== .template.spec.resources
Description::
+
--
ResourceRequirements describes the compute resource requirements.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `claims`
| `array`
| Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
| `claims[]`
| `object`
| ResourceClaim references one entry in PodSpec.ResourceClaims.
| `limits`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| `requests`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|===
=== .template.spec.resources.claims
Description::
+
--
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
--
Type::
`array`
=== .template.spec.resources.claims[]
Description::
+
--
ResourceClaim references one entry in PodSpec.ResourceClaims.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
| `request`
| `string`
| Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
|===
=== .template.spec.schedulingGates
Description::
@@ -7786,6 +7873,20 @@ Possible enum values:
| `integer`
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
| `seLinuxChangePolicy`
| `string`
| seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
| `seLinuxOptions`
| `object`
| SELinuxOptions are the labels to be applied to the container
@@ -8957,14 +9058,7 @@ Type::
| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
| TypedObjectReference contains enough information to let you locate the typed referenced object
| `resources`
| `object`
@@ -9032,14 +9126,7 @@ Required::
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
TypedObjectReference contains enough information to let you locate the typed referenced object
--
Type::

2
rest_api/workloads_apis/cronjob-batch-v1.adoc
View File

@@ -185,7 +185,7 @@ Possible enum values:
| `string`
| ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable.
This field is alpha-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (disabled by default).
This field is beta-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (enabled by default).
| `manualSelector`
| `boolean`

2
rest_api/workloads_apis/job-batch-v1.adoc
View File

@@ -99,7 +99,7 @@ Possible enum values:
| `string`
| ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable.
This field is alpha-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (disabled by default).
This field is beta-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (enabled by default).
| `manualSelector`
| `boolean`

215
rest_api/workloads_apis/pod-v1.adoc
View File

@@ -211,6 +211,10 @@ This field is immutable.
It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.
| `resources`
| `object`
| ResourceRequirements describes the compute resource requirements.
| `restartPolicy`
| `string`
| Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
@@ -252,7 +256,7 @@ SchedulingGates can only be set at pod creation time, and be removed only afterw
| `setHostnameAsFQDN`
| `boolean`
| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
| `shareProcessNamespace`
| `boolean`
@@ -1989,7 +1993,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2046,7 +2050,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -2275,7 +2279,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2332,7 +2336,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -2863,7 +2867,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2920,7 +2924,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -3247,11 +3251,11 @@ Type::
| `name`
| `string`
| Required.
| Name is this DNS resolver option's name. Required.
| `value`
| `string`
|
| Value is this DNS resolver option's value.
|===
=== .spec.ephemeralContainers
@@ -4179,7 +4183,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -4236,7 +4240,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -4465,7 +4469,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -4522,7 +4526,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -5053,7 +5057,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -5110,7 +5114,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -6364,7 +6368,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -6421,7 +6425,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -6650,7 +6654,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -6707,7 +6711,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -7238,7 +7242,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -7295,7 +7299,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -7675,6 +7679,89 @@ This field is immutable and no changes will be made to the corresponding Resourc
Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
|===
=== .spec.resources
Description::
+
--
ResourceRequirements describes the compute resource requirements.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `claims`
| `array`
| Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
| `claims[]`
| `object`
| ResourceClaim references one entry in PodSpec.ResourceClaims.
| `limits`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| `requests`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|===
=== .spec.resources.claims
Description::
+
--
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
--
Type::
`array`
=== .spec.resources.claims[]
Description::
+
--
ResourceClaim references one entry in PodSpec.ResourceClaims.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
| `request`
| `string`
| Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
|===
=== .spec.schedulingGates
Description::
@@ -7764,6 +7851,20 @@ Possible enum values:
| `integer`
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
| `seLinuxChangePolicy`
| `string`
| seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
| `seLinuxOptions`
| `object`
| SELinuxOptions are the labels to be applied to the container
@@ -8935,14 +9036,7 @@ Type::
| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
| TypedObjectReference contains enough information to let you locate the typed referenced object
| `resources`
| `object`
@@ -9010,14 +9104,7 @@ Required::
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
TypedObjectReference contains enough information to let you locate the typed referenced object
--
Type::
@@ -10454,7 +10541,7 @@ Type::
| `containerStatuses`
| `array`
| The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
| Statuses of containers in this pod. Each container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
| `containerStatuses[]`
| `object`
@@ -10462,7 +10549,7 @@ Type::
| `ephemeralContainerStatuses`
| `array`
| Status for any ephemeral containers that have run in this pod.
| Statuses for any ephemeral containers that have run in this pod. Each ephemeral container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
| `ephemeralContainerStatuses[]`
| `object`
@@ -10482,7 +10569,7 @@ Type::
| `initContainerStatuses`
| `array`
| The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
| Statuses of init containers in this pod. The most recent successful non-restartable init container will have ready = true, the most recently started container will have startTime set. Each init container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-and-container-status
| `initContainerStatuses[]`
| `object`
@@ -10615,7 +10702,7 @@ Required::
Description::
+
--
The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
Statuses of containers in this pod. Each container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
--
Type::
@@ -10657,7 +10744,7 @@ Required::
| `allocatedResourcesStatus[]`
| `object`
|
| ResourceStatus represents the status of a single resource allocated to a Pod.
| `containerID`
| `string`
@@ -10731,7 +10818,7 @@ Type::
Description::
+
--
ResourceStatus represents the status of a single resource allocated to a Pod.
--
Type::
@@ -10748,22 +10835,22 @@ Required::
| `name`
| `string`
| Name of the resource. Must be unique within the pod and match one of the resources from the pod spec.
| Name of the resource. Must be unique within the pod and in case of non-DRA resource, match one of the resources from the pod spec. For DRA resources, the value must be "claim:<claim_name>/<request>". When this status is reported about a container, the "claim_name" and "request" must match one of the claims of this container.
| `resources`
| `array`
| List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
| List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases.
| `resources[]`
| `object`
| ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.
| ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.
|===
=== .status.containerStatuses[].allocatedResourcesStatus[].resources
Description::
+
--
List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases.
--
Type::
@@ -10776,7 +10863,7 @@ Type::
Description::
+
--
ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.
ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.
--
Type::
@@ -11252,7 +11339,7 @@ Required::
Description::
+
--
Status for any ephemeral containers that have run in this pod.
Statuses for any ephemeral containers that have run in this pod. Each ephemeral container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
--
Type::
@@ -11294,7 +11381,7 @@ Required::
| `allocatedResourcesStatus[]`
| `object`
|
| ResourceStatus represents the status of a single resource allocated to a Pod.
| `containerID`
| `string`
@@ -11368,7 +11455,7 @@ Type::
Description::
+
--
ResourceStatus represents the status of a single resource allocated to a Pod.
--
Type::
@@ -11385,22 +11472,22 @@ Required::
| `name`
| `string`
| Name of the resource. Must be unique within the pod and match one of the resources from the pod spec.
| Name of the resource. Must be unique within the pod and in case of non-DRA resource, match one of the resources from the pod spec. For DRA resources, the value must be "claim:<claim_name>/<request>". When this status is reported about a container, the "claim_name" and "request" must match one of the claims of this container.
| `resources`
| `array`
| List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
| List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases.
| `resources[]`
| `object`
| ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.
| ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.
|===
=== .status.ephemeralContainerStatuses[].allocatedResourcesStatus[].resources
Description::
+
--
List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases.
--
Type::
@@ -11413,7 +11500,7 @@ Type::
Description::
+
--
ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.
ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.
--
Type::
@@ -11926,7 +12013,7 @@ Required::
Description::
+
--
The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
Statuses of init containers in this pod. The most recent successful non-restartable init container will have ready = true, the most recently started container will have startTime set. Each init container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-and-container-status
--
Type::
@@ -11968,7 +12055,7 @@ Required::
| `allocatedResourcesStatus[]`
| `object`
|
| ResourceStatus represents the status of a single resource allocated to a Pod.
| `containerID`
| `string`
@@ -12042,7 +12129,7 @@ Type::
Description::
+
--
ResourceStatus represents the status of a single resource allocated to a Pod.
--
Type::
@@ -12059,22 +12146,22 @@ Required::
| `name`
| `string`
| Name of the resource. Must be unique within the pod and match one of the resources from the pod spec.
| Name of the resource. Must be unique within the pod and in case of non-DRA resource, match one of the resources from the pod spec. For DRA resources, the value must be "claim:<claim_name>/<request>". When this status is reported about a container, the "claim_name" and "request" must match one of the claims of this container.
| `resources`
| `array`
| List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
| List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases.
| `resources[]`
| `object`
| ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.
| ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.
|===
=== .status.initContainerStatuses[].allocatedResourcesStatus[].resources
Description::
+
--
List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases.
--
Type::
@@ -12087,7 +12174,7 @@ Type::
Description::
+
--
ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.
ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.
--
Type::

161
rest_api/workloads_apis/replicationcontroller-v1.adoc
View File

@@ -271,6 +271,10 @@ This field is immutable.
It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.
| `resources`
| `object`
| ResourceRequirements describes the compute resource requirements.
| `restartPolicy`
| `string`
| Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
@@ -312,7 +316,7 @@ SchedulingGates can only be set at pod creation time, and be removed only afterw
| `setHostnameAsFQDN`
| `boolean`
| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
| `shareProcessNamespace`
| `boolean`
@@ -2049,7 +2053,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2106,7 +2110,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -2335,7 +2339,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2392,7 +2396,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -2923,7 +2927,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -2980,7 +2984,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -3307,11 +3311,11 @@ Type::
| `name`
| `string`
| Required.
| Name is this DNS resolver option's name. Required.
| `value`
| `string`
|
| Value is this DNS resolver option's value.
|===
=== .spec.template.spec.ephemeralContainers
@@ -4239,7 +4243,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -4296,7 +4300,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -4525,7 +4529,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -4582,7 +4586,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -5113,7 +5117,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -5170,7 +5174,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -6424,7 +6428,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -6481,7 +6485,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -6710,7 +6714,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -6767,7 +6771,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -7298,7 +7302,7 @@ Type::
| `grpc`
| `object`
| GRPC specifies an action involving a GRPC port.
| GRPCAction specifies an action involving a GRPC service.
| `httpGet`
| `object`
@@ -7355,7 +7359,7 @@ Type::
Description::
+
--
GRPC specifies an action involving a GRPC port.
GRPCAction specifies an action involving a GRPC service.
--
Type::
@@ -7735,6 +7739,89 @@ This field is immutable and no changes will be made to the corresponding Resourc
Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
|===
=== .spec.template.spec.resources
Description::
+
--
ResourceRequirements describes the compute resource requirements.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `claims`
| `array`
| Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
| `claims[]`
| `object`
| ResourceClaim references one entry in PodSpec.ResourceClaims.
| `limits`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| `requests`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|===
=== .spec.template.spec.resources.claims
Description::
+
--
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
--
Type::
`array`
=== .spec.template.spec.resources.claims[]
Description::
+
--
ResourceClaim references one entry in PodSpec.ResourceClaims.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
| `request`
| `string`
| Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
|===
=== .spec.template.spec.schedulingGates
Description::
@@ -7824,6 +7911,20 @@ Possible enum values:
| `integer`
| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
| `seLinuxChangePolicy`
| `string`
| seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
| `seLinuxOptions`
| `object`
| SELinuxOptions are the labels to be applied to the container
@@ -8995,14 +9096,7 @@ Type::
| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
| TypedObjectReference contains enough information to let you locate the typed referenced object
| `resources`
| `object`
@@ -9070,14 +9164,7 @@ Required::
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
TypedObjectReference contains enough information to let you locate the typed referenced object
--
Type::