Link Search Menu Expand Document Documentation Menu
Documentation

Forecaster access control

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, join the discussion on the OpenSearch forum.

The forecaster resource integrates with the Security plugin’s resource sharing and access control framework to provide document-level authorization for forecaster resources. This replaces the legacy plugins.forecast.filter_by_backend_roles setting with a more flexible sharing system that allows resource owners to grant specific access levels to users, roles, or backend roles.

For the end-to-end framework concepts and APIs, see Resource sharing and access control.

Resource configuration

The following table describes the forecaster resource configuration.

Field Value
Resource type forecaster
System index .opensearch-forecasters
Onboarded version OpenSearch 3.3

When resource-level authorization is enabled for forecasters, each forecaster’s visibility is governed by a central sharing record. Resource owners and users with sharing capabilities can grant or revoke access permissions for specific users, roles, or backend roles.

Enable forecaster resource sharing

To enable resource sharing for forecasters, you must add the forecaster resource type to the protected types list and enable resource sharing cluster-wide.

Admin-only: These settings can be configured only by cluster administrators with superadmin privileges.

Configuration using opensearch.yml

Add the following settings to your opensearch.yml configuration file to enable resource sharing for forecasters:

plugins.security.experimental.resource_sharing.enabled: true
plugins.security.system_indices.enabled: true
plugins.security.experimental.resource_sharing.protected_types:
  - "forecaster"

Configuration using the Cluster Settings API

Alternatively, you can enable resource sharing dynamically using the Cluster Settings API:

PUT _cluster/settings
{
  "transient": {
    "plugins.security.experimental.resource_sharing.enabled": true,
    "plugins.security.experimental.resource_sharing.protected_types": ["forecaster"]
  }
}

When adding the forecaster resource type to an existing configuration, include all previously configured resource types in the protected_types array.

Forecaster access levels

The forecaster plugin provides three predefined access levels for forecaster documents. These access levels determine the specific permissions granted to users who have been granted access to a forecaster resource.

forecast_read_only

The forecast_read_only read-only access level grants users the ability to view and search shared forecasters but not modify them. This access level includes the following permissions:

- 'cluster:admin/plugin/forecast/forecaster/info'
- 'cluster:admin/plugin/forecast/forecaster/stats'
- 'cluster:admin/plugin/forecast/forecaster/suggest'
- 'cluster:admin/plugin/forecast/forecaster/validate'
- 'cluster:admin/plugin/forecast/forecasters/get'
- 'cluster:admin/plugin/forecast/forecasters/info'
- 'cluster:admin/plugin/forecast/result/topForecasts'

forecast_read_write

The forecast_read_write read-write access level grants users full access to forecaster operations except for sharing capabilities. This access level includes all read permissions plus write operations:

- 'cluster:admin/plugin/forecast/*'
- 'cluster:monitor/*'
- 'cluster:admin/settings/update'

forecast_full_access

The forecast_full_access full access level grants users complete control over a forecaster, including owner-like permissions such as sharing the resource with other users. This access level includes all forecaster operations plus resource sharing permissions:

- 'cluster:admin/plugin/forecast/*'
- 'cluster:monitor/*'
- 'cluster:admin/settings/update'
- "cluster:admin/security/resource/share"

These access levels are predefined and cannot be modified. To request additional access levels, create an issue in the Anomaly Detection GitHub repository.

Migrating from the legacy framework

After enabling resource sharing and marking forecasters as a protected resource type, cluster administrators must run the migration API to transfer existing forecaster sharing information from the legacy framework to the new resource sharing system.

Admin-only: The Migrate API can only be executed by cluster administrators with superadmin or REST admin privileges.

Use the following API call to migrate legacy forecaster sharing data to the resource sharing framework:

POST _plugins/_security/api/resources/migrate
{
  "source_index": ".opensearch-forecasters",
  "username_path": "/user/name",
  "backend_roles_path": "/user/backend_roles",
  "default_owner": "<replace-with-existing-user>",
  "default_access_level": {
    "forecaster": "<select-appropriate-access-level>"
  }
}

Replace <replace-with-existing-user> with the username of an existing user who should own forecasters without explicit ownership information. Replace <select-appropriate-access-level> with one of the available forecaster access levels: forecast_read_only, forecast_read_write, or forecast_full_access.

350 characters left

Have a question? .

Want to contribute? or .