Helm Chart
Introduction
The following document outlines how to deploy and update the service application onto an existing Kubernetes deployment using the Helm package manager.
Prerequisites
The below software must be installed before continuing:
Additionally, an OSDU on AWS environment must be deployed.
Installation/Updating
To install or update the service application by executing the following command in the CHART folder:
helm upgrade [RELEASE_NAME] . -i -n [NAMESPACE]To observe the Kubernetes resources before deploying them using the command:
helm upgrade [RELEASE_NAME] . -i -n [NAMESPACE] --dry-run --debugTo observe the history of the current release, use the following command:
helm history [RELEASE_NAME] -n [NAMESPACE]To revert to a previous release, use the following command:
helm rollback [RELEASE] [REVISION] -n [NAMESPACE]Customizing the Deployment
It is possible to modify the default values specified in the values.yaml file using the --set option. The below parameters can be modified by advanced users to customize the deployment configuration:
| Name | Example Value | Description | Type | Required |
|---|---|---|---|---|
global.accountID |
000123456789 |
The AWS account ID. | int | yes |
global.region |
us-east-1 |
The AWS region containing the OSDU deployment. | str | yes |
global.resourcePrefix |
osdu |
The resource prefix of the OSDU deployment. | str | yes |
global.allowOrigins |
{http://localhost,https://www.osdu.aws} |
A list of domains that are permitted by CORS policy. An empty list permits all origins. | array[str] | no |
podAnnotations |
podAnnotations.version=v1.0.0 |
Additional annotations on the service pod | dict | no |
imagePullPolicy |
IfNotPresent |
The service image pull policy | str | no |
replicaCount |
1 |
The number of pod replicas to be deployed | int | no |
autoscaling.minReplicas |
1 |
Minimum number of pod replicas | int | no |
autoscaling.maxReplicas |
100 |
Maximum number of pod replicas | int | no |
autoscaling.targetCPUUtilizationPercentage |
80 |
CPU utilization target | int | no |
Uninstalling the Chart
To uninstall the helm release:
helm uninstall [RELEASE] -n [NAMESPACE] --keep-history