Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

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
languagecss
themeMidnight
export HELM_EXPERIMENTAL_OCI=1

...

  1. Go to https://artifacthub.io/packages/helm/adeptia-connect/adeptia-connect to view the details of Adeptia Connect helm package.
  2. Add Adeptia Connect repo using following command:

    Code Block
    languagecss
    themeMidnight
    helm repo add adeptia-connect https://adeptia.github.io/adeptia-connect-helm-package/charts/


  3. Click DEFAULT VALUES to download the values.yaml file.
  4. Update the values.yaml as per instruction given in this section.

  5. Run the the following command to deploy the application.

    Code Block
    languagecss
    themeMidnight
    helm install adeptia-connect adeptia-connect/adeptia-connect -f <PATH_-version <Version number> -f <PATH_OF_VALUES.YAML> --timeout 10m


    Warning
    titleImportant
    Use a specific version number in the version argument, else the latest version of Adeptia Connect will be installed.

    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.


...

PropertyValueDescription
config.image.pullSecret.enabledtrue (Default)

If set to false, external Secrets will be used.

infra.secret.enabledfalse (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
languagecss
themeMidnight
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.