|
| 1 | +# Cloudinary-staging Chart packaged by Indiegogo |
| 2 | + |
| 3 | +The Cloudinary-staging application is responsible for proxying the Cloudinary images in our Staging environment. |
| 4 | + |
| 5 | +## TL;DR |
| 6 | + |
| 7 | +```bash |
| 8 | +$ helm repo add indiegogo https://charts.indiegogo.com |
| 9 | +$ helm install my-release indiegogo/cloudinary-staging |
| 10 | +``` |
| 11 | + |
| 12 | +## Introduction |
| 13 | + |
| 14 | +This chart bootstraps a Cloudinary-staging deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | + |
| 18 | +- Kubernetes 1.12+ |
| 19 | +- Helm 3.6.2 |
| 20 | + |
| 21 | +## Installing the Chart |
| 22 | + |
| 23 | +To install the chart with the release name `my-release`: |
| 24 | + |
| 25 | +```bash |
| 26 | +$ helm install my-release indiegogo/cloudinary-staging |
| 27 | +``` |
| 28 | + |
| 29 | +The command deploys Cloudinary-staging on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation. |
| 30 | + |
| 31 | +> **Tip**: List all releases using `helm list` |
| 32 | +
|
| 33 | +## Uninstalling the Chart |
| 34 | + |
| 35 | +To uninstall/delete the `my-release` deployment: |
| 36 | + |
| 37 | +```bash |
| 38 | +$ helm uninstall my-release |
| 39 | +``` |
| 40 | + |
| 41 | +> 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: |
| 42 | +
|
| 43 | +```bash |
| 44 | +$ helm uninstall -n namespace my-release |
| 45 | +``` |
| 46 | + |
| 47 | +The command removes all the Kubernetes components associated with the chart and deletes the release. |
| 48 | + |
| 49 | +## Parameters |
| 50 | + |
| 51 | + |
| 52 | +### Common parameters |
| 53 | + |
| 54 | +| Name | Type | Description | Default | |
| 55 | +| ------------------- | ------ | -------------------------------------------------------------------------- | ------- | |
| 56 | +| `kubeVersion` | string | Override Kubernetes version | `nil` | |
| 57 | +| `nameOverride` | string | Partially override names.fullname | `nil` | |
| 58 | +| `fullnameOverride` | string | Fully override names.fullname | `nil` | |
| 59 | +| `commonLabels` | object | Labels to add to all deployed objects | `{}` | |
| 60 | +| `commonAnnotations` | object | Annotations to add to all deployed objects | `{}` | |
| 61 | +| `networkPort` | int | Deployment container, Deployment readinessProbe, Ingress, and Service port | `80` | |
| 62 | + |
| 63 | + |
| 64 | +### Deployment parameters |
| 65 | + |
| 66 | +| Name | Type | Description | Default | |
| 67 | +| ------------------------------------ | ------- | ------------------------------------------------------------- | --------------------------- | |
| 68 | +| `image.registry` | string | The Docker image registry | `"gcr.io"` | |
| 69 | +| `image.repository` | string | The Docker image repository | `"indiegogo-staging/nginx"` | |
| 70 | +| `image.tag` | string | The Docker image tag | `'latest'` | |
| 71 | +| `image.pullPolicy` | string | The Docker image pull policy | `"IfNotPresent"` | |
| 72 | +| `containerPort` | int | Cloudinary container port (overrides `networkPort`) | `nil` | |
| 73 | +| `replicaCount` | int | Number of Cloudinary replicas to deploy | `3` | |
| 74 | +| `strategy.type` | string | Deployment strategy type | `"RollingUpdate"` | |
| 75 | +| `resources.requests` | object | CPU/memory resource requests | `{}` | |
| 76 | +| `resources.limits` | object | CPU/memory resource limits | `{}` | |
| 77 | +| `readinessProbe.enabled` | boolean | Enable/Disable the default httpGet readinessProbe | `true` | |
| 78 | +| `readinessProbe.port` | int | Default readinessProbe httpGet port (overrides `networkPort`) | `nil` | |
| 79 | +| `readinessProbe.initialDelaySeconds` | int | Initial delay seconds for readinessProbe | `5` | |
| 80 | +| `readinessProbe.periodSeconds` | int | Period seconds for readinessProbe | `5` | |
| 81 | +| `readinessProbe.timeoutSeconds` | int | Timeout seconds for readinessProbe | `nil` | |
| 82 | +| `readinessProbe.successThreshold` | int | Success threshold for readinessProbe | `nil` | |
| 83 | +| `readinessProbe.failureThreshold` | int | Failure threshold for readinessProbe | `nil` | |
| 84 | +| `customReadinessProbe` | object | Custom readinessProbe that overrides the default one | `{}` | |
| 85 | +| `livenessProbeEnabled` | boolean | Enable the custom livenessProbe | `false` | |
| 86 | +| `livenessProbe` | object | Write your custom liveness probe here | `{}` | |
| 87 | + |
| 88 | + |
| 89 | +### Service parameters |
| 90 | + |
| 91 | +| Name | Type | Description | Default | |
| 92 | +| ---------------| ------- | --------------------------------------------------- | ------------ | |
| 93 | +| `service.name` | string | Cloudinary Service port (overrides `.Release.Name`) | `"http"` | |
| 94 | +| `service.port` | int | Cloudinary Service port (overrides `networkPort`) | `80` | |
| 95 | +| `service.type` | string | Cloudinary Service Type | `"NodePort"` | |
| 96 | + |
| 97 | + |
| 98 | +### Ingress parameters |
| 99 | + |
| 100 | +| Name | Type | Description | Default | |
| 101 | +| ----------------------------- | ------- | ---------------------------------------------------- | ------- | |
| 102 | +| `ingress.enabled` | boolean | Enable/Disable Ingress | `true` | |
| 103 | +| `ingress.backend.serviceName` | string | Ingress rules service name | `nil` | |
| 104 | +| `ingress.backend.servicePort` | int | Ingress rules service port (overrides `networkPort`) | `nil` | |
| 105 | +| `ingress.customAnnotations` | object | Ingress custom annotations | `{}` | |
| 106 | + |
| 107 | + |
| 108 | +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, |
| 109 | + |
| 110 | +```bash |
| 111 | +$ helm install my-release \ |
| 112 | + --set replicaCount=1 \ |
| 113 | + indiegogo/cloudinary-staging |
| 114 | +``` |
| 115 | + |
| 116 | +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, |
| 117 | + |
| 118 | +```bash |
| 119 | +$ helm install my-release -f values.yaml indiegogo/cloudinary-staging |
| 120 | +``` |
| 121 | + |
| 122 | +> **Tip**: You can use the default [values.yaml](values.yaml) |
0 commit comments