Enhancing Security configuration steps #8058

leanneeliatra · 2024-08-20T15:49:26Z

Description

Expanding on the Security Configuration steps listed
https://opensearch.org/docs/latest/security/configuration/index/

Issues Resolved

#7881

Version

all

Frontend features

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

…7881

github-actions · 2024-08-20T15:49:40Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

vagimeli · 2024-08-20T18:15:16Z

Hi @cwperks @shikharj05 @stephen-crawford, The documentation team needs a technical review of this security PR, with approval from you. Do one of you have capacity to take on this task? Turnaround time is by end of day Friday, 8/23. Thank you.

_security/configuration/index.md

vagimeli · 2024-08-20T20:57:37Z

@leanneeliatra Please see tech reviewer's feedback. Once these comments are addressed, please tag me to request tech reviewer approval. Thank you.

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

leanneeliatra · 2024-08-22T16:05:09Z

Addressing comments.

…7881 Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

…7881

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

…7881

natebower

@leanneeliatra @vagimeli @Naarcha-AWS Please see my comments and changes and tag me for approval once addressed (I'd like to verify lines 16 and 26). Thanks!

_security/configuration/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

_security/configuration/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: leanneeliatra <131779422+leanneeliatra@users.noreply.github.com>

_security/configuration/index.md

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

… the text, as is the standard (not to have hyperlinked headings). Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

leanneeliatra · 2024-09-19T11:41:46Z

@natebower I have completed all suggested updates and throughly reviewed the page in light of so many changes.

I also added a toc to the bottom of the page with all relevant links, as there is a lot of information on the page this is helpful. If you do not agree with that one, I can remove it. Thank you for the thorough review.

…7881

natebower

@Naarcha-AWS @leanneeliatra Please see my comments and changes and tag me for approval once addressed. Thanks!

natebower · 2024-09-19T12:08:03Z

_security/configuration/index.md

 redirect_from:
  - /security-plugin/configuration/
  - /security-plugin/configuration/index/
 ---

 # Security configuration

-The plugin includes demo certificates so that you can get up and running quickly. To use OpenSearch in a production environment, you must configure it manually:
+The plugin includes demo certificates so that you can get up and running quickly. To use OpenSearch in a production environment, you must configure it manually.


"The plugin" => "The Security plugin"? In the second sentence, does "it" refer to OpenSearch or to "the plugin"?

_security/configuration/index.md

natebower · 2024-09-19T12:12:50Z

_security/configuration/index.md

+   plugins.security.ssl.http.pemkey_filepath: /path/to/your/key.pem
+   plugins.security.ssl.http.pemtrustedcas_filepath: /path/to/your/ca.pem
+   ```
+For more information, see [Configuring TLS certificates.


Suggested change

For more information, see [Configuring TLS certificates.

For more information, see [Configuring TLS certificates

natebower · 2024-09-19T12:12:59Z

_security/configuration/index.md

+   plugins.security.ssl.http.pemtrustedcas_filepath: /path/to/your/ca.pem
+   ```
+For more information, see [Configuring TLS certificates.
+]({{site.url}}{{site.baseurl}}/security/configuration/tls/)


Suggested change

]({{site.url}}{{site.baseurl}}/security/configuration/tls/)

]({{site.url}}{{site.baseurl}}/security/configuration/tls/).

_security/configuration/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

natebower

@Naarcha-AWS LGTM with edited suggestions. Thanks!

_security/configuration/index.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* wip building out the security configuration steps Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * adding relevant links to docs. Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * adding further info to security settings Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * reviewdog issues fixed Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * paths given for 1.0 securityadmin Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * Reconfiguring layout Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * updating security configuraton Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * Update _security/configuration/index.md Co-authored-by: Craig Perkins <craig5008@gmail.com> Signed-off-by: leanneeliatra <131779422+leanneeliatra@users.noreply.github.com> * Updates for examples given in config doc. Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * Add doc review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update index.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Delete _security/configuration/test Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Made the securityadmin.sh backup tool instructions clearer Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _security/configuration/index.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * updating the command for the securityadmin tool Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * reviewdog updates Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: leanneeliatra <131779422+leanneeliatra@users.noreply.github.com> * removing headings as links Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * Updating headings to be headings and adding extra links at the end of the text, as is the standard (not to have hyperlinked headings). Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update index.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> Signed-off-by: leanneeliatra <131779422+leanneeliatra@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Craig Perkins <craig5008@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.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 9230b00) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

wip building out the security configuration steps

00124e0

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

leanneeliatra requested review from kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners August 20, 2024 15:49

Merge branch 'main' into adding-further-security-configuration-steps-…

a4c2155

…7881

github-actions bot assigned kolchfa-aws Aug 20, 2024

kolchfa-aws assigned vagimeli and unassigned kolchfa-aws Aug 20, 2024

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

cwperks reviewed Aug 20, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

vagimeli added 3 - Tech review PR: Tech review in progress 2 - In progress Issue/PR: The issue or PR is in progress. labels Aug 20, 2024

leanneeliatra changed the title ~~[DRAFT] Enhancing Security configuration steps~~ Enhancing Security configuration steps Aug 21, 2024

leanneeliatra added 2 commits August 22, 2024 17:03

adding relevant links to docs.

61d250e

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

adding further info to security settings

5a6c4e7

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

Naarcha-AWS and others added 5 commits September 5, 2024 11:17

Merge branch 'main' into adding-further-security-configuration-steps-…

b2d7b86

…7881 Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Merge branch 'main' into adding-further-security-configuration-steps-…

ddf194f

…7881

Merge branch 'main' into adding-further-security-configuration-steps-…

3f9cbc2

…7881

reviewdog updates

fd1e181

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

Merge branch 'main' into adding-further-security-configuration-steps-…

521712b

…7881

natebower requested changes Sep 17, 2024

View reviewed changes

natebower removed the 6 - Done but waiting to merge PR: The work is done and ready to merge label Sep 17, 2024

Naarcha-AWS reviewed Sep 17, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

Apply suggestions from code review

46a3134

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

natebower reviewed Sep 18, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

natebower reviewed Sep 18, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

natebower reviewed Sep 18, 2024

View reviewed changes

_security/configuration/index.md Show resolved Hide resolved

Apply suggestions from code review

74bbc7b

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: leanneeliatra <131779422+leanneeliatra@users.noreply.github.com>

natebower reviewed Sep 18, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

leanneeliatra added 2 commits September 19, 2024 11:40

removing headings as links

cfaceac

Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

Updating headings to be headings and adding extra links at the end of…

bb29ae0

… the text, as is the standard (not to have hyperlinked headings). Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

Merge branch 'main' into adding-further-security-configuration-steps-…

7a7426f

…7881

natebower requested changes Sep 19, 2024

View reviewed changes

Naarcha-AWS reviewed Sep 19, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Sep 19, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

Naarcha-AWS and others added 2 commits September 19, 2024 07:24

Apply suggestions from code review

039ddda

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Update index.md

86d09ab

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

natebower approved these changes Sep 19, 2024

View reviewed changes

_security/configuration/index.md Outdated Show resolved Hide resolved

_security/configuration/index.md Outdated Show resolved Hide resolved

Apply suggestions from code review

e296118

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS added the backport 2.17 Backport for version 2.17 label Sep 19, 2024

Naarcha-AWS merged commit 9230b00 into opensearch-project:main Sep 19, 2024
6 checks passed

opensearch-trigger-bot bot mentioned this pull request Sep 19, 2024

[Backport 2.17] Enhancing Security configuration steps #8341

Merged

github-actions bot pushed a commit that referenced this pull request Sep 19, 2024

Enhancing Security configuration steps (#8058) (#8341)

937c70c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancing Security configuration steps #8058

Enhancing Security configuration steps #8058

leanneeliatra commented Aug 20, 2024 •

edited

Loading

github-actions bot commented Aug 20, 2024

vagimeli commented Aug 20, 2024

vagimeli commented Aug 20, 2024

leanneeliatra commented Aug 22, 2024

natebower left a comment

leanneeliatra commented Sep 19, 2024

natebower left a comment

natebower Sep 19, 2024

natebower Sep 19, 2024

natebower Sep 19, 2024

natebower left a comment

	For more information, see [Configuring TLS certificates.
	For more information, see [Configuring TLS certificates

	]({{site.url}}{{site.baseurl}}/security/configuration/tls/)
	]({{site.url}}{{site.baseurl}}/security/configuration/tls/).

Enhancing Security configuration steps #8058

Enhancing Security configuration steps #8058

Conversation

leanneeliatra commented Aug 20, 2024 • edited Loading

Description

Issues Resolved

Version

Frontend features

Checklist

github-actions bot commented Aug 20, 2024

vagimeli commented Aug 20, 2024

vagimeli commented Aug 20, 2024

leanneeliatra commented Aug 22, 2024

natebower left a comment

Choose a reason for hiding this comment

leanneeliatra commented Sep 19, 2024

natebower left a comment

Choose a reason for hiding this comment

natebower Sep 19, 2024

Choose a reason for hiding this comment

natebower Sep 19, 2024

Choose a reason for hiding this comment

natebower Sep 19, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

leanneeliatra commented Aug 20, 2024 •

edited

Loading