docs: Add password-protected SSH keys information #801
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
pjbgf
commented
Jun 29, 2022
| @@ -152,7 +152,7 @@ data: | |||
| #### SSH authentication | |||
|
|
|||
| To authenticate towards a Git repository over SSH, the referenced Secret is | |||
| expected to contain `.data.identity` and `known_hosts` fields. With the respective | |||
| expected to contain `identity` and `known_hosts` fields. With the respective | |||
There was a problem hiding this comment.
Removed .data. to align with the approach with known_hosts. Alternatively, we could add the .data. prefix on both.
There was a problem hiding this comment.
We should be using stringData in examples, since flux create secret generates secrets that way, so GitHub and others will alert when you push unencrypted tokens. We should tell people to use flux create secret --export especially for Git where the CLI helps generating know hosts like SC expects.
There was a problem hiding this comment.
I updated the example, but did not mention the data/stringData conundrum, as we support both and it will come down to user preference.
Also added a Flux CLI example for SSH secret creation. PTAL
Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
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.
Similar information is present for older versions of the API, however, not for the latest, which affects the live documentation.