You can install Adeptia Connect microservices using Helm Charts. A Helm Chart is a collection of files and templates that describe Kubernetes resources governing the deployment of microservices.
...
Enabling OCI support in the Helm 3 client
Helm 3 supports Open Container Initiative (OCI) for package distribution. Set the HELM_EXPERIMENTAL_OCI in the environment to enable OCI support in the Helm 3 client by running the following command on the Helm CLI.
Code Block | ||||
---|---|---|---|---|
| ||||
export HELM_EXPERIMENTAL_OCI=1 |
...
- Go to https://artifacthub.io/packages/helm/adeptia-connect/adeptia-connect to view the details of Adeptia Connect helm package.
Add Adeptia Connect repo using following command:
Code Block language css theme Midnight helm repo add adeptia-connect https://adeptia.github.io/adeptia-connect-helm-package/charts/
- Click DEFAULT VALUES to download the values.yaml file.
- Update the values.yaml as per instruction given in this section.
Run the the following command to deploy the application.
Code Block language css theme Midnight helm install adeptia-connect adeptia-connect/adeptia-connect -f <PATH_OF_VALUES.YAML> --timeout 10m
This command deploys Adeptia Connect on the Kubernetes cluster.
Info Once you've completed the deployment, you need to configure your domain specific SSL certificate by using either of the two options:
- Use Ingress in front of the Gateway service and configure SSL on Ingress.
- Configure SSL directly on the Gateway service.
To know more about configuring SSL, click here.
...
Property | Value | Description |
---|---|---|
config.image.pullSecret.enabled | true (Default) | If set to false, external Secrets will be used. |
infra.secret.enabled | false (Default) | You'd need to set this value to true to work with external Secrets. |
infra.secret.vaultMountPoint | Authentication method that you have created in the external tool. | |
infra.secret.vaultRole | Role that you've created in the tool. | |
infra.secret.dbDataFrom | Path of the database Secret created in the tool. | |
infra.secret.imageDataFrom | Path of the image Secret created in the tool. | |
infra.secret.env.VAULT_ADDR | URL of the external tool such as Vault. |
Setting the property EXECUTE_STATIC_JOB
To ensure that the application starts running successfully after its deployment, you need to set the property EXECUTE_STATIC_JOB in the static section of the global values.yaml file.
Property | Description |
---|---|
EXECUTE_STATIC_JOB | Set the value for this property to true to ensure that the files required for running the application are copied in the PVC while deploying the application. |
Removing the resources if installation fails
...
Uninstalling Adeptia Connect
If you wish to uninstall the application, run the following command.
Code Block | ||||
---|---|---|---|---|
| ||||
helm uninstall <adeptia-connect> |
...
Info |
---|
If you've configured external Secrets, you need to manually delete the Secrets and its deployment after you uninstall the application. |