Install

Adeptia Connect as an application is decoupled into different independent services that can run independently and communicate with each other to perform a task. These independent services are called Microservices and are Cloud ready. 

It has a containerized architecture that provides flexible deployment options to ensure that it can be set up to meet the expected reliability, redundancy and performance requirements for the appropriate use cases. It is more granular in nature, highly scalable, and offers ease of maintenance, making your IT and business operations easier and smoother. 

This page guides you on the prerequisites, and the steps required to deploy Adeptia Connect. 

Prerequisites for deployment

Before you start deploying, you may want to see if you’re meeting all the prerequisites for deployment. Ensure that you have:

1. Created Kubernetes Cluster.
2. Downloaded the values.yaml file and set the required properties. To know more about the properties in values.yaml, click here.
3. Installed Helm CLI 3.1 or above.
4. Kubernetes Kubectl CLI.
5. PV provisioner support in the underlying infrastructure.
6. ReadWriteMany volumes for deployment scaling.
7. Configured Secrets. To know how to configure Secrets, click here.
8. Set up two databases to host Adeptia backend and log database.
9. The database must be accessible through TCP/IP. The port must be fixed and opened.

10. Ensure that you have below database permissions for Adeptia backend and log database.

    Database	Ensure that you have permission to
    MySQL	SELECT, CREATE, DROP, INDEX, ALTER, INSERT, UPDATE, DELETE, REFERENCES, CREATE ROUTINE, ALTER ROUTINE, and EXECUTE for MySQL database.
    Oracle	CREATE SESSION, CREATE TABLE or CREATE ANY TABLE, CREATE PROCEDURE or CREATE ANY PROCEDURE, and CREATE VIEW or CREATE ANY VIEW for Oracle database.
    MS SQL server	CREATE TABLE, ADD COLUMN, CREATE INDEX, DROP COLUMN, DROP INDEX, DROP TABLE, CREATE PROCEDURE, ALTER PROCEDURE, EXECUTE, and DROP PROCEDURE for SQL Server database.

11. Use SQL authentication mode in case you are using MS SQL server.
12. Administrator rights on the Kubernetes Cluster.
13. Setup and configure an internal and external load balancer as per the deployment diagram.
    • The security certificate to be installed on the internal and external load balancer can be either CA-signed or self-signed, however, we recommend a CA-signed certificate. 
    • Both load balancer should support SSL and SSL must be terminated at load balancer. 
14. These below points are applicable only for clustering environment:
    • Connect Server nodes must have read/write access to shared drive without login credentials. 
    • Port 1098 and 21000 to be opened in all Connect Server nodes for communication among them.
15. HTTP/HTTPS port (80/443) to be opened for an inbound request to the DMZ from the external environment.
    In case, you are using default application ports then open the ports for HTTP/HTTPS (8088/8843).
16. HTTP/HTTPS port (80/443) to be opened for the inbound request to the private network from the DMZ.
    In case, you are using default application ports then open the ports for HTTP/HTTPS (8080/8443).
17. Ensure that the port mentioned in the point 13 and 14 are whitelisted. If they are not whitelisted then Microsoft Windows firewall from all instances must be turned OFF. 
18. One email account with SMTP address details (for example, username, account name, password, SMTP address, SMTP port, and SSL information) used for sending notifications from the Adeptia application.
19. Whitelist https://connect.adeptia.com in the firewall for incoming and outgoing traffic for using business applications such as QuickBooks, Salesforce, or any other. 
20. Maintain a replica of the database and shared drives you are using. This is necessary if you are setting a disaster recovery environment.
21. Antivirus application should be configured to whitelist Adeptia Connect binaries.

Deployment steps

You can deploy 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.

When you deploy Adeptia Connect using the Helm Chart, the following Microservices are deployed in Kubernetes Cluster.

• Webrunner
• Portal
• Runtime
• Gateway
• RabbitMq
• DatabaseMigration
• Infra
• Autoscaler

You need to follow the steps below in the same order to deploy Adeptia Connect.

Adding Adeptia Connect Helm repository

On the Helm CLI run the following command to add the repository.

helm repo add adeptia https://charts.adeptia.com/adeptia

Where,

• adeptia is the name given to the Adeptia Connect Helm repository.
• https://charts.adeptia.com/adeptia is the repository.

Setting the values for the properties in values.yaml file

Before you run the command to deploy the Adeptia Connect Microservices, you need to set some properties as a part of application configuration. You can find and set these properties in values.yaml file that can be downloaded from this location. For more details on how to set the properties, refer to this page.

Running the command for deployment

Once you’ve finished setting up the properties and saved the values.yaml file, you need to run the following command on the Helm CLI to deploy the application.

helm upgrade -i adeptia-connect adeptia/ -f adeptia/values.yaml -n <NAMESPACE>

where,

• adeptia-connect is the name you want to give to your deployment.
• adeptia/ is path of the application within the adeptia repository.

• -f denotes file.
• adeptia/values.yaml is the location of your values.yaml file.
• -n denotes namespace.
• <NAMESPACE> is the namespace the application will belong to in the Kubernetes Cluster.

Verifying the deployment

When you deploy Adeptia Connect, a URL for Gateway service is automatically created.

You be able to get this URL by running the following command.

OR

This URL also gets printed along with the other details after the deployment completes. Refer to the screenshot below.

To verify the deployment, enter this URL in the browser. If you're able to see the Adeptia Connect login page, you've successfully deployed the application. 

Uninstalling Adeptia Connect

Run the below command to uninstall/delete the adeptia-connect deployment:

helm delete adeptia-connect