SAMi - Smart API Marketplace Documentation

SAMi Portal Upgradation

 

SAMi Portal Upgradation

Step 1 - Update the Environment Configuration file

Update the Environment configuration file in case there has been any change from the previous configuration file

This is an optional Step and only needs to be performed in case of any changes from previous installation.

Step 2 - Create a K8 Secret for the Cluster to Connect to the SIDGS Docker Registry

The SAMi Product team will provision and provide an AWS Client ID and Secret that need to be used for the below and replace the region name

with the appropriate

aws configure --region <region-name>

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

Configure Secret

setting the secrets with ECR creds to pull the images.

  1. The below step will set the namespace environment variable followed by creating the namespace

namespace=${K8_NAMESPACE:-ns_name} kubectl create ns $namespace

Modify the ns_name with the namespace name used while setting up SAMi portal.

For instance, please find the example below

namespace=${K8_NAMESPACE:-sam-portal-system} kubectl create ns $namespace

The output should look like the following:

  1. Create secrets with ECR creds to pull the images.

Please find the example below.

The output should look like the following:

Step 3 - Download the Latest HELM chart

  1. Download the HELM Chart, which is used for the upgrade. The below sets the creds to download helm charts.

Change the CHART_VERSION to the desired version, and upon successfully running the above command, sam-portal-chart-3.0.1.tgz should be downloaded.

Step 4 - Upgrade the portal

  1. Validate that Kubectl is available and connected to the Kubernetes cluster

  2. Validate that the namespace ‘sam-portal-system’ is available and reachable by running the below command

Please refer to the example below for more details.

The output should look like the following:

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

    Update the path-to-chart file to the latest chart, and the complete Manifest is printed upon successful interpretation. Please refer to the example below for more details

  1. Install the sam-portal by running step 4 without the dry-run flag

Please refer to the example below for more details

The output should look like the following:

SAMi Integration Services Upgradation

Step 1 - Update the Configuration file

Create the Environment Configuration file

The sample file is shown below:

The table below provides the details regarding the fields

Name

Description

Name

Description

DB_USERNAME

database username for jdbc connection

DB_PASSWORD

database user password for jdbc connection

DB_HOST

database hostname for postgres connection

DB_PORT

database port for jdbc connection

DB_NAME

database named for jdbc connection

liferay-url

liferay Portal url not including http:// or https:// for example: sam-portal-dev.demo.global.cloud

INTEGRATION_URL

URL used for integration services

Image-tag

docker image tag used for deploying the services

activemq-image-tag

docker image tag used for deploying activemq

Latest-Image-TAG

The Image version to which the upgrade will be done.

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

Change the “Latest-chart-version” to desired chart version

  1. Validate that Kubectl is available and connected to the SAM K8s Cluster

  2. Validate that the namespace ‘sam-int-system’ is available and reachable by running the below command

Please refer to the example below for more details.

The output should look like below.

Step 2 - Create a K8 Secret for the K8 Cluster to Connect to the SIDGS Docker Registry

Create a K8 Secret for the K8 Cluster to Connect to the SIDGS Docker Registry

Configure AWS

The SAMi Product team will provision and provide an AWS Client ID and Secret that need to be used for the below

Please update the region-name accordingly in 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

Configure Secret

  1. Create secrets with ECR creds to pull the images.

Change the “namespace” to the namespace used while setting up SAMi Integration Services

Please find the example below

The output should look like the following:

Step 3 - Download the HELM charts and Install Integration system

  1. Download the HELM Chart

    Update the “Latest-chart-version” to the desired chart version. This will result in creating the file sky-gateway-api-chart-3.0.1.tgz in the current working directory.

  2. Validate that Kubectl is available and connected to the K8 Cluster

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

    Please refer to the sample below

Upon successful interpretation, the complete Manifest is printed

  1. Upgrade sam-integration as shown below

The sample is mentioned below:

The output should look like the following:

 

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