1 Install Process
- 1.1 Step 1 - Create the Configuration file
  - 1.1.1 Sample Reference
- 1.2 Step 2 - Install the Integration Services
  - 1.2.1 Reference for step 5
  - 1.2.2 Reference for step 6
  - 1.2.3 Install Chart
- 1.3 Step 3 - Deploy SAMi Integration Connector for Apigee Org
- 1.4 Create the Configuration file
  - 1.4.1 Sample Reference
- 1.5 Install the SAMi Integration Connector
  - 1.5.1 Install Chart

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

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

Change to the directory using the following command:

cd sami-platform

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:

activemq :
  image:
    tag: "3.0.1"

sky-data-services-api :
  image:
    tag: 3.0.1
  env:
    # non sensitive variables
    normal:
      DB_HOST: xxxx-dev.cjip1jjvpzht.us-east-1.rds.amazonaws.com
      DB_PORT: 5432
      DB_NAME: db-integration
      DB_TYPE: postgresql
      SPRING_PROFILES_ACTIVE: rds
      AMQ_BROKER_URL: tcp://sky-amq:61616
      SPRING_JPA_DATABASE-PLATFORM: org.hibernate.dialect.PostgreSQLDialect
      LIFERAY_URL: https://liferay.demo.global.cloud
      MANAGEMENT_URL: https://integration.demo.global.cloud/vsp/api/vds

    # Load Secrets from 1 secret ref secret.name
    secret:
      DB_USERNAME: xxxxxxx
      DB_PASSWORD: xxxxxxx
  # Secret to Create with sensitive data
  secret:
    name: sky-api-service-credential
    create: true
  # name of Apigee Org to Use
  apigee:
    org: vspa
image:
  tag: 3.0.1

global:
  istio: ingress
  gateway:
    protocol: "HTTP"
    port:
      number: 80
    secure:
      enabled: false
      credentialName: sam-portal-tls
    domain:
      use: true
      name: integration.demo.global.cloud

Step 2 - Install the Integration Services

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

helm pull oci://registry-1.docker.io/mysami/sky-gateway-api-chart --version 3.0.0

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.

Validate the Download of Helm Chart

ls -ltr
-rw-r--r--  1 staff  staff  42188 Sep 29 18:10 sky-gateway-api-chart-3.0.0.tgz

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

kubectl version

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

kubectl config current-context

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

kubectl get ns| grep "sami-platform"
kubectl get pods -n sami-platform

Reference for step 5

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

kubectl get ns | grep "sami-platform"
kubectl get pods -n sami-platform

B. The output should look like below:

kubectl get ns | grep "sami-platfrom"
sam-portal-system

kubectl get pods -n sami-platform
NAME                              READY   STATUS    RESTARTS   AGE
sam-app-server-547987c7b-d47kt    1/1     Running   0          6d
sam-web-server-7bf994d976-p5bmk   1/1     Running   0          6d
sami-master-0                     1/1     Running   0          6d

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

namespace=${K8_NAMESPACE:-sami-platform-integration}
kubectl create ns $namespace

Reference for step 6

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

kubectl get ns | grep "sami-platform-integration"
kubectl get pods -n sami-platform

B. The output should look like below:

kubectl get ns | grep "sami-platform-integration"
sami-platform-integration Active 26s

kubectl get pods -n sami-platform-integration
No resources found in sami-platform-integration

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

aws configure --region us-east-1

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

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

kubectl delete secret sam-regcred -n $namespace
kubectl create secret docker-registry sam-regcred \
        --docker-server=865615422972.dkr.ecr.us-east-1.amazonaws.com \
        --docker-username=AWS \
        --docker-password=`aws ecr get-login-password` \
        -n $namespace

Verify the secret creation by running the below:

kubectl get secret -n $namespace | grep "sam-regcred"

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

aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/sidgs
export HELM_EXPERIMENTAL_OCI=1
helm pull oci://public.ecr.aws/sidgs/sky-gateway-api-chart --version 3.0.0

Install Chart

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

helm install sky-gateway ./sky-gateway-api-chart-3.0.0.tgz \
  -f sam-integration-values.yaml \
  -n $namespace\
  --dry-run

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

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

helm install sky-gateway ./sky-gateway-api-chart-3.0.0.tgz \
  -f sam-integration-values.yaml \
  -n $namespace

The output should look like below:

Name: sky-gateway
NAMESPACE: sami-platform
STATUS: deployed
REVISION: 1
TEST SUITE: None

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

kubectl get pods -n sami-platform       
NAME                                                        READY   STATUS    RESTARTS   AGE
sam-app-server-7bb4c5dcf6-bv22h                             1/1     Running   0          21h
sam-web-server-6964698877-svbtp                             1/1     Running   0          22h
sami-master-0                                               1/1     Running   0          20h
sami-platform-sky-analytics-services-api-5f7685cd67-b9s4n   1/1     Running   0          22h
sami-platform-sky-data-services-api-774dd589fd-mlv65        1/1     Running   0          22h
sky-amq-7896dc5c9b-znsv5                                    1/1     Running   0          22h
sky-gateway-784b6998fb-mv5cg                                1/1     Running   0          22h
sky-proxy-gen-789d8dbfd8-bn6bd                              1/1     Running   0          22h
skyline-pubhub-api-c769fbb65-p4pjn                          1/1     Running   0          22h
skyline-pubhub-api-ep-7c95bb44f6-qqj22                      1/1     Running   0          22h

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.

helm upgrade sky-gateway ./sky-gateway-api-chart-3.0.0.tgz \
  -f sam-integration-values.yaml \
  -n $namespace \
  --dry-run

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

helm upgrade sky-gateway ./sky-gateway-api-chart-3.0.0.tgz \
  -f sam-integration-values.yaml \
  -n $namespace

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

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

pwd

Change to the directory using the following command:

cd sami-platform

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

global:
  env:
    normal:
      DB_HOST: <DB_HOST>
      DB_PORT: 5432
      DB_NAME: <DB_NAME>
      DB_TYPE: postgresql
      ORG_TYPE: X # use "x" for Apigee X, "Hybrid" for Apigee hybrid and "edge" for Apigee Edge
      LIFERAY_URL: https://<PORTAL-URL>
    # sensitive variables
    # Load Secrets from 1 secret ref secret.name
    secret:
      DB_USERNAME: <DB_USERNAME>
      DB_PASSWORD: <DB_PASSWORD>
  # Secret to Create with sensitive data
  secret:
    name: combined-sync-job-<ORG_TYPE>
    create: true

sky-opdk-sync-job :
  nameOverride: sync-job-<ORG_TYPE>
  image:
    repository: <repo-name>
    pullPolicy: Always
    tag: 3.0.1

opdk-event-processor :
  nameOverride: event-processor-<ORG_TYPE>
  image:
    pullPolicy: Always
    tag: 3.0.1

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

Sample Reference

Please find a sample reference for the above configuration file:

global:
  env:
    normal:
      DB_HOST: xxxxxxxxx.us-east-1.rds.amazonaws.com
      DB_PORT: 5432
      DB_NAME: db-integration
      DB_TYPE: postgresql
      ORG_TYPE: X
      LIFERAY_URL: https://liferay.demo.global.cloud
    # sensitive variables
    # Load Secrets from 1 secret ref secret.name
    secret:
      DB_USERNAME: xxxxxxxx
      DB_PASSWORD: xxxxxxxx
  # Secret to Create with sensitive data
  secret:
    name: combined-sync-job-x
    create: true

sky-opdk-sync-job :
  nameOverride: sync-job-x
  image:
    repository: xxxxxxxxx.dkr.ecr.us-east-1.amazonaws.com/sky-opdk-sync-job-x
    pullPolicy: Always
    tag: 3.0.1

opdk-event-processor :
  nameOverride: event-processor-x
  image:
    pullPolicy: Always
    tag: 3.0.1

Install the SAMi Integration Connector

Download the HELM Chart

helm pull oci://registry-1.docker.io/mysami/sami-apigee-connector --version 3.0.0

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

Validate the Download of Helm Chart

ls -ltr
-rw-r--r--  1 staff  staff  42188 Sep 29 18:10 sami-apigee-connector-3.0.0.tgz

The outlined process above represents the anticipated future methodology for downloading Helm charts. However, as of the present moment, acquiring Helm charts and run the below commands.

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

aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/sidgs
export HELM_EXPERIMENTAL_OCI=1
helm pull oci://public.ecr.aws/sidgs/skyline-opdk-connector-chart --version 2.3.1

Install Chart

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

helm install sky-connector-$APIGEE_ORG ./skyline-opdk-connector-chart-2.3.1.tgz \
  -f sam-integration-connector-values.yaml \
  -n  $namespace\
  --dry-run

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

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

helm install sky-connector-$APIGEE_ORG ./skyline-opdk-connector-chart-2.3.1.tgz \
  -f sam-integration-connector-values.yaml \
  -n  $namespace

The output should look like the following:

Name: sky-connector-edge
NAMESPACE: sami-platform
STATUS: deployed
REVISION: 1
TEST SUITE: None

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

kubectl get pods -n sami-platform     
NAME                                                        READY   STATUS    RESTARTS   AGE
sam-app-server-7bb4c5dcf6-bv22h                             1/1     Running   0          21h
sam-web-server-6964698877-svbtp                             1/1     Running   0          22h
sami-master-0                                               1/1     Running   0          20h
sami-platform-event-processor-x-c646cc479-qp4lk             1/1     Running   0          22h
sami-platform-sky-analytics-services-api-5f7685cd67-b9s4n   1/1     Running   0          22h
sami-platform-sky-data-services-api-774dd589fd-mlv65        1/1     Running   0          22h
sami-platform-sync-job-x-7f89b7c8c4-25tgd                   1/1     Running   0          22h
sky-amq-7896dc5c9b-znsv5                                    1/1     Running   0          22h
sky-gateway-784b6998fb-mv5cg                                1/1     Running   0          22h
sky-proxy-gen-789d8dbfd8-bn6bd                              1/1     Running   0          22h
skyline-pubhub-api-c769fbb65-p4pjn                          1/1     Running   0          22h
skyline-pubhub-api-ep-7c95bb44f6-qqj22                      1/1     Running   0          22h

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.

helm upgrade sky-connector-$APIGEE_ORG ./skyline-opdk-connector-chart-2.3.1.tgz \
  -f sam-integration-connector-values.yaml \
  -n  $namespace \
  --dry-run

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

helm upgrade sky-connector-$APIGEE_ORG ./skyline-opdk-connector-chart-2.3.1.tgz\
  -f sam-integration-connector-values.yaml \
  -n  $namespace

SAMi - Smart API Marketplace Documentation

Integration service Installation User Guide

Install Process

Step 1 - Create the Configuration file

Sample Reference

Step 2 - Install the Integration Services

Reference for step 5

Reference for step 6

Install Chart

Step 3 - Deploy SAMi Integration Connector for Apigee Org

Create the Configuration file

Sample Reference

Install the SAMi Integration Connector

Install Chart

Related content