mirror of
https://github.com/bitnami/charts.git
synced 2026-03-05 14:57:31 +08:00
4829a51d1a
* [bitnami/node] Update Mongodb dependency to latest major version Signed-off-by: juan131 <juanariza@vmware.com>
260 lines
30 KiB
Markdown
260 lines
30 KiB
Markdown
# Parse
|
|
|
|
[Parse](https://parse.com/) is an open source version of the Parse backend that can be deployed to any infrastructure that can run Node.js.
|
|
|
|
## TL;DR;
|
|
|
|
```console
|
|
$ helm repo add bitnami https://charts.bitnami.com/bitnami
|
|
$ helm install my-release bitnami/parse
|
|
```
|
|
|
|
## Introduction
|
|
|
|
This chart bootstraps a [Parse](https://github.com/bitnami/bitnami-docker-parse) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
|
|
|
|
Bitnami charts can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the [BKPR](https://kubeprod.io/).
|
|
|
|
## Prerequisites
|
|
|
|
- Kubernetes 1.12+
|
|
- Helm 2.12+ or Helm 3.0-beta3+
|
|
- PV provisioner support in the underlying infrastructure
|
|
- ReadWriteMany volumes for deployment scaling
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `my-release`:
|
|
|
|
```console
|
|
$ helm install my-release bitnami/parse
|
|
```
|
|
|
|
The command deploys Parse on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) 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.
|
|
|
|
## Parameters
|
|
|
|
The following table lists the configurable parameters of the Parse chart and their default values.
|
|
|
|
| Parameter | Description | Default |
|
|
|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
|
|
| `global.imageRegistry` | Global Docker image registry | `nil` |
|
|
| `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` (does not add image pull secrets to deployed pods) |
|
|
| `global.storageClass` | Global storage class for dynamic provisioning | `nil` |
|
|
| `nameOverride` | String to partially override parse.fullname template with a string (will prepend the release name) | `nil` |
|
|
| `fullnameOverride` | String to fully override parse.fullname template with a string | `nil` |
|
|
| `volumePermissions.enabled` | Enable init container that changes volume permissions in the data directory (for cases where the default k8s `runAsUser` and `fsUser` values do not work) | `false` |
|
|
| `volumePermissions.image.registry` | Init container volume-permissions image registry | `docker.io` |
|
|
| `volumePermissions.image.repository` | Init container volume-permissions image name | `bitnami/minideb` |
|
|
| `volumePermissions.image.tag` | Init container volume-permissions image tag | `buster` |
|
|
| `volumePermissions.image.pullPolicy` | Init container volume-permissions image pull policy | `Always` |
|
|
| `volumePermissions.resources` | Init container resource requests/limit | `nil` |
|
|
| `service.type` | Kubernetes Service type | `LoadBalancer` |
|
|
| `service.port` | Service HTTP port (Dashboard) | `80` |
|
|
| `service.loadBalancerIP` | `loadBalancerIP` for the Parse Service | `nil` |
|
|
| `service.externalTrafficPolicy` | Enable client source IP preservation | `Cluster` |
|
|
| `service.nodePorts.http` | Kubernetes http node port | `""` |
|
|
| `server.image.registry` | Parse image registry | `docker.io` |
|
|
| `server.image.repository` | Parse image name | `bitnami/parse` |
|
|
| `server.image.tag` | Parse image tag | `{TAG_NAME}` |
|
|
| `server.image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
|
| `server.image.pullSecrets` | Specify docker-registry secret names as an array | `[]` (does not add image pull secrets to deployed pods) |
|
|
| `server.securityContext.enabled` | Enable security context for Parse Server | `true` |
|
|
| `server.securityContext.fsGroup` | Group ID for Parse Server container | `1001` |
|
|
| `server.securityContext.runAsUser` | User ID for Parse Server container | `1001` |
|
|
| `server.host` | Hostname to use to access Parse server (when `ingress.enabled=true` is set to `ingress.server.hosts[0].name` by default) | `nil` |
|
|
| `server.port` | Parse server port | `1337` |
|
|
| `server.mountPath` | Parse server API mount path | `/parse` |
|
|
| `server.appId` | Parse server App Id | `myappID` |
|
|
| `server.masterKey` | Parse server Master Key | `random 10 character alphanumeric string` |
|
|
| `server.enableCloudCode` | Enable Parse Cloud Clode | `false` |
|
|
| `server.cloudCodeScripts` | Dictionary of Cloud Code scripts | `nil` |
|
|
| `server.existingCloudCodeScriptsCM` | ConfigMap with Cloud Code scripts (Note: Overrides `cloudCodeScripts`). | `nil` |
|
|
| `server.resources` | The [resources] to allocate for container | `{}` |
|
|
| `server.livenessProbe` | Liveness probe configuration for Server | `Check values.yaml file` |
|
|
| `server.readinessProbe` | Readiness probe configuration for Server | `Check values.yaml file` |
|
|
| `server.affinity` | Affinity for pod assignment | `{}` (The value is evaluated as a template) |
|
|
| `server.nodeSelector` | Node labels for pod assignment | `{}` (The value is evaluated as a template) |
|
|
| `server.tolerations` | Tolerations for pod assignment | `[]` (The value is evaluated as a template) |
|
|
| `server.extraEnvVars` | Array containing extra env vars (evaluated as a template) | `nil` |
|
|
| `server.extraEnvVarsCM` | ConfigMap containing extra env vars (evaluated as a template) | `nil` |
|
|
| `server.extraEnvVarsSecret` | Secret containing extra env vars (evaluated as a template) | `nil` |
|
|
| `dashboard.enabled` | Enable parse dashboard | `true` |
|
|
| `dashboard.image.registry` | Dashboard image registry | `docker.io` |
|
|
| `dashboard.image.repository` | Dashboard image name | `bitnami/parse-dashboard` |
|
|
| `dashboard.image.tag` | Dashboard image tag | `{TAG_NAME}` |
|
|
| `dashboard.image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
|
| `dashboard.securityContext.enabled` | Enable security context for Dashboard | `true` |
|
|
| `dashboard.securityContext.fsGroup` | Group ID for Dashboard container | `1001` |
|
|
| `dashboard.securityContext.runAsUser` | User ID for Dashboard container | `1001` |
|
|
| `dashboard.image.pullSecrets` | Specify docker-registry secret names as an array | `[]` (does not add image pull secrets to deployed pods) |
|
|
| `dashboard.username` | Dashboard username | `user` |
|
|
| `dashboard.password` | Dashboard user password | `random 10 character alphanumeric string` |
|
|
| `dashboard.appName` | Dashboard application name | `MyDashboard` |
|
|
| `dashboard.parseServerUrlProtocol` | Protocol used by Parse Dashboard to form the URLs to Parse Server. | `http` |
|
|
| `dashboard.resources` | The [resources] to allocate for container | `{}` |
|
|
| `dashboard.livenessProbe` | Liveness probe configuration for Dashboard | `Check values.yaml file` |
|
|
| `dashboard.readinessProbe` | Readiness probe configuration for Dashboard | `Check values.yaml file` |
|
|
| `dashboard.affinity` | Affinity for pod assignment | `{}` (The value is evaluated as a template) |
|
|
| `dashboard.nodeSelector` | Node labels for pod assignment | `{}` (The value is evaluated as a template) |
|
|
| `dashboard.tolerations` | Tolerations for pod assignment | `[]` (The value is evaluated as a template) |
|
|
| `dashboard.extraEnvVars` | Array containing extra env vars (evaluated as a template) | `nil` |
|
|
| `dashboard.extraEnvVarsCM` | ConfigMap containing extra env vars (evaluated as a template) | `nil` |
|
|
| `dashboard.extraEnvVarsSecret` | Secret containing extra env vars (evaluated as a template) | `nil` |
|
|
| `persistence.enabled` | Enable Parse persistence using PVC | `true` |
|
|
| `persistence.storageClass` | PVC Storage Class for Parse volume | `nil` (uses alpha storage class annotation) |
|
|
| `persistence.accessMode` | PVC Access Mode for Parse volume | `ReadWriteOnce` |
|
|
| `persistence.size` | PVC Storage Request for Parse volume | `8Gi` |
|
|
| `ingress.enabled` | Enable ingress controller resource | `false` |
|
|
| `ingress.annotations` | Ingress annotations | `[]` |
|
|
| `ingress.certManager` | Add annotations for cert-manager | `false` |
|
|
| `ingress.dashboard.hosts[0].name` | Hostname to your Parse Dashboard installation | `ghost.local` |
|
|
| `ingress.dashboard.hosts[0].path` | Path within the url structure | `/` |
|
|
| `ingress.dashboard.hosts[0].tls` | Utilize TLS backend in ingress | `false` |
|
|
| `ingress.dashboard.hosts[0].tlsHosts` | Array of TLS hosts for ingress record (defaults to `ingress.hosts[0].name` if `nil`) | `nil` |
|
|
| `ingress.dashboard.hosts[0].tlsSecret` | TLS Secret (certificates) | `ghost.local-tls-secret` |
|
|
| `ingress.server.hosts[0].name` | Hostname to your Parse Server installation | `ghost.local` |
|
|
| `ingress.server.hosts[0].path` | Path within the url structure | `/` |
|
|
| `ingress.server.hosts[0].tls` | Utilize TLS backend in ingress | `false` |
|
|
| `ingress.server.hosts[0].tlsHosts` | Array of TLS hosts for ingress record (defaults to `ingress.hosts[0].name` if `nil`) | `nil` |
|
|
| `ingress.server.hosts[0].tlsSecret` | TLS Secret (certificates) | `ghost.local-tls-secret` |
|
|
| `ingress.secrets[0].name` | TLS Secret Name | `nil` |
|
|
| `ingress.secrets[0].certificate` | TLS Secret Certificate | `nil` |
|
|
| `ingress.secrets[0].key` | TLS Secret Key | `nil` |
|
|
| `mongodb.auth.enabled` | Enable MongoDB password authentication | `true` |
|
|
| `mongodb.auth.rootPassword` | MongoDB admin password | `nil` |
|
|
| `mongodb.persistence.enabled` | Enable MongoDB persistence using PVC | `true` |
|
|
| `mongodb.persistence.storageClass` | PVC Storage Class for MongoDB volume | `nil` (uses alpha storage class annotation) |
|
|
| `mongodb.persistence.accessMode` | PVC Access Mode for MongoDB volume | `ReadWriteOnce` |
|
|
| `mongodb.persistence.size` | PVC Storage Request for MongoDB volume | `8Gi` |
|
|
|
|
The above parameters map to the env variables defined in [bitnami/parse](http://github.com/bitnami/bitnami-docker-parse). For more information please refer to the [bitnami/parse](http://github.com/bitnami/bitnami-docker-parse) image documentation.
|
|
|
|
> **Note**:
|
|
>
|
|
> For the Parse application function correctly, you should specify the `parseHost` parameter to specify the FQDN (recommended) or the public IP address of the Parse service.
|
|
>
|
|
> Optionally, you can specify the `loadBalancerIP` parameter to assign a reserved IP address to the Parse service of the chart. However please note that this feature is only available on a few cloud providers (f.e. GKE).
|
|
>
|
|
> To reserve a public IP address on GKE:
|
|
>
|
|
> ```bash
|
|
> $ gcloud compute addresses create parse-public-ip
|
|
> ```
|
|
>
|
|
> The reserved IP address can be associated to the Parse service by specifying it as the value of the `loadBalancerIP` parameter while installing the chart.
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
|
|
```console
|
|
$ helm install my-release \
|
|
--set dashboard.username=admin,dashboard.password=password \
|
|
bitnami/parse
|
|
```
|
|
|
|
The above command sets the Parse administrator account username and password to `admin` and `password` respectively.
|
|
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
|
|
|
|
```console
|
|
$ helm install my-release -f values.yaml bitnami/parse
|
|
```
|
|
|
|
> **Tip**: You can use the default [values.yaml](values.yaml)
|
|
|
|
## Configuration and installation details
|
|
|
|
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
|
|
|
|
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
|
|
|
|
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
|
|
|
|
### Deploy your Cloud functions with Parse Cloud Code
|
|
|
|
The [Bitnami Parse](https://github.com/bitnami/bitnami-docker-parse) image allows you to deploy your Cloud functions with Parse Cloud Code (a feature which allows running a piece of code in your Parse Server instead of the user's mobile devices). In order to add your custom scripts, they must be located inside the chart folder `files/cloud` so they can be consumed as a ConfigMap.
|
|
|
|
Alternatively, you can specify custom scripts using the `cloudCodeScripts` parameter as dict.
|
|
|
|
In addition to these options, you can also set an external ConfigMap with all the Cloud Code scripts. This is done by setting the `existingCloudCodeScriptsCM` parameter. Note that this will override the two previous options.
|
|
|
|
## Persistence
|
|
|
|
The [Bitnami Parse](https://github.com/bitnami/bitnami-docker-parse) image stores the Parse data and configurations at the `/bitnami/parse` path of the container.
|
|
|
|
Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube.
|
|
See the [Parameters](#parameters) section to configure the PVC or to disable persistence.
|
|
|
|
### Adjust permissions of persistent volume mountpoint
|
|
|
|
As the image run as non-root by default, it is necessary to adjust the ownership of the persistent volume so that the container can write data into it.
|
|
|
|
By default, the chart is configured to use Kubernetes Security Context to automatically change the ownership of the volume. However, this feature does not work in all Kubernetes distributions.
|
|
As an alternative, this chart supports using an initContainer to change the ownership of the volume before mounting it in the final destination.
|
|
|
|
You can enable this initContainer by setting `volumePermissions.enabled` to `true`.
|
|
|
|
### Adding extra environment variables
|
|
|
|
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the `extraEnvVars` (available in the `server` and `dashboard` sections) property.
|
|
|
|
```yaml
|
|
extraEnvVars:
|
|
- name: PARSE_SERVER_ALLOW_CLIENT_CLASS_CREATION
|
|
value: true
|
|
```
|
|
|
|
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the `extraEnvVarsCM` or the `extraEnvVarsSecret` values.
|
|
|
|
## Upgrading
|
|
|
|
### To 11.0.0
|
|
|
|
Backwards compatibility is not guaranteed since breaking changes were included in MongoDB subchart. More information in the link below:
|
|
|
|
- https://github.com/bitnami/charts/tree/master/bitnami/mongodb#to-800
|
|
|
|
### To 10.0.0
|
|
|
|
Backwards compatibility is not guaranteed. The following notables changes were included:
|
|
|
|
- **parse-dashboard** is bumped to the branch 2 (major version)
|
|
- Labels are adapted to follow the Helm charts best practices.
|
|
|
|
### To 5.1.0
|
|
|
|
Parse & Parse Dashboard containers were moved to a non-root approach. There shouldn't be any issue when upgrading since the corresponding `securityContext` is enabled by default. Both container images and chart can be upgraded by running the command below:
|
|
|
|
```
|
|
$ helm upgrade my-release bitnami/parse
|
|
```
|
|
|
|
If you use a previous container image (previous to **3.1.2-r14** for Parse or **1.2.0-r69** for Parse Dashboard), disable the `securityContext` by running the command below:
|
|
|
|
```
|
|
$ helm upgrade my-release bitnami/parse --set server.securityContext.enabled=false,dashboard.securityContext.enabled=false,server.image.tag=XXX,dashboard.image.tag=YYY
|
|
```
|
|
|
|
### To 3.0.0
|
|
|
|
Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments.
|
|
Use the workaround below to upgrade from versions previous to 3.0.0. The following example assumes that the release name is parse:
|
|
|
|
```console
|
|
$ kubectl patch deployment parse-parse-dashboard --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
|
|
$ kubectl patch deployment parse-parse-server --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
|
|
$ kubectl patch deployment parse-mongodb --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
|
|
```
|