Manage workspaces

Introduced 2.18

You can access and modify the workspace details, including name, description, use case, and icon color, on the Workspace details page.

To access and modify your workspace details, follow these steps:

1. Open OpenSearch Dashboards and navigate to My Workspaces.
2. Choose the desired workspace and then select the Edit button to make changes
3. Select the Save button to confirm changes or the Discard changes button to cancel modifications.

Workspace update permissions

The following permissions apply when changing workspaces:

1. Without the Security plugin: All users can edit and update the workspace.
2. With the Security plugin installed and savedObjects.permission.enabled: false in the config/opensearch_dashboards.yml file: All users can edit and update workspaces.
3. With the Security plugin and savedObjects.permission.enabled: true in the config/opensearch_dashboards.yml: Only the workspace owner and the workspace admins can edit and update workspaces.

Workspace update restrictions

When updating workspace use cases, the following rules apply.

Workspace control panel

The Workspace details page features the following buttons in the upper-right corner:

1. Delete ( icon)
   • Without the Security plugin installed: All users can delete the workspace.
   • With the Security plugins installed and savedObjects.permission.enabled: false in the config/opensearch_dashboards.yml file: All users can delete the workspace.
   • With the Security plugin installed and savedObjects.permission.enabled: true in the config/opensearch_dashboards.yml file: Only the admin can delete the workspace.
2. Set as default workspace: Sets the current workspace as the default login destination.
3. Workspace overview: Opens the Overview page in a new tab.

Adding assets to the workspace

Access the Sample data in the navigation menu on the left. Select the appropriate dataset to install it in your cluster and OpenSearch Dashboards.

Migrating unassigned assets into a workspace

Saved objects created before workspaces were enabled don’t belong to any workspace. A workspace displays only the assets assigned to it, so these assets aren’t visible in any workspace even though they still exist in the cluster. A dashboard admin can move all unassigned assets into a new workspace using the migration wizard.

When unassigned assets exist, the workspaces landing page displays a Migrate existing assets (N) button to dashboard admins, where N is the number of unassigned assets.

To migrate unassigned assets into a new workspace, follow these steps:

1. On the workspaces landing page, select Migrate existing assets (N).
2. In the Workspace name field, enter a name for the new workspace.
3. Review the list of unassigned assets. You can search the list and filter it by asset type. The wizard migrates all unassigned assets, regardless of the search term or filter.
4. Select Create workspace and migrate. OpenSearch Dashboards creates the workspace, connects all data sources and data connections to it so that migrated dashboards continue to display data, and then migrates the assets. You can’t close the wizard while the migration is running.
5. Review the summary, which shows the number of migrated assets, failed assets, and connected data sources.
6. Select Go to <workspace name> to open the new workspace.

Assets that fail to migrate remain unassigned, and the summary lists each one with the reason it failed. To migrate them into the same workspace, select Retry failed assets. If the migration stops before it finishes, select Continue migrating to migrate the remaining assets into the same workspace.

Copying assets between workspaces

Data sources and configuration copying are not supported.

The assets page provides the following methods for copying assets across workspaces:

1. Copy all assets to…: Copies all assets in the table.
2. Copy to…: Moves selected assets from the table.
3. Copy to…: Copies a single asset from the table.

After selecting a copy option, choose the target workspace from the dropdown menu. The Copy related assets checkbox allows you to transfer associated assets.

Upon selecting the Copy button, a side panel appears showing successful and failed asset transfers. Asset copy destinations depend on the following security configurations:

1. Without the Security plugin: All workspaces are accessible.
2. With the Security plugin and savedObjects.permission.enabled: false in the config/opensearch_dashboards.yml file: All workspaces are accessible.
3. With the Security plugin and savedObjects.permission.enabled: true in the config/opensearch_dashboards.yml file: Only workspaces for which the user has read and write or admin permissions are accessible.

Associating data sources

On the data source management page, you can access a comprehensive list of associated OpenSearch connections, monitor direct query connections relevant to your current workspace, and establish new data source associations as needed.

Managing OpenSearch connections

The OpenSearch connections tab displays all associated connections for the current workspace. Follow these steps to manage your connections:

1. Access a comprehensive list of associated OpenSearch connections on the connections tab.
2. Use the Remove association button to unlink connections as needed.
3. Add new data sources by selecting the OpenSearch data sources button and subsequent modal.
4. Select from unassociated OpenSearch connections to expand your workspace’s capabilities.

Adding direct query connections

The Direct query connections tab displays a list of all direct query connections associated with your current workspace. To add more direct query connections to your workspace, select the Direct query data sources button. A modal window opens.

The association modal displays a list of OpenSearch connections that contain direct query connections and have not yet been associated with your current workspace. When you associate an OpenSearch connection with your current workspace, all direct query connections within that OpenSearch connection are automatically associated as well.

Deleting your workspace

Workspace deletion is restricted to admins. If you do not see a icon, check your permissions. See Configuring dashboard administrators for more information.

Deleting a workspace permanently erases all its assets (except data sources) and the workspace itself. This action cannot be reversed.

To delete a workspace, follow these steps:

1. From the Workspace details page, select the (trash can) icon in the upper-right corner to delete the current workspace.
2. Alternatively, from the workspace list page, select the (ellipsis) icon and select Delete. Optionally, select multiple workspaces for bulk deletion.

Navigating the workspaces list

The workspaces list page serves as your central hub for workspace management, displaying all workspaces for which you have access permissions. Key features include the following:

• Search: Quickly find a workspace by name.
• Filter: Sort workspaces by use case.
• At a glance: View each workspace’s name, use case, description, last update time, and associated data sources.

Each workspace entry includes an Actions column with the following functional buttons. These tools streamline your workspace management, allowing for efficient organization and customization of your OpenSearch Dashboards environment:

1. Copy ID: One-click copying of the workspace ID.
2. Edit: Direct access to the workspace’s detailed configuration page.
3. Set as default: Easily set any workspace as your default workspace.
4. Delete: Remove workspaces as needed (may require admin privileges).