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

Addition of full file paths in security documentation #8113

Conversation

leanneeliatra
Copy link
Contributor

Description

Adding in the full file paths for the files listed in the configuration of opensearch security.
Namely full file paths added to these pages of the docs:

  1. https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/security-settings/
  2. https://opensearch.org/docs/latest/security/configuration/yaml/

Issues Resolved

Closes #7879

Version

all

Frontend features

n/a

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.

Copy link

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.

@kolchfa-aws kolchfa-aws assigned vagimeli and unassigned kolchfa-aws Aug 28, 2024
@vagimeli
Copy link
Contributor

vagimeli commented Aug 28, 2024

@cwperks @shikharj05 @stephen-crawford Will one of you provide technical review and approval? Following your review, we'll move this forward to get the documentation published. Thank you for your support.

@vagimeli
Copy link
Contributor

@leanneeliatra Please see tech reviewer comments. Please tag me when it's ready to move forward. Thank you.

@leanneeliatra
Copy link
Contributor Author

@leanneeliatra Please see tech reviewer comments. Please tag me when it's ready to move forward. Thank you.

Review comments addressed and PR ready to move on @vagimeli, thank you.

@vagimeli
Copy link
Contributor

@Naarcha-AWS Assigning this security PR to you for doc review. Thank you.

@vagimeli vagimeli added security 4 - Doc review PR: Doc review in progress 2 - In progress Issue/PR: The issue or PR is in progress. labels Aug 29, 2024
_security/configuration/security-admin.md Outdated Show resolved Hide resolved
_security/configuration/security-admin.md Outdated Show resolved Hide resolved
_security/configuration/yaml.md Outdated Show resolved Hide resolved
_security/configuration/yaml.md Outdated Show resolved Hide resolved
_security/configuration/yaml.md Outdated Show resolved Hide resolved
_security/configuration/yaml.md Outdated Show resolved Hide resolved
@@ -284,6 +281,8 @@ _meta:

## roles_mapping.yml

Typically found at `<OPENSEARCH_HOME>/config/opensearch-security/roles_mapping.yml`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This file contains any role mappings required for your security configuration. You can find the role_mapping.yml file in <OPENSEARCH_HOME>/config/opensearch-security/roles_mapping.yml.

@Naarcha-AWS Naarcha-AWS merged commit ef8abd7 into opensearch-project:main Sep 3, 2024
5 checks passed
epugh pushed a commit to o19s/documentation-website that referenced this pull request Sep 12, 2024
…ject#8113)

* added full file paths for security config files
Signed-off-by: [email protected] <[email protected]>

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

* added full file paths for security config files
Signed-off-by: [email protected] <[email protected]>

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

# Conflicts:
#	_security/configuration/yaml.md

* small edits to full file paths for security config files
Signed-off-by: [email protected] <[email protected]>

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

* updates to file paths following tech review
Signed-off-by: [email protected] <[email protected]>

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

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Take into account previous changes

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

* Apply suggestions from code review

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

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. 4 - Doc review PR: Doc review in progress security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Describe full paths in security documentation
5 participants