SuiteCRM

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.

TL;DR;

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

Prerequisites

• Kubernetes 1.5+ with Beta APIs enabled
• PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release stable/suitecrm

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

Configuration

The following tables lists the configurable parameters of the SuiteCRM chart and their default values.

Parameter	Description	Default
imageTag	bitnami/suitecrm image tag.	SuiteCRM image version
imagePullPolicy	Image pull policy.	IfNotPresent
suitecrmHost	SuiteCRM host to create application URLs	nil
suitecrmLoadBalancerIP	loadBalancerIP for the SuiteCRM Service	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
mariadb.mariadbRootPassword	MariaDB admin password	nil
serviceType	Kubernetes Service type	LoadBalancer
persistence.enabled	Enable persistence using PVC	true
persistence.apache.storageClass	PVC Storage Class for apache volume	nil (uses alpha storage class annotation)
persistence.apache.accessMode	PVC Access Mode for apache volume	ReadWriteOnce
persistence.apache.size	PVC Storage Request for apache volume	1Gi
persistence.suitecrm.storageClass	PVC Storage Class for SuiteCRM volume	nil (uses alpha storage class annotation)
persistence.suitecrm.accessMode	PVC Access Mode for SuiteCRM volume	ReadWriteOnce
persistence.suitecrm.size	PVC Storage Request for SuiteCRM volume	8Gi
resources	CPU/Memory resource requests/limits	Memory: 512Mi, CPU: 300m

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,

$ helm install --name 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 --name my-release -f values.yaml stable/suitecrm

Tip: You can use the default values.yaml

Persistence

The Bitnami SuiteCRM image stores the SuiteCRM data and configurations at the /bitnami/suitecrm and /bitnami/apache paths 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 Configuration section to configure the PVC or to disable persistence.