Back to Charts

⚠️ Repo Archive Notice

stable/uchiwa/README.md

latest3.8 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.

⚠️ Chart Deprecated

Uchiwa

Uchiwa is a simple yet effective open-source dashboard for the Sensu monitoring framework.

TL;DR;

console
$ helm install stable/uchiwa

Introduction

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

Prerequisites

  • Kubernetes 1.4+ with Beta APIs enabled

Get this chart

Download the latest release of the chart from the releases page.

Alternatively, clone the repo if you wish to use the development snapshot:

console
$ git clone https://github.com/kubernetes/charts.git

Installing the Chart

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

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

The command deploys Uchiwa 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 Uchiwa chart and their default values.

ParameterDescriptionDefault
imageUchiwa imagesstarcher/uchiwa
imageTagUchiwa version0.22
imagePullPolicyImage pull policyIfNotPresent
replicaCountNumber of Uchiwa replicas1
httpPortService port for Kubernetes80
routableEnables routing through the Deis routerfalse
resources.requests.cpuCPU request for Uchiwa10m
resources.requests.memoryMemory request for Uchiwa50Mi
resources.limits.cpuCPU limit for Uchiwa``
resources.limits.memoryMemory limit for Uchiwa50Mi
hostAddress on which Uchiwa will listen0.0.0.0
portPort on which Uchiwa will listen3000
refreshDetermines the interval to pull the Sensu APIs, in seconds10
loglevelLevel of logging to show after Uchiwa has startedinfo
configCustom content configuration file (json)default

Detailed documentation for the config json can be found at Uchiwa/Docs

console
$ helm install --name my-release \
  --set imageTag=0.18.2 \
    stable/uchiwa

The above command sets the Uchiwa version to 0.18.2.

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/uchiwa

Tip: You can use the default values.yaml