README.md 2.1 KB
Newer Older
1
2
[![pipeline status](https://gitlab.triumf.ca/k8s/helm/envelope/badges/master/pipeline.svg)](https://gitlab.triumf.ca/k8s/helm/envelope/commits/master)

Dan Thomson's avatar
Dan Thomson committed
3
4
5
6
7
8
9
10
11
12
13
14
# Envelope Helm Chart

This chart is useful for deploying the [Envelope app](https://gitlab.triumf.ca/hla/envelope)
in Kubernetes.

# Configuration

Parameter | Description | Default
--------- | ----------- | -------
replicas  | The number of replicas to spin up | `1`
image     | The name of the Docker image to run | `kube-registry.triumf.ca/envelope`
imageTag  | The docker image tag to use | `latest`
15
16
17
18
imagePullPolicy | The [imagePullPolicy](https://kubernetes.io/docs/concepts/containers/images/#updating-images) to use in the deployment | `IfNotPresent`
hostname  | The public hostname of the envelope site (used for external requests) | `envelope.example.com`
path | The path under which the app exists (used for external requests) | `/`
port | The port upon which the envelope app will run | `5000`
Dan Thomson's avatar
Dan Thomson committed
19
20
21
22
23
registry.name | The name of the private registry to use | `kube-registry.triumf.ca`
registry.user | The username to use when logging into a private registry | `registry`
registry.password | The password to use when logging into the private Docker registry | `abc123`
cpuLimit | The maximum available CPU resources provided to the app | `100m`
memoryLimit | The maximum available memory resources provided to the app | `500Mi`
24
25
ingress.enabled | Enable an Ingress for this deployment | `false`
ingress.tls | Use TLS termination in the Ingress object | `true`
Dan Thomson's avatar
Dan Thomson committed
26
ingress.secretName | The name of the secret resource that holds the TLS certificate details | `null`
27
28
ingress.letsEncrypt.enabled | Use Let's Encrypt to automatically generate a TLS certificate for the deployment | `false`
ingress.letsEncrypt.issuer | Provides the name of the cert-manager issuer for making Let's Encrypt requests | `letsencrypt`
Dan Thomson's avatar
Dan Thomson committed
29
30
31
32
33
34
35
36
37

# Installation

As with other Helm charts, simply set your values in a custom values YAML file,
or specify your values with `--set` on the command line. Eg:

```bash
[~]$ helm upgrade --install --namespace=envelope envelope -f custom-values.yaml https://gitlab.triumf.ca/k8s/helm/envelope
```