// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="imagecontentpolicy-config-openshift-io-v1"]
= ImageContentPolicy [config.openshift.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
ImageContentPolicy holds cluster-wide information about how to handle registry mirror rules.
When multiple policies are defined, the outcome of the behavior is defined on each field.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--

Type::
  `object`

Required::
  - `spec`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

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

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

| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| spec holds user settable values for configuration

|===
=== .spec
Description::
+
--
spec holds user settable values for configuration
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `repositoryDigestMirrors`
| `array`
| repositoryDigestMirrors allows images referenced by image digests in pods to be
pulled from alternative mirrored repository locations. The image pull specification
provided to the pod will be compared to the source locations described in RepositoryDigestMirrors
and the image may be pulled down from any of the mirrors in the list instead of the
specified repository allowing administrators to choose a potentially faster mirror.
To pull image from mirrors by tags, should set the "allowMirrorByTags".

Each “source” repository is treated independently; configurations for different “source”
repositories don’t interact.

If the "mirrors" is not specified, the image will continue to be pulled from the specified
repository in the pull spec.

When multiple policies are defined for the same “source” repository, the sets of defined
mirrors will be merged together, preserving the relative order of the mirrors, if possible.
For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the
mirrors will be used in the order `a, b, c, d, e`.  If the orders of mirror entries conflict
(e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified.

| `repositoryDigestMirrors[]`
| `object`
| RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.

|===
=== .spec.repositoryDigestMirrors
Description::
+
--
repositoryDigestMirrors allows images referenced by image digests in pods to be
pulled from alternative mirrored repository locations. The image pull specification
provided to the pod will be compared to the source locations described in RepositoryDigestMirrors
and the image may be pulled down from any of the mirrors in the list instead of the
specified repository allowing administrators to choose a potentially faster mirror.
To pull image from mirrors by tags, should set the "allowMirrorByTags".

Each “source” repository is treated independently; configurations for different “source”
repositories don’t interact.

If the "mirrors" is not specified, the image will continue to be pulled from the specified
repository in the pull spec.

When multiple policies are defined for the same “source” repository, the sets of defined
mirrors will be merged together, preserving the relative order of the mirrors, if possible.
For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the
mirrors will be used in the order `a, b, c, d, e`.  If the orders of mirror entries conflict
(e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified.
--

Type::
  `array`




=== .spec.repositoryDigestMirrors[]
Description::
+
--
RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.
--

Type::
  `object`

Required::
  - `source`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `allowMirrorByTags`
| `boolean`
| allowMirrorByTags if true, the mirrors can be used to pull the images that are referenced by their tags. Default is false, the mirrors only work when pulling the images that are referenced by their digests.
Pulling images by tag can potentially yield different images, depending on which endpoint
we pull from. Forcing digest-pulls for mirrors avoids that issue.

| `mirrors`
| `array (string)`
| mirrors is zero or more repositories that may also contain the same images.
If the "mirrors" is not specified, the image will continue to be pulled from the specified
repository in the pull spec. No mirror will be configured.
The order of mirrors in this list is treated as the user's desired priority, while source
is by default considered lower priority than all mirrors. Other cluster configuration,
including (but not limited to) other repositoryDigestMirrors objects,
may impact the exact order mirrors are contacted in, or some mirrors may be contacted
in parallel, so this should be considered a preference rather than a guarantee of ordering.

| `source`
| `string`
| source is the repository that users refer to, e.g. in image pull specifications.

|===

== API endpoints

The following API endpoints are available:

* `/apis/config.openshift.io/v1/imagecontentpolicies`
- `DELETE`: delete collection of ImageContentPolicy
- `GET`: list objects of kind ImageContentPolicy
- `POST`: create an ImageContentPolicy
* `/apis/config.openshift.io/v1/imagecontentpolicies/{name}`
- `DELETE`: delete an ImageContentPolicy
- `GET`: read the specified ImageContentPolicy
- `PATCH`: partially update the specified ImageContentPolicy
- `PUT`: replace the specified ImageContentPolicy
* `/apis/config.openshift.io/v1/imagecontentpolicies/{name}/status`
- `GET`: read status of the specified ImageContentPolicy
- `PATCH`: partially update status of the specified ImageContentPolicy
- `PUT`: replace status of the specified ImageContentPolicy


=== /apis/config.openshift.io/v1/imagecontentpolicies



HTTP method::
  `DELETE`

Description::
  delete collection of ImageContentPolicy




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list objects of kind ImageContentPolicy




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-config-v1-ImageContentPolicyList[`ImageContentPolicyList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create an ImageContentPolicy


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

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 201 - Created
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 202 - Accepted
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1/imagecontentpolicies/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ImageContentPolicy
|===


HTTP method::
  `DELETE`

Description::
  delete an ImageContentPolicy


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


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified ImageContentPolicy




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified ImageContentPolicy


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


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified ImageContentPolicy


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

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 201 - Created
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1/imagecontentpolicies/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ImageContentPolicy
|===


HTTP method::
  `GET`

Description::
  read status of the specified ImageContentPolicy




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified ImageContentPolicy


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


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified ImageContentPolicy


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

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 201 - Created
| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema
| 401 - Unauthorized
| Empty
|===


