1.0.5-0.1.0 • Published 5 years ago

@helm-charts/bitnami-sugarcrm v1.0.5-0.1.0

Weekly downloads
1
License
MIT
Repository
-
Last release
5 years ago

@helm-charts/bitnami-sugarcrm

SugarCRM enables businesses to create extraordinary customer relationships with the most innovative and affordable CRM solution in the market.

FieldValue
Repository Namebitnami
Chart Namesugarcrm
Chart Version1.0.5
NPM Package Version0.1.0
## Bitnami SugarCRM image version
## ref: https://hub.docker.com/r/bitnami/sugarcrm/tags/
##
image:
  registry: docker.io
  repository: bitnami/sugarcrm
  tag: 6.5.26
  ## Specify a imagePullPolicy
  ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
  ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
  ##
  pullPolicy: IfNotPresent
  ## Optionally specify an array of imagePullSecrets.
  ## Secrets must be manually created in the namespace.
  ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
  ##
  # pullSecrets:
  #   - myRegistrKeySecretName

## SugarCRM host to create application URLs
## ref: https://github.com/bitnami/bitnami-docker-sugarcrm#configuration
##
# sugarcrmHost:

## loadBalancerIP for the SugarCRM Service (optional, cloud specific)
## ref: http://kubernetes.io/docs/user-guide/services/#type-loadbalancer
##
# sugarcrmLoadBalancerIP:

## User of the application
## ref: https://github.com/bitnami/bitnami-docker-sugarcrm#configuration
##
sugarcrmUsername: user

## Application password
## Defaults to a random 10-character alphanumeric string if not set
## ref: https://github.com/bitnami/bitnami-docker-sugarcrm#configuration
##
# sugarcrmPassword:

## Admin email
## ref: https://github.com/bitnami/bitnami-docker-sugarcrm#configuration
##
sugarcrmEmail: user@example.com

## Last Name
## ref: https://github.com/bitnami/bitnami-docker-sugarcrm#configuration
##
sugarcrmLastName: LastName

## Set to `yes` to allow the container to be started with blank passwords
## ref: https://github.com/bitnami/bitnami-docker-sugarcrm#environment-variables
allowEmptyPassword: 'yes'

##
## External database configuration
##
externalDatabase:
  ## Database host
  host:

  ## Database host
  port: 3306

  ## Database user
  user: bn_sugarcrm

  ## Database password
  password:

  ## Database name
  database: bitnami_sugarcrm

## SMTP mail delivery configuration
## ref: https://github.com/bitnami/bitnami-docker-orangehrm/#smtp-configuration
# sugarcrmSmtpHost:
# sugarcrmSmtpPort:
# sugarcrmSmtpUser:
# sugarcrmSmtpPassword:
# sugarcrmSmtpProtocol:

##
## MariaDB chart configuration
##
mariadb:
  ## Whether to deploy a mariadb server to satisfy the applications database requirements. To use an external database set this to false and configure the externalDatabase parameters
  enabled: true

  ## Create a database
  ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-on-first-run
  ##
  mariadbDatabase: bitnami_sugarcrm

  ## Create a database user
  ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-user-on-first-run
  ##
  mariadbUser: bn_sugarcrm

  ## Password for mariadbUser
  ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-user-on-first-run
  ##
  # mariadbPassword:

  ## MariaDB admin password
  ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#setting-the-root-password-on-first-run
  ##
  # mariadbRootPassword:

  ## Enable persistence using Persistent Volume Claims
  ## ref: http://kubernetes.io/docs/user-guide/persistent-volumes/
  ##
  persistence:
    enabled: true
    ## mariadb data Persistent Volume Storage Class
    ## If defined, storageClassName: <storageClass>
    ## If set to "-", storageClassName: "", which disables dynamic provisioning
    ## If undefined (the default) or set to null, no storageClassName spec is
    ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
    ##   GKE, AWS & OpenStack)
    ##
    # storageClass: "-"
    accessMode: ReadWriteOnce
    size: 8Gi

## Kubernetes configuration
## For minikube, set this to NodePort, elsewhere use LoadBalancer
##
serviceType: LoadBalancer

## Enable persistence using Persistent Volume Claims
## ref: http://kubernetes.io/docs/user-guide/persistent-volumes/
##
persistence:
  enabled: true
  apache:
    ## apache data Persistent Volume Storage Class
    ## If defined, storageClassName: <storageClass>
    ## If set to "-", storageClassName: "", which disables dynamic provisioning
    ## If undefined (the default) or set to null, no storageClassName spec is
    ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
    ##   GKE, AWS & OpenStack)
    ##
    # storageClass: "-"
    accessMode: ReadWriteOnce
    size: 1Gi
  sugarcrm:
    ## sugarcrm data Persistent Volume Storage Class
    ## If defined, storageClassName: <storageClass>
    ## If set to "-", storageClassName: "", which disables dynamic provisioning
    ## If undefined (the default) or set to null, no storageClassName spec is
    ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
    ##   GKE, AWS & OpenStack)
    ##
    # storageClass: "-"
    accessMode: ReadWriteOnce
    size: 8Gi

## Configure resource requests and limits
## ref: http://kubernetes.io/docs/user-guide/compute-resources/
##
resources:
  {}
  # requests:
  #   memory: 512Mi
  #   cpu: 300m

SugarCRM

SugarCRM offers the most innovative, flexible and affordable CRM in the market and delivers the best all-around value of any CRM.

TL;DR;

$ helm install stable/sugarcrm

Introduction

This chart bootstraps a SugarCRM 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 SugarCRM 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/sugarcrm

The command deploys SugarCRM 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 table lists the configurable parameters of the SugarCRM chart and their default values.

ParameterDescriptionDefault
image.registrySugarCRM image registrydocker.io
image.repositorySugarCRM image namebitnami/sugarcrm
image.tagSugarCRM image tag{VERSION}
image.pullPolicyImage pull policyAlways if imageTag is latest, else IfNotPresent
image.pullSecretsSpecify image pull secretsnil
sugarcrmUsernameUser of the applicationuser
sugarcrmPasswordApplication passwordrandom 10 character alphanumeric string
sugarcrmEmailAdmin emailuser@example.com
sugarcrmLastnameLast nameName
sugarcrmHostHost domain or IPnil
sugarcrmLoadBalancerIPloadBalancerIP of the applicationnil
sugarcrmSmtpHostSMTP hostnil
sugarcrmSmtpPortSMTP portnil
sugarcrmSmtpProtocolSMTP Protocolnil
sugarcrmSmtpUserSMTP usernil
sugarcrmSmtpPasswordSMTP passwordnil
allowEmptyPasswordAllow DB blank passwordsyes
externalDatabase.hostHost of the external databasenil
externalDatabase.portPort of the external database3306
externalDatabase.userExisting username in the external dbbn_sugarcrm
externalDatabase.passwordPassword for the above usernamenil
externalDatabase.databaseName of the existing databasebitnami_sugarcrm
mariadb.enabledWhether to use the MariaDB charttrue
mariadb.mariadbDatabaseDatabase name to createbitnami_sugarcrm
mariadb.mariadbUserDatabase user to createbn_sugarcrm
mariadb.mariadbPasswordPassword for the databasenil
mariadb.mariadbRootPasswordMariaDB admin passwordnil
serviceTypeKubernetes Service typeLoadBalancer
persistence.enabledEnable persistence using PVCtrue
persistence.apache.storageClassPVC Storage Class for apache volumenil (uses alpha storage class annotation)
persistence.apache.accessModePVC Access Mode for apache volumeReadWriteOnce
persistence.apache.sizePVC Storage Request for apache volume1Gi
persistence.sugarcrm.storageClassPVC Storage Class for SugarCRM volumenil (uses alpha storage class annotation)
persistence.sugarcrm.accessModePVC Access Mode for SugarCRM volumeReadWriteOnce
persistence.sugarcrm.sizePVC Storage Request for SugarCRM volume8Gi
resourcesCPU/Memory resource requests/limitsMemory: 512Mi, CPU: 300m

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

Note:

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

Optionally, you can specify the sugarcrmLoadBalancerIP parameter to assign a reserved IP address to the SugarCRM 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 sugarcrm-public-ip

The reserved IP address can be associated to the SugarCRM service by specifying it as the value of the sugarcrmLoadBalancerIP 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 sugarcrmUsername=admin,sugarcrmPassword=password,mariadb.mariadbRootPassword=secretpassword \
    stable/sugarcrm

The above command sets the SugarCRM 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/sugarcrm

Tip: You can use the default values.yaml

Persistence

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