Proxy [config.openshift.io/v1] - Config APIs | API reference

Specification
API endpoints

Description

Proxy holds cluster-wide information on how to configure default proxies for the cluster. The canonical name is cluster Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Required

spec

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	Spec holds user-settable values for the proxy configuration
`status`	`object`	status holds observed values from the cluster. They may not be overridden.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

Spec holds user-settable values for the proxy configuration

status

object

status holds observed values from the cluster. They may not be overridden.

.spec

Description: Spec holds user-settable values for the proxy configuration
Type: object

Property Type Description

Property	Type	Description
`httpProxy`	`string`	httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var.
`httpsProxy`	`string`	httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var.
`noProxy`	`string`	noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var.
`readinessEndpoints`	`array (string)`	readinessEndpoints is a list of endpoints used to verify readiness of the proxy.
`trustedCA`	`object`	trustedCA is a reference to a configmap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key "ca-bundle.crt", merging it with the system default trust bundle, and writing the merged trust bundle to a configmap named "trusted-ca-bundle" in the "openshift-config-managed" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well. The namespace for the configmap referenced by trustedCA is "openshift-config". Here is an example configmap (in yaml): apiVersion: v1 kind: configmap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

httpProxy

string

httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var.

httpsProxy

string

httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var.

noProxy

string

noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var.

readinessEndpoints

array (string)

readinessEndpoints is a list of endpoints used to verify readiness of the proxy.

trustedCA

object

trustedCA is a reference to a configmap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key "ca-bundle.crt", merging it with the system default trust bundle, and writing the merged trust bundle to a configmap named "trusted-ca-bundle" in the "openshift-config-managed" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well. The namespace for the configmap referenced by trustedCA is "openshift-config". Here is an example configmap (in yaml): apiVersion: v1 kind: configmap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

.spec.trustedCA

Description

trustedCA is a reference to a configmap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key "ca-bundle.crt", merging it with the system default trust bundle, and writing the merged trust bundle to a configmap named "trusted-ca-bundle" in the "openshift-config-managed" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well. The namespace for the configmap referenced by trustedCA is "openshift-config". Here is an example configmap (in yaml): apiVersion: v1 kind: configmap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

Type

object

Required

name

Property Type Description

Property	Type	Description
`name`	`string`	name is the metadata.name of the referenced config map

name

string

name is the metadata.name of the referenced config map

.status

Description: status holds observed values from the cluster. They may not be overridden.
Type: object

Property Type Description

Property	Type	Description
`httpProxy`	`string`	httpProxy is the URL of the proxy for HTTP requests.
`httpsProxy`	`string`	httpsProxy is the URL of the proxy for HTTPS requests.
`noProxy`	`string`	noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used.

httpProxy

string

httpProxy is the URL of the proxy for HTTP requests.

httpsProxy

string

httpsProxy is the URL of the proxy for HTTPS requests.

noProxy

string

noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used.

API endpoints

The following API endpoints are available:

/apis/config.openshift.io/v1/proxies
- DELETE: delete collection of Proxy
- GET: list objects of kind Proxy
- POST: create a Proxy
/apis/config.openshift.io/v1/proxies/{name}
- DELETE: delete a Proxy
- GET: read the specified Proxy
- PATCH: partially update the specified Proxy
- PUT: replace the specified Proxy
/apis/config.openshift.io/v1/proxies/{name}/status
- GET: read status of the specified Proxy
- PATCH: partially update status of the specified Proxy
- PUT: replace status of the specified Proxy

/apis/config.openshift.io/v1/proxies

HTTP method: DELETE
Description: delete collection of Proxy

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind Proxy

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`ProxyList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a Proxy

Table 3. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter	Type	Description
`body`	`Proxy` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`Proxy` schema
201 - Created	`Proxy` schema
202 - Accepted	`Proxy` schema
401 - Unauthorized	Empty

/apis/config.openshift.io/v1/proxies/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Proxy

HTTP method: DELETE
Description: delete a Proxy

Table 7. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified Proxy

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`Proxy` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified Proxy

Table 10. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`Proxy` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified Proxy

Table 12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter	Type	Description
`body`	`Proxy` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`Proxy` schema
201 - Created	`Proxy` schema
401 - Unauthorized	Empty

/apis/config.openshift.io/v1/proxies/{name}/status

Table 15. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Proxy

HTTP method: GET
Description: read status of the specified Proxy

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`Proxy` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified Proxy

Table 17. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`Proxy` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified Proxy

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter	Type	Description
`body`	`Proxy` schema

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`Proxy` schema
201 - Created	`Proxy` schema
401 - Unauthorized	Empty