⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

Rookout

Rookout Get data from your live code, as it runs. Extract any piece of data from your code and pipeline it anywhere, in realtime, even if you’d never thought about it beforehand or created any instrumentation to collect it.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

TL;DR;

bash

$ helm install --name my-release stable/rookout --set token=YOUR_ORGANIZATIONAL_TOKEN

Introduction

This chart bootstraps a Rookout Router deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

Kubernetes 1.9+ with Beta APIs enabled

Installing the Chart

To install the chart with the release name my-release:

bash

$ helm install --name my-release stable/rookout --set token=YOUR_ORGANIZATIONAL_TOKEN

The command deploys Rookout on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

bash

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the Rookout Router chart and their default values.

Parameter	Description	Default
`token`	Rookout organizational token	`Nil` You must provide your own token
`tags`	Rookout Router tags	`Nil` You must provide your own token
`listenAll`	Configuring the agent to listen on all addresses instead of only localhost.	`True` You must provide your own token
`image.registry`	Rookout image registry	`docker.io`
`image.repository`	Rookout image name	`rookout/agent`
`image.tag`	Rookout image tag	`{VERSION}`
`image.pullPolicy`	Image pull policy	`Always` if `imageTag` is `latest`, else `IfNotPresent`
`image.pullSecrets`	Specify image pull secrets	`nil`

The above parameters map to the env variables defined in rookout/agent. For more information please refer to the rookout/agent image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

bash

$ helm install --name my-release \
  --set token=YOUR_TOKEN_HERE,listenAll=False,tags=tag1;tag2;tag3 \
    stable/rookout

The above command sets the Rookout Router token to your organizational token. Additionally, it sets the listenAll to False and Router tags to tag1;tag2;tag3.

Tip: You can use the default values.yaml