LogoLogo
StackState.comDownloadSupportExplore playground
StackState v6.0
StackState v6.0
  • StackState docs!
  • Docs for all StackState products
  • 🚀Get started
    • Quick start guide
    • StackState walk-through
    • SUSE Rancher Prime
      • Air-gapped
      • Agent Air-gapped
  • 🦮Guided troubleshooting
    • What is guided troubleshooting?
    • YAML Configuration
    • Changes
    • Logs
  • 🚨Monitors and alerts
    • Monitors
    • Out of the box monitors for Kubernetes
    • Notifications
      • Configure notifications
      • Notification channels
        • Slack
        • Teams
        • Webhook
        • Opsgenie
      • Troubleshooting
    • Customize
      • Add a monitor using the CLI
      • Override monitor arguments
      • Write a remediation guide
  • 📈Metrics
    • Explore Metrics
    • Custom charts
      • Adding custom charts to components
      • Writing PromQL queries for representative charts
      • Troubleshooting custom charts
    • Advanced Metrics
      • Grafana Datasource
      • Prometheus remote_write
      • OpenMetrics
  • 📑Logs
    • Explore Logs
    • Log Shipping
  • 🔭Traces
    • Explore Traces
  • 📖Health
    • Health synchronization
    • Send health data over HTTP
      • Send health data
      • Repeat Snapshots JSON
      • Repeat States JSON
      • Transactional Increments JSON
    • Debug health synchronization
  • 🔍Views
    • Kubernetes views
    • Custom views
    • Component views
    • Explore views
    • View structure
      • Filters
      • Overview perspective
      • Highlights perspective
      • Topology perspective
      • Events perspective
      • Metrics perspective
      • Traces perspective
    • Timeline and time travel
  • 🕵️Agent
    • Network configuration
      • Proxy Configuration
    • Using a custom registry
    • Custom Secret Management
    • Request tracing
      • Certificates for sidecar injection
  • 🔭Open Telemetry
    • Getting started
    • Open telemetry collector
    • Languages
      • Generic Exporter configuration
      • Java
      • Node.js
      • .NET
      • Verify the results
    • Troubleshooting
  • CLI
    • StackState CLI
  • 🚀Self-hosted setup
    • Install StackState
      • Requirements
      • Kubernetes / OpenShift
        • Kubernetes install
        • OpenShift install
        • Required Permissions
        • Non-high availability setup
        • Small profile setup
        • Override default configuration
        • Configure storage
        • Exposing StackState outside of the cluster
      • Initial run guide
      • Troubleshooting
        • Logs
    • Configure StackState
      • Slack notifications
      • Stackpacks
    • Release Notes
      • v1.11.0 - 18/07/2024
      • v1.11.3 - 15/08/2024
      • v1.11.4 - 29/08/2024
      • v1.12.0 - 24/10/2024
      • v1.12.1 - 08/11/2024
    • Upgrade StackState
      • Steps to upgrade
      • Version-specific upgrade instructions
    • Uninstall StackState
    • Air-gapped
      • StackState air-gapped
      • StackState Kubernetes Agent air-gapped
    • Data management
      • Backup and Restore
        • Kubernetes backup
        • Configuration backup
      • Data retention
      • Clear stored data
    • Security
      • Authentication
        • Authentication options
        • File-based
        • LDAP
        • Open ID Connect (OIDC)
        • KeyCloak
        • Service tokens
      • RBAC
        • Role-based Access Control
        • Permissions
        • Roles
        • Scopes
      • Self-signed certificates
  • 🔐Security
    • Service Tokens
    • Ingestion API Keys
  • ☁️SaaS
    • User Management
  • Reference
    • StackState Query Language (STQL)
    • Chart units
Powered by GitBook
LogoLogo

Legal notices

  • Privacy
  • Cookies
  • Responsible disclosure
  • SOC 2/SOC 3
On this page
  • Overview
  • StackState permissions
  • Manage permissions
  • List all permissions
  • Show granted permissions
  • Grant permissions
  • Revoke permissions
  • StackState UI with no permissions
  1. Self-hosted setup
  2. Security
  3. RBAC

Permissions

StackState Self-hosted

PreviousRole-based Access ControlNextRoles

Last updated 7 months ago

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 doesn't 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.

StackState permissions

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, these can be granted for a specific view or for all views. For details of the permissions attached to each predefined role in StackState, see

The following permissions are available in StackState:

  • access-admin-api -Access the administrator API.

  • access-analytics - Access the page in the StackState UI.

  • access-cli - Access the CLI page. This provides the API key to use for authentication with the StackState CLI.

  • access-explore - Access the page in the StackState UI.

  • access-log-data - Access StackState logs using the CLI.

  • access-synchronization-data - Access StackState synchronization status and data using the CLI.

  • access-topic-data - Access StackState Receiver data using the CLI.

  • access-view - A View permission. Access a specific view (when granted on a view) or all views (when granted on everything). Granted on the following views for predefined StackState roles:

    • Administrator: everything (all views)

    • Platform Administrator: everything (all views)

    • Power User: everything (all views)

    • Guest: everything (all views)

  • create-views - in the StackState UI.

  • delete-view - A view permission. Delete a specific view (when granted on a view) or all views (when granted on everything). Granted on the following views for predefined StackState roles:

    • Administrator: everything (all views)

    • Platform Administrator: -

    • Power User: everything (all views)

    • Guest: -

  • execute-component-actions - Execute .

  • execute-component-templates - Invoke a component template API extension (internal use only).

  • execute-node-sync - Reset or delete a synchronization.

  • execute-restricted-scripts - Execute scripts using the in the StackState UI analytics environment. Also requires execute-scripts.

  • 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.

  • export-settings - Export settings.

  • import-settings - Import settings.

  • manage-annotations - Persist and fetch Anomaly annotations in StackState.

  • manage-ingestion-api-keys - Manage for data ingestion.

  • manage-metric-bindings - Create, delete and change

  • manage-monitors - Create, delete and change .

  • manage-notifications - Create, delete, and modify .

  • manage-service-tokens- Create/delete in StackState.

  • manage-stackpacks - Install/upgrade/uninstall StackPacks.

  • manage-star-view - Add and remove from views in the StackState UI.

  • manage-telemetry-streams - for components in the StackState UI.

  • manage-topology-elements - Create/update/delete topology elements.

  • perform-custom-query - Access the .

  • read-agents - List connected agents with the cli agent list command

  • read-permissions - List all granted permissions across the entire system using the CLI.

  • read-settings - Access the Settings page in the StackState UI.

  • read-stackpacks

  • read-system-notifications - Access the system notifications in the UI

  • read-telemetry-streams - Access the telemetry data for components in the StackState UI

  • read-traces - Read and access trace data.

  • run-monitors - Execute a and make it run periodically.

  • save-view- A view permission. Update a specific view (when granted on a view) or all views (when granted on everything). Granted on the following views for predefined StackState roles:

    • Administrator: everything (all views)

    • Platform Administrator: -

    • Power User: everything (all views)

    • Guest: -

  • unlock-node - Unlock .

  • update-permissions - Grant/revoke permissions or change subjects.

  • update-settings - Update settings.

  • update-visualization - Change .

  • upload-stackpacks - Upload new (versions of) StackPacks.

  • view-metric-bindings - View (via the cli)

  • view-monitors - View monitor configurations.

  • view-notifications - View notification settings.

Manage permissions

StackState permissions can be managed using the sts CLI.

Important note: All permissions in StackState are case sensitive.

List all permissions

List all permissions:

sts rbac list-permissions

Show granted permissions

Show the permissions granted to a specific role.

sts rbac describe-permissions --subject [role-name]

Grant permissions

Allow a user to open a view

Give a subject with permission to open a view:

sts rbac grant --subject [role-name] --permission access-view --resource [view-name]

Allow a user to create (save) views

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

sts rbac grant --subject [role-name] --permission create-views

Allow a user to check StackState settings

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

sts rbac grant --subject [role-name] --permission read-settings

Allow a user to add or edit event handlers

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

sts rbac grant --subject [role-name] --permission manage-event-handlers

Revoke permissions

Revoke permissions for a subject to open a view:

sts rbac revoke --subject [role-name] --permission access-view --resource [view-name]

StackState UI with no permissions

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

🚀
Analytics
Explore
Create views
component actions
HTTP script API
API keys
metric bindings
monitors
notifications
Service Tokens
stars
Create or edit new telemetry streams
topology filter
monitor
visualization settings
metric bindings
predefined roles
No permissions
locked configuration items