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

fixing api builds

Browse Source
This commit is contained in:
Kathryn Alexander
2025-02-12 10:59:35 -05:00
committed by openshift-cherrypick-robot
parent c5cbaf3ce3
commit 685f785853
9 changed files with 165 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -356,7 +356,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.
| `params{}`
| `array (string)`
|
|
| `path`
| `string`
@@ -382,7 +382,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
@@ -780,7 +780,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -1316,7 +1316,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 +1866,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 +1999,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema
|
|
|===
.HTTP responses

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

@@ -530,7 +530,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -1143,9 +1143,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 +1194,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 +1868,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 +2001,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema
|
|
|===
.HTTP responses

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

@@ -823,7 +823,7 @@ in a breaking way.
| `scrapeClasses[]`
| `object`
|
|
| `scrapeConfigNamespaceSelector`
| `object`
@@ -968,7 +968,7 @@ the triple <key,value,effect> using the matching operator <operator>.
| `topologySpreadConstraints[]`
| `object`
|
|
| `tracingConfig`
| `object`
@@ -4368,7 +4368,7 @@ Type::
| `deny`
| `boolean`
|
|
|===
=== .spec.containers
@@ -10201,7 +10201,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -10475,7 +10475,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -11484,7 +11484,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -11982,7 +11982,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -13541,7 +13541,7 @@ More info: https://prometheus.io/docs/prometheus/latest/configuration/configurat
| Relabelings configures the relabeling rules to apply to all scrape targets.
The Operator automatically adds relabelings for a few standard Kubernetes fields
like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.
like `\__meta_kubernetes_namespace` and `\__meta_kubernetes_service_name`.
Then the Operator adds the scrape class relabelings defined here.
Then the Operator adds the target-specific relabelings defined in the scrape object.
@@ -13683,7 +13683,7 @@ Description::
Relabelings configures the relabeling rules to apply to all scrape targets.
The Operator automatically adds relabelings for a few standard Kubernetes fields
like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.
like `\__meta_kubernetes_namespace` and `\__meta_kubernetes_service_name`.
Then the Operator adds the scrape class relabelings defined here.
Then the Operator adds the target-specific relabelings defined in the scrape object.
@@ -15850,7 +15850,7 @@ persistent volume is being resized.
| `status`
| `string`
|
|
| `type`
| `string`
@@ -20992,7 +20992,7 @@ being performed. Only delete actions will be performed.
| `shardStatuses[]`
| `object`
|
|
| `shards`
| `integer`
@@ -21246,7 +21246,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
|
|
|===
.HTTP responses
@@ -21379,7 +21379,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
|
|
|===
.HTTP responses
@@ -21481,7 +21481,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema
|
|
|===
.HTTP responses
@@ -21583,7 +21583,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema
|
|
|===
.HTTP responses

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

@@ -346,7 +346,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`.
| `params{}`
| `array (string)`
|
|
| `path`
| `string`
@@ -372,7 +372,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
@@ -768,7 +768,7 @@ It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0.
| `proxyConnectHeader{}`
| `array`
|
|
| `proxyConnectHeader{}[]`
| `object`
@@ -1304,7 +1304,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 +1894,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 +2027,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema
|
|
|===
.HTTP responses

230
rest_api/objects/index.adoc
View File

@@ -1339,7 +1339,7 @@ Required::
| `items`
| xref:../oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc#useroauthaccesstoken-oauth-openshift-io-v1[`array (UserOAuthAccessToken)`]
|
|
| `kind`
| `string`
@@ -1818,12 +1818,12 @@ Type::
| Property | Type | Description
| `owned`
| xref:../objects/index.adoc#com-github-operator-framework-api-pkg-operators-v1alpha1-APIServiceDescription[`array (APIServiceDescription)`]
|
| `array (APIServiceDescription)`
|
| `required`
| xref:../objects/index.adoc#com-github-operator-framework-api-pkg-operators-v1alpha1-APIServiceDescription[`array (APIServiceDescription)`]
|
| `array (APIServiceDescription)`
|
|===
@@ -1851,12 +1851,12 @@ Type::
| Property | Type | Description
| `owned`
| xref:../objects/index.adoc#com-github-operator-framework-api-pkg-operators-v1alpha1-CRDDescription[`array (CRDDescription)`]
|
| `array (CRDDescription)`
|
| `required`
| xref:../objects/index.adoc#com-github-operator-framework-api-pkg-operators-v1alpha1-CRDDescription[`array (CRDDescription)`]
|
| `array (CRDDescription)`
|
|===
@@ -1886,11 +1886,11 @@ Required::
| `supported`
| `boolean`
|
|
| `type`
| `string`
|
|
|===
@@ -1923,7 +1923,7 @@ Required::
| `items`
| xref:../operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc#packagemanifest-packages-operators-coreos-com-v1[`array (PackageManifest)`]
|
|
| `kind`
| `string`
@@ -1931,7 +1931,7 @@ Required::
| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ListMeta[`ListMeta`]
|
|
|===
@@ -2628,7 +2628,7 @@ Required::
| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ListMeta[`ListMeta`]
|
|
|===
@@ -2783,7 +2783,7 @@ Type::
| defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
| `items`
| xref:../objects/index.adoc#io-k8s-api-core-v1-KeyToPath[`array (KeyToPath)`]
| `array (KeyToPath)`
| items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
| `name`
@@ -2828,7 +2828,7 @@ Required::
| fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
| `nodePublishSecretRef`
| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference[`LocalObjectReference`]
| `LocalObjectReference`
| nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
| `readOnly`
@@ -2914,7 +2914,7 @@ Required::
| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
| `valueFrom`
| xref:../objects/index.adoc#io-k8s-api-core-v1-EnvVarSource[`EnvVarSource`]
| `EnvVarSource`
| Source for the environment variable's value. Cannot be used if value is not empty.
|===
@@ -3085,15 +3085,15 @@ Required::
| `lastTransitionTime`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Time[`Time`]
|
|
| `message`
| `string`
|
|
| `reason`
| `string`
|
|
| `status`
| `string`
@@ -3589,11 +3589,11 @@ Required::
| `status`
| `string`
|
|
| `type`
| `string`
|
|
|===
..status.modifyVolumeStatus
@@ -3746,15 +3746,15 @@ Type::
| accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
| `awsElasticBlockStore`
| xref:../objects/index.adoc#io-k8s-api-core-v1-AWSElasticBlockStoreVolumeSource[`AWSElasticBlockStoreVolumeSource`]
| `AWSElasticBlockStoreVolumeSource`
| awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
| `azureDisk`
| xref:../objects/index.adoc#io-k8s-api-core-v1-AzureDiskVolumeSource[`AzureDiskVolumeSource`]
| `AzureDiskVolumeSource`
| azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
| `azureFile`
| xref:../objects/index.adoc#io-k8s-api-core-v1-AzureFilePersistentVolumeSource[`AzureFilePersistentVolumeSource`]
| `AzureFilePersistentVolumeSource`
| azureFile represents an Azure File Service mount on the host and bind mount to the pod.
| `capacity`
@@ -3762,11 +3762,11 @@ Type::
| capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
| `cephfs`
| xref:../objects/index.adoc#io-k8s-api-core-v1-CephFSPersistentVolumeSource[`CephFSPersistentVolumeSource`]
| `CephFSPersistentVolumeSource`
| cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
| `cinder`
| xref:../objects/index.adoc#io-k8s-api-core-v1-CinderPersistentVolumeSource[`CinderPersistentVolumeSource`]
| `CinderPersistentVolumeSource`
| cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
| `claimRef`
@@ -3774,39 +3774,39 @@ Type::
| claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
| `csi`
| xref:../objects/index.adoc#io-k8s-api-core-v1-CSIPersistentVolumeSource[`CSIPersistentVolumeSource`]
| `CSIPersistentVolumeSource`
| csi represents storage that is handled by an external CSI driver (Beta feature).
| `fc`
| xref:../objects/index.adoc#io-k8s-api-core-v1-FCVolumeSource[`FCVolumeSource`]
| `FCVolumeSource`
| fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
| `flexVolume`
| xref:../objects/index.adoc#io-k8s-api-core-v1-FlexPersistentVolumeSource[`FlexPersistentVolumeSource`]
| `FlexPersistentVolumeSource`
| flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
| `flocker`
| xref:../objects/index.adoc#io-k8s-api-core-v1-FlockerVolumeSource[`FlockerVolumeSource`]
| `FlockerVolumeSource`
| flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
| `gcePersistentDisk`
| xref:../objects/index.adoc#io-k8s-api-core-v1-GCEPersistentDiskVolumeSource[`GCEPersistentDiskVolumeSource`]
| `GCEPersistentDiskVolumeSource`
| gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
| `glusterfs`
| xref:../objects/index.adoc#io-k8s-api-core-v1-GlusterfsPersistentVolumeSource[`GlusterfsPersistentVolumeSource`]
| `GlusterfsPersistentVolumeSource`
| glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md
| `hostPath`
| xref:../objects/index.adoc#io-k8s-api-core-v1-HostPathVolumeSource[`HostPathVolumeSource`]
| `HostPathVolumeSource`
| hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
| `iscsi`
| xref:../objects/index.adoc#io-k8s-api-core-v1-ISCSIPersistentVolumeSource[`ISCSIPersistentVolumeSource`]
| `ISCSIPersistentVolumeSource`
| iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
| `local`
| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalVolumeSource[`LocalVolumeSource`]
| `LocalVolumeSource`
| local represents directly-attached storage with node affinity
| `mountOptions`
@@ -3814,11 +3814,11 @@ Type::
| mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
| `nfs`
| xref:../objects/index.adoc#io-k8s-api-core-v1-NFSVolumeSource[`NFSVolumeSource`]
| `NFSVolumeSource`
| nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
| `nodeAffinity`
| xref:../objects/index.adoc#io-k8s-api-core-v1-VolumeNodeAffinity[`VolumeNodeAffinity`]
| `VolumeNodeAffinity`
| nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
| `persistentVolumeReclaimPolicy`
@@ -3831,23 +3831,23 @@ Possible enum values:
- `"Retain"` means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.
| `photonPersistentDisk`
| xref:../objects/index.adoc#io-k8s-api-core-v1-PhotonPersistentDiskVolumeSource[`PhotonPersistentDiskVolumeSource`]
| `PhotonPersistentDiskVolumeSource`
| photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
| `portworxVolume`
| xref:../objects/index.adoc#io-k8s-api-core-v1-PortworxVolumeSource[`PortworxVolumeSource`]
| `PortworxVolumeSource`
| portworxVolume represents a portworx volume attached and mounted on kubelets host machine
| `quobyte`
| xref:../objects/index.adoc#io-k8s-api-core-v1-QuobyteVolumeSource[`QuobyteVolumeSource`]
| `QuobyteVolumeSource`
| quobyte represents a Quobyte mount on the host that shares a pod's lifetime
| `rbd`
| xref:../objects/index.adoc#io-k8s-api-core-v1-RBDPersistentVolumeSource[`RBDPersistentVolumeSource`]
| `RBDPersistentVolumeSource`
| rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
| `scaleIO`
| xref:../objects/index.adoc#io-k8s-api-core-v1-ScaleIOPersistentVolumeSource[`ScaleIOPersistentVolumeSource`]
| `ScaleIOPersistentVolumeSource`
| scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
| `storageClassName`
@@ -3855,7 +3855,7 @@ Possible enum values:
| storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
| `storageos`
| xref:../objects/index.adoc#io-k8s-api-core-v1-StorageOSPersistentVolumeSource[`StorageOSPersistentVolumeSource`]
| `StorageOSPersistentVolumeSource`
| storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md
| `volumeAttributesClassName`
@@ -3871,7 +3871,7 @@ Possible enum values:
- `"Filesystem"` means the volume will be or is formatted with a filesystem.
| `vsphereVolume`
| xref:../objects/index.adoc#io-k8s-api-core-v1-VsphereVirtualDiskVolumeSource[`VsphereVirtualDiskVolumeSource`]
| `VsphereVirtualDiskVolumeSource`
| vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
|===
@@ -3984,7 +3984,7 @@ Type::
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| xref:../objects/index.adoc#io-k8s-api-core-v1-PodSpec[`PodSpec`]
| `PodSpec`
| Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
|===
@@ -4097,7 +4097,7 @@ Type::
| hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
| `scopeSelector`
| xref:../objects/index.adoc#io-k8s-api-core-v1-ScopeSelector_v2[`ScopeSelector_v2`]
| `ScopeSelector_v2`
| scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
| `scopes`
@@ -4159,7 +4159,7 @@ Type::
| Property | Type | Description
| `claims`
| xref:../objects/index.adoc#io-k8s-api-core-v1-ResourceClaim[`array (ResourceClaim)`]
| `array (ResourceClaim)`
| 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.
@@ -4296,7 +4296,7 @@ Type::
| defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
| `items`
| xref:../objects/index.adoc#io-k8s-api-core-v1-KeyToPath[`array (KeyToPath)`]
| `array (KeyToPath)`
| items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
| `optional`
@@ -4465,7 +4465,7 @@ Type::
| Property | Type | Description
| `matchLabelExpressions`
| xref:../objects/index.adoc#io-k8s-api-core-v1-TopologySelectorLabelRequirement[`array (TopologySelectorLabelRequirement)`]
| `array (TopologySelectorLabelRequirement)`
| A list of topology selector requirements by labels.
|===
@@ -4899,7 +4899,7 @@ Type::
| Property | Type | Description
| `clusterRoleSelectors`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-LabelSelector_v3[`array (LabelSelector_v3)`]
| `array (LabelSelector_v3)`
| ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
|===
@@ -5378,63 +5378,63 @@ Type::
| `$ref`
| `string`
|
|
| `$schema`
| `string`
|
|
| `additionalItems`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaPropsOrBool[``]
|
| ``
|
| `additionalProperties`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaPropsOrBool[``]
|
| ``
|
| `allOf`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaProps[`array (undefined)`]
|
|
| `anyOf`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaProps[`array (undefined)`]
|
|
| `default`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSON[`JSON`]
| `JSON`
| default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
| `definitions`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaProps[`object (undefined)`]
|
|
| `dependencies`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaPropsOrStringArray[`object (undefined)`]
|
| `object (undefined)`
|
| `description`
| `string`
|
|
| `enum`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSON[`array (JSON)`]
|
| `array (JSON)`
|
| `example`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSON[`JSON`]
|
| `JSON`
|
| `exclusiveMaximum`
| `boolean`
|
|
| `exclusiveMinimum`
| `boolean`
|
|
| `externalDocs`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-ExternalDocumentation[`ExternalDocumentation`]
|
| `ExternalDocumentation`
|
| `format`
| `string`
@@ -5444,87 +5444,87 @@ Type::
| `id`
| `string`
|
|
| `items`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaPropsOrArray[``]
|
| ``
|
| `maxItems`
| `integer`
|
|
| `maxLength`
| `integer`
|
|
| `maxProperties`
| `integer`
|
|
| `maximum`
| `number`
|
|
| `minItems`
| `integer`
|
|
| `minLength`
| `integer`
|
|
| `minProperties`
| `integer`
|
|
| `minimum`
| `number`
|
|
| `multipleOf`
| `number`
|
|
| `not`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaProps[``]
|
|
| `nullable`
| `boolean`
|
|
| `oneOf`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaProps[`array (undefined)`]
|
|
| `pattern`
| `string`
|
|
| `patternProperties`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaProps[`object (undefined)`]
|
|
| `properties`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-JSONSchemaProps[`object (undefined)`]
|
|
| `required`
| `array (string)`
|
|
| `title`
| `string`
|
|
| `type`
| `string`
|
|
| `uniqueItems`
| `boolean`
|
|
| `x-kubernetes-embedded-resource`
| `boolean`
@@ -5584,7 +5584,7 @@ Defaults to atomic for arrays.
| x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
| `x-kubernetes-validations`
| xref:../objects/index.adoc#io-k8s-apiextensions-apiserver-pkg-apis-apiextensions-v1-ValidationRule[`array (ValidationRule)`]
| `array (ValidationRule)`
| x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
|===
@@ -5612,7 +5612,7 @@ The serialization format is:
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
<decimalExponent> ::= "e" <signedNumber> \| "E" <signedNumber>
<decimalExponent> ::= "e" <signedNumber> \| "E" <signedNumber>
No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.
@@ -5735,7 +5735,7 @@ Type::
| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
| `preconditions`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Preconditions[`Preconditions`]
| `Preconditions`
| Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
| `propagationPolicy`
@@ -5824,15 +5824,15 @@ Required::
| `group`
| `string`
|
|
| `kind`
| `string`
|
|
| `version`
| `string`
|
|
|===
@@ -5889,7 +5889,7 @@ Type::
| Property | Type | Description
| `matchExpressions`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-LabelSelectorRequirement_v2[`array (LabelSelectorRequirement_v2)`]
| `array (LabelSelectorRequirement_v2)`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
| `matchLabels`
@@ -6052,7 +6052,7 @@ Applied only if Name is not specified. More info: https://git.k8s.io/community/c
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
| `managedFields`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ManagedFieldsEntry[`array (ManagedFieldsEntry)`]
| `array (ManagedFieldsEntry)`
| ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
| `name`
@@ -6066,7 +6066,7 @@ Applied only if Name is not specified. More info: https://git.k8s.io/community/c
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
| `ownerReferences`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-OwnerReference[`array (OwnerReference)`]
| `array (OwnerReference)`
| List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
| `resourceVersion`
@@ -6149,7 +6149,7 @@ Applied only if Name is not specified. More info: https://git.k8s.io/community/c
| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
| `managedFields`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ManagedFieldsEntry[`array (ManagedFieldsEntry)`]
| `array (ManagedFieldsEntry)`
| ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
| `name`
@@ -6163,7 +6163,7 @@ Applied only if Name is not specified. More info: https://git.k8s.io/community/c
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
| `ownerReferences`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-OwnerReference[`array (OwnerReference)`]
| `array (OwnerReference)`
| List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
| `resourceVersion`
@@ -6214,7 +6214,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails[`StatusDetails`]
| `StatusDetails`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6269,7 +6269,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6324,7 +6324,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6379,7 +6379,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6434,7 +6434,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6489,7 +6489,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6544,7 +6544,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6599,7 +6599,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6654,7 +6654,7 @@ Type::
| Suggested HTTP return code for this status, 0 if not set.
| `details`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-StatusDetails_v2[`StatusDetails_v2`]
| `StatusDetails_v2`
| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
| `kind`
@@ -6728,7 +6728,7 @@ Required::
| `type`
| `string`
|
|
|===

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

@@ -993,7 +993,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
@@ -2948,11 +2948,11 @@ This should be when the underlying condition changed. If that is not known, the
| `message`
| `string`
|
|
| `reason`
| `string`
|
|
| `status`
| `string`
@@ -3548,7 +3548,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 +4012,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 +4145,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 +4247,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema
|
|
|===
.HTTP responses
@@ -4349,7 +4349,7 @@ Description::
| Parameter | Type | Description
| `body`
| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema
|
|
|===
.HTTP responses

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

@@ -85,12 +85,12 @@ 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
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`
@@ -111,11 +111,11 @@ 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
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`
@@ -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