Add hot reload TLS certificate section #433 #6875
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: AntonEliatra <anton.rubin@eliatra.com>
AntonEliatra
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
stephen-crawford
approved these changes
Apr 9, 2024
Naarcha-AWS
added
4 - Doc review
Naarcha-AWS
requested changes
Apr 12, 2024
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
hdhalter
changed the title
Naarcha-AWS
approved these changes
Apr 17, 2024
Naarcha-AWS
added
5 - Editorial review
natebower
reviewed
Apr 17, 2024
There was a problem hiding this comment.
@AntonEliatra @Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!
_security/configuration/tls.md
Outdated
|
|
||
| After enabling hot reloading, use the Reload Certificates API to replace the expired certification. The API expects the old certificates to be replaced with valid certificates issued with the same `Issuer/Subject DN` and `SAN`. The new certificates also need be in the same location as the previous certificates, in order to prevent any changes to `opensearch.yml` file. | ||
|
|
||
| Only a [super admin]({{site.url}}{{site.baseurl}}/security/configuration/tls/#configuring-admin-certificates) can use the Reload Certificates API. |
There was a problem hiding this comment.
We've been using this as one word. I'll add it to the style guide/Vale if I haven't already.
_security/configuration/tls.md
Outdated
| {: .note } | ||
|
|
||
| ### Reload TLS certificates on the transport layer | ||
| The following example reloads TLS certificates on the transport layer: |
There was a problem hiding this comment.
Let's add the noun after "example".
_security/configuration/tls.md
Outdated
|
|
||
| ### Reload TLS certificates on the http layer | ||
|
|
||
| The following example reloads TLS certificates on the `http` layer: |
There was a problem hiding this comment.
Let's add the noun after "example".
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 18, 2024
* adding hot reload TLS certificate section #433 Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> * fixing issues on hot reload #433 Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> * Update tls.md Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> * Apply suggestions from code review Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> * Update tls.md Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> --------- Signed-off-by: AntonEliatra <anton.rubin@eliatra.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit fa38567) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.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.
Description
Adding a section outlining TLS certificate Hot Reloading API
Issues Resolved
Part of #433
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.