docs: correct ocp ssh key docs#8675
Merged
Merged
Conversation
Update description of OCP `ssh_key` config item to clarify it is the key contents, not a path. Signed-off-by: Toby Aurelius <22025115+taurelius@users.noreply.github.com>
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why the changes in this PR are needed?
The current OPA Control Plane docs for configuring an ssh_key secret are incorrect, stating the ssh_key.key value should be a path.
This should instead be the SSH key content itself. Providing a path causes the configuration to fail. See secret.go.
What are the changes in this PR?
Updates the ssh_key configuration documentation to explicitly state that the value must be the literal SSH key content, not a file path.
Notes to assist PR review:
N/A
Further comments:
N/A