Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _dashboards/workspace/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav_order: 10
---

# Workspaces APIs
Introduced 2.18
**Introduced 2.18**
{: .label .label-purple }

The Workspaces API provides a set of endpoints for managing workspaces in OpenSearch Dashboards.
Expand Down
2 changes: 1 addition & 1 deletion _dashboards/workspace/create-workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav_order: 1
---

# Create a workspace
Introduced 2.18
**Introduced 2.18**
{: .label .label-purple }

Before getting started with this tutorial, you must enable the workspace feature flag. See [Enabling the ACL feature]({{site.url}}{{site.baseurl}}/dashboards/workspace/workspace/#enabling-the-workspace-feature) for more information.
Expand Down
2 changes: 1 addition & 1 deletion _dashboards/workspace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:
---

# Getting started with workspaces
Introduced 2.18
**Introduced 2.18**
{: .label .label-purple }

OpenSearch Dashboards 2.18 introduces an enhanced home page that provides a comprehensive view of all your workspaces.
Expand Down
2 changes: 1 addition & 1 deletion _dashboards/workspace/manage-workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav_order: 2
---

# Manage workspaces
Introduced 2.18
**Introduced 2.18**
{: .label .label-purple }

You can access and modify the workspace details, including name, description, use case, and icon color, on the **Workspace details** page.
Expand Down
8 changes: 4 additions & 4 deletions _dashboards/workspace/workspace-acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav_order: 3
---

# Workspace access control lists
Introduced 2.18
**Introduced 2.18**
{: .label .label-purple }

Workspace access control lists (ACLs) manage authorization for saved objects `AuthZ(Authorization)` while enabling [Security in OpenSearch]({{site.url}}{{site.baseurl}}/security/) for `AuthN(Authentication)`.
Expand Down Expand Up @@ -47,7 +47,7 @@ Set all users as admins with this wildcard setting:
```yaml
opensearchDashboards.dashboardAdmin.users: ["*"]
```
{% include copy-curl.html %}
{% include copy.html %}

### Configuring admin access for a single user

Expand All @@ -56,7 +56,7 @@ Configure a user with the `admin-user-id` setting:
```yaml
opensearchDashboards.dashboardAdmin.users: ["admin-user-id"]
```
{% include copy-curl.html %}
{% include copy.html %}

### Configuring admin access by backend role

Expand All @@ -65,7 +65,7 @@ Configure a user with the `admin-role` setting:
```yaml
opensearchDashboards.dashboardAdmin.groups: ["admin-role"]
```
{% include copy-curl.html %}
{% include copy.html %}

### Admin-restricted operations

Expand Down
14 changes: 7 additions & 7 deletions _dashboards/workspace/workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ has_children: true
---

# Workspace for OpenSearch Dashboards
Introduced 2.18
**Introduced 2.18**
{: .label .label-purple }

The Workspace feature in OpenSearch Dashboards enables you to tailor your environment with use-case-specific configurations. For example, you can create dedicated workspaces for observability scenarios, allowing you to focus on relevant functionalities. Additionally, the Workspace feature enables organization of visual assets, such as dashboards and visualizations, within a workspace with isolated storage.
Expand All @@ -25,7 +25,7 @@ interface Workspace {
uiSettings: Record<string, unknown>;
}
```
{% include copy-curl.html %}
{% include copy.html %}

The Workspace data model is composed of the following key attributes:

Expand All @@ -48,7 +48,7 @@ The following object shows a typical Workspace configuration:
features: ["use-case-analytics"],
}
```
{% include copy-curl.html %}
{% include copy.html %}

The configuration creates the `Analytics team` using the `use-case-observability` feature set. Use cases map to specific feature groups, limiting functionality to the defined set within each workspace.

Expand Down Expand Up @@ -77,7 +77,7 @@ The following saved object shows a dashboard object associated with the workspac
workspaces: ["M5NqCu"]
}
```
{% include copy-curl.html %}
{% include copy.html %}

Saved objects support association with multiple workspaces, facilitating cross-team collaboration and resource sharing. This feature is useful when an object is relevant to multiple teams, projects, or use cases.

Expand All @@ -90,7 +90,7 @@ The following example shows a data source object linked to multiple workspaces:
workspaces: ["M5NqCu", "<TeamA-workspace-id>", "<Analytics-workspace-id>"]
}
```
{% include copy-curl.html %}
{% include copy.html %}

## Non-workspace saved objects

Expand All @@ -108,11 +108,11 @@ uiSettings:
overrides:
"home:useNewHomePage": true
```
{% include copy-curl.html %}
{% include copy.html %}

If your cluster has the Security plugin installed, then multi-tenancy must be disabled to avoid conflicts with similar workspaces:

```yaml
opensearch_security.multitenancy.enabled: false
```
{% include copy-curl.html %}
{% include copy.html %}