Update README.md to clarify prerequisites #32
Merged
Conversation
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
sm-powell
reviewed
Aug 5, 2025
README.md
Outdated
|
|
||
| **Kubeconfig** (`~/.kube/config` or set via the `--kube-config-path` flag) | ||
| Required to connect to the target Kubernetes cluster. | ||
| If multiple clusters are configured, the tool will use the default context unless specified using `--kube-context` flag. |
There was a problem hiding this comment.
Don't quite follow this. Multiple clusters in the command?
There was a problem hiding this comment.
If multiple clusters are configured in the kube config
README.md
Outdated
| #### Registry Authentication | ||
|
|
||
| **Registry credentials** (`~/.docker/config.json` or `$XDG_RUNTIME_DIR/containers/auth.json`) | ||
| Required for accessing private container registries. The tool relies on `containers/image`, which uses the same credential configuration as: |
There was a problem hiding this comment.
Add some details as to when/why a private registry might be needed
There was a problem hiding this comment.
Moved this section (when/why included) to Private Registry Authentication
sm-powell
approved these changes
Aug 5, 2025
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.
Update README.md to clarify prerequisites regarding the kube config and container registry authentication.