[Workspace] Dashboard admin(groups/users) implementation #6554

yubonluo · 2024-04-19T07:27:06Z

Description

This PR set the backend roles in groups or users, whoever has the backend roles or exactly match the user or groups ids defined in this yml.config/dynamic config will be regard as dashboard admin.
Dashboard admin will have the access to all the workspaces and objects inside OpenSearch Dashboards.

Issues Resolved

#6389

Changelog

feat: [Workspace] Dashboard admin(groups/users) implementation.

Screenshot

No UI change in this PR.

Testing the changes

Yml config test

Clone the latest code and clone security-dashboards-plugin to the plugins directory
Build the security-dashboards-plugin and bootstrap
Download the patch file test.patch and yarn git apply ./test.patch
Modify config/opensearch_dashboards.yml

workspace.enabled: true 
opensearch.hosts: ["https://localhost:9200"]
opensearch.username: "username"
opensearch.password: "password" 
opensearch.ssl.verificationMode: none
savedObjects.permission.enabled: true

opensearchDashboards.dashboardAdmin.groups: ["dashboard_admin"]
opensearchDashboards.dashboardAdmin.users: ["dashboard_admin"]

Run yarn start --no-base-path and visit http://localhost:5601
You can check whether it is dashboards admin in the console.

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

…ing with dynamic application config Signed-off-by: yubonluo <yubonluo@amazon.com>

Signed-off-by: yubonluo <yubonluo@amazon.com>

…boards into main-admin-back

Signed-off-by: yubonluo <yubonluo@amazon.com>

codecov · 2024-04-19T08:13:19Z

Codecov Report

Attention: Patch coverage is 96.77419% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 67.38%. Comparing base (3e9a159) to head (e6f9a18).

Files	Patch %	Lines
src/plugins/workspace/server/plugin.ts	90.90%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6554      +/-   ##
==========================================
+ Coverage   67.36%   67.38%   +0.01%     
==========================================
  Files        3443     3443              
  Lines       67762    67788      +26     
  Branches    11024    11031       +7     
==========================================
+ Hits        45651    45679      +28     
+ Misses      19440    19439       -1     
+ Partials     2671     2670       -1

Flag	Coverage Δ
Linux_1	`33.07% <96.77%> (+0.03%)`	⬆️
Linux_2	`55.13% <100.00%> (ø)`
Linux_3	`45.15% <0.00%> (+<0.01%)`	⬆️
Linux_4	`34.81% <100.00%> (ø)`
Windows_1	`33.09% <96.77%> (+0.03%)`	⬆️
Windows_2	`55.10% <100.00%> (ø)`
Windows_3	`45.16% <0.00%> (ø)`
Windows_4	`34.81% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/plugins/workspace/server/utils.ts

src/plugins/workspace/server/types.ts

Signed-off-by: yubonluo <yubonluo@amazon.com>

src/plugins/workspace/server/plugin.ts

…oards into main-admin-back

Signed-off-by: yubonluo <yubonluo@amazon.com>

…oards into main-admin-back

Signed-off-by: yubonluo <yubonluo@amazon.com>

…oards into main-admin-back

Signed-off-by: yubonluo <yubonluo@amazon.com>

…boards into main-admin-back

src/plugins/workspace/server/utils.ts

Signed-off-by: yubonluo <yubonluo@amazon.com>

…oards into main-admin-back

* [Workspace] dashboard admin(groups/users) implementation and integrating with dynamic application config Signed-off-by: yubonluo <yubonluo@amazon.com> * Modify change log Signed-off-by: yubonluo <yubonluo@amazon.com> * optimize the code Signed-off-by: yubonluo <yubonluo@amazon.com> * modify change log Signed-off-by: yubonluo <yubonluo@amazon.com> * modify change log Signed-off-by: yubonluo <yubonluo@amazon.com> * solve change log issue Signed-off-by: yubonluo <yubonluo@amazon.com> * Changeset file for PR #6554 created/updated * [Workspace] delete useless code Signed-off-by: yubonluo <yubonluo@amazon.com> * Changeset file for PR #6554 created/updated * delete useless code Signed-off-by: yubonluo <yubonluo@amazon.com> * Optimize the code Signed-off-by: yubonluo <yubonluo@amazon.com> * Add unit test to cover setupPermission in plugin. Signed-off-by: yubonluo <yubonluo@amazon.com> * delete the logic of dynamic application config Signed-off-by: yubonluo <yubonluo@amazon.com> * Default to OSD admin if security uninstall Signed-off-by: yubonluo <yubonluo@amazon.com> * Default to OSD admin if security uninstall Signed-off-by: yubonluo <yubonluo@amazon.com> --------- Signed-off-by: yubonluo <yubonluo@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit b839da1) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* [Workspace] dashboard admin(groups/users) implementation and integrating with dynamic application config * Modify change log * optimize the code * modify change log * modify change log * solve change log issue * Changeset file for PR #6554 created/updated * [Workspace] delete useless code * Changeset file for PR #6554 created/updated * delete useless code * Optimize the code * Add unit test to cover setupPermission in plugin. * delete the logic of dynamic application config * Default to OSD admin if security uninstall * Default to OSD admin if security uninstall --------- (cherry picked from commit b839da1) Signed-off-by: yubonluo <yubonluo@amazon.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: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

…project#6554) * [Workspace] dashboard admin(groups/users) implementation and integrating with dynamic application config Signed-off-by: yubonluo <yubonluo@amazon.com> * Modify change log Signed-off-by: yubonluo <yubonluo@amazon.com> * optimize the code Signed-off-by: yubonluo <yubonluo@amazon.com> * modify change log Signed-off-by: yubonluo <yubonluo@amazon.com> * modify change log Signed-off-by: yubonluo <yubonluo@amazon.com> * solve change log issue Signed-off-by: yubonluo <yubonluo@amazon.com> * Changeset file for PR opensearch-project#6554 created/updated * [Workspace] delete useless code Signed-off-by: yubonluo <yubonluo@amazon.com> * Changeset file for PR opensearch-project#6554 created/updated * delete useless code Signed-off-by: yubonluo <yubonluo@amazon.com> * Optimize the code Signed-off-by: yubonluo <yubonluo@amazon.com> * Add unit test to cover setupPermission in plugin. Signed-off-by: yubonluo <yubonluo@amazon.com> * delete the logic of dynamic application config Signed-off-by: yubonluo <yubonluo@amazon.com> * Default to OSD admin if security uninstall Signed-off-by: yubonluo <yubonluo@amazon.com> * Default to OSD admin if security uninstall Signed-off-by: yubonluo <yubonluo@amazon.com> --------- Signed-off-by: yubonluo <yubonluo@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

yubonluo and others added 5 commits April 15, 2024 13:45

[Workspace] dashboard admin(groups/users) implementation and integrat…

9488790

…ing with dynamic application config Signed-off-by: yubonluo <yubonluo@amazon.com>

Modify change log

4209c2a

Signed-off-by: yubonluo <yubonluo@amazon.com>

solve code conflict

8f06c87

Signed-off-by: yubonluo <yubonluo@amazon.com>

optimize the code

32224a6

Signed-off-by: yubonluo <yubonluo@amazon.com>

optimize the code

87c4288

Signed-off-by: yubonluo <yubonluo@amazon.com>

yubonluo requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, SuZhou-Joe, ruanyl, BionIT and xinruiba as code owners April 19, 2024 07:27

github-actions bot added first-time-contributor failed changeset labels Apr 19, 2024

yubonluo and others added 3 commits April 19, 2024 15:29

Merge branch 'main' into main-admin-back

ed1ff7f

modify change log

c4cd56a

Signed-off-by: yubonluo <yubonluo@amazon.com>

Merge branch 'main-admin-back' of github.com:yubonluo/OpenSearch-Dash…

efb52e1

…boards into main-admin-back

SuZhou-Joe added the workspace label Apr 19, 2024

modify change log

34f0164

Signed-off-by: yubonluo <yubonluo@amazon.com>

SuZhou-Joe reviewed May 17, 2024

View reviewed changes

src/plugins/workspace/server/utils.ts Show resolved Hide resolved

SuZhou-Joe reviewed May 17, 2024

View reviewed changes

src/plugins/workspace/server/utils.ts Outdated Show resolved Hide resolved

SuZhou-Joe reviewed May 17, 2024

View reviewed changes

src/plugins/workspace/server/types.ts Outdated Show resolved Hide resolved

Optimize the code

797698f

Signed-off-by: yubonluo <yubonluo@amazon.com>

SuZhou-Joe reviewed May 20, 2024

View reviewed changes

src/plugins/workspace/server/plugin.ts Outdated Show resolved Hide resolved

SuZhou-Joe previously approved these changes May 20, 2024

View reviewed changes

yubonluo added 2 commits May 20, 2024 13:25

Merge branch 'main' of github.com:opensearch-project/OpenSearch-Dashb…

da8e238

…oards into main-admin-back

Add unit test to cover setupPermission in plugin.

1e0b749

Signed-off-by: yubonluo <yubonluo@amazon.com>

yubonluo dismissed SuZhou-Joe’s stale review via 1e0b749 May 20, 2024 05:26

yubonluo added 2 commits May 21, 2024 16:35

Merge branch 'main' of github.com:opensearch-project/OpenSearch-Dashb…

422ee19

…oards into main-admin-back

delete the logic of dynamic application config

570e684

Signed-off-by: yubonluo <yubonluo@amazon.com>

SuZhou-Joe previously approved these changes May 23, 2024

View reviewed changes

yubonluo added 4 commits May 23, 2024 13:55

Merge branch 'main' into main-admin-back

347ed1b

Merge branch 'main' of github.com:opensearch-project/OpenSearch-Dashb…

05a3454

…oards into main-admin-back

Default to OSD admin if security uninstall

fd10be4

Signed-off-by: yubonluo <yubonluo@amazon.com>

Merge branch 'main-admin-back' of github.com:yubonluo/OpenSearch-Dash…

9010a31

…boards into main-admin-back

yubonluo dismissed SuZhou-Joe’s stale review via 9010a31 May 23, 2024 14:53

SuZhou-Joe reviewed May 24, 2024

View reviewed changes

src/plugins/workspace/server/utils.ts Show resolved Hide resolved

yubonluo added 3 commits May 24, 2024 10:15

Default to OSD admin if security uninstall

a9569af

Signed-off-by: yubonluo <yubonluo@amazon.com>

Merge branch 'main' of github.com:opensearch-project/OpenSearch-Dashb…

6dd28ef

…oards into main-admin-back

Merge branch 'main' into main-admin-back

e6f9a18

ruanyl approved these changes May 24, 2024

View reviewed changes

SuZhou-Joe approved these changes May 24, 2024

View reviewed changes

SuZhou-Joe added v2.15.0 backport 2.x labels May 24, 2024

SuZhou-Joe merged commit b839da1 into opensearch-project:main May 24, 2024
71 checks passed

opensearch-trigger-bot bot mentioned this pull request May 24, 2024

[Backport 2.x] [Workspace] Dashboard admin(groups/users) implementation #6829

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] Dashboard admin(groups/users) implementation #6554

[Workspace] Dashboard admin(groups/users) implementation #6554

yubonluo commented Apr 19, 2024 •

edited

codecov bot commented Apr 19, 2024 •

edited

[Workspace] Dashboard admin(groups/users) implementation #6554

[Workspace] Dashboard admin(groups/users) implementation #6554

Conversation

yubonluo commented Apr 19, 2024 • edited

Description

Issues Resolved

Changelog

Screenshot

Testing the changes

Yml config test

Check List

codecov bot commented Apr 19, 2024 • edited

Codecov Report

yubonluo commented Apr 19, 2024 •

edited

codecov bot commented Apr 19, 2024 •

edited