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

adding a get started with security page #6668 #7128

Merged

Conversation

AntonEliatra
Copy link
Contributor

@AntonEliatra AntonEliatra commented May 10, 2024

Description

Adding "Getting started with OpenSearch security" page

Issues Resolved

Closes #6668

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.

@hdhalter
Copy link
Contributor

hdhalter commented May 10, 2024

Thanks, @AntonEliatra ! Looks great. Can you please address the Vale errors? In the meantime, I'm checking on the location with @kolchfa-aws.

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. security labels May 10, 2024
@AntonEliatra
Copy link
Contributor Author

@hdhalter Great thanks, Vale errors are fixed now

@hdhalter
Copy link
Contributor

@hdhalter Great thanks, Vale errors are fixed now

Thanks! From Fanit: #7119

@AntonEliatra
Copy link
Contributor Author

@hdhalter this is now ready for review

@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels May 16, 2024
@hdhalter
Copy link
Contributor

Thanks, @AntonEliatra ! @scrawfor99 - can you please give this a review? Is there anyone else that you think should take a look? Thanks.

@hdhalter hdhalter added the backport 2.14 PR: Backport label for 2.14 label May 16, 2024
Copy link
Contributor

@stephen-crawford stephen-crawford left a comment

Choose a reason for hiding this comment

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

Nice :D

_getting-started/security.md Outdated Show resolved Hide resolved
@hdhalter
Copy link
Contributor

Thanks, @scrawfor99 ! @DarshitChanpura , can you please review this since it has a section on setting up the security config demo?

Copy link
Member

@DarshitChanpura DarshitChanpura left a comment

Choose a reason for hiding this comment

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

Hi @AntonEliatra thank you for raising this PR.

Left some suggestions for changes. We should also mention the already existing setup doc for using demo configuration: https://opensearch.org/docs/latest/security/configuration/demo-configuration/ since that talks in depth about how to set-up security using demo configuration.

_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
AntonEliatra and others added 3 commits May 27, 2024 09:21
Co-authored-by: Darshit Chanpura <[email protected]>
Co-authored-by: Stephen Crawford <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
Copy link
Member

@DarshitChanpura DarshitChanpura left a comment

Choose a reason for hiding this comment

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

LGTM @AntonEliatra ! Thank you for addressing the comments. There are a couple of minor vale errors around styling. Please take a look at those once you get a chance.

Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
@Naarcha-AWS Naarcha-AWS self-assigned this May 29, 2024
@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels May 29, 2024
@AntonEliatra
Copy link
Contributor Author

@DarshitChanpura Thanks for the review, I've added reference to existing documentation, regarding the Vale error, I'm not sure how to reference a name of external too without raising a vale error

@natebower
Copy link
Collaborator

@DarshitChanpura Thanks for the review, I've added reference to existing documentation, regarding the Vale error, I'm not sure how to reference a name of external too without raising a vale error

@AntonEliatra @DarshitChanpura You can ignore the Vale error. It's just flagging it because it's not in the dictionary. Thanks!

Signed-off-by: Naarcha-AWS <[email protected]>
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 Please see my comments and changes and let me know if you have any questions. Thanks!

_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
_getting-started/security.md Outdated Show resolved Hide resolved
```
{% include copy.html %}

## Uploading the configuration to security index
Copy link
Collaborator

Choose a reason for hiding this comment

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

Either "a" or "the" should precede "security index".

_getting-started/security.md Outdated Show resolved Hide resolved

## Uploading the configuration to security index

The final step in configuring users, roles and any other security configuration is uploading it to OpenSearch security index. Only updating the files, without uploading them, will not change any configuration inside the already running OpenSearch cluster.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Either "a" or "the" should precede "OpenSearch security index".

_getting-started/security.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS merged commit f912f9d into opensearch-project:main Jun 4, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 4, 2024
* adding a get started with security page #6668

Signed-off-by: AntonEliatra <[email protected]>

* fixing vale errors #6668

Signed-off-by: AntonEliatra <[email protected]>

* fixing vale errors #6668

Signed-off-by: AntonEliatra <[email protected]>

* adding role configurations for users without kibanauser mapping #2359

Signed-off-by: AntonEliatra <[email protected]>

* updating the page layout for getting started with security #6668

Signed-off-by: AntonEliatra <[email protected]>

* Apply suggestions from code review

Co-authored-by: Darshit Chanpura <[email protected]>
Co-authored-by: Stephen Crawford <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>

* adding additional details to getting started with security

Signed-off-by: AntonEliatra <[email protected]>

* adding additional details to getting started with security

Signed-off-by: AntonEliatra <[email protected]>

* Update security.md

Signed-off-by: AntonEliatra <[email protected]>

* Update security.md

Signed-off-by: AntonEliatra <[email protected]>

* adding link for existing docs for demo config

Signed-off-by: AntonEliatra <[email protected]>

* Doc review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Darshit Chanpura <[email protected]>
Co-authored-by: Stephen Crawford <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit f912f9d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@AntonEliatra AntonEliatra deleted the getting-started-with-security branch June 5, 2024 10:47
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.14 PR: Backport label for 2.14 security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Getting started with OpenSearch security
6 participants