/
Example—Migrating REST Pipeline and Account to HTTP Client

Example—Migrating REST Pipeline and Account to HTTP Client

 

Overview

This example outlines how to migrate a REST pipeline to an HTTP client Snap and the associated REST AWS SigV4 Account to an AWS Signature V4 Account. In this migration process, we use three pipelines:

  1. Source pipeline: The REST pipeline that is to be migrated to the HTTP Client.

  2. Account Migration pipeline: The pipeline that migrates the REST AWS SigV4 Account to an AWS Signature V4 Account.

  3. REST Migration pipeline: The pipeline that migrates the source REST pipeline to the HTTP Client.

Understanding the migration process

The migration process involves converting existing REST-based Snaps to HTTP Client Snap using a script. The Source pipeline (REST pipeline) undergoes transformation through two migration pipelines:

  1. Account Migration Pipeline: Converts the existing REST AWS SigV4 Account to an AWS Signature V4 Account to ensure compatibility with the HTTP Client.

  2. REST Migration Pipeline: Replaces REST Snaps with equivalent HTTP Client methods and updates authentication by migrating the account.

After the migration is complete, the pipeline systematically replaces REST Snaps with HTTP Client Snap as outlined below:

REST Snaps

Migrates to

REST Snaps

Migrates to

Create Multipart: REST Post

HTTP Client > Request method: POST

Upload Multipart: REST Put

HTTP Client > Request method: PUT

Complete Multipart: REST Post

HTTP Client > Request method: POST

Read the File: REST Get

HTTP Client > Request method: GET

REST AWS SigV4 Account

AWS Signature V4 Account

Source pipeline

This REST pipeline uses all the REST (GET, PUT, POST, PATCH) Snaps to create a new file in the AWS S3 bucket, initiate the multipart upload, upload the file parts, complete the upload, and finally read the uploaded file.

Step 1: Copy the REST pipeline and Account (to be migrated to HTTP Client) to a specific project folder.

rest-pipeline-overview.png

Account Migration pipeline

Step 2: Open the Account migration pipeline.

account-migration-pipeline.jpg

Step 3: Configure the pipeline parameters as shown below:

Key

Value

Description

Key

Value

Description

path

/<Org>/<Project>/<Folder>/<RESTAccountName>

For example,

/QA/qa_diagnostic_space/Docs-Migrating-REST-pipelines-to-http-client/Docs-REST AWS Sig v4 Account

 

The source path where your REST account that is to be migrated is located.

destinationFolder

/<Org>/<Project>/<Folder>

For example,

/QA/qa_diagnostic_space/Migrated-from-rest-to-http-client

The destination path where you want to create and save the migrated account.

buildTag

440patches30202

The Snap Pack version.

action

create

Creates the AWS Signature V4 Account.

Step 4: Validate the pipeline.

account-rest-to-http-client.png

The REST AWS SigV4 Account has been migrated to the AWS Signature V4 Account. You can navigate to Manager and view the created account in the destination folder.

 

REST Migration pipeline

Step 5: Open the REST migration pipeline that is designed to migrate the REST pipeline.

pipeline-rest-to-http-client.png

Step 6: Configure the pipeline parameters as shown below:

Key

Value

Description

Key

Value

Description

buildTag

440patches30202

The Snap Pack version.

destinationFolder

/<Org>/<Project>/<Folder>

For example,

/QA/qa_diagnostic_space/Migrated-from-rest-to-http-client

 

Provide the path of the destination where you want to create and save the migrated pipeline.

action

create

Creates the HTTP Client pipeline with AWS Signature V4 Account.

path

/<Org>/<Project>/<Folder>/<RESTAccountName>

For example,

/QA/qa_diagnostic_space/Docs-Migrating-REST-pipelines-to-http-client/REST Pipeline with AWS V4 Sig Account

Provide the path where your REST pipeline that is to be migrated is located.

Step 7: Validate the pipeline. All the REST Snaps will be migrated to the respective method of the HTTP Client method Snap. You can navigate to Manager to view the HTTP Client pipeline that is migrated from REST.

 

 

  File Modified

File Example_Create_New_File_with_AWSV4Sig .slp

Mar 20, 2025 by Kalpana Malladi