Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-02-15 07:47:12 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
7aaaaff3f876b077aa0211ca2ffb2b2efce66711
charts/bitnami/parse
History

README.md

Parse Server packaged by Bitnami

Parse is a platform that enables users to add a scalable and powerful backend to launch a full-featured app for iOS, Android, JavaScript, Windows, Unity, and more.

Overview of Parse Server

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/parse

Introduction

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

Bitnami charts can be used with Kubeapps 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.

Prerequisites

  • Kubernetes 1.19+
  • Helm 3.2.0+
  • 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:

$ helm install my-release bitnami/parse

The command deploys Parse on the Kubernetes cluster in the default configuration. The 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:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

Global parameters

Name Description Value
global.imageRegistry Global Docker image registry ""
global.imagePullSecrets Global Docker registry secret names as an array []
global.storageClass Global StorageClass for Persistent Volume(s) ""

Common Parameters

Name Description Value
nameOverride String to partially override common.names.fullname template (will maintain the release name) ""
fullnameOverride String to fully override common.names.fullname template ""
kubeVersion Force target Kubernetes version (using Helm capabilites if not set) ""
commonLabels Add labels to all the deployed resources {}
commonAnnotations Add annotations to all the deployed resources {}
extraDeploy Array of extra objects to deploy with the release []

Parse server parameters

Name Description Value
server.image.registry Parse image registry docker.io
server.image.repository Parse image repository bitnami/parse
server.image.tag Parse image tag (immutable tags are recommended) 4.10.4-debian-10-r74
server.image.pullPolicy Image pull policy IfNotPresent
server.image.pullSecrets Specify docker-registry secret names as an array []
server.hostAliases Deployment pod host aliases []
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.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 ""
server.extraEnvVars An array to add extra env vars []
server.extraEnvVarsCM Name of a ConfigMap containing extra environment variables ""
server.extraEnvVarsSecret Name of a Secret containing extra environment variables ""
server.enableCloudCode Enable Parse Cloud Code false
server.cloudCodeScripts Cloud Code scripts {}
server.existingCloudCodeScriptsCM ConfigMap with Cloud Code scripts (Note: Overrides cloudCodeScripts). ""
server.resources Parse Server pods' resource requests and limits {}
server.livenessProbe.enabled Enable livenessProbe true
server.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 120
server.livenessProbe.periodSeconds Period seconds for livenessProbe 10
server.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
server.livenessProbe.failureThreshold Failure threshold for livenessProbe 5
server.livenessProbe.successThreshold Success threshold for livenessProbe 1
server.readinessProbe.enabled Enable readinessProbe true
server.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 30
server.readinessProbe.periodSeconds Period seconds for readinessProbe 5
server.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
server.readinessProbe.failureThreshold Failure threshold for readinessProbe 5
server.readinessProbe.successThreshold Success threshold for readinessProbe 1
server.podAffinityPreset Parse server pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard ""
server.podAntiAffinityPreset Parse server pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard soft
server.nodeAffinityPreset.type Parse server node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard ""
server.nodeAffinityPreset.key Parse server node label key to match Ignored if affinity is set. ""
server.nodeAffinityPreset.values Parse server node label values to match. Ignored if affinity is set. []
server.affinity Parse server affinity for pod assignment {}
server.nodeSelector Parse server node labels for pod assignment {}
server.tolerations Parse server tolerations for pod assignment []

Traffic Exposure Parameters

Name Description Value
service.type Kubernetes Service type LoadBalancer
service.port Service HTTP port (Dashboard) 80
service.nodePorts.http Kubernetes HTTP node port ""
service.externalTrafficPolicy Enable client source IP preservation Cluster
ingress.enabled Set to true to enable ingress record generation false
ingress.tls Enable TLS configuration for the hostname defined at ingress.hostname parameter false
ingress.annotations Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations. {}
ingress.dashboard.hostname Default host for the ingress resource parse-dashboard.local
ingress.dashboard.path The Path to WordPress. You may need to set this to '/*' in order to use this with ALB ingress controllers. /
ingress.dashboard.pathType Ingress path type ImplementationSpecific
ingress.dashboard.extraHosts The list of additional hostnames to be covered with this ingress record. []
ingress.dashboard.extraPaths Any additional arbitrary paths that may need to be added to the ingress under the main host. []
ingress.server.hostname Default host for the ingress resource parse-server.local
ingress.server.path Default path for the ingress resource*' in order to use this with ALB ingress controllers. /
ingress.server.pathType Ingress path type ImplementationSpecific
ingress.server.extraHosts The list of additional hostnames to be covered with this ingress record. []
ingress.server.extraPaths Any additional arbitrary paths that may need to be added to the ingress under the main host. []
ingress.extraTls The tls configuration for additional hostnames to be covered with this ingress record. []
ingress.secrets If you're providing your own certificates, please use this to add the certificates as secrets []

Persistence Parameters

Name Description Value
persistence.enabled Enable Parse persistence using PVC true
persistence.storageClass PVC Storage Class for Parse volume ""
persistence.accessMode PVC Access Mode for Parse volume ReadWriteOnce
persistence.size PVC Storage Request for Parse volume 8Gi

Dashboard Parameters

Name Description Value
dashboard.enabled Enable parse dashboard true
dashboard.image.registry Dashboard image registry docker.io
dashboard.image.repository Dashboard image repository bitnami/parse-dashboard
dashboard.image.tag Dashboard image tag (immutable tags are recommended) 3.2.1-debian-10-r73
dashboard.image.pullPolicy Image pull policy IfNotPresent
dashboard.image.pullSecrets Specify docker-registry secret names as an array []
dashboard.hostAliases Deployment pod host aliases []
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.username Parse Dashboard application username user
dashboard.password Parse Dashboard application password ""
dashboard.appName Parse Dashboard application name MyDashboard
dashboard.resources Parse Dashboard pods' resource requests and limits {}
dashboard.livenessProbe.enabled Enable livenessProbe true
dashboard.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 240
dashboard.livenessProbe.periodSeconds Period seconds for livenessProbe 10
dashboard.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
dashboard.livenessProbe.failureThreshold Failure threshold for livenessProbe 5
dashboard.livenessProbe.successThreshold Success threshold for livenessProbe 1
dashboard.readinessProbe.enabled Enable readinessProbe true
dashboard.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 30
dashboard.readinessProbe.periodSeconds Period seconds for readinessProbe 5
dashboard.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
dashboard.readinessProbe.failureThreshold Failure threshold for readinessProbe 5
dashboard.readinessProbe.successThreshold Success threshold for readinessProbe 1
dashboard.podAffinityPreset Parse dashboard pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard ""
dashboard.podAntiAffinityPreset Parse dashboard pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard soft
dashboard.nodeAffinityPreset.type Parse dashboard node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard ""
dashboard.nodeAffinityPreset.key Parse dashboard node label key to match Ignored if affinity is set. ""
dashboard.nodeAffinityPreset.values Parse dashboard node label values to match. Ignored if affinity is set. []
dashboard.affinity Parse dashboard affinity for pod assignment {}
dashboard.nodeSelector Parse dashboard node labels for pod assignment {}
dashboard.tolerations Parse dashboard tolerations for pod assignment []
dashboard.parseServerUrlProtocol Protocol used by Parse Dashboard to form the URLs to Parse server http
dashboard.extraEnvVars An array to add extra env vars []
dashboard.extraEnvVarsCM Name of a ConfigMap containing extra environment variables ""
dashboard.extraEnvVarsSecret Name of a Secret containing extra environment variables ""

Volume Permissions parameters

Name Description Value
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/bitnami-shell
volumePermissions.image.tag Init container volume-permissions image tag 10-debian-10-r292
volumePermissions.image.pullPolicy Init container volume-permissions image pull policy IfNotPresent
volumePermissions.image.pullSecrets Init container volume-permissions image pull secrets []
volumePermissions.resources The resources for the container {}

MongoDB® Parameters

Name Description Value
mongodb.enabled Enable MongoDB® chart true
mongodb.auth.enabled Enable MongoDB® password authentication true
mongodb.auth.rootPassword MongoDB® admin password ""
mongodb.auth.username MongoDB® user bn_parse
mongodb.auth.password MongoDB® user password ""
mongodb.auth.database MongoDB® database bitnami_parse
mongodb.persistence.enabled Enable MongoDB® persistence using PVC true
mongodb.persistence.storageClass PVC Storage Class for MongoDB® volume ""
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. For more information please refer to the bitnami/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:

$ 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,

$ 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.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/parse

Tip

: You can use the default values.yaml

Configuration and installation details

Rolling VS Immutable tags

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

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.

Deploying extra resources

There are cases where you may want to deploy extra objects, such as KongPlugins, KongConsumers, amongst others. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy parameter. The following example would activate a plugin at deployment time.

## Extra objects to deploy (value evaluated as a template)
##
extraDeploy: |-
  - apiVersion: rbac.authorization.k8s.io/v1
    kind: RoleBinding
    metadata:
      name: {{ include "common.names.fullname" . }}-privileged
      namespace: {{ .Release.Namespace }}
      labels: {{- include "common.labels.standard" . | nindent 6 }}
    roleRef:
      apiGroup: rbac.authorization.k8s.io
      kind: ClusterRole
      name: cluster-admin
    subjects:
      - kind: ServiceAccount
        name: default
        namespace: {{ .Release.Namespace }}

Setting Pod's affinity

This chart allows you to set your custom affinity using the XXX.affinity paremeter(s). Find more infomation about Pod's affinity in the kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the XXX.podAffinityPreset, XXX.podAntiAffinityPreset, or XXX.nodeAffinityPreset parameters.

Troubleshooting

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading

To 16.0.0

In this version, the mongodb-exporter bundled as part of the bitnami/mongodb dependency was updated to a new version which, even it is not a major change, can contain breaking changes (from 0.11.X to 0.30.X).

Please visit the release notes from the upstream project at https://github.com/percona/mongodb_exporter/releases

To 15.0.0

The Bitnami Parse and Bitnami Parse Dashboard images were refactored and now the source code is published in GitHub in the rootfs folder of the container images.

Compatibility is not guaranteed due to the amount of involved changes, however no breaking changes are expected.

To 14.0.0

This version standardizes the way of defining Ingress rules. When configuring a single hostname for the Ingress rule, set the ingress.dashboard.hostname and ingress.server.hostname values. When defining more than one, set the ingress.dashboard.extraHosts and ingress.server.extraHosts arrays. Apart from this case, no issues are expected to appear when upgrading.

To 13.0.0

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

What changes were introduced in this major version?

  • Previous versions of this Helm Chart use apiVersion: v1 (installable by both Helm 2 and 3), this Helm Chart was updated to apiVersion: v2 (installable by Helm 3 only). Here you can find more information about the apiVersion field.
  • Move dependency information from the requirements.yaml to the Chart.yaml
  • After running helm dependency update, a Chart.lock file is generated containing the same structure used in the previous requirements.lock
  • The different fields present in the Chart.yaml file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

Considerations when upgrading to this version

  • If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
  • If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
  • If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the official Helm documentation about migrating from Helm v2 to v3

Useful links

To 15.0.0

To 12.0.0

MongoDB® subchart container images were updated to 4.4.x and it can affect compatibility with older versions of MongoDB®.

To 11.0.0

Backwards compatibility is not guaranteed since breaking changes were included in MongoDB® subchart. More information in the link below:

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:

$ 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"}]'

License

Copyright © 2022 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Reference in New Issue View Git Blame Copy Permalink