Add UnqualifiedSearchRegistries to the Image CR #28152
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * openshift_images/image-configuration.adoc | ||
| // * post_installation_configuration/preparing-for-users.adoc | ||
|
||
|
|
||
| [id="images-configuration-shortname_{context}"] | ||
| = Adding registries that allow image short names | ||
|
|
||
| You can add registries to search for an image short name by editing the `image.config.openshift.io/cluster` custom resource (CR). {product-title} applies the changes to this CR to all nodes in the cluster. | ||
|
|
||
| An image short name enables you to search for images without including the fully qualified domain name in the pull spec. For example, you could use `rhel7/etcd` instead of `registry.access.redhat.com/rhe7/etcd`. | ||
|
|
||
| You might use short names in situations where using the full path is not practical. For example, if your cluster references multiple internal registries whose DNS changes frequently, you would need to update the fully qualified domain names in your pull specs with each change. In this case, using an image short name might be beneficial. | ||
|
|
||
| When pulling or pushing images, the container runtime searches the registries listed under the `registrySources` parameter in the `image.config.openshift.io/cluster` CR. If you created a list of registries under the `containerRuntimeSearchRegistries` parameter, when pulling an image with a short name, the container runtime searches those registries. | ||
|
|
||
| [WARNING] | ||
| ==== | ||
| Using image short names with public registries is strongly discouraged. You should use image short names with only internal or private registries. | ||
|
|
||
| If you list public registries under the `containerRuntimeSearchRegistries` parameter, you expose your credentials to all the registries on the list and you risk network and registry attacks. You should always use fully-qualified image names with public registries. | ||
| ==== | ||
|
|
||
| The Machine Config Operator (MCO) watches the `image.config.openshift.io/cluster` resource for any changes to the registries. When the MCO detects a change, it drains the nodes, applies the change, and uncordons the nodes. After the nodes return to the `Ready` state, if the `containerRuntimeSearchRegistries` parameter is added, the MCO creates a file in the `/etc/containers/registries.conf.d` directory on each node with the listed registries. The file overrides the default list of unqualified search registries in the `/host/etc/containers/registries.conf` file. There is no way to fall back to the default list of unqualified search registries. | ||
|
|
||
| The `containerRuntimeSearchRegistries` parameter works only with the Podman and CRI-O container engines. The registries in the list can be used only in pod specs, not in builds and image streams. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Edit the `image.config.openshift.io/cluster` custom resource: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc edit image.config.openshift.io/cluster | ||
| ---- | ||
| + | ||
| The following is an example `image.config.openshift.io/cluster` CR: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: config.openshift.io/v1 | ||
| kind: Image | ||
| metadata: | ||
| annotations: | ||
| release.openshift.io/create-only: "true" | ||
| creationTimestamp: "2019-05-17T13:44:26Z" | ||
| generation: 1 | ||
| name: cluster | ||
| resourceVersion: "8302" | ||
| selfLink: /apis/config.openshift.io/v1/images/cluster | ||
| uid: e34555da-78a9-11e9-b92b-06d6c7da38dc | ||
| spec: | ||
| allowedRegistriesForImport: | ||
| - domainName: quay.io | ||
| insecure: false | ||
| additionalTrustedCA: | ||
| name: myconfigmap | ||
| registrySources: | ||
| containerRuntimeSearchRegistries: <1> | ||
| - "reg1.io" | ||
| - "reg2.io" | ||
| - "reg3.io" | ||
| allowedRegistries: <2> | ||
| - example.com | ||
| - quay.io | ||
| - registry.redhat.io | ||
| - "reg1.io" | ||
| - "reg2.io" | ||
| - "reg3.io" | ||
| ... | ||
| status: | ||
| internalRegistryHostname: image-registry.openshift-image-registry.svc:5000 | ||
| ---- | ||
| <1> Specify registries to use with image short names. You should use image short names with only internal or private registries to reduce possible security risks. | ||
| <2> Ensure that any registries listed under `containerRuntimeSearchRegistries` are included in the `allowedRegistries` list. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| When the `allowedRegistries` parameter is defined, all registries including the `registry.redhat.io` and `quay.io` registries are blocked unless explicitly listed. If you use this parameter, to prevent pod failure, add `registry.redhat.io` and `quay.io` to the `allowedRegistries` list, as they are required by payload images within your environment. | ||
| ==== | ||
|
|
||
| . To check that the registries have been added, use the following command on a node: | ||
| + | ||
|
||
| [source,terminal] | ||
| ---- | ||
| $ cat /host/etc/containers/registries.conf.d/01-image-searchRegistries.conf | ||
| ---- | ||
| + | ||
| .Example output | ||
| [source,terminal] | ||
| ---- | ||
| unqualified-search-registries = ['reg1.io', 'reg2.io', 'reg3.io'] | ||
| ---- | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an editorial change for consistency only. No need for QE review.