docs: Fix TLS secret name ConfigMap update example #260
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
Motivation
The script snippet in our TLS docs for creating a configmap with the TLS secret name parameter included incorrect yaml which would not result in TLS being enabled. It should be:
data:
config.yaml: |
tls:
secretName: ${SECRET_NAME}
instead of
data:
config.yaml: |
tls.secretName: ${SECRET_NAME}
Modification
- Fix the config yaml
- Change kubectl appy to kubectl create to avoid overwriting existing config
- Add "> ca.crt" to the cert retrieval command
- Replace oc with kubectl in Certificate CR example
Result
Correct docs.
Signed-off-by: Nick Hill <[email protected]>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: njhill The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/lgtm |
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.
Motivation
The script snippet in our TLS docs for creating a configmap with the TLS secret name parameter included incorrect yaml which would not result in TLS being enabled. It should be:
instead of
Modification
kubectl applytokubectl createto avoid overwriting existing config> ca.crtto the cert retrieval commandocwithkubectlin Certificate CR exampleResult
Correct docs.
Signed-off-by: Nick Hill [email protected]