📖 Document how to configure global pull secrets #1410
Conversation
This file contains 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
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1410 +/- ##
=======================================
Coverage 73.57% 73.57%
=======================================
Files 42 42
Lines 3194 3194
=======================================
Hits 2350 2350
Misses 659 659
Partials 185 185
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
anik120
force-pushed
the
private-registry-docs
branch
from
ee89046
to
f90b98e
Compare
|
@m1kola that is correct. Please hold until we reach some kind of a resolution in this thread https://kubernetes.slack.com/archives/C0181L6JYQ2/p1729859882375089 /hold |
openshift-ci
bot
added
the
do-not-merge/hold
anik120
force-pushed
the
private-registry-docs
branch
9 times, most recently
from
06398e0
to
602752a
Compare
anik120
force-pushed
the
private-registry-docs
branch
from
602752a
to
405aa50
Compare
| - alpha | ||
| --- | ||
|
|
||
| # Configure global pull secrets for allowing components to pull private images |
There was a problem hiding this comment.
Suggested change
| # Configure global pull secrets for allowing components to pull private images | |
| # Configure global pull secrets for allowing components to pull from private registries |
I think it would be more clearer to use the term "private registries" instead of "private images," as the authentication is specifically for accessing the registry where images are hosted, right?
|
|
||
| # Configure global pull secrets for allowing components to pull private images | ||
|
|
||
| **Note: The UX for how auth info for using private images is provided is an active work in progress.** |
There was a problem hiding this comment.
Suggested change
| **Note: The UX for how auth info for using private images is provided is an active work in progress.** | |
| **Note: The UX for providing authentication details for private registry images is an active work in progress.** |
same ^
|
|
||
| **Note: The UX for how auth info for using private images is provided is an active work in progress.** | ||
|
|
||
| To configure `catalogd` and `operator-controller` to use authentication information for pulling private images (catalog/bundle images etc), the components can be informed about a kubernetes `Secret` object that contains the relevant auth information. The `Secret` must be of type `kubernetes.io/dockerconfigjson`. |
There was a problem hiding this comment.
Suggested change
| To configure `catalogd` and `operator-controller` to use authentication information for pulling private images (catalog/bundle images etc), the components can be informed about a kubernetes `Secret` object that contains the relevant auth information. The `Secret` must be of type `kubernetes.io/dockerconfigjson`. | |
| To allow [catalogd](https://github.com/operator-framework/catalogd) and [operator-controller](https://github.com/operator-framework/operator-controller) to authenticate and pull images from a private registry (for catalog/bundle images, etc.), you need to provide these components with a Kubernetes `Secret` object containing the necessary credentials. The `Secret` must be of type [`kubernetes.io/dockerconfigjson`](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#registry-secret-existing-credentials). |
- The correct term would be "private registry," right, not "images"?
- Additionally, wdyt about adding links to both project repositories for catalogd and operator-controller?
- wdyt about including a reference to the Kubernetes documentation on kubernetes.io/dockerconfigjson secrets for further guidance?
|
|
||
| To configure `catalogd` and `operator-controller` to use authentication information for pulling private images (catalog/bundle images etc), the components can be informed about a kubernetes `Secret` object that contains the relevant auth information. The `Secret` must be of type `kubernetes.io/dockerconfigjson`. | ||
|
|
||
| Once the `Secret` is created, `catalogd` and `operator-controller` needs to be redeployed with an additional field, `--global-pull-secret=<secret-namespace>/<secret-name>` passed to the respective binaries. |
There was a problem hiding this comment.
Suggested change
| Once the `Secret` is created, `catalogd` and `operator-controller` needs to be redeployed with an additional field, `--global-pull-secret=<secret-namespace>/<secret-name>` passed to the respective binaries. | |
| Once the `Secret` is created, `catalogd` and `operator-controller` needs to be redeployed with an additional flag, --global-pull-secret=<secret-namespace>/<secret-name>, to pass the registry credentials to the respective binaries. |
|
|
||
| Once the `Secret` is created, `catalogd` and `operator-controller` needs to be redeployed with an additional field, `--global-pull-secret=<secret-namespace>/<secret-name>` passed to the respective binaries. | ||
|
|
||
| For eg, create a `Secret` using locally available `config.json`: |
There was a problem hiding this comment.
Suggested change
| For eg, create a `Secret` using locally available `config.json`: | |
| For example, to create a `Secret` using locally available `config.json` for the private registry: |
| $ kubectl create secret docker-registry test-secret \ | ||
| --from-file=.dockerconfigjson=$HOME/.docker/config.json \ | ||
| --namespace olmv1-system | ||
| secret/test-secret created |
There was a problem hiding this comment.
Should we include the output of the command? Adding it might make it harder for users to copy, paste, and use the command directly, right?
| type: kubernetes.io/dockerconfigjson | ||
| ``` | ||
|
|
||
| Modify the `config/base/manager/manager.yaml` file for `catalogd` and `operator-controller` to include the new field in the binary args: |
There was a problem hiding this comment.
Suggested change
| Modify the `config/base/manager/manager.yaml` file for `catalogd` and `operator-controller` to include the new field in the binary args: | |
| Modify the `config/base/manager/manager.yaml` file for `catalogd` and `operator-controller` to include the new flag in the binary args: |
| - --global-pull-secret=olmv1-system/test-secret | ||
| ``` | ||
|
|
||
| With the above configuration, creating a `ClusterCatalog` or a `ClusterExention` whose content is packaged in a private container image hosted in an image registry, will become possible. |
There was a problem hiding this comment.
Suggested change
| With the above configuration, creating a `ClusterCatalog` or a `ClusterExention` whose content is packaged in a private container image hosted in an image registry, will become possible. | |
| With the above configuration, creating a `ClusterCatalog` or a `ClusterExention` whose content is packaged in a container image hosted in an private registry, will become possible. |
is the registry which is private right?
| @@ -14,6 +14,8 @@ After you add a catalog to your cluster, you can install an extension by creatin | |||
| * The name, and optionally version, or channel, of the [supported extension](../project/olmv1_limitations.md) to be installed | |||
| * An existing namespace in which to install the extension | |||
|
|
|||
| **Note** To install ClusterExentions that are shipped as private container images hosted in an image registry, please see [How to conifgure global pull secrets](../howto/configure-global-pull-secrets.md). | |||
There was a problem hiding this comment.
Suggested change
| **Note** To install ClusterExentions that are shipped as private container images hosted in an image registry, please see [How to conifgure global pull secrets](../howto/configure-global-pull-secrets.md). | |
| **Note** To install `ClusterExentions` that are shipped as container images hosted in an private registry, please see the HowTo [Configure global pull secrets for allowing components to pull from private registries](../howto/configure-global-pull-secrets.md). |
Just to match the title
| @@ -36,6 +37,7 @@ nav: | |||
| - Uninstall an Extension: tutorials/uninstall-extension.md | |||
| - How-To Guides: | |||
| - Catalog queries: howto/catalog-queries.md | |||
| - Configure Global pull secrets: howto/configure-global-pull-secrets.md | |||
There was a problem hiding this comment.
Suggested change
| - Configure Global pull secrets: howto/configure-global-pull-secrets.md | |
| - Configure global pull secrets to pull from private registries: howto/configure-global-pull-secrets.md |
maybe a little more informative wdyt?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Closes #1409
Reviewer Checklist