This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Observability security

You can use the Security plugin with Observability in OpenSearch to limit non-admin users to specific actions. For example, you might want some users to only view visualizations, notebooks, and other Observability objects, while others can create and modify them.

Basic permissions

The Security plugin has two built-in roles that cover most Observability use cases: observability_full_access and observability_read_access. For descriptions of each, see Predefined roles. If you don’t see these predefined roles in OpenSearch Dashboards, you can create them with the following commands:

  1. PUT _plugins/_security/api/roles/observability_read_access
  2. {
  3.   "cluster_permissions": [
  4.     "cluster:admin/opensearch/observability/get"
  5.   ]
  6. }
  1. PUT _plugins/_security/api/roles/observability_full_access
  2. {
  3.   "cluster_permissions": [
  4.     "cluster:admin/opensearch/observability/*"
  5.   ]
  6. }

If these roles don’t meet your needs, mix and match individual Observability permissions to suit your use case. For example, the cluster:admin/opensearch/observability/create permission lets you create Observability objects (visualizations, operational panels, notebooks, etc.).

The following is an example role that provides access to Observability:

  1. PUT _plugins/_security/api/roles/observability_permissions
  2. {
  3.   "cluster_permissions": [
  4.     "cluster:admin/opensearch/observability/create",
  5.     "cluster:admin/opensearch/observability/update",
  6.     "cluster:admin/opensearch/observability/delete",
  7.     "cluster:admin/opensearch/observability/get"
  8.     ],
  9.   "index_permissions": [{
  10.     "index_patterns": [".opensearch-observability"],
  11.     "allowed_actions": ["write", "read", "search"]
  12.   }],
  13.   "tenant_permissions": [{
  14.     "tenant_patterns": ["global_tenant"],
  15.     "allowed_actions": ["opensearch_dashboards_all_write"]
  16.   }]
  17. }