ps-19 opened a new pull request, #1769:
URL: https://github.com/apache/apisix-ingress-controller/pull/1769

   <!-- Please answer these questions before submitting a pull request -->
   
   ### Type of change:
   
   <!-- Please delete options that are not relevant. -->
   
   <!-- Select all the options from below that matches the type your PR best -->
   
   - [ ] Bugfix
   - [ ] New feature provided
   - [ ] Improve performance
   - [ ] Backport patches
   - [x] 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.
   
   
   <!--- Why is this change required? What problem does it solve? -->
   <!--- If it fixes an open issue, please link to the issue here. -->
   
   ### Pre-submission checklist:
   
   <!--
   Please follow the requirements:
   1. Use Draft if the PR is not ready to be reviewed
   2. Test is required for the feat/fix PR, unless you have a good reason
   3. Doc is required for the feat PR
   4. Use a new commit to resolve review instead of `push -f`
   5. Use "request review" to notify the reviewer once you have resolved the 
review
   -->
   
   - [x] Did you explain what problem does this PR solve? Or what new features 
have been added?
   - [x] Have you added corresponding test cases?
   - [x] Have you modified the corresponding document?
   - [x] Is this PR backward compatible? **If it is not backward compatible, 
please discuss on the [mailing 
list](https://github.com/apache/apisix-ingress-controller#community) first**
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to