Back to Charts

⚠️ Repo Archive Notice

stable/goldpinger/README.md

latest5.9 KB
Original Source

⚠️ 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.

Goldpinger

Goldpinger makes calls between its instances for visibility and alerting.


Deprecation Warning

As part of the deprecation timeline, another repository has taken over the chart here

Please make PRs / Issues here from now on.


TL;DR;

console
$ helm install stable/goldpinger

Introduction

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

Prerequisites

  • Kubernetes 1.4+ with Beta APIs enabled

Installing the Chart

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

console
$ helm install --name my-release stable/goldpinger

The command deploys Goldpinger 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:

console
$ 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 Goldpinger chart and their default values.

ParameterDescriptionDefault
image.repositoryGoldpinger imagebloomberg/goldpinger
image.tagGoldpinger image tag2.0.0
pullPolicyImage pull policyIfNotPresent
rbac.createInstall required rbac clusterroletrue
serviceAccount.createEnable ServiceAccount creationtrue
serviceAccount.nameServiceAccount for Goldpinger podsdefault
goldpinger.portGoldpinger app port listen to80
extraEnvExtra environment variables[]
service.typeKubernetes service typeLoadBalancer
service.portService HTTP port80
service.annotationsService annotations{}
ingress.enabledEnable ingress controller resourcefalse
ingress.annotationsIngress annotations{}
ingress.pathIngress path/
ingress.hostsURLs to address your Goldpinger installationgoldpinger.local
ingress.tlsIngress TLS configuration[]
priorityClassNameSet a priorityClassName for pod``
podAnnotationsPod annotations{}
nodeSelectorNode labels for pod assignment{}
tolerationsList of node taints to tolerate[]
affinityMap of node/pod affinities{}
resourcesCPU/Memory resource requests/limits{}
podSecurityPolicy.enabledEnable podSecuritypolicyfalse
podSecurityPolicy.policyNamePodSecurityPolicy Nameunrestricted-psp
serviceMonitor.enabledSet this to true to create ServiceMonitor for Prometheus operatorfalse
serviceMonitor.additionalLabelsAdditional labels that can be used so ServiceMonitor will be discovered by Prometheus{}
serviceMonitor.honorLabelshonorLabels chooses the metric's labels on collisions with target labels.false
serviceMonitor.namespacenamespace where servicemonitor resource should be createdthe same namespace as goldpinger
serviceMonitor.scrapeIntervalinterval between Prometheus scraping30s

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

console
$ helm install --name my-release \
  --set goldpinger.port=8080,serviceAccount.name=goldpinger \
    stable/goldpinger

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

console
$ helm install --name my-release -f values.yaml stable/goldpinger

Tip: You can use the default values.yaml

Ingress

This chart provides support for Ingress resource. If you have an available Ingress Controller such as Nginx or Traefik you maybe want to set ingress.enabled to true and choose an ingress.hostname for the URL. Then, you should be able to access the installation using that address.