stable/sapho/README.md
As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.
The Sapho Micro App Platform is the best way to put actionable business information into your employees’ hands. This micro application development and integration platform enables organizations to create and deliver secure micro apps that tie into existing business systems and track changes to key business data. The result is a work feed that keeps employees up-to-date with important information and their associated actions. Employees benefits from real time data updates and one-click task completion from a single unified app, browser, or messenger client. All of this runs on Azure, connects to your existing infrastructure, and integrates with your existing identity and access control solutions to maintain security. For more information, please visit Sapho.
This chart bootstraps a Sapho deployment on a Kubernetes cluster using the Helm package manager.
It also packages the MySQL chart which is required for bootstrapping a MySQL deployment for the database requirements of the Sapho application.
To install the chart:
$ helm install --name my-release stable/sapho
Tip: List all releases using
helm list
The command deploys Sapho 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
To uninstall/delete the my-release deployment, use helm list command to obtain the release name, then :
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
The following table lists the configurable parameters of the Sapho chart and their default values.
| Parameter | Description | Default |
|---|---|---|
image | Sapho image | sapho/ops-docker-tomcat:{VERSION} |
imagePullPolicy | Image pull policy | Always if image tag is latest, else IfNotPresent |
saphoDBuser | User of the application | user |
saphoDBpass | MySQL DB Password | nil |
saphoDBtype | Sapho DB Type | mysql |
saphoDBhost | Sapho DB HostName | nil |
mysql.mysqlRootPassword | MySQL admin password | nil |
serviceType | Kubernetes Service type | LoadBalancer |
mysql.persistence.enabled | Enable persistence using PVC | true |
mysql.persistence.storageClass | The PVC storage class to use. | nil (uses alpha storage class annotation) |
The above parameters map to the env variables defined in sapho/ops-docker-tomcat. For more information please refer to the sapho/ops-docker-tomcat image documentation.
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
$ helm install --set saphoDBuser=root,saphoDBpass=password,mysql.mysqlRootPassword=password sapho
The above command sets Sapho's JDBC connection's username and password to root and password respectively. Additionally it sets the MySQL root user password to password.
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 sapho
Tip: You can use the default values.yaml
The MySQL image stores the data at the /var/lib/mysql path of the container which is mounted to a PVC.
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.