OrangeHRM
OrangeHRM is a free HR management system that offers a wealth of modules to suit the needs of your business. This widely-used system is feature-rich, intuitive and provides an essential HR management platform along with free documentation and access to a broad community of users.
TL;DR;
$ helm install stable/orangehrm
Introduction
This chart bootstraps an OrangeHRM 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 OrangeHRM application.
Prerequisites
- Kubernetes 1.4+ 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/orangehrm
The command deploys OrangeHRM 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 OrangeHRM chart and their default values.
| Parameter | Description | Default |
|---|---|---|
image.registry |
OrangeHRM image registry | docker.io |
image.repository |
OrangeHRM Image name | bitnami/orangehrm |
image.tag |
OrangeHRM Image tag | {VERSION} |
image.pullPolicy |
Image pull policy | Always if imageTag is latest, else IfNotPresent |
image.pullSecrets |
Specify image pull secrets | nil |
orangehrmUsername |
User of the application | user |
orangehrmPassword |
Application password | random 10 character long alphanumeric string |
smtpHost |
SMTP host | nil |
smtpPort |
SMTP port | nil |
smtpUser |
SMTP user | nil |
smtpPassword |
SMTP password | nil |
smtpProtocol |
SMTP protocol [ssl, none] |
nil |
serviceType |
Kubernetes Service type | LoadBalancer |
resources |
CPU/Memory resource requests/limits | Memory: 512Mi, CPU: 300m |
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.orangehrm.storageClass |
PVC Storage Class for OrangeHRM volume | nil (uses alpha storage class annotation) |
persistence.orangehrm.accessMode |
PVC Access Mode for OrangeHRM volume | ReadWriteOnce |
persistence.orangehrm.size |
PVC Storage Request for OrangeHRM volume | 8Gi |
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_orangehrm |
externalDatabase.password |
Password for the above username | nil |
externalDatabase.database |
Name of the existing database | bitnami_orangehrm |
mariadb.enabled |
Whether to use the MariaDB chart | true |
mariadb.db.name |
Database name to create | bitnami_orangehrm |
mariadb.db.user |
Database user to create | bn_orangehrm |
mariadb.db.password |
Password for the database | nil |
mariadb.rootUser.password |
MariaDB admin password | nil |
mariadb.persistence.enabled |
Enable MariaDB persistence using PVC | true |
mariadb.persistence.storageClass |
PVC Storage Class for MariaDB volume | nil (uses alpha storage class annotation) |
mariadb.persistence.accessMode |
PVC Access Mode for MariaDB volume | ReadWriteOnce |
mariadb.persistence.size |
PVC Storage Request for MariaDB volume | 8Gi |
The above parameters map to the env variables defined in bitnami/orangehrm. For more information please refer to the bitnami/orangehrm image documentation.
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
$ helm install --name my-release \
--set orangehrmUsername=admin,orangehrmPassword=password,mariadb.mariadbRootPassword=secretpassword \
stable/orangehrm
The above command sets the OrangeHRM 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/orangehrm
Tip
: You can use the default values.yaml
Persistence
The Bitnami OrangeHRM image stores the OrangeHRM data and configurations at the /bitnami/orangehrm 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.