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 Security information to Security Analytics documentation #3184

Merged
merged 23 commits into from
Apr 5, 2023

Conversation

cwillum
Copy link
Contributor

@cwillum cwillum commented Mar 3, 2023

Description

Most plugins have a topic in their documentation that provides information about integration with the Security plugin. This adds an equivalent topic for Security Analytics

Issues Resolved

Created documentation that discusses basic permissions and backend roles for for Security Analytics
Fixes #3183

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: cwillum <cwmmoore@amazon.com>
@cwillum cwillum added 2 - In progress Issue/PR: The issue or PR is in progress. backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 security-analytics labels Mar 3, 2023
@cwillum cwillum requested a review from a team as a code owner March 3, 2023 00:56
@cwillum cwillum self-assigned this Mar 3, 2023
cwillum added 4 commits March 8, 2023 14:27
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
@cwillum
Copy link
Contributor Author

cwillum commented Mar 13, 2023

@opensearch-project/security Team, to begin organizing, defining, and rounding out permissions in the documentation, I took the opportunity to categorize cluster permissions and provide references to APIs while adding new permissions for Security Analytics. There are two cluster permissions, however, that I'm not clear on:

  1. cluster:admin/reindex/rethrottle
  2. cluster:admin/reroute

Do you know what these allow users to do and what API you would associate them with? Thanks.

cwillum added 4 commits March 13, 2023 16:39
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
@cwillum cwillum added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Mar 14, 2023
@cwillum
Copy link
Contributor Author

cwillum commented Mar 14, 2023

@sbcd90 @amsiglan Could one of you two have a look at the new security section I added for Security Analytics? It's borrowed from other plugins (e.g., alerting, anomaly detection) and includes information like basic roles for the plugin and how to use backend roles. It also cross references to the Permissions page in documentation. This now lists the permissions for Security Analytics.
I also began reorganizing all cluster permissions on this page. It probably wasn't a good idea to mix the two tasks. But I couldn't resist the change. You'll see a lot of that in the changes, too. Thanks.

@amsiglan
Copy link

@sbcd90 @amsiglan Could one of you two have a look at the new security section I added for Security Analytics? It's borrowed from other plugins (e.g., alerting, anomaly detection) and includes information like basic roles for the plugin and how to use backend roles. It also cross references to the Permissions page in documentation. This now lists the permissions for Security Analytics. I also began reorganizing all cluster permissions on this page. It probably wasn't a good idea to mix the two tasks. But I couldn't resist the change. You'll see a lot of that in the changes, too. Thanks.

Left a couple of comments, rest looks good to me

Signed-off-by: cwillum <cwmmoore@amazon.com>
@cwillum cwillum added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Mar 15, 2023
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@cwillum Review completed. Minimal comments.

_security-analytics/security.md Outdated Show resolved Hide resolved
_security-analytics/security.md Outdated Show resolved Hide resolved
_security-analytics/security.md Outdated Show resolved Hide resolved
_security-analytics/security.md Outdated Show resolved Hide resolved
_security-analytics/security.md Outdated Show resolved Hide resolved
_security/access-control/permissions.md Outdated Show resolved Hide resolved
_security/access-control/permissions.md Outdated Show resolved Hide resolved
_security/access-control/permissions.md Show resolved Hide resolved
_security/access-control/permissions.md Show resolved Hide resolved
_security/access-control/users-roles.md Outdated Show resolved Hide resolved
Signed-off-by: cwillum <cwmmoore@amazon.com>
cwillum and others added 6 commits March 21, 2023 16:14
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
@cwillum
Copy link
Contributor Author

cwillum commented Mar 23, 2023

@JeffH-AWS Thanks for the thorough review. The broken links you pointed out are now resolved.

@cwillum
Copy link
Contributor Author

cwillum commented Mar 24, 2023

@here Just waiting for a final sign-off on this from doc team review comments.

@cwillum
Copy link
Contributor Author

cwillum commented Mar 30, 2023

@JeffH-AWS please verify and OK changes so I can get this one out the door. Thanks.

Signed-off-by: cwillum <cwmmoore@amazon.com>
@Naarcha-AWS Naarcha-AWS dismissed JeffHuss’s stale review April 5, 2023 16:20

Review feedback already implemented

@cwillum cwillum merged commit ede7271 into main Apr 5, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.4 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.4 2.4
# Navigate to the new working tree
pushd ../.worktrees/backport-2.4
# Create a new branch
git switch --create backport/backport-3184-to-2.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ede72716a584fc76d72df244cbafe6bcaeb7c8dc
# Push it to GitHub
git push --set-upstream origin backport/backport-3184-to-2.4
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.4

Then, create a pull request where the base branch is 2.4 and the compare/head branch is backport/backport-3184-to-2.4.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.5 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.5 2.5
# Navigate to the new working tree
pushd ../.worktrees/backport-2.5
# Create a new branch
git switch --create backport/backport-3184-to-2.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ede72716a584fc76d72df244cbafe6bcaeb7c8dc
# Push it to GitHub
git push --set-upstream origin backport/backport-3184-to-2.5
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.5

Then, create a pull request where the base branch is 2.5 and the compare/head branch is backport/backport-3184-to-2.5.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.6 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.6 2.6
# Navigate to the new working tree
pushd ../.worktrees/backport-2.6
# Create a new branch
git switch --create backport/backport-3184-to-2.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ede72716a584fc76d72df244cbafe6bcaeb7c8dc
# Push it to GitHub
git push --set-upstream origin backport/backport-3184-to-2.6
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.6

Then, create a pull request where the base branch is 2.6 and the compare/head branch is backport/backport-3184-to-2.6.

@cwillum
Copy link
Contributor Author

cwillum commented Apr 5, 2023

Will revisit merge conflicts after 2.7 release.

@cwillum cwillum removed the 4 - Doc review PR: Doc review in progress label Apr 7, 2023
vagimeli pushed a commit that referenced this pull request Apr 25, 2023
* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183 for merge main

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183 fixing links-breaking links

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
vagimeli added a commit that referenced this pull request Apr 25, 2023
vagimeli pushed a commit that referenced this pull request May 4, 2023
* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183 for merge main

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183 fixing links-breaking links

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
vagimeli added a commit that referenced this pull request May 4, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
…rch-project#3184)

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183 for merge main

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183 fixing links-breaking links

Signed-off-by: cwillum <cwmmoore@amazon.com>

* sec permissions for SA

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#3183-sec-for-sec-a

Signed-off-by: cwillum <cwmmoore@amazon.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
@hdhalter hdhalter deleted the fix#3183-sec-for-sec-a branch March 28, 2024 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 security-analytics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]Create an OpenSearch Security compatibility topic for Security Analytics
7 participants