/tfa-bot

Dockerfile and Helm chart for the fabulous TFA Bot

Primary LanguageDockerfile

tfa-bot

Helm chart for TFA's monitoring bot.

The Factoid Authority Bot provides monitoring and alerting of Factom® nodes.

Helm Chart

TL;DR;

$ helm install -f /path/to/values.yaml --name tfa-bot tfa-bot

Introduction

This chart bootstraps a tfa-bot deployment on a Kubernetes cluster using the Helm package manager.

Prequisites

  • Google Kubernetes Engine 1.11.5-gke.5+

Installing the Chart

Create a chart configuration file that contains the URL of your Google configuration spreadsheet:

# values.yaml

botUrl: https://docs.google.com/spreadsheets/d/XXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXX

Add the Bedrock Solutions Helm chart repository:

helm repo add bedrocksolutions https://helm.bedrocksolutions.io

Install the chart:

helm install -f /path/to/values.yaml --name tfa-bot bedrocksolutions/tfa-bot

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the tfa-bot deployment:

helm delete --purge `tfa-bot`

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 tfa-bot chart and their default values.

Parameter Description Default
botUrl URL to config document (see below) none
deployment.replicas desired number of tfa-bot replicas 1
deployment.restartPolicy pod restart policy Always
docker.image docker image repository bedrocksolutions/tfa-bot
docker.imageTag docker image tag latest
docker.pullPolicy docker image pull policy Always
resources.cpuLimit container cpu limit 100m
resources.cpuRequested container cpu requested 50m
resources.memoryLimit container memory limit 256Mi
resources.memoryRequested container memory requested 96Mi

Bot URL

The only required configuration parameter is a URL to the Google Sheet configuration document.

Configuration Description
botUrl URL to a Google Sheet Configuration