stable/suitecrm

Chart version: 8.0.11
Api version: v1
App version: 7.11.12
DEPRECATED SuiteCRM is a completely open source enterprise-grad...
application
Chart Type
DEPRECATED
Status
Unknown
License
2811
Downloads
https://kubernetes-charts.storage.googleapis.com
Set me up:
helm repo add center https://repo.chartcenter.io
Install Chart:
helm install suitecrm center/stable/suitecrm
Versions (0)

SuiteCRM

SuiteCRM is a completely open source enterprise-grade Customer Relationship Management (CRM) application. SuiteCRM is a software fork of the popular customer relationship management (CRM) system SugarCRM.

This Helm chart is deprecated

Given the stable deprecation timeline, the Bitnami maintained SuiteCRM Helm chart is now located at bitnami/charts.

The Bitnami repository is already included in the Hubs and we will continue providing the same cadence of updates, support, etc that we’ve been keeping here these years. Installation instructions are very similar, just adding the bitnami repo and using it during the installation (bitnami/<chart> instead of stable/<chart>)

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/<chart>           # Helm 3
$ helm install --name my-release bitnami/<chart>    # Helm 2

To update an exisiting stable deployment with a chart hosted in the bitnami repository you can execute

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm upgrade my-release bitnami/<chart>

Issues and PRs related to the chart itself will be redirected to bitnami/charts GitHub repository. In the same way, we’ll be happy to answer questions related to this migration process in this issue created as a common place for discussion.

TL;DR;

$ helm install my-release stable/suitecrm

Introduction

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

It also packages the Bitnami MariaDB chart which is required for bootstrapping a MariaDB deployment for the database requirements of the SuiteCRM application.

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.12+
  • Helm 2.11+ 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:

$ helm install my-release stable/suitecrm

The command deploys SuiteCRM 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

The following table lists the configurable parameters of the SuiteCRM 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
image.registry SuiteCRM image registry docker.io
image.repository SuiteCRM image name bitnami/suitecrm
image.tag SuiteCRM image tag {TAG_NAME}
image.pullPolicy Image pull policy IfNotPresent
image.pullSecrets Specify docker-registry secret names as an array [] (does not add image pull secrets to deployed pods)
nameOverride String to partially override suitecrm.fullname template with a string (will prepend the release name) nil
fullnameOverride String to fully override suitecrm.fullname template with a string nil
suitecrmHost SuiteCRM host to create application URLs nil
suitecrmUsername User of the application user
suitecrmPassword Application password random 10 character alphanumeric string
suitecrmEmail Admin email user@example.com
suitecrmLastName Last name Last
suitecrmSmtpHost SMTP host nil
suitecrmSmtpPort SMTP port nil
suitecrmSmtpUser SMTP user nil
suitecrmSmtpPassword SMTP password nil
suitecrmSmtpProtocol SMTP protocol [ssl, tls] nil
suitecrmValidateUserIP Whether to validate the user IP address or not no
allowEmptyPassword Allow DB blank passwords yes
externalDatabase.host Host of the external database nil
externalDatabase.port Port of the external database 3306
externalDatabase.user Existing username in the external db bn_suitecrm
externalDatabase.password Password for the above username nil
externalDatabase.database Name of the existing database bitnami_suitecrm
ingress.enabled Enable ingress controller resource false
ingress.annotations Ingress annotations []
ingress.certManager Add annotations for cert-manager false
ingress.hosts[0].name Hostname to your SuiteCRM installation suitecrm.local
ingress.hosts[0].path Path within the url structure /
ingress.hosts[0].tls Utilize TLS backend in ingress false
ingress.hosts[0].tlsHosts Array of TLS hosts for ingress record (defaults to ingress.hosts[0].name if nil) nil
ingress.hosts[0].tlsSecret TLS Secret (certificates) suitecrm.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
mariadb.enabled Whether to use the MariaDB chart true
mariadb.db.name Database name to create bitnami_suitecrm
mariadb.db.user Database user to create bn_suitecrm
mariadb.db.password Password for the database nil
mariadb.rootUser.password MariaDB admin password nil
service.type Kubernetes Service type LoadBalancer
service.port Service HTTP port 80
service.httpsPort Service HTTPS port 443
service.nodePorts.http Kubernetes http node port ""
service.nodePorts.https Kubernetes https node port ""
service.externalTrafficPolicy Enable client source IP preservation Cluster
service.loadBalancerIP loadBalancerIP for the SuiteCRM Service nil
persistence.enabled Enable persistence using PVC true
persistence.storageClass PVC Storage Class for SuiteCRM volume nil (uses alpha storage class annotation)
persistence.existingClaim An Existing PVC name for SuiteCRM volume nil (uses alpha storage class annotation)
persistence.accessMode PVC Access Mode for SuiteCRM volume ReadWriteOnce
persistence.size PVC Storage Request for SuiteCRM volume 8Gi
resources CPU/Memory resource requests/limits Memory: 512Mi, CPU: 300m
podAnnotations Pod annotations {}
affinity Map of node/pod affinities {}
metrics.enabled Start a side-car prometheus exporter false
metrics.image.registry Apache exporter image registry docker.io
metrics.image.repository Apache exporter image name bitnami/apache-exporter
metrics.image.tag Apache exporter image tag {TAG_NAME}
metrics.image.pullPolicy Image pull policy IfNotPresent
metrics.image.pullSecrets Specify docker-registry secret names as an array nil
metrics.podAnnotations Additional annotations for Metrics exporter pod {prometheus.io/scrape: "true", prometheus.io/port: "9117"}
metrics.resources Exporter resource requests/limit {}

The above parameters map to the env variables defined in bitnami/suitecrm. For more information please refer to the bitnami/suitecrm image documentation.

Note:

For SuiteCRM to function correctly, you should specify the suitecrmHost parameter to specify the FQDN (recommended) or the public IP address of the SuiteCRM service.

Optionally, you can specify the suitecrmLoadBalancerIP parameter to assign a reserved IP address to the SuiteCRM 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 suitecrm-public-ip
> ```
>
> The reserved IP address can be associated to the SuiteCRM service by specifying it as the value of the `suitecrmLoadBalancerIP` 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 suitecrmUsername=admin,suitecrmPassword=password,mariadb.mariadbRootPassword=secretpassword \
    stable/suitecrm

The above command sets the SuiteCRM administrator account username and password to admin and password respectively. Additionally, it sets the MariaDB root user password to secretpassword.

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 stable/suitecrm

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.

Persistence

The Bitnami SuiteCRM image stores the SuiteCRM data and configurations at the /bitnami/suitecrm 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.

Upgrading

8.0.0

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes’ point of view, so you cannot “upgrade” those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In https://github.com/helm/charts/pull/17310 the apiVersion of the deployment resources was updated to apps/v1 in tune with the api’s deprecated, resulting in compatibility breakage.

This major version signifies this change.

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 suitecrm:

$ kubectl patch deployment suitecrm-suitecrm --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl delete statefulset suitecrm-mariadb --cascade=false