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

Add sections for removing OpenSearch Dashboards Security plugin #5830

Merged

Conversation

john-eliatra
Copy link
Contributor

@john-eliatra john-eliatra commented Dec 11, 2023

Description

The steps for disabling security needed more info relating to removing the securityDashboards plugin

Issues Resolved

Fixes #5812

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.

…ation types

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
john-eliatra and others added 3 commits December 13, 2023 11:21
Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Making the changes suggested by reviewer to move the paragraph relating to Dashboards removal down to the Remove OpenSearch Dashboards plugin section. 

Also, changing the headings within that section from 'Binary' to 'Tarball', and from 'Service' to 'RPM and Debian' to reflect the wording used for those types in the OpenSearch Installation sections.

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Dec 14, 2023
john-eliatra and others added 9 commits December 15, 2023 13:07
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Clarify the location of the running OpenSearch Dashboards instance before stopping it with the Ctrl + C command.

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@john-eliatra @Naarcha-AWS Please see my comments and changes and let me know if you have any questions. I'd like to read lines 46, 83, and 110 again before approving, so please tag me when complete. Thanks!

1. In `docker-compose.yml`, change `opensearchproject/opensearch-dashboards:{{site.opensearch_dashboards_version}}` to `opensearch-dashboards-no-security`.
1. Change `OPENSEARCH_HOSTS` or `opensearch.hosts` to `http://` rather than `https://`.
1. Enter `docker-compose up`.
1. Remove all Security plugin related configuration from the opensearch_dashbaords.yml file, or use the example file and place the file in the `/etc/opensearch_dashboards` folder.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Remove all Security plugin related configuration" needs a little revision for clarity.

john-eliatra and others added 6 commits December 18, 2023 13:53
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Quick fix on couple of typos of opensearch_dashboards.yml

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS Three deletions and then I can approve.

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

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Naarcha-AWS Naarcha-AWS merged commit ef7cace into opensearch-project:main Dec 20, 2023
@Naarcha-AWS Naarcha-AWS added the backport 2.11 PR: Backport label for 2.11 label Dec 20, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 20, 2023
* Add sections for removing Dashboards Security plugin in other installation types

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update disable.md

Making the changes suggested by reviewer to move the paragraph relating to Dashboards removal down to the Remove OpenSearch Dashboards plugin section.

Also, changing the headings within that section from 'Binary' to 'Tarball', and from 'Service' to 'RPM and Debian' to reflect the wording used for those types in the OpenSearch Installation sections.

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update disable.md

Clarify the location of the running OpenSearch Dashboards instance before stopping it with the Ctrl + C command.

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update disable.md

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update the HMAC authentication requirements of exchange_key

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.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: 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: 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: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update disable.md

Quick fix on couple of typos of opensearch_dashboards.yml

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.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>

---------

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.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 ef7cace)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS added a commit that referenced this pull request Dec 20, 2023
… (#5926)

* Add sections for removing Dashboards Security plugin in other installation types



* Update _security/configuration/disable.md




* Update _security/configuration/disable.md




* Update disable.md

Making the changes suggested by reviewer to move the paragraph relating to Dashboards removal down to the Remove OpenSearch Dashboards plugin section.

Also, changing the headings within that section from 'Binary' to 'Tarball', and from 'Service' to 'RPM and Debian' to reflect the wording used for those types in the OpenSearch Installation sections.



* Update _security/configuration/disable.md




* Update _security/configuration/disable.md




* Update _security/configuration/disable.md




* Update _security/configuration/disable.md




* Update _security/configuration/disable.md




* Update _security/configuration/disable.md




* Update disable.md

Clarify the location of the running OpenSearch Dashboards instance before stopping it with the Ctrl + C command.



* Update disable.md



* Update the HMAC authentication requirements of exchange_key



* Apply suggestions from code review




* Apply suggestions from code review




* Apply suggestions from code review




* Apply suggestions from code review




* Update disable.md

Quick fix on couple of typos of opensearch_dashboards.yml



* Apply suggestions from code review




---------






(cherry picked from commit ef7cace)

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
@hdhalter hdhalter mentioned this pull request Dec 20, 2023
20 tasks
@hdhalter hdhalter added the Feedback Feedback received from feedback mechanism on doc-website label Dec 20, 2023
@john-eliatra john-eliatra deleted the johnh-disable-security branch December 21, 2023 11:35
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
* Add sections for removing Dashboards Security plugin in other installation types

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update disable.md

Making the changes suggested by reviewer to move the paragraph relating to Dashboards removal down to the Remove OpenSearch Dashboards plugin section. 

Also, changing the headings within that section from 'Binary' to 'Tarball', and from 'Service' to 'RPM and Debian' to reflect the wording used for those types in the OpenSearch Installation sections.

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update _security/configuration/disable.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update disable.md

Clarify the location of the running OpenSearch Dashboards instance before stopping it with the Ctrl + C command.

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update disable.md

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>

* Update the HMAC authentication requirements of exchange_key

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.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: 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: 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: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update disable.md

Quick fix on couple of typos of opensearch_dashboards.yml

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.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>

---------

Signed-off-by: John Heraghty <148883955+john-eliatra@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.11 PR: Backport label for 2.11 Feedback Feedback received from feedback mechanism on doc-website security
Projects
None yet
5 participants