diff --git a/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc b/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc index 6d0b8258ca52..df4a34dcbd07 100644 --- a/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc @@ -138,7 +138,7 @@ Required:: | TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed. | `to` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | To is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used |=== @@ -2524,7 +2524,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport`] schema -| +| |=== .HTTP responses diff --git a/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc index cde368fd85f7..805b36bf2c5d 100644 --- a/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc @@ -386,7 +386,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`. | `params{}` | `array (string)` -| +| | `path` | `string` @@ -436,7 +436,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 @@ -835,7 +835,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -1436,7 +1436,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 -- @@ -1986,7 +1986,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema -| +| |=== .HTTP responses @@ -2119,7 +2119,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema -| +| |=== .HTTP responses diff --git a/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc index fa53a6b0a2bc..7609ad1e5b6b 100644 --- a/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc @@ -554,7 +554,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -1304,9 +1304,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[]` @@ -1355,9 +1355,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 -- @@ -2029,7 +2029,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema -| +| |=== .HTTP responses @@ -2162,7 +2162,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema -| +| |=== .HTTP responses diff --git a/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc index f504dc011596..a0a6215ebf2f 100644 --- a/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc @@ -865,7 +865,7 @@ in a breaking way. | `scrapeClasses[]` | `object` -| +| | `scrapeClassicHistograms` | `boolean` @@ -1021,7 +1021,7 @@ ServiceMonitor and ScrapeConfig resources. * The `__param_target__` label for Probe resources. Users can define their own sharding implementation by setting the -`__tmp_hash` label during the target discovery with relabeling +`\__tmp_hash` label during the target discovery with relabeling configuration (either in the monitoring resources or via scrape class). You can also disable sharding on a specific target by setting the @@ -1071,7 +1071,7 @@ the triple using the matching operator . | `topologySpreadConstraints[]` | `object` -| +| | `tracingConfig` | `object` @@ -3144,7 +3144,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -4660,7 +4660,7 @@ Type:: | `deny` | `boolean` -| +| |=== === .spec.containers @@ -10538,7 +10538,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -10812,7 +10812,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -11821,7 +11821,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -12340,7 +12340,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -13911,7 +13911,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. @@ -14124,7 +14124,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. @@ -21599,7 +21599,7 @@ being performed. Only delete actions will be performed. | `shardStatuses[]` | `object` -| +| | `shards` | `integer` @@ -21853,7 +21853,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema -| +| |=== .HTTP responses @@ -21986,7 +21986,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema -| +| |=== .HTTP responses @@ -22088,7 +22088,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema -| +| |=== .HTTP responses @@ -22190,7 +22190,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema -| +| |=== .HTTP responses diff --git a/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc index d5895f3d5fb6..fc9bbbea1ded 100644 --- a/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc @@ -385,7 +385,7 @@ Cannot be set at the same time as `authorization`, or `basicAuth`. | `params{}` | `array (string)` -| +| | `path` | `string` @@ -431,7 +431,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 @@ -828,7 +828,7 @@ It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. | `proxyConnectHeader{}` | `array` -| +| | `proxyConnectHeader{}[]` | `object` @@ -1429,7 +1429,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 -- @@ -2177,7 +2177,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema -| +| |=== .HTTP responses @@ -2310,7 +2310,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema -| +| |=== .HTTP responses diff --git a/rest_api/network_apis/gateway-gateway-networking-k8s-io-v1.adoc b/rest_api/network_apis/gateway-gateway-networking-k8s-io-v1.adoc index a0dc7ea9d9fa..77d20afaaea2 100644 --- a/rest_api/network_apis/gateway-gateway-networking-k8s-io-v1.adoc +++ b/rest_api/network_apis/gateway-gateway-networking-k8s-io-v1.adoc @@ -113,7 +113,7 @@ Support: Extended logical endpoints that are bound on this Gateway's addresses. At least one Listener MUST be specified. -## Distinct Listeners +Distinct Listeners Each Listener in a set of Listeners (for example, in a single Gateway) MUST be _distinct_, in that a traffic flow MUST be able to be assigned to @@ -190,20 +190,20 @@ values to choose the correct Listener and its associated set of Routes. Exact matches MUST be processed before wildcard matches, and wildcard matches MUST be processed before fallback (empty Hostname value) matches. For example, `"foo.example.com"` takes precedence over -`"*.example.com"`, and `"*.example.com"` takes precedence over `""`. +`"\*.example.com"`, and `"\*.example.com"` takes precedence over `""`. Additionally, if there are multiple wildcard entries, more specific wildcard entries must be processed before less specific wildcard entries. -For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. +For example, `"\*.foo.example.com"` takes precedence over `"\*.example.com"`. The precise definition here is that the higher the number of dots in the hostname to the right of the wildcard character, the higher the precedence. The wildcard character will match any number of characters _and dots_ to -the left, however, so `"*.example.com"` will match both +the left, however, so `"\*.example.com"` will match both `"foo.bar.example.com"` _and_ `"bar.example.com"`. -## Handling indistinct Listeners +Handling indistinct Listeners If a set of Listeners contains Listeners that are not distinct, then those Listeners are _Conflicted_, and the implementation MUST set the "Conflicted" @@ -231,7 +231,7 @@ indicate in the Message which Listeners are conflicted, and which are Accepted. Additionally, the Listener status for those listeners SHOULD indicate which Listeners are conflicted and not Accepted. -## General Listener behavior +General Listener behavior Note that, for all distinct Listeners, requests SHOULD match at most one Listener. For example, if Listeners are defined for "foo.example.com" and "*.example.com", a @@ -247,7 +247,7 @@ Implementations that _do_ support Listener Isolation SHOULD claim support for the Extended `GatewayHTTPListenerIsolation` feature and pass the associated conformance tests. -## Compatible Listeners +Compatible Listeners A Gateway's Listeners are considered _compatible_ if: @@ -538,17 +538,17 @@ values to choose the correct Listener and its associated set of Routes. Exact matches MUST be processed before wildcard matches, and wildcard matches MUST be processed before fallback (empty Hostname value) matches. For example, `"foo.example.com"` takes precedence over -`"*.example.com"`, and `"*.example.com"` takes precedence over `""`. +`"\*.example.com"`, and `"\*.example.com"` takes precedence over `""`. Additionally, if there are multiple wildcard entries, more specific wildcard entries must be processed before less specific wildcard entries. -For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. +For example, `"\*.foo.example.com"` takes precedence over `"\*.example.com"`. The precise definition here is that the higher the number of dots in the hostname to the right of the wildcard character, the higher the precedence. The wildcard character will match any number of characters _and dots_ to -the left, however, so `"*.example.com"` will match both +the left, however, so `"\*.example.com"` will match both `"foo.bar.example.com"` _and_ `"bar.example.com"`. ## Handling indistinct Listeners @@ -719,7 +719,7 @@ there MUST be an intersection between the values for a Route to be accepted. For more information, refer to the Route specific Hostnames documentation. -Hostnames that are prefixed with a wildcard label (`*.`) are interpreted +Hostnames that are prefixed with a wildcard label (`\*.`) are interpreted as a suffix match. That means that a match for `*.example.com` would match both `test.example.com`, and `foo.test.example.com`, but not `example.com`. @@ -1697,7 +1697,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/gateway-gateway-networking-k8s-io-v1.adoc#gateway-gateway-networking-k8s-io-v1[`Gateway`] schema -| +| |=== .HTTP responses @@ -1830,7 +1830,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/gateway-gateway-networking-k8s-io-v1.adoc#gateway-gateway-networking-k8s-io-v1[`Gateway`] schema -| +| |=== .HTTP responses @@ -1932,7 +1932,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/gateway-gateway-networking-k8s-io-v1.adoc#gateway-gateway-networking-k8s-io-v1[`Gateway`] schema -| +| |=== .HTTP responses diff --git a/rest_api/network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc b/rest_api/network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc index 07a28e47d7da..b85f7a7db519 100644 --- a/rest_api/network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc +++ b/rest_api/network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc @@ -96,7 +96,7 @@ Host header to select a GRPCRoute to process the request. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: 1. IPs are not allowed. -2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard +2. A hostname may be prefixed with a wildcard label (`\*.`). The wildcard label MUST appear by itself as the first label. If a hostname is specified by both the Listener and GRPCRoute, there @@ -106,13 +106,13 @@ attached to the Listener. For example: * A Listener with `test.example.com` as the hostname matches GRPCRoutes that have either not specified any hostnames, or have specified at least one of `test.example.com` or `*.example.com`. -* A Listener with `*.example.com` as the hostname matches GRPCRoutes +* A Listener with `\*.example.com` as the hostname matches GRPCRoutes that have either not specified any hostnames or have specified at least one hostname that matches the Listener hostname. For example, - `test.example.com` and `*.example.com` would both match. On the other + `test.example.com` and `\*.example.com` would both match. On the other hand, `example.com` and `test.example.net` would not match. -Hostnames that are prefixed with a wildcard label (`*.`) are interpreted +Hostnames that are prefixed with a wildcard label (`\*.`) are interpreted as a suffix match. That means that a match for `*.example.com` would match both `test.example.com`, and `foo.test.example.com`, but not `example.com`. @@ -1277,11 +1277,11 @@ Required:: | `denominator` | `integer` -| +| | `numerator` | `integer` -| +| |=== === .spec.rules[].backendRefs[].filters[].responseHeaderModifier @@ -2061,11 +2061,11 @@ Required:: | `denominator` | `integer` -| +| | `numerator` | `integer` -| +| |=== === .spec.rules[].filters[].responseHeaderModifier @@ -2938,7 +2938,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc#grpcroute-gateway-networking-k8s-io-v1[`GRPCRoute`] schema -| +| |=== .HTTP responses @@ -3071,7 +3071,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc#grpcroute-gateway-networking-k8s-io-v1[`GRPCRoute`] schema -| +| |=== .HTTP responses @@ -3173,7 +3173,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/grpcroute-gateway-networking-k8s-io-v1.adoc#grpcroute-gateway-networking-k8s-io-v1[`GRPCRoute`] schema -| +| |=== .HTTP responses diff --git a/rest_api/network_apis/httproute-gateway-networking-k8s-io-v1.adoc b/rest_api/network_apis/httproute-gateway-networking-k8s-io-v1.adoc index 4c1c08b807ae..060880d52c70 100644 --- a/rest_api/network_apis/httproute-gateway-networking-k8s-io-v1.adoc +++ b/rest_api/network_apis/httproute-gateway-networking-k8s-io-v1.adoc @@ -80,7 +80,7 @@ Valid values for Hostnames are determined by RFC 1123 definition of a hostname with 2 notable exceptions: 1. IPs are not allowed. -2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard +2. A hostname may be prefixed with a wildcard label (`\*.`). The wildcard label must appear by itself as the first label. If a hostname is specified by both the Listener and HTTPRoute, there @@ -90,14 +90,14 @@ attached to the Listener. For example: * A Listener with `test.example.com` as the hostname matches HTTPRoutes that have either not specified any hostnames, or have specified at least one of `test.example.com` or `*.example.com`. -* A Listener with `*.example.com` as the hostname matches HTTPRoutes +* A Listener with `\*.example.com` as the hostname matches HTTPRoutes that have either not specified any hostnames or have specified at least one hostname that matches the Listener hostname. For example, - `*.example.com`, `test.example.com`, and `foo.test.example.com` would + `\*.example.com`, `test.example.com`, and `foo.test.example.com` would all match. On the other hand, `example.com` and `test.example.net` would not match. -Hostnames that are prefixed with a wildcard label (`*.`) are interpreted +Hostnames that are prefixed with a wildcard label (`\*.`) are interpreted as a suffix match. That means that a match for `*.example.com` would match both `test.example.com`, and `foo.test.example.com`, but not `example.com`. @@ -1319,11 +1319,11 @@ Required:: | `denominator` | `integer` -| +| | `numerator` | `integer` -| +| |=== === .spec.rules[].backendRefs[].filters[].requestRedirect @@ -2379,11 +2379,11 @@ Required:: | `denominator` | `integer` -| +| | `numerator` | `integer` -| +| |=== === .spec.rules[].filters[].requestRedirect @@ -3675,7 +3675,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/httproute-gateway-networking-k8s-io-v1.adoc#httproute-gateway-networking-k8s-io-v1[`HTTPRoute`] schema -| +| |=== .HTTP responses @@ -3808,7 +3808,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/httproute-gateway-networking-k8s-io-v1.adoc#httproute-gateway-networking-k8s-io-v1[`HTTPRoute`] schema -| +| |=== .HTTP responses @@ -3910,7 +3910,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../network_apis/httproute-gateway-networking-k8s-io-v1.adoc#httproute-gateway-networking-k8s-io-v1[`HTTPRoute`] schema -| +| |=== .HTTP responses diff --git a/rest_api/objects/index.adoc b/rest_api/objects/index.adoc index 73a29b4c835b..d122d7370e59 100644 --- a/rest_api/objects/index.adoc +++ b/rest_api/objects/index.adoc @@ -1307,7 +1307,7 @@ Required:: | `items` | xref:../oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc#useroauthaccesstoken-oauth-openshift-io-v1[`array (UserOAuthAccessToken)`] -| +| | `kind` | `string` @@ -1775,12 +1775,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)` +| |=== @@ -1807,12 +1807,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)` +| |=== @@ -1841,11 +1841,11 @@ Required:: | `supported` | `boolean` -| +| | `type` | `string` -| +| |=== @@ -1877,7 +1877,7 @@ Required:: | `items` | xref:../operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc#packagemanifest-packages-operators-coreos-com-v1[`array (PackageManifest)`] -| +| | `kind` | `string` @@ -1885,7 +1885,7 @@ Required:: | `metadata` | xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ListMeta[`ListMeta`] -| +| |=== @@ -2645,7 +2645,7 @@ Required:: | `metadata` | xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ListMeta[`ListMeta`] -| +| |=== @@ -2796,7 +2796,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` @@ -2840,7 +2840,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` @@ -2924,7 +2924,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. |=== @@ -3090,15 +3090,15 @@ Required:: | `lastTransitionTime` | xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Time[`Time`] -| +| | `message` | `string` -| +| | `reason` | `string` -| +| | `status` | `string` @@ -3730,15 +3730,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. 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` -| 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. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver. | `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. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver. | `capacity` @@ -3746,11 +3746,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. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. | `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. 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 | `claimRef` @@ -3758,39 +3758,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. | `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. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. | `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. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. | `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. 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 | `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. 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` -| 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` @@ -3798,11 +3798,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` @@ -3815,23 +3815,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. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. | `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. 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. | `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. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. | `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. 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` -| xref:../objects/index.adoc#io-k8s-api-core-v1-ScaleIOPersistentVolumeSource[`ScaleIOPersistentVolumeSource`] +| `ScaleIOPersistentVolumeSource` | 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. | `storageClassName` @@ -3839,7 +3839,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. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info: https://examples.k8s.io/volumes/storageos/README.md | `volumeAttributesClassName` @@ -3855,7 +3855,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. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver. |=== @@ -3965,7 +3965,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 |=== @@ -4075,7 +4075,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` @@ -4135,7 +4135,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. @@ -4269,7 +4269,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` @@ -4434,7 +4434,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. |=== @@ -4937,7 +4937,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 |=== @@ -5404,63 +5404,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` @@ -5470,87 +5470,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` @@ -5610,7 +5610,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. |=== @@ -5638,7 +5638,7 @@ The serialization format is: (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) - ::= "e" \| "E" + ::= "e" \| "E" 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. @@ -5763,7 +5763,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` @@ -5850,15 +5850,15 @@ Required:: | `group` | `string` -| +| | `kind` | `string` -| +| | `version` | `string` -| +| |=== @@ -5913,7 +5913,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` @@ -6073,7 +6073,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` @@ -6087,7 +6087,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` @@ -6169,7 +6169,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` @@ -6183,7 +6183,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` @@ -6233,7 +6233,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` @@ -6287,7 +6287,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` @@ -6341,7 +6341,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` @@ -6395,7 +6395,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` @@ -6449,7 +6449,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` @@ -6503,7 +6503,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` @@ -6557,7 +6557,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` @@ -6611,7 +6611,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` @@ -6665,7 +6665,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` @@ -6738,7 +6738,7 @@ Required:: | `type` | `string` -| +| |=== diff --git a/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc b/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc index 548ee1d84b8f..809332f32e49 100644 --- a/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc @@ -1059,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 @@ -3014,11 +3014,11 @@ This should be when the underlying condition changed. If that is not known, the | `message` | `string` -| +| | `reason` | `string` -| +| | `status` | `string` @@ -3614,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 @@ -4078,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 @@ -4211,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 @@ -4313,7 +4313,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema -| +| |=== .HTTP responses @@ -4415,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 diff --git a/rest_api/operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc b/rest_api/operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc index eaf1cab2115e..d2cfb6e7c029 100644 --- a/rest_api/operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc +++ b/rest_api/operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc @@ -229,7 +229,7 @@ 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. +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". @@ -243,11 +243,11 @@ 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. +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. +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" @@ -587,7 +587,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema -| +| |=== .HTTP responses @@ -720,7 +720,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema -| +| |=== .HTTP responses @@ -822,7 +822,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../operatorhub_apis/clustercatalog-olm-operatorframework-io-v1.adoc#clustercatalog-olm-operatorframework-io-v1[`ClusterCatalog`] schema -| +| |=== .HTTP responses diff --git a/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc b/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc index a472da8942a1..925ad39b5d05 100644 --- a/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc +++ b/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc @@ -85,13 +85,13 @@ 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 -as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. +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. +e.g. "foo.\*" allows "foo.bar", "foo.baz", etc. | `apiVersion` | `string` @@ -111,8 +111,8 @@ 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 -as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. +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. @@ -282,7 +282,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema -| +| |=== .HTTP responses @@ -437,7 +437,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema -| +| |=== .HTTP responses diff --git a/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc b/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc index 19eb1918bfe4..1f39295fb5d2 100644 --- a/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc +++ b/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc @@ -74,7 +74,7 @@ Required:: | TemplateInstanceRequester holds the identity of an agent requesting a template instantiation. | `secret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | secret is a reference to a Secret object containing the necessary template parameters. | `template` @@ -107,7 +107,7 @@ Type:: | `extra{}` | `array (string)` -| +| | `groups` | `array (string)` @@ -529,7 +529,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema -| +| |=== .HTTP responses @@ -684,7 +684,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema -| +| |=== .HTTP responses @@ -816,7 +816,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema -| +| |=== .HTTP responses diff --git a/rest_api/workloads_apis/build-build-openshift-io-v1.adoc b/rest_api/workloads_apis/build-build-openshift-io-v1.adoc index 39d4899327e2..bb49a478a1e4 100644 --- a/rest_api/workloads_apis/build-build-openshift-io-v1.adoc +++ b/rest_api/workloads_apis/build-build-openshift-io-v1.adoc @@ -200,7 +200,7 @@ Type:: | ImageLabel represents a label applied to the resulting image. | `pushSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | PushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub). | `to` @@ -507,7 +507,7 @@ Type:: | SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting. | `sourceSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | sourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data's key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey. | `type` @@ -570,7 +570,7 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | configMap is a reference to an existing configmap that you want to use in your build. | `destinationDir` @@ -667,7 +667,7 @@ Required:: | ImageSourcePath describes a path to be copied from a source image and its destination within the build directory. | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set. |=== @@ -750,7 +750,7 @@ Required:: | destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. | `secret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | secret is a reference to an existing secret that you want to use in your build. |=== @@ -832,7 +832,7 @@ Required:: | from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `secrets` @@ -882,7 +882,7 @@ Required:: | mountPath is the path at which to mount the secret | `secretSource` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | secretSource is a reference to the secret |=== @@ -932,7 +932,7 @@ Type:: | noCache if set to true indicates that the container image build must be executed with the --no-cache=true flag | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `volumes` @@ -1134,7 +1134,7 @@ Required:: | incremental flag forces the Source build to do incremental builds if true. | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `scripts` @@ -2342,7 +2342,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema -| +| |=== .HTTP responses @@ -2497,7 +2497,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema -| +| |=== .HTTP responses @@ -2580,7 +2580,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema -| +| |=== .HTTP responses diff --git a/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc b/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc index 507fa7417891..de746fcadb86 100644 --- a/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc +++ b/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc @@ -216,7 +216,7 @@ Type:: | ImageLabel represents a label applied to the resulting image. | `pushSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | PushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub). | `to` @@ -523,7 +523,7 @@ Type:: | SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting. | `sourceSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | sourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data's key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey. | `type` @@ -586,7 +586,7 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | configMap is a reference to an existing configmap that you want to use in your build. | `destinationDir` @@ -683,7 +683,7 @@ Required:: | ImageSourcePath describes a path to be copied from a source image and its destination within the build directory. | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set. |=== @@ -766,7 +766,7 @@ Required:: | destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. | `secret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | secret is a reference to an existing secret that you want to use in your build. |=== @@ -848,7 +848,7 @@ Required:: | from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `secrets` @@ -898,7 +898,7 @@ Required:: | mountPath is the path at which to mount the secret | `secretSource` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | secretSource is a reference to the secret |=== @@ -948,7 +948,7 @@ Type:: | noCache if set to true indicates that the container image build must be executed with the --no-cache=true flag | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `volumes` @@ -1150,7 +1150,7 @@ Required:: | incremental flag forces the Source build to do incremental builds if true. | `pullSecret` -| xref:../objects/index.adoc#io-k8s-api-core-v1-LocalObjectReference_v2[`LocalObjectReference_v2`] +| `LocalObjectReference_v2` | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `scripts` @@ -1849,7 +1849,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema -| +| |=== .HTTP responses @@ -2004,7 +2004,7 @@ Description:: | Parameter | Type | Description | `body` | xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema -| +| |=== .HTTP responses