-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Reorganize Image configuration resources topic #28268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * openshift_images/image-configuration.adoc | ||
| // * post_installation_configuration/preparing-for-users.adoc | ||
|
|
||
| [id="images-configuration-allowed_{context}"] | ||
| = Adding specific registries | ||
|
|
||
| You can add a list of registries that are permitted for image pull and push actions by 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. | ||
|
|
||
| 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 `allowedRegistries` parameter, the container runtime searches only those registries. Registries not in the list are blocked. | ||
|
|
||
| [WARNING] | ||
| ==== | ||
| 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 the 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. For disconnected clusters, mirror registries should also be added. | ||
| ==== | ||
|
|
||
| .Procedure | ||
|
|
||
| . Edit the `image.config.openshift.io/cluster` CR: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc edit image.config.openshift.io/cluster | ||
| ---- | ||
| + | ||
| The following is an example `image.config.openshift.io/cluster` CR with an allowed list: | ||
| + | ||
| [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: | ||
| registrySources: <1> | ||
| allowedRegistries: <2> | ||
| - example.com | ||
| - quay.io | ||
| - registry.redhat.io | ||
| status: | ||
| internalRegistryHostname: image-registry.openshift-image-registry.svc:5000 | ||
| ---- | ||
| <1> `registrySources`: Contains configurations that determine how the container runtime should treat individual registries when accessing images for builds and pods. It does not contain configuration for the internal cluster registry. | ||
| <2> `allowedRegistries`: Registries to use for image pull and push actions. All other registries are blocked. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| Either the `allowedRegistries` parameter or the `blockedRegistries` parameter can be set, but not both. | ||
| ==== | ||
| + | ||
| The Machine Config Operator (MCO) watches the `image.config.openshift.io/cluster` CR for any changes to registries and reboots the nodes when it detects changes. Changes to the allowed registries creates or updates the image signature policy in the `/host/etc/containers/policy.json` file on each node. | ||
|
|
||
| . To check that the registries have been added to the policy file, use the following command on a node: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ cat /host/etc/containers/policy.json | ||
| ---- | ||
| + | ||
| The following policy indicates that only images from the example.com, quay.io, and registry.redhat.io registries are permitted for image pulls and pushes: | ||
| + | ||
| .Example image signature policy file | ||
| [%collapsible] | ||
| ==== | ||
| [source,terminal] | ||
| ---- | ||
| { | ||
| "default": [{ | ||
| "type": "reject" | ||
| }], | ||
| "transports": { | ||
| "atomic": { | ||
| "example.com": [{ | ||
| "type": "insecureAcceptAnything" | ||
| }], | ||
| "quay.io": [{ | ||
| "type": "insecureAcceptAnything" | ||
| }], | ||
| "registry.redhat.io": [{ | ||
| "type": "insecureAcceptAnything" | ||
| }] | ||
| }, | ||
| "docker": { | ||
| "example.com": [{ | ||
| "type": "insecureAcceptAnything" | ||
| }], | ||
| "quay.io": [{ | ||
| "type": "insecureAcceptAnything" | ||
| }], | ||
| "registry.redhat.io": [{ | ||
| "type": "insecureAcceptAnything" | ||
| }] | ||
| }, | ||
| "docker-daemon": { | ||
| "": [{ | ||
| "type": "insecureAcceptAnything" | ||
| }] | ||
| } | ||
| } | ||
| } | ||
| ---- | ||
| ==== | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| If your cluster uses the `registrySources.insecureRegistries` parameter, ensure that any insecure registries are included in the allowed list. | ||
|
|
||
| For example: | ||
|
|
||
| [source,yml] | ||
| ---- | ||
| spec: | ||
| registrySources: | ||
| insecureRegistries: | ||
| - insecure.com | ||
| allowedRegistries: | ||
| - example.com | ||
| - quay.io | ||
| - registry.redhat.io | ||
| - insecure.com | ||
| ---- | ||
| ==== | ||
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,72 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * openshift_images/image-configuration.adoc | ||
| // * post_installation_configuration/preparing-for-users.adoc | ||
|
|
||
| [id="images-configuration-blocked_{context}"] | ||
| = Blocking specific registries | ||
|
|
||
| You can block any registry 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. | ||
|
|
||
| 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 `blockedRegistries` parameter, the container runtime does not search those registries. All other registries are allowed. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Edit the `image.config.openshift.io/cluster` CR: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc edit image.config.openshift.io/cluster | ||
| ---- | ||
| + | ||
| The following is an example `image.config.openshift.io/cluster` CR with a blocked list: | ||
| + | ||
| [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: | ||
| registrySources: <1> | ||
| blockedRegistries: <2> | ||
| - untrusted.com | ||
| status: | ||
| internalRegistryHostname: image-registry.openshift-image-registry.svc:5000 | ||
| ---- | ||
| <1> `registrySources`: Contains configurations that determine how the container runtime should treat individual registries when accessing images for builds and pods. It does not contain configuration for the internal cluster registry. | ||
| <2> Specify registries that should not be used for image pull and push actions. All other registries are allowed. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| Either the `blockedRegistries` registry or the `allowedRegistries` registry can be set, but not both. | ||
| ==== | ||
| + | ||
| The Machine Config Operator (MCO) watches the `image.config.openshift.io/cluster` CR for any changes to registries and reboots the nodes when it detects changes. Changes to the blocked registries appear in the `/etc/containers/registries.conf` file on each node. | ||
|
|
||
| . To check that the registries have been added to the policy file, use the following command on a node: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ cat /host/etc/containers/registries.conf | ||
| ---- | ||
| + | ||
| The following example indicates that images from the `untrusted.com` registry are prevented for image pulls and pushes: | ||
| + | ||
| .Example output | ||
| [source,terminal] | ||
| ---- | ||
| unqualified-search-registries = ["registry.access.redhat.com", "docker.io"] | ||
|
|
||
| [[registry]] | ||
| prefix = "" | ||
| location = "untrusted.com" | ||
| blocked = true | ||
| ---- |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.