|
| 1 | +# Lita Chart packaged by Indiegogo |
| 2 | + |
| 3 | +## TL;DR |
| 4 | + |
| 5 | +```bash |
| 6 | +$ helm repo add indiegogo https://charts.indiegogo.com |
| 7 | +$ helm install my-release indiegogo/lita |
| 8 | +``` |
| 9 | + |
| 10 | +## Introduction |
| 11 | + |
| 12 | +This chart bootstraps a Lita deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. |
| 13 | + |
| 14 | +## Prerequisites |
| 15 | + |
| 16 | +- Kubernetes 1.12+ |
| 17 | +- Helm 3.6.2 |
| 18 | + |
| 19 | +## Getting started with default values |
| 20 | + |
| 21 | +To get you started with modifying the default values to your liking/needs, use the below command to grab the latest `values.yaml` file: |
| 22 | + |
| 23 | +```bash |
| 24 | +$ helm show values indiegogo/lita > values.yaml |
| 25 | +``` |
| 26 | + |
| 27 | +## Installing the Chart |
| 28 | + |
| 29 | +To install the chart with the release name `my-release`: |
| 30 | + |
| 31 | +```bash |
| 32 | +$ helm install my-release indiegogo/lita |
| 33 | +``` |
| 34 | + |
| 35 | +The command deploys Lita on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation. |
| 36 | + |
| 37 | +> **Tip**: List all releases using `helm list` |
| 38 | +
|
| 39 | +## Uninstalling the Chart |
| 40 | + |
| 41 | +To uninstall/delete the `my-release` deployment: |
| 42 | + |
| 43 | +```bash |
| 44 | +$ helm uninstall my-release |
| 45 | +``` |
| 46 | + |
| 47 | +> NOTE: If you used `-n namespace` when you installed the chart, be sure to use it again when you uninstall the chart, otherwise the associated dependency Kubernetes resources will not be deleted: |
| 48 | +
|
| 49 | +```bash |
| 50 | +$ helm uninstall -n namespace my-release |
| 51 | +``` |
| 52 | + |
| 53 | +The command removes all the Kubernetes components associated with the chart and deletes the release. |
| 54 | + |
| 55 | +## Parameters |
| 56 | + |
| 57 | + |
| 58 | +### Common parameters |
| 59 | + |
| 60 | +| Name | Type | Description | Default | |
| 61 | +| ------------------ | ------ | ---------------------------------------------------------------- | ------- | |
| 62 | +| `kubeVersion` | string | Override Kubernetes version | `nil` | |
| 63 | +| `nameOverride` | string | Partially override names.fullname | `nil` | |
| 64 | +| `fullnameOverride` | string | Fully override names.fullname | `nil` | |
| 65 | +| `commonLabels` | object | Labels to add to all deployed objects | `{}` | |
| 66 | +| `networkPort` | int | Deployment container, Deployment livenessProbe, and Service port | `8080` | |
| 67 | + |
| 68 | + |
| 69 | +### Lita configuration parameters |
| 70 | + |
| 71 | +| Name | Type | Description | Default | |
| 72 | +| -------------------------------- | ------ | ---------------------------------------------------------- | --------------------| |
| 73 | +| `configuration.circleCiHost` | string | CircleCI host that Lita communicates with | `"circleci.igg.me"` | |
| 74 | +| `configuration.enableDebug` | string | Enable debugging in Lita | `""` | |
| 75 | +| `configuration.circleCiApiToken` | string | CircleCI API token so Lita can communication with CircleCI | `"CHANGEME"` | |
| 76 | +| `configuration.slackToken` | string | Slack token so Lita can communicate with Slack | `"CHANGEME"` | |
| 77 | + |
| 78 | + |
| 79 | +### Deployment parameters |
| 80 | + |
| 81 | +| Name | Type | Description | Default | |
| 82 | +| ----------------------------------- | ------- | -------------------------------------------------------------- | -------------------------- | |
| 83 | +| `image.registry` | string | The Docker image registry | `"gcr.io"` | |
| 84 | +| `image.repository` | string | The Docker image repository | `"indiegogo-staging/lita"` | |
| 85 | +| `image.tag` | string | The Docker image tag | `'latest'` | |
| 86 | +| `image.pullPolicy` | string | The Docker image pull policy | `"IfNotPresent"` | |
| 87 | +| `environmentIncludeDefault` | boolean | Include/don't include the default environment variables | `true` | |
| 88 | +| `environment` | object | Custom/extra environment variables | `{}` | |
| 89 | +| `containerPort` | int | Lita container port (overrides `networkPort`) | `nil` | |
| 90 | +| `replicaCount` | int | Number of Lita replicas to deploy | `1` | |
| 91 | +| `strategy.type` | string | Deployment strategy type | `"RollingUpdate"` | |
| 92 | +| `strategy.rollingUpdate` | object | Rolling update deployment strategy options | `{}` | |
| 93 | +| `resources.requests` | object | CPU/memory resource requests | `{}` | |
| 94 | +| `resources.limits` | object | CPU/memory resource limits | `{}` | |
| 95 | +| `livenessProbe.enabled` | boolean | Enable/Disable the default tcpSocket livenessProbe | `true` | |
| 96 | +| `livenessProbe.port` | int | Default livenessProbe tcpSocket port (overrides `networkPort`) | `nil` | |
| 97 | +| `livenessProbe.initialDelaySeconds` | int | Initial delay seconds for livenessProbe | `nil` | |
| 98 | +| `livenessProbe.periodSeconds` | int | Period seconds for livenessProbe | `nil` | |
| 99 | +| `livenessProbe.timeoutSeconds` | int | Timeout seconds for livenessProbe | `nil` | |
| 100 | +| `livenessProbe.successThreshold` | int | Success threshold for livenessProbe | `nil` | |
| 101 | +| `livenessProbe.failureThreshold` | int | Failure threshold for livenessProbe | `nil` | |
| 102 | +| `customLivenessProbe` | object | Custom livenessProbe that overrides the default one | `{}` | |
| 103 | +| `readinessProbeEnabled` | boolean | Enable the custom readinessProbe | `false` | |
| 104 | +| `readinessProbe` | object | Write your custom readiness probe here | `{}` | |
| 105 | +| `usePacificTime` | boolean | Use Pacific time instead of UTC in container | `false` | |
| 106 | + |
| 107 | + |
| 108 | +### Service parameters |
| 109 | + |
| 110 | +| Name | Type | Description | Default | |
| 111 | +| ---------------| ------ | ------------------------------------------- | ------------ | |
| 112 | +| `service.port` | int | Lita Service port (overrides `networkPort`) | `nil` | |
| 113 | +| `service.type` | string | Lita Service Type | `"NodePort"` | |
| 114 | + |
| 115 | + |
| 116 | +### Ingress parameters |
| 117 | + |
| 118 | +| Name | Type | Description | Default | |
| 119 | +| --------------------------- | ------- | -------------------------- | ----------------- | |
| 120 | +| `ingress.enabled` | boolean | Enable/Disable Ingress | `true` | |
| 121 | +| `ingress.tls.enabled` | boolean | Enable/Disable Ingress TLS | `false` | |
| 122 | +| `ingress.tls.hosts` | list | Ingress TLS host(s) | see `values.yaml` | |
| 123 | +| `ingress.tls.secretName` | string | Ingress TLS Secret name | `nil` | |
| 124 | +| `ingress.rules.hosts` | list | Ingress rules host(s) | see `values.yaml` | |
| 125 | +| `ingress.customAnnotations` | object | Ingress custom annotations | `{}` | |
| 126 | + |
| 127 | + |
| 128 | +### Redis storage parameters |
| 129 | + |
| 130 | +| Name | Type | Description | Default | |
| 131 | +| -------------------------------- | ------- | ----------------------------------------------- | ---------- | |
| 132 | +| `persistentVolume.enabled` | boolean | Enable to use an existing Redis persistent disk | `false` | |
| 133 | +| `persistentVolume.pdName` | string | Name of the existing persistent disk | `nil` | |
| 134 | +| `persistentVolume.reclaimPolicy` | string | Reclamation of the persistent disk resources | `"Retain"` | |
| 135 | + |
| 136 | + |
| 137 | +### Redis chart parameters |
| 138 | + |
| 139 | +| Name | Type | Description | Default | |
| 140 | +| ----------------------------------------- | ------- | ---------------------------------------------- | ------------ | |
| 141 | +| `redis.chartEnabled` | boolean | Enable the Redis chart dependency | `true` | |
| 142 | +| `redis.fullnameOverride` | string | Fully override the default Redis instance name | `"redis"` | |
| 143 | +| `redis.args` | list | Add extra Redis command arguments | `[]` | |
| 144 | +| `redis.storage.persistentVolumeClaimName` | string | Set to use an existing Persistent Volume Claim | `nil` | |
| 145 | +| `redis.storage.requestedSize` | string | Set to create a new Persistent Volume Claim | `"10Gi"` | |
| 146 | +| `redis.storage.className` | string | Type of storage (standard/ssd) | `"standard"` | |
| 147 | + |
| 148 | + |
| 149 | +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, |
| 150 | + |
| 151 | +```bash |
| 152 | +$ helm install my-release \ |
| 153 | + --set replicaCount=1 \ |
| 154 | + indiegogo/lita |
| 155 | +``` |
| 156 | + |
| 157 | +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, |
| 158 | + |
| 159 | +```bash |
| 160 | +$ helm install my-release -f values.yaml indiegogo/lita |
| 161 | +``` |
| 162 | + |
| 163 | +> **Tip**: You can use the default [values.yaml](values.yaml) |
0 commit comments