Permissions

Overview

Permissions in StackState allow Administrators to manage the actions that each user or user group can perform inside StackState and the information that will be shown in their StackState UI. Only the feature set relevant to each user's active role will be presented. The actions, information and pages that a user does not have access to are simply not displayed in their StackState UI.

Permissions are stored in StackGraph. This means that:

  • If you perform an upgrade with "clear all data", permission setup will also be removed.

  • To completely remove a user, they must also be manually removed from StackGraph.

There are two types of permission in StackState:

  • ​System permissions - Scope user capabilities, such as access to settings, query execution and scripting.

  • ​View permissions - Allow for CRUD operations on StackState Views.

Predefined roles

StackState comes with three predefined roles:

  • Administrators (stackstate-admin): Have all permissions and access to all views.

  • Power Users (stackstate-power-user): This role is typically granted to users that need to configure StackState for their team(s), but will not manage the entire StackState installation. Power users have all Administrator permissions except for:

    • execute-restricted-scripts

    • update-permissions

    • upload-stackpacks

  • Guests (stackstate-guest): Have read access, as you can see below when we use the StackState CLI to show granted permissions for the role:

    $ sts permission show stackstate-guest
    subject permission resource
    ---------------- ------------------------- ----------
    stackstate-guest access-explore system
    stackstate-guest perform-custom-query system
    stackstate-guest read-permissions system
    stackstate-guest update-visualization system
    stackstate-guest execute-component-actions system
    stackstate-guest access-view everything

Default and custom role names

The default names for the pre-defined roles (stackstate-admin, stackstate-power-user, stackstate-guest) can be overridden. In the same way, extra roles can also be added that have the same permissions. Below is an example of how to do this for both Kubernetes and Linux installations.

Kubernetes
Linux
Kubernetes

Include this YAML snippet in an authentication.yaml when customizing the authentication configuration to replace the default role names with these custom role names.

stackstate:
authentication:
roles:
guest: ["custom-guest-role"]
powerUser: ["custom-power-user-role"]
admin: ["custom-admin-role"]

It is also possible to leave the defaults in place, for example the guestGroups would then have an array with 2 entries: ["stackstate-guest", "custom-guest-role"].

To use it in for your StackState installation (or already running instance, note that it will restart the API):

helm upgrade \
--install \
--namespace stackstate \
--values values.yaml \
--values authentication.yaml \
stackstate \
stackstate/stackstate
Linux

Edit the existing keys in the authentication section (nested in stackstate.api) in the configuration file like in the example to replace the default role names with these custom role names. Restart StackState to make the change take effect.

guestGroups = ["custom-guest-role"]
powerUserGroups = ["custom-power-user-role"]
adminGroups = ["custom-admin-role"]
}

Of course it is also possible to leave the defaults in place, for example the guestGroups would then have an array with 2 entries: ["stackstate-guest", "custom-guest-role"].

All permissions in StackState

There are two types of permission in StackState:

  • ​System permissions - Scope user capabilities, such as access to settings, query execution and scripting.

  • ​View permissions - Allow for CRUD operations on StackState Views.

System permissions

System permissions scope user capabilities, such as access to settings, query execution and scripting. They are set system wide.

See also the full list of view permissions.

Permission

Purpose

Guest

Power user

Admin

access-explore

Access the Explore page.

βœ…

βœ…

βœ…

execute-component-actions

Execute component actions.

βœ…

βœ…

βœ…

perform-custom-query

Access the topology filter.

βœ…

βœ…

βœ…

read-permissions

List all granted permissions across the entire system via the CLI.

βœ…

βœ…

βœ…

update-visualization

Change visualization settings.

βœ…

βœ…

βœ…

access-admin-api

Access the administrator API.

-

βœ…

βœ…

access-analytics

Access the Analytics page.

-

βœ…

βœ…

access-log-data

Access StackState logs via the CLI.

-

βœ…

βœ…

access-topic-data

Access StackState receiver data via the CLI.

-

βœ…

βœ…

create-views

Create views.

-

βœ…

βœ…

execute-component-templates

Invoke a component template API extension (internal use only).

-

βœ…

βœ…

execute-node-sync

Reset or delete a synchronization.

-

βœ…

βœ…

execute-scripts

Execute a query in the StackState UI Analytics environment. The execute-restricted-scripts permission is also required to execute scripts using the HTTP script API.

-

βœ…

βœ…

import-settings

Import settings.

-

βœ…

βœ…

export-settings

Export settings.

-

βœ…

βœ…

manage-annotations

Persist and fetch Anomaly annotations in StackState.

-

βœ…

βœ…

manage-event-handlers

Create or edit event handlers.

-

βœ…

βœ…

manage-telemetry-streams

Create or edit new streams for components via the UI.

-

βœ…

βœ…

manage-topology-elements

Create/update/delete topology elements.

-

βœ…

βœ…

manage-stackpacks

Install/upgrade/uninstall StackPacks.

-

βœ…

βœ…

read-settings

Access the Settings page.

-

βœ…

βœ…

update-settings

Update settings.

-

βœ…

βœ…

execute-restricted-scripts

Execute scripts using the HTTP script API in the StackState UI analytics environment. Also requires execute-scripts.

-

-

βœ…

update-permissions

Grant/revoke permissions or modify subjects.

-

-

βœ…

upload-stackpacks

Upload new (versions of) StackPacks.

-

-

βœ…

View permissions

View permissions allow for CRUD operations on StackState Views. They can be set for a specific view or all views (everything).

See also the full list of system permissions.

Permission

Purpose

Guest

Power user

Admin

access-view

Access a specific view (when granted on a view) or all views (when granted on everything).

βœ… everything

βœ… everything

βœ… everything

delete-view

Delete a specific view (when granted on a view) or all views (when granted on everything).

-

βœ… everything

βœ… everything

save-view

Update a specific view (when granted on a view) or all views (when granted on everything).

-

βœ… everything

βœ… everything

Permissions by action

Page access

The permissions in the table below are required to access specific pages in the StackState UI. Without these permissions, the associated page will be hidden in the StackState UI and will not be accessible via its URL.

Main menu with all permissions granted

Page

Permission

Guest

Power user

Admin

Explore Mode

access-explore

βœ…

βœ…

βœ…

Views Access can be granted either for a specific view using the view ID or for all views using the everything resource. For details, see the view management permissions.

access-view

βœ… everything

βœ… everything

βœ… everything

Analytics For details, see the analytics environment permissions.

access-analytics

-

βœ…

βœ…

StackPacks

manage-stackpacks

-

βœ…

βœ…

Settings For details, see the settings page permissions.

read-settings

-

βœ…

βœ…

Settings > Export Settings Also requires read-settings. Without this permission, Export Settings is removed from Settings Menu. For details, see the settings page permissions.

export-settings

-

βœ…

βœ…

Settings > Import Settings Also requires read-settings. Without this permission, Import Settings is removed from Settings Menu. For details, see the settings page permissions.

import-settings

-

βœ…

βœ…

See the full list of permissions for pre-defined roles (above).

Topology

The permissions listed below are required to work with topology in StackState:

Action

Permission

Guest

Power user

Admin

Access and edit the view visualization settings. If not granted, the visualization settings button will be hidden.

update-visualization

βœ…

βœ…

βœ…

Basic and Advanced filtering. If not granted, filtering options will be hidden.

perform-custom-query

βœ…

βœ…

βœ…

Execute actions from the component context menu.

execute-component-actions

βœ…

βœ…

βœ…

Drag and drop components.

manage-topology-elements

-

βœ…

βœ…

Add components button. Create relations between topology elements.

manage-topology-elements and perform-custom-query and read-settings

-

βœ…

βœ…

See the full list of permissions for pre-defined roles (above).

Component/relation details

The permissions listed below are required to carry out specific actions in the component or relation details pane.

Action

Permission

Guest

Power user

Admin

Telemetry streams Add a new telemetry stream. Edit / delete / add baseline to an existing telemetry stream. Without this permission, only the Inspect action is available in the ... menu and the ADD button is hidden.

manage-topology-elements

-

βœ…

βœ…

Health checks Add a new health check. Edit / delete an existing health check. Without this permission, the ... menu and the ADD button are hidden.

manage-topology-elements

-

βœ…

βœ…

Elements Delete an element or element template.

manage-topology-elements

-

βœ…

βœ…

Elements Edit an element or element template.

manage-topology-elements and perform-custom-query and read-settings

-

βœ…

βœ…

See the full list of permissions for pre-defined roles (above).

View management

The permissions listed below can be set to access and work with views:

Action

Permission

Guest

Power user

Admin

Access a specific view or all views (everything). Example: Grant permissions to open a view.

access-view

βœ… everything

βœ… everything

βœ… everything

Access and edit the view visualization settings. If not granted, the visualization settings button will be hidden.

update-visualization

βœ…

βœ…

βœ…

Add or edit event handlers. If not granted, the ADD NEW EVENT HANDLER button will not be available, however, users will be able to view details of existing event handlers. Example: Grant permissions to add and edit event handlers.

manage-event-handlers

-

βœ…

βœ…

Create views. Example: Grant permissions to create views.

create-views

-

βœ…

βœ…

Save updates to a view. For a specific view or all views (everything).

save-view

-

βœ… everything

βœ… everything

Delete a view. For a specific view or all views (everything).

delete-view

-

βœ… everything

βœ… everything

See the full list of permissions for pre-defined roles (above).

Analytics environment

The permissions listed below are required to access and execute scripts in the StackState UI analytics environment:

Action

Permission

Guest

Power user

Admin

Access the Analytics page in the StackState UI. Without this permission, the analytics environment will be hidden in the StackState UI, and it will not be accessible via its URL.

access-analytics

-

βœ…

βœ…

Execute scripts in the StackState UI analytics environment. Without this permission, the Execute button will not be available. Also requires access-analytics.

execute-scripts

-

βœ…

βœ…

Execute scripts that use the HTTP script API. Also requires access-analytics and execute-scripts.

execute-restricted-scripts

-

-

βœ…

See the full list of permissions for pre-defined roles (above).

Settings page

The permissions listed below are required to access and manage settings in the StackState UI:

Action

Permission

Guest

Power user

Admin

Access the Settings page in the StackState UI. Without this permission, the settings section will be hidden in the StackState UI main menu, and it will not be accessible via its URL.

read-settings

-

βœ…

βœ…

Add / Edit / Delete capabilities. This permission unlocks the ... menu and the ADD buttons on all Settings Pages.

update-settings

-

βœ…

βœ…

Export capability. Without this permission, checkboxes are not available on the settings page.

export-settings

-

βœ…

βœ…

Delete and Reset synchronization capabilities.

execute-node-sync

-

βœ…

βœ…

See the full list of permissions for pre-defined roles (above).

Example CLI commands

Important note: All permissions in StackState are case sensitive.

List all permissions

List all permissions:

sts permission list

Show granted permissions

Show the permissions granted to a specific role.

sts permission show [role-name]

Grant permissions

Allow a user to open a view

Provide a subject with permission to open a view:

sts permission grant [subject-handle] access-view [view-name]

Allow a user to create (save) views

Provide a subject with the system permission to create (save) views:

sts permission grant [subject-handle] create-views system

Allow a user to check StackState settings

Provide a subject with the system permission to check StackState settings:

sts permission grant [subject-handle] read-settings system

Allow a user to add or edit event handlers

Provide a subject with the system permission to add new event handlers and edit existing event handlers:

sts permission grant [subject-handle] manage-event-handlers system

Revoke permissions

Revoke permissions for a subject to open a view:

sts permission revoke [subject-handle] access-view [view-name]

StackState UI with no permissions

Below is an example of how the StackState UI would look for a user without any permissions:

No permissions