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 --version <Version number> -f <PATH_OF_VALUES.YAML> --timeout 10mWarning title Important 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.
...
Update the following properties in values.yaml before you run the helm install command to install the application.
| Table of Contents | ||||
|---|---|---|---|---|
|
Defining the required database properties
| Property | Value for Azure SQL Database | Value for Oracle Database | Value for Oracle Database | Description |
| BACKEND_DB_USERNAME | <User defined> | <User defined> | <User defined> | Username for your backend database. If you're using external Secrets, you need not provide a value for this property. |
| BACKEND_DB_PASSWORD | <User defined> | <User defined> | <User defined> | Password for your backend database. If you're using external Secrets, you need not provide a value for this property. |
| LOG_DB_USERNAME | <User defined> | <User defined> | <User defined> | Username for your log database. If you're using external Secrets, you need not provide a value for this property. |
| LOG_DB_PASSWORD | <User defined> | <User defined> | <User defined> | Password for your log database. If you're using external Secrets, you need not provide a value for this property. |
| LOG_ARCHIVE_DB_PASSWORD | <User defined> | <User defined> | <User defined> | Password for your log archive database. If you're using external Secrets, you need not provide a value for this property. |
| LOG_ARCHIVE_DB_USERNAME | <User defined> | <User defined> | <User defined> | Username for your log archive database. If you're using external Secrets, you need not provide a value for this property. |
| QUARTZ_DB_USERNAME | <User defined> | <User defined> | <User defined> | Username for your quartz database. This value will be the same as that for the backend database. If you're using external Secrets, you need not provide a value for this property. |
| QUARTZ_DB_PASSWORD | <User defined> | <User defined> | <User defined> | Password for your quartz database. This value will be the same as that for the backend database. If you're using external Secrets, you need not provide a value for this property. |
| BACKEND_DB_URL | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Backend Database Name> | jdbc:oracle:thin:@<hostName>:<portNumber>:<S ID/ServiceName> |
| jdbc:mysql://<hostName>:<portNumber>/<DBName>?useSSL=true | Backend database name and its URL. Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. | ||||
BACKEND_DB_DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | oracle.jdbc.OracleDriver | com.mysql.cj.jdbc.Driver | Driver class name based on the backend db. Do not change the value for this pre-defined property. |
| BACKEND_DB_TYPE | SQL-Server |
| Oracle | MySQL | Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. | ||||
| BACKEND_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | org.hibernate.dialect.Oracle12cDialect | org.hibernate.dialect.MySQLDialect | Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. |
| BACKEND_DB_ |
- com.microsoft.sqlserver.jdbc.SQLServerDriver
- oracle.jdbc.OracleDriver
| TRANSACTION_ISOLATION | 1 | 8 | 1 | Transaction isolation level in database. |
| BACKEND_DB_VALIDATION_QUERY | SELECT 1 | SELECT 1 from dual | SELECT 1 | Query that can be used by the pool to validate connections before they are returned to the application. |
| LOG_DB |
| _DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | oracle.jdbc.OracleDriver | com.mysql.cj.jdbc.Driver | Driver class name based on the log db. Do not change the value for this pre-defined property. |
| LOG_DB_URL | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Log Database Name> | jdbc:oracle:thin:@<hostName>:<portNumber>:<S ID/ServiceName> |
| jdbc:mysql://<hostName>:<portNumber>/<DBName>?useSSL=true | Log database name and its URL. Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. | |
| LOG_DB_TYPE | SQL-Server |
| Oracle | MySQL | Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. | ||||
| LOG_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | org.hibernate.dialect.Oracle12cDialect | org.hibernate.dialect.MySQLDialect | Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. |
| LOG_ |
| DB_ |
| TRANSACTION_ |
- jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Log Archive Database Name>
- jdbc:oracle:thin:@<hostName>:<portNumber>:<S ID/ServiceName>
| ISOLATION | 1 | 8 | 1 | Transaction isolation level in database. |
| LOG_DB_VALIDATION_QUERY | SELECT 1 | SELECT 1 from dual | SELECT 1 | Query that can be used by the pool to validate connections before they are returned to the application. |
| LOG_ARCHIVE_DB_ |
- com.microsoft.sqlserver.jdbc.SQLServerDriver
- oracle.jdbc.OracleDriver
| URL | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Log Archive Database Name> | jdbc:oracle:thin:@<hostName>:<portNumber>:<S ID/ServiceName> | jdbc:mysql://<hostName>:<portNumber>/<DBName>?useSSL=true | Log archive database name and its URL. Currently, the MS Azure SQL, Oracle, and Azure MySQL databases are certified. |
LOG_ARCHIVE_DB_DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | oracle.jdbc.OracleDriver | com.mysql.cj.jdbc.Driver | Driver class name based on the log archive db. Do not change the value for this pre-defined property. |
| LOG_ARCHIVE_DB_TYPE | SQL-Server |
| Oracle | MySQL | Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. | ||||
| LOG_ARCHIVE_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | org.hibernate.dialect.Oracle12cDialect | org.hibernate.dialect.MySQLDialect | Currently, |
| the MS Azure SQL |
| , Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. |
| LOG_ARCHIVE_DB_TRANSACTION_ |
- jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Backend Database Name>
- jdbc:oracle:thin:@<hostName>:<portNumber>:<S ID/ServiceName>
- com.microsoft.sqlserver.jdbc.SQLServerDriver
- oracle.jdbc.OracleDriver
| ISOLATION | 1 | 8 | 1 | Transaction isolation level in database. |
| LOG_ARCHIVE_DB_VALIDATION_QUERY | SELECT 1 | SELECT 1 from dual | SELECT 1 | Query that can be used by the pool to validate connections before they are returned to the application. |
QUARTZ_DB_ |
SQL-Server, Oracle
URL | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Backend Database Name> | jdbc:oracle:thin:@<hostName>:<portNumber>:<S ID/ServiceName> | jdbc:mysql://<hostName>:<portNumber>/<DBName>?useSSL=true | Quartz database name and its URL. Currently, the MS Azure SQL, Oracle, and Azure MySQL databases are certified. This value will be the same as that for the backend database. |
| QUARTZ_DB_ |
- org.hibernate.dialect.SQLServer2008Dialect
- org.hibernate.dialect.Oracle12cDialect
| DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | oracle.jdbc.OracleDriver | com.mysql.cj.jdbc.Driver | Driver class name based on the quartz db. This value will be the same as that for the backend database. |
| QUARTZ_DB_TYPE | SQL-Server | Oracle | MySQL | Currently, the MS Azure SQL, Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. |
| QUARTZ_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | org.hibernate.dialect.Oracle12cDialect | org.hibernate.dialect.MySQLDialect | Currently, the MS Azure SQL, Oracle, and Azure MySQL databases are certified. Do not change the value for this pre-defined property. This value will be the same as that for the backend database. |
Defining required Secrets properties
| Warning |
|---|
You need to set these properties only when you're using external Secrets. If you're not using external Secrets, skip to the next step. |
| QUARTZ_DB_TRANSACTION_ISOLATION | 1 | 8 | 1 | Transaction isolation level in database. |
| QUARTZ_DB_VALIDATION_QUERY | SELECT 1 | SELECT 1 from dual | SELECT 1 | Query that can be used by the pool to validate connections before they are returned to the application. |
Defining the required Secrets properties
The following table contains the properties to be set if you're using an external tool such as 'Vault' for managing Secrets. Refer to to this page to know more about configuring Secrets. to know more about configuring Secrets.
| Warning | ||
|---|---|---|
| ||
You need to set these properties only when you're using external Secrets. |
| 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. | 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. |