Docs Home
Start your 30 day free trial.
START FOR FREE

Deploying Failure Flags on Kubernetes

This document will walk you through setting up Failure Flags for your Kubernetes Pods. Gremlin provides a sidecar container called "Failure-Flags-Sidecar" that runs in the same pod as your application. Failure-Flags-Sidecar container images are available via DockerHub and support both AMD64/x86_64 and ARM64 architectures. These container images include a LICENSE file and a single binary program built for Linux. Alternatively, you can download archives directly: arm64, x86_64.

All versions are listed in a file at: https://assets.gremlin.com/packages/failure-flags-sidecar/VERSIONS.

‍

Configuring Failure Flags for Kubernetes

In addition to the common configuration options, Failure Flags on Kubernetes accepts the following options:

Environment variable Config file property Description
SERVICE_NAME service_name Set to the name of the service as you want it to appear in Gremlin. Service names can only contain alphanumeric characters, hyphens, and underscores, and must be less than 64 characters long. This is required for Kubernetes.

‍

Adding the sidecar to your Kubernetes manifest

To add the sidecar, define the sidecar container in the same Pod as your application. For example, this deployment adds the sidecar container and uses Kubernetes Secrets to securely store authentication details. The Failure Flag service will show in Gremlin as demo-application:

‍

Verify

  1. Apply your changes and confirm both containers are running: kubectl get pods -l app=sidecar-demo should show 2/2.
  2. Check the sidecar registered: kubectl logs deploy/sidecar-demo -c gremlin. Look for a successful service registration line and no TLS or auth errors.
  3. Send a few requests to your app, including some that call a dependency.
  4. In Gremlin, open Failure Flags. demo-application should be listed with process, ingress, http-ingress, egress, and one dependency- flag per host it called.

‍

On this page
Back to top
RELATED PAGES