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
  • Copying images to another registry
  • Prerequisites
  • Copying the images
  • Images
  • Configuring the Helm Chart to use a custom registry
  1. Agent

Using a custom registry

StackState v6.0

PreviousProxy ConfigurationNextCustom Secret Management

Last updated 10 months ago

Overview

This page describes how to use a custom image registry to install the StackState Agent. There are many reasons why you might want to do this, for example:

  • You want to use an image registry that is behind a firewall or on-premises.

  • You have specific security requirements that prevent you from using public image registries like Docker Hub.

In this guide you can find how to copy the required Docker images to your own registry, and how to configure the Helm chart to pull images from the custom registry.

Copying images to another registry

This section describes how to copy the images used by the StackState Agent to another registry. The images are listed in the section.

Prerequisites

The following prerequisites are required to copy the images:

  • Setup a registry if you don't have one available. You can use or for example.

  • Have the access credentials for your newly setup registry available.

  • Have the docker command line tool installed.

  • Install the copy_images.sh script from the

Copying the images

To copy the images, execute the following steps:

> docker login -u <username> --password-stdin <registry>
Password: ********
Login Succeeded
> ./copy_images.sh -d <registry>
  • 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:

  • Additional optional flags can be used when running the script:

    • -c specify a different chart to use.

    • -r specify a different repository to use.

Images

The images listed below are used in the StackState Agent Helm Chart:

Configuring the Helm Chart to use a custom registry

This section describes the values that need to be configured in the StackState Agent Helm Chart to use a custom registry.

The following values need to be configured:

  • global.imageRegistry - the registry to use.

  • all.image.pullSecretUsername and all.image.pullSecretPassword The authentication details required for the global.imageRegistry.

For example:

global:
  imageRegistry: 57413481473.dkr.ecr.eu-west-1.amazonaws.com
  imagePullCredentials:
    default:
      username: johndoe
      password: my_secret-p@ssw0rd

🕵️
quay.io/stackstate/container-tools
quay.io/stackstate/generic-sidecar-injector
quay.io/stackstate/http-header-injector-proxy-init
quay.io/stackstate/http-header-injector-proxy
quay.io/stackstate/stackstate-k8s-agent
quay.io/stackstate/stackstate-k8s-process-agent
quay.io/stackstate/stackstate-k8s-cluster-agent
Amazon Elastic Container Registry (ECR)
Azure Container Registry (ACR)
StackState Agent Helm Chart
Images