LogoLogo
StackState.comDownloadSupportExplore playground
StackState v5.1
StackState v5.1
  • Welcome to the StackState docs!
  • StackState self-hosted v5.1 docs
  • Getting Started
  • 🚀Setup
    • Install StackState
      • Requirements
      • Kubernetes / OpenShift
        • Kubernetes install
        • OpenShift install
        • Required Permissions
        • Non-high availability setup
        • Override default configuration
        • Configure storage
        • Configure Ingress
        • Install from custom image registry
        • Migrate from Linux install
      • Linux
        • Before you install
        • Download
        • Install StackState
        • Install with production configuration
        • Install with development configuration
        • Install with POC configuration
        • Set up a reverse proxy
        • Set up TLS without reverse proxy
      • Initial run guide
      • Troubleshooting
    • Upgrade StackState
      • Steps to upgrade
      • Version specific upgrade instructions
      • StackPack versions
      • StackState release notes
    • StackState Agent
      • About StackState Agent V3
      • Docker
      • Kubernetes / OpenShift
      • Linux
      • Windows
      • Advanced Agent configuration
      • Use an HTTP/HTTPS proxy
      • Agent V1 (legacy)
      • Migrate Agent V1 to Agent V2
        • Linux
        • Docker
    • StackState CLI
      • CLI: sts
      • CLI: stac (deprecated)
      • Comparison between CLIs
    • Data management
      • Backup and Restore
        • Kubernetes backup
        • Linux backup
        • Configuration backup
      • Data retention
      • Clear stored data
  • 👤Use
    • Concepts
      • The 4T data model
      • Components
      • Relations
      • Health state
      • Layers, Domains and Environments
      • Perspectives
      • Anomaly detection
      • StackState architecture
    • StackState UI
      • Explore mode
      • Filters
      • Views
        • About views
        • Configure the view health
        • Create and edit views
        • Visualization settings
      • Perspectives
        • Topology Perspective
        • Events Perspective
        • Traces Perspective
        • Metrics Perspective
      • Timeline and time travel
      • Analytics
      • Keyboard shortcuts
    • Checks and monitors
      • Checks
      • Add a health check
      • Anomaly health checks
      • Monitors
      • Manage monitors
    • Problem analysis
      • About problems
      • Problem lifecycle
      • Investigate a problem
      • Problem notifications
    • Metrics
      • Telemetry streams
      • Golden signals
      • Top metrics
      • Add a telemetry stream
      • Browse telemetry
      • Set telemetry stream priority
    • Events
      • About events
      • Event notifications
      • Manage event handlers
    • Glossary
  • 🧩StackPacks
    • About StackPacks
    • Add-ons
      • Autonomous Anomaly Detector
      • Health Forecast
    • Integrations
      • About integrations
      • 💠StackState Agent V2
      • 💠AWS
        • AWS
        • AWS ECS
        • AWS X-ray
        • StackState/Agent IAM role: EC2
        • StackState/Agent IAM role: EKS
        • Policies for AWS
        • AWS (legacy)
        • Migrate AWS (legacy) to AWS
      • 💠Dynatrace
      • 💠Kubernetes
      • 💠OpenShift
      • 💠OpenTelemetry
        • About instrumentations
        • AWS NodeJS Instrumentation
        • Manual Instrumentation
          • Prerequisites
          • Tracer and span mappings
          • Relations between components
          • Span health state
          • Merging components
          • Code examples
      • 💠ServiceNow
      • 💠Slack
      • 💠Splunk
        • Splunk
        • Splunk Events
        • Splunk Health
        • Splunk Metrics
        • Splunk Topology
      • 💠VMWare vSphere
      • Apache Tomcat
      • Azure
      • Cloudera
      • Custom Synchronization
      • DotNet APM
      • Elasticsearch
      • Humio
      • Java APM
      • JMX
      • Logz.io
      • MySQL
      • Nagios
      • OpenMetrics
      • PostgreSQL
      • Prometheus
      • SAP
      • SCOM
      • SolarWinds
      • Static Health
      • Static Topology
      • Traefik
      • WMI
      • Zabbix
    • Develop your own StackPacks
  • 🔧Configure
    • Topology
      • Component actions
      • Identifiers
      • Topology naming guide
      • Topology sources
      • Create a topology manually
      • Configure topology synchronizations
      • Enable email event notifications
      • Send topology data over HTTP
      • Set the topology filtering limit
      • Use a proxy for event handlers
      • Use tags
      • Tune topology synchronization
      • Debug topology synchronization
    • Telemetry
      • Add telemetry during topology synchronization
      • Data sources
        • Elasticsearch
        • Prometheus mirror
      • Send events over HTTP
      • Send metrics data over HTTP
      • Set the default telemetry interval
      • Debug telemetry synchronization
    • Traces
      • Set up traces
      • Advanced configuration for traces
    • Health
      • Health synchronization
      • Send health data over HTTP
        • Send health data
        • Repeat Snapshots JSON
        • Repeat States JSON
        • Transactional Increments JSON
      • Debug health synchronization
    • Anomaly Detection
      • Export anomaly feedback
      • Scale the AAD up and down
      • The AAD status UI
    • Security
      • Authentication
        • Authentication options
        • File based
        • LDAP
        • Open ID Connect (OIDC)
        • KeyCloak
        • Service tokens
      • RBAC
        • Role-based Access Control
        • Permissions
        • Roles
        • Scopes
        • Subjects
      • Secrets management
      • Self-signed certificates
      • Set up a security backend for Linux
      • Set up a security backend for Windows
    • Logging
      • Kubernetes logs
      • Linux logs
      • Enable logging for functions
  • 📖Develop
    • Developer guides
      • Agent checks
        • About Agent checks
        • Agent check API
        • Agent check state
        • How to develop Agent checks
        • Connect an Agent check to StackState
      • Custom functions and scripts
        • StackState functions
        • Check functions
        • Component actions
        • Event handler functions
        • ID extractor functions
        • Mapping functions
        • Monitor functions
        • Propagation functions
        • Template functions
        • View health state configuration functions
      • Custom Synchronization StackPack
        • About the Custom Synchronization StackPack
        • How to customize elements created by the Custom Synchronization StackPack
        • How to configure a custom synchronization
      • Integrate external services
      • Mirroring Telemetry
      • Monitors
        • Create monitors
        • Monitor STJ file format
      • StackPack development
        • How to create a StackPack
        • Packaging
        • How to get a template file
        • How to make a multi-instance StackPack
        • Prepare a multi-instance provisioning script
        • Upload a StackPack file
        • Prepare a shared template
        • Customize a StackPack
        • Prepare instance template files
        • Prepare a StackPack provisioning script
        • Resources in a StackPack
        • StackState Common Layer
      • Synchronizations and templated files
    • Reference
      • StackState OpenAPI docs
      • StackState Template JSON (STJ)
        • Using STJ
        • Template functions
      • StackState Markup Language (STML)
        • Using STML
        • STML Tags
      • StackState Query Language (STQL)
      • StackState Scripting Language (STSL)
        • Scripting in StackState
        • Script result: Async
        • Script result: Streaming
        • Time in scripts
        • Script APIs
          • Async - script API
          • Component - script API
          • HTTP - script API
          • Prediction - script API
          • StackPack - script API
          • Telemetry - script API
          • Time - script API
          • Topology - script API
          • UI - script API
          • View - script API
    • Tutorials
      • Create a simple StackPack
      • Push data to StackState from an external system
      • Send events to StackState from an external system
      • Set up a mirror to pull telemetry data from an external system
Powered by GitBook
LogoLogo

Legal notices

  • Privacy
  • Cookies
  • Responsible disclosure
  • SOC 2/SOC 3
On this page
  • Overview
  • Serve images from a different image registry
  • Images
  • StackState
  • StackState Agent, Cluster Agent, and Process Agent
  1. Setup
  2. Install StackState
  3. Kubernetes / OpenShift

Install from custom image registry

StackState Self-hosted v5.1.x

PreviousConfigure IngressNextMigrate from Linux install

Last updated 1 year ago

Overview

This page describes how to use a custom image registry to install StackState, the StackState Agent, Cluster Agent and kube-state-metrics. The required images are first copied and then the helm chart can then be configured to pull images using the custom registry and tag.

Serve images from a different image registry

Pulling the images from the different image registries can take some time when pods are started, either when the application starts for the first time or when it's being scaled to a new node. If one of those registries isn't accessible for some reason, the pods won't start.

To address this issue, you can copy all the images to a single registry close to your cluster, and configure the Helm chart to pull the images from that registry:

The install script copy_images.sh must be run on an Intel x86_64 machine. It isn't compatible with Macs that have an M1 or M2 processor.

  1. Set up a registry close to your cluster.

    • For Amazon Elastic Kubernetes Service (EKS), use .

    • For Azure Kubernetes Service (AKS), use .

  2. Log in to both Docker image registries:

    • StackState image registry - docker login quay.io - use the username and password provided by StackState.

    • Custom image registry - docker login --username <USERNAME> <CUSTOM_REGISTRY_ADDRESS>

  3. Download the relevant script and use this to copy all images used by the Helm chart to the custom registry. Note that you will first need to make the downloaded script executable:

    • StackState:

    • StackState Agent:

    • For example:

      # make downloaded script executable
      chmod a+x copy_images.sh
      
      # download images to the custom image registry
      ./installation/copy_images.sh -d <CUSTOM_REGISTRY_ADDRESS>
      
    • The script will detect when an ECR registry is used and automatically create the required repositories. Most other registries will automatically create repositories when the first image is pushed to it.

    • The script has a dry-run option that can be activated with the -t flag. This will show the images that will be copied without actually copying them, for example:

       $ ./installation/copy_images.sh -d 57413481473.dkr.ecr.eu-west-1.amazonaws.com -t
       Copying stackstate/elasticsearch_exporter:1.1.0 to 57413481473.dkr.ecr.eu-west-1.amazonaws.com/stackstate/elasticsearch_exporter:1.1.0 (dry-run)
       Copying quay.io/stackstate/stackgraph-console:3.6.14 to 57413481473.dkr.ecr.eu-west-1.amazonaws.com/stackstate/stackgraph-console:3.6.14 (dry-run)
       Copying quay.io/stackstate/stackstate-server-stable:4.2.2 to 57413481473.dkr.ecr.eu-west-1.amazonaws.com/stackstate/stackstate-server-stable:4.2.2 (dry-run)
       Copying quay.io/stackstate/wait:1.0.0 to 57413481473.dkr.ecr.eu-west-1.amazonaws.com/stackstate/wait:1.0.0 (dry-run)
       Copying quay.io/stackstate/stackstate-server-stable:4.2.2 to 57413481473.dkr.ecr.eu-west-1.amazonaws.com/stackstate/stackstate-server-stable:4.2.2 (dry-run)
      
    • Additional optional flags can be used when running the script:

      • -c specify a different chart to use.

      • -r specify a different repository to use.

  4. Edit the values.yaml file and add the following:

    • global.imageRegistry - the registry to use.

    • global.imagePullSecrets and pull-secret object - optional. The authentication details required for the global.imageRegistry.

    • minio.image.registry - The image registry used by the minio sub-chart. Required as it can't be configured with the setting global.imageRegistry.

    • elasticsearch.prometheus-elasticsearch-exporter.image.repository - the image used by the prometheus-elasticsearch-exporter sub-chart. Required as it can't be configured with the setting global.imageRegistry.

    global:
      imageRegistry: 57413481473.dkr.ecr.eu-west-1.amazonaws.com
    ## to specify authentication details for the global.imageRegistry
    ## add the sections below.
    #   imagePullSecrets:
    #   - stackstate-pull-secret
    # pull-secret:
    #   enabled: true
    #   fullNameOverride: stackstate-pull-secret
    #   credentials:
    #   - registry: 57413481473.dkr.ecr.eu-west-1.amazonaws.com
    #     username: johndoe
    #     password: my_secret-p@ssw0rd
    
    minio:
      image:
        registry: 57413481583.dkr.ecr.eu-west-1.amazonaws.com
    
     elasticsearch:
       prometheus-elasticsearch-exporter:
         image:
           repository: 57413481473.dkr.ecr.eu-west-1.amazonaws.com/stackstate/elasticsearch_exporter

Images

StackState

The images listed below are used in StackState v5.1.2:

  • quay.io/stackstate/container-tools:1.1.4

  • quay.io/stackstate/elasticsearch-exporter:v1.2.1-2738680411

  • quay.io/stackstate/elasticsearch:7.17.2-2738749846

  • quay.io/stackstate/envoy:v1.19.1-2738711656

  • quay.io/stackstate/hadoop:2.10.1-java11-6-2738734712

  • quay.io/stackstate/hbase-master:4.9.2

  • quay.io/stackstate/hbase-regionserver:4.9.2

  • quay.io/stackstate/jmx-exporter:0.17.0-2738680727

  • quay.io/stackstate/kafka:2.8.1-2738720666

  • quay.io/stackstate/kafkaup-operator:0.0.2

  • quay.io/stackstate/minio:RELEASE.2021-02-14T04-01-33Z-3118065624

  • quay.io/stackstate/nginx-prometheus-exporter:0.9.0-2738682730

  • quay.io/stackstate/spotlight:5.1.2

  • quay.io/stackstate/stackgraph-console:4.9.2

  • quay.io/stackstate/stackstate-correlate-stable:5.1.2

  • quay.io/stackstate/stackstate-kafka-to-es-stable:5.1.2

  • quay.io/stackstate/stackstate-receiver-stable:5.1.2

  • quay.io/stackstate/stackstate-server-stable:5.1.2

  • quay.io/stackstate/stackstate-ui-stable:5.1.2

  • quay.io/stackstate/tephra-server:4.9.2

  • quay.io/stackstate/wait:1.0.7-2755960650

  • quay.io/stackstate/zookeeper:3.6.3-2738717608

StackState Agent, Cluster Agent, and Process Agent

The images listed below are used in StackState Agent v3.0.0:

  • quay.io/stackstate/stackstate-agent:3.0.0

  • quay.io/stackstate/stackstate-cluster-agent:3.0.0

  • quay.io/stackstate/stackstate-process-agent:4.0.11

🚀
Amazon Elastic Container Registry (ECR)
Azure Container Registry (ACR) (azure.microsoft.com)
stackstate/installation/copy_images.sh (github.com)
stackstate-agent/installation/copy_images.sh (github.com)