Installing Marketing Catalog Microservices in AWS

This section helps you to install the Marketing Catalog Microservice in AWS cloud.

Procedure:

1. Download the zip file.
2. Extract the zip file.
3. Perform the JWT authentication in the installation scripts to enable the in-house authentication in addition to API key.
4. Verify the below properties related to ingestion in the install script.

   Environment Variable	Description	Example
   temn_msf_schema_registry_url	URL of the schema registry	http://localhost:8081
   HTTP_BASE_PATH	Base path of the IRF provider container	http://<IP>:<PORT>/irf-provider-container/api/v1.0.0/
   HTTP_RESOURCE_PATH	Resource path of IRIS API used by marketing catalog microservice - "product/{productId}/productConditions"	product/{productId}/productConditions

5. In AWS command line, navigate to the installation directory.
6. Modify the region information in the install-aws.sh script specific to your installation
   EXAMPLE:

   --region us-west-2
   --event-source-arn arn:aws:kinesis:us-west-2
   --uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2

7. To deploy the microservice, execute the following shell scripts to create the resources.

   Script	Description
   install-aws.sh	To deploy all the necessary components for a microservice including streaming services, in order to run the microservice independently.
   install-aws-ms.sh	To deploy only the components necessary for microservice. Data Event Streaming (DES) is presumed to be deployed and running already. The streaming services are not deployed.

8. Log in to AWS portal and verify the following if they have been created properly.
   • Lambda functions

     

   • API Gateways

     

9. To obtain the API key for all the endpoints in AWS, navigate to API Key section under the Amazon API gateway and select the corresponding API key. Click show. The API key should be a part of header (x-api-key) in all the requests.

   

   After the successful deployment, database, collections and the reference data (master data) are loaded into the dynamo database for the Marketing Catalog microservice.

   The Base path of the API gateway URL follows the structure below.

   Base URI

   https://<REST-API-ID>.execute-api.<LOCATION>.amazonaws.com/<DEPLOYMENT_ID>

   For example,

   https://7061g8fb9d.execute-api.eu-west-2.amazonaws.com/ms-marketingcatalog-api

   For information on the resource path of the endpoint, see the APIs section.

   Below is a sample endpoint of Marketing Catalog.

   https://7061g8fb9d.execute-api.eu-west-2.amazonaws.com/ms-marketingcatalog-api/v1.0.0/product/products/marketingCatalogue

   You can retrieve the Rest API Id from Amazon API Gateway as shown below.

   

   NOTE: Ensure that you replace the location and deployment Id with the appropriate values provided in the script during deployment.