Add workspace documentation #213
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ruanyl
requested review from
wanglam,
SuZhou-Joe,
gaobinlong,
yuye-aws,
raintygao and
Hailong-am
xluo-aws
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| ``` | ||
|
|
||
| 1. `id`: A unique identifier that distinguishes each workspace. | ||
| 2. `name`: The name of the workspace. |
xluo-aws
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| enhances security and access control (Please ref to this [DOC](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4633) for more details | ||
| about access control). | ||
|
|
||
| A new attribute, `workspaces`, is being added to saved objects which type is an array of string. A saved object can be associated with one |
There was a problem hiding this comment.
or no workspace for example advanced setting
There was a problem hiding this comment.
I will add a separate section for non-workspace data
xluo-aws
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| } | ||
| ``` | ||
|
|
||
| Saved object can also associated with multiple workspaces, this is useful in scenarios where a saved object is relevant |
xluo-aws
reviewed
Oct 10, 2023
xluo-aws
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| } | ||
| ``` | ||
| ### Handling Dependencies | ||
| A significant aspect of copying saved objects is the handling of dependencies. Many saved objects, particularly |
There was a problem hiding this comment.
Should we use duplicate instead of copy to align with UX?
xluo-aws
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| - **Purpose**: The Global Workspace serves as a centralized environment for managing resources and configurations that apply | ||
| globally across OpenSearch Dashboards. | ||
| - **Features**: It includes features that are accessible to all users, regardless of their specific teams or projects. | ||
| - **Permissions**: All users have `read` and `write` permission to public workspace and its associated saved objects. |
There was a problem hiding this comment.
Could you replace public with global to be consistent?
xluo-aws
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| - **Permissions**: Access to the Personal Workspace is limited to the user who owns it, ensuring data privacy and personalization. | ||
| 3. Management Workspace | ||
| - **Purpose**: The Management Workspace is dedicated to administrative tasks and configurations within OpenSearch Dashboards. | ||
| - **Features**: It encompasses features and tools necessary for system administrators to manage OSD advanced settings, data sources |
There was a problem hiding this comment.
data source can be managed in any workspace, so we may not want to call out here
There was a problem hiding this comment.
I see, what features are management workspace exclusive?
There was a problem hiding this comment.
Index management, snapshot management, security plugin, notification.
xluo-aws
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| - **Permissions**: Initially, access to the Management Workspace is set to public during initialization, administrators have the | ||
| responsibility and privilege to restrict access and define permissions within the Management Workspace. | ||
|
|
||
|
|
There was a problem hiding this comment.
Can we add a link to opensearch-project#5083 for workspace and it's object permission?
wanglam
reviewed
Oct 10, 2023
docs/plugins/workspace.md
Outdated
| 1. `id`: A unique identifier that distinguishes each workspace. | ||
| 2. `name`: The name of the workspace. | ||
| 3. `description`: A description providing context for the workspace. | ||
| 4. `features`: An array of application IDs associated with the workspace, derived from the plugins registered. These application IDs |
There was a problem hiding this comment.
The features accept applications IDs and rules right? Do we need to add rule syntax here?
There was a problem hiding this comment.
Yes. There are some examples in the below. We can say accept rules here.
Signed-off-by: Yulong Ruan <[email protected]>
Signed-off-by: Yulong Ruan <[email protected]>
Signed-off-by: Yulong Ruan <[email protected]>
xluo-aws
approved these changes
Oct 13, 2023
raintygao
reviewed
Oct 13, 2023
xluo-aws
approved these changes
Oct 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Issues Resolved
Screenshot
Testing the changes
Check List
yarn test:jestyarn test:jest_integrationyarn test:ftr