Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: describe how to generate secret from cert file #1769

Merged
merged 2 commits into from
Apr 7, 2023

Conversation

ps-19
Copy link
Contributor

@ps-19 ps-19 commented Apr 6, 2023

Type of change:

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches
  • Documentation
  • Refactor
  • Chore
  • CI/CD or Tests

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:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@tao12345666333 tao12345666333 added the documentation Improvements or additions to documentation label Apr 6, 2023
@kingluo
Copy link

kingluo commented Apr 6, 2023

The changes are ok with me. Please ensure passing the CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants