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
  • Regarding the Helm Chart
  • Configuration Options
  • Behavior Description
  • How to Use in values.yaml
  1. Agent

Custom Secret Management

Overview

The stackstate/stackstate-k8s-agent (starting from version 1.0.79) supports specifying the name of a custom secret that contains the API key and cluster authorization token. This feature is useful for users who wish to manage their own secrets and avoid the automatic creation of secrets by the Helm chart.

Regarding the Helm Chart

Configuration Options

  • stackstate.manageOwnSecrets: A boolean flag that determines whether the user wishes to manage their own secrets. Default value is false.

  • stackstate.customSecretName: (Optional) Name of the custom secret to be created by the user. Required if stackstate.manageOwnSecrets is set to true.

  • stackstate.customApiKeySecretKey: (Optional) Key name for the API key within the custom secret. Required if stackstate.manageOwnSecrets is set to true.

  • stackstate.customClusterAuthTokenSecretKey: (Optional) Key name for the cluster authorization token within the custom secret. Required if stackstate.manageOwnSecrets is set to true.

Behavior Description

  • Automatic Secret Creation: By default, the chart continues to automatically create secrets as before if stackstate.manageOwnSecrets is set to false.

  • Custom Secret Management: If stackstate.manageOwnSecrets is set to true, the chart expects the user to provide the name of the custom secret (stackstate.customSecretName) along with the keys for the API key and authorization token (stackstate.customApiKeySecretKey and stackstate.customClusterAuthTokenSecretKey, respectively).

  • Implied Omission: When specifying that you would like to manage your own secrets, the chart will ignore values for stackstate.apiKey and stackstate.cluster.authToken.

How to Use in values.yaml

  1. Using Automatic Secret Creation (Default):

    stackstate:
      manageOwnSecrets: false
      apiKey: "<your api key>"
  2. Managing Own Secrets:

    stackstate:
      manageOwnSecrets: true
      customSecretName: my-custom-secret
      customApiKeySecretKey: api-key
      customClusterAuthTokenSecretKey: auth-token
PreviousUsing a custom registryNextRequest tracing

Last updated 1 year ago

🕵️