docs: describe how to generate secret from cert file #1769
Merged
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.
Type of change:
What this PR does / why we need it:
This PR addresses issue #1767, which highlights a lack of documentation on how to generate a Kubernetes secret from a cert file. Specifically, the current documentation for protecting a route using SSL with the Apache APISIX Ingress Controller does not provide information on the format and meaning of the secret or how to generate it.
To address this issue, this PR adds detailed instructions on generating a Kubernetes secret from a cert file. The updated documentation includes the meaning and format of the secret, as well as commands to generate the base64 value of the cert and private key files. With these instructions, users will be able to properly generate a secret and use it to protect their routes using SSL with the Apache APISIX Ingress Controller.
Overall, this PR improves the usability and accessibility of the Apache APISIX Ingress Controller documentation by providing clear instructions on an important aspect of SSL configuration.
Pre-submission checklist: