SAMi - Smart API Marketplace Documentation

Integration service Installation User Guide

Owned by Manikanta Swamy G
Last updated: Nov 23, 2023
13 min read

<< Prev

Next >>

 

Install Process

Gather the below-mentioned data before proceeding to the step 1:

Name

Description

Name

Description

DB_USERNAME

Specifies the username for accessing the integration services database.

DB_PASSWORD

Defines the password associated with the username for database access for integration services.

DB_HOST

Identifies the host address or server location of the integration services database.

DB_PORT

Designates the port number used for connecting to the integration services database.

DB_NAME

Specifies the name of the database within the integration services to which connections are made.

PORTAL-URL

URL used while using SAMi-portal in SAMi GA 3.0.0Portal Installation User GuideUNDEFINED

INTEGRATION_HOST_ALIAS

Host alias used for connecting to the Integration services.

ORG-NAME

Name of the Apigee org intended for connection.

Table 1.2 Configuration Property Reference

Step 1 - Create the Configuration file

  1. Make sure that you are in the installation home directory which is “sami-platform”. In case you are not in the base directory please proceed to next else to 2 else 3.

pwd

  1. Change to the directory using the following command:

cd sami-platform

  1. Create the Environment Configuration file using a fresh database for integration services

activemq : image: tag: 3.0.1 sky-data-services-api : image: tag: 3.0.1 env: # non sensitive variables normal: DB_HOST: <DB_HOST> # (refer to table 1.2) DB_PORT: 5432 DB_NAME: <DB-name> # (refer to table 1.2) DB_TYPE: postgresql SPRING_PROFILES_ACTIVE: rds AMQ_BROKER_URL: tcp://sky-amq:61616 SPRING_JPA_DATABASE-PLATFORM: org.hibernate.dialect.PostgreSQLDialect LIFERAY_URL: <PORTAL-URL> # (refer to table 1.2) MANAGEMENT_URL: https://<integration_url>/vsp/api/vds # (refer to table 1.2) # Load Secrets from 1 secret ref secret.name secret: DB_USERNAME: <DB_USERNAME> # (refer to table 1.2) DB_PASSWORD: <DB_PASSWORD> # (refer to table 1.2) # Secret to Create with sensitive data secret: name: sky-api-service-credential create: true # name of Apigee Org to Use apigee: org: <org-name> # (refer to table 1.2) image: tag: 3.0.1 global: gateway: istio: <ISTIO_INGRESS> # Please provide the istio ingress details. The default value is "ingressgateway" protocol: "HTTP" port: number: 80 SecurePort: number: 443 protocol: "HTTP" secure: enabled: false credentialName: <sam-portal-tls> # Refers to the Kubernetes secret name for holding the SAMi Alias/hostname full chain certificate & key domain: use: true name: <integration_url> # Enter the SAMi Alias/Hostname which is used for Integration services

Save the configuration in a file called sam-integration-values.yaml

Sample Reference

Please find a sample reference for the above configuration file:

Step 2 - Install the Integration Services

1. Download the HELM Chart. The below sets the creds to download helm charts.

upon successfully running the above command sky-gateway-api-chart.tgz should be downloaded.

The outlined process above represents the anticipated future methodology for downloading Helm charts. However, as of the present moment, acquiring Helm charts and establishing the secret for image retrieval necessitates the execution of steps 7, 8, and 9 detailed in the subsequent section.

  1. Validate the Download of Helm Chart

  1. Validate that Kubectl is installed on the local workstation with the supported version and is compatible with the k8s server

  1. Check the current context and ensure you are connected to the intended cluster

  1. Ensure the desired namespace for deployment is accessible. If opting for a different namespace, proceed to 6; otherwise, continue to 7."

Reference for step 5

A. Please refer to the below example for more details.

B. The output should look like below:

  1. If you intend to use a different namespace run the below commands to create the namespace

Reference for step 6

A. Please refer to the below example for more details.

B. The output should look like below:

  1. Configure AWS by running the below command and the details will be provided by the product team.

The below table provides all the required details for the above command.

Name

Value

Name

Value

AWS Access Key ID

Ref Provided Info

AWS Secret Access Key

Ref Provided Info

Default Region Name

us-east-1

Default Output format

json

  1. Please configure the secret using the below command if it is not present:

Verify the secret creation by running the below:

  1. Download the HELM Chart by running below to set the credentials and to download helm charts:

Install Chart

  1. Validate the sam-integration-values.yaml using the steps given below:

Note: The complete SAMi Integration services Kubernetes Manifest is printed upon successful interpretation.

  1. Install the Integration services by running step 1 without the dry-run flag

The output should look like below:

  1. Verify the pod status by listing all the pods in the current namespace using the command:

Helm install will fail if you are trying to rerun the setup due to any sort of wrong environment configuration being passed in the sam-integration-values.yaml Please run the below Helm upgrade command for upgrading the deployment.

Validate the helm upgrade by passing the dry-run flag.

The complete SAMi Integration Kubernetes Manifest is printed upon successful interpretation. Then run the above command without the dry-run flag for upgrading.

Step 3 - Deploy SAMi Integration Connector for Apigee Org

Gather the below-mentioned data before proceeding to the 1.

Note: SAMi Integration Connector must use the same Database schema from STEP 2.

Name

Description

Name

Description

DB_USERNAME

Specifies the username for accessing the integration services database.

DB_PASSWORD

Defines the password associated with the username for database access for integration services.

DB_HOST

Identifies the host address or server location of the integration services database.

DB_NAME

Specifies the name of the database within the integration services to which connections are made.

APIGEE_ORG_NAME

Name of the Apigee Org name used for connection.

Table 1.3:Connector Configuration Property Reference

Create the Configuration file

  1. Make sure that you are in the installation home directory which is “sami-platform”

  1. Change to the directory using the following command:

  1. Create the Environment Configuration file based on the template file shown below

Save the configuration in a file called sam-integration-connector-values.yaml

Sample Reference

Please find a sample reference for the above configuration file:

Install the SAMi Integration Connector

  1. Download the HELM Chart

This will result in creating the file sami-apigee-connector-3.0.0.tgz in the current working directory

  1. Validate the Download of Helm Chart

  1. Download the HELM Chart by running below to set the credentials and to download helm charts:

Install Chart

  1. Validate the sam-integration-values.yaml using the steps below

Note: The complete SAMi Integration connector Kubernetes Manifest is printed upon successful interpretation.

2. Now run step 1 without the dry-run flag

The output should look like the following:

Upon successful installation, you should be able to see below deployments

Validate the helm upgrade by passing the dry-run flag.

The complete SAMi Integration Kubernetes Manifest is printed upon successful interpretation. Then run the above command without the dry-run flag for upgrading.

 

© 2024 SID Global Solutions | https://www.mysami.io | https://www.sidgs.com | +1 484-218-0021