docs: Reword SSO Client Secrets doc #8666
Merged
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
Signed-off-by: Trung <trung.hoang@pricehubble.com>
Codecov Report
@@ Coverage Diff @@
## master #8666 +/- ##
==========================================
- Coverage 46.14% 46.12% -0.02%
==========================================
Files 217 217
Lines 25912 25912
==========================================
- Hits 11958 11953 -5
- Misses 12297 12301 +4
- Partials 1657 1658 +1
Continue to review full report at Codecov.
|
| to obtain the actual value. This allows you to store the `clientSecret` as a kubernetes secret. | ||
| Kubernetes secrets must be base64 encoded. To base64 encode your secret, you can run | ||
| `printf RAW_STRING | base64`. | ||
| `argocd-secret` can be used to store sensititve data which can be referenced by ArgoCD. Values starting with `$` in configmaps is interpreted as follows: |
There was a problem hiding this comment.
Minor Spelling mistakes:
sensititve data - >sensitive data
is interpreted -> are interpreted
|
|
||
| Data should be base64 encoded before it is added to `argocd-secret`. You can do so by running `printf RAW_SECRET_STRING | base64`. | ||
| - If value has the form: `$<secret>:a.key.in.k8s.secret`, look for a k8s secret with the name `<secret>` (minus the `$`), and reads it value. |
There was a problem hiding this comment.
and reads it value -> and read its value
kostis-codefresh
suggested changes
May 9, 2022
Signed-off-by: Trung <trung.hoang@pricehubble.com>
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.
The Sensitive Data and SSO Client Secrets section can mislead users to thinking that the secret value needs to be base encoded twice. This PR attempts to reword to make the doc clearer.
Checklist: