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.
Follow the steps below in the same order to install Adeptia Connect.
| Table of Contents | ||||
|---|---|---|---|---|
|
| Note |
|---|
| Before you begin to install the application, ensure that you're meeting all the prerequisites and system requirements. |
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 |
...
| Tip | ||
|---|---|---|
| ||
| You can refer to this page for the links to Adeptia Connect docker images. |
...
| Property | Value | Description |
| BACKEND_DB_USERNAME | <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> | 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> | 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> | 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> | 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> | 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> | 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> | 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<User defined> | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Backend Database Name> | Backend database name and its URL. Currently, only the MS Azure SQL database is certified. |
BACKEND_DB_DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | Driver class name based on the backend db. Do not change the value for this pre-defined property. |
| BACKEND_DB_TYPE | SQL-Server | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. |
| BACKEND_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. |
| LOG_DB_DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | Driver class name based on the log db. Do not change the value for this pre-defined property. |
| LOG_DB_URL<User defined> | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Log Database Name> | Log database name and its URL. Currently, only the MS Azure SQL database is certified. |
| LOG_DB_TYPE | SQL-Server | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. |
| LOG_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. |
| LOG_ARCHIVE_DB_URL<User defined> | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Log Archive Database Name> | Log archive database name and its URL. Currently, only the MS Azure SQL database is certified. |
LOG_ARCHIVE_DB_DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | 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 | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. |
| LOG_ARCHIVE_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. |
QUARTZ_DB_URL <User defined> | jdbc:sqlserver://<DB Hostname>:<Port Number>;database=<Backend Database Name> | Quartz database name and its URL. Currently, only the MS Azure SQL database is certified. This value will be the same as that for the backend database. |
| QUARTZ_DB_DRIVER_CLASS | com.microsoft.sqlserver.jdbc.SQLServerDriver | 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 | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. |
| QUARTZ_DB_DIALECT | org.hibernate.dialect.SQLServer2008Dialect | Currently, only the MS Azure SQL database is certified. Do not change the value for this pre-defined property. This value will be the same as that for the backend database. |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
helm install <Name of the release> <Name of the repository> -f <Path of the values.yaml file> -n <Namespace> |
For example,
helm install adeptia adeptia-connect adeptia -f /home/ec2-user/values.yaml -n devspace
Where,
- adeptia-connect is the name you want to give to your release.
- adeptia is path of the application within the adeptia repository.
- -f denotes file.
- /home/ec2-user/values.yaml is the path of the values.yaml file.
- -n denotes Kubernetes namespace.
- devspace is the Kubernetes Namespace.
This command deploys Adeptia Connect on the Kubernetes cluster in with the default configuration.
| Info |
|---|
Once you've completed the deployment, you need to configure your domain specific SSL certificate by using either of the two options:
To know more about configuring SSL, click here. |
Removing the resources if installation fails
If the installation fails for any reason, you need to take the following steps before you reinstall the application.
Check if there is an entry of the release (Name given to the release while installing) in the namespace. Use the following command to check the entry:
Code Block language css theme Midnight helm list -n <Namespace>Remove the entry of the release. Use the following command to remove the release.
Code Block language css theme Midnight helm delete <Name of the release> -n <Namespace>- Remove the resources that were deployed during the failed installation.
Ensure that you have removed the following resources before you begin to install the application once again.- Jobs (For example, Migration)
- Deployment of the microservices
- Secrets
- PVC
Uninstalling Adeptia Connect
If you wish to uninstall the application, run the below following command.
| Code Block | ||||
|---|---|---|---|---|
| ||||
helm uninstall <adeptia-connect> |
Where,
adeptia-connect is is name of the deployment.
After the uninstalling is complete, there are some resources that you need to remove from the system manually. The resources on the following list are subject to be deleted manually, and their removal ensures a successful installation of the application in the future.
- Service Account
- Secrets
- PVC
| Info |
|---|
| If you've configured external Secrets, you need to manually delete the Secrets and its pod deployment after you uninstall the application. |