Dev Environment Setup for working with the Connect SDK

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Author:

Fluent Commerce

Changed on:

28 Nov 2023

Key Points

This article providfes you with templates to setup your local environment for developing with the Connect SDK
Local development uses a Docker localstack to emulate AWS services.

Steps

Localstack

Local development uses a Docker localstack to emulate AWS services. Run the command below to download the Docker image and to run the container. Change the `yml` file according to your needs. The default configuration is always set to run unless stopped. Please note that secrets and messages do not persist between server restarts.`docker-compose -f docker-compose-localstack.yml up -d`

Configuring secrets in your localstack

Use the template below to create secrets in localstack before starting the application. The SDK expects ALL secrets to be prefixed with "fc/connect/\/". See Fluent Connector Configuration | Credential / Secrets Configuration for details on required secrets.

1docker exec -d localstack awslocal secretsmanager create-secret --name fc/connect/<FC-CONNECTOR>/api/fluent/activeAccounts --secret-string "{\"accounts\":[{\"name\":\"<FLUENT-ACCOUNT>\", \"region\":\"<FC-ACCOUNT-REGION>\" , \"retailers\":[<FLUENT-RETAILER1>,<FLUENT-RETAILER2>]}]}" ;
2docker exec -d localstack awslocal secretsmanager create-secret --name fc/connect/<FC-CONNECTOR>/<FLUENT-ACCOUNT>/api/fluent-account/<FLUENT-RETAILER> --secret-string "{\"retailer\":\"<FLUENT-RETAILER>\", \"userName\":\"<FC-USERNAME>\", \"password\":\"<FC-PASSWORD>\"}";

The property FC-CONNECTOR value must match the connector configuration name found at `application-connector.yml` (example below).`connector-name: <FC-CONNECTOR>`

Note

If the command above doesn’t work for Windows machines, then try the following.First run this command to open a session with the localstack container`docker exec -it localstack /bin/bash`Then use an alternative template:

`awslocal secretsmanager create-secret --name fc/connect/<FC-CONNECTOR>/api/fluent/activeAccounts --secret-string "{\"accounts\":[{\"name\":\"<FLUENT-ACCOUNT>\", \"region\":\"<FC-ACCOUNT-REGION>\" , \"retailers\":[<FLUENT-RETAILER1>,<FLUENT-RETAILER2>]}]}" ;`

Use ctrl + d to exit the localstack session.

AWS CLI Configuration (Optional)

This is required when sending events to the queues or managing secrets in localstack directly from your terminal window.

Run the AWS configuration and set your localstack profile.
The access key values can be anything but empty
The region has to be us-east-1

`aws configure --profile localstack`
`export AWS_PROFILE=localstack`Please note that localstack region is defaulted to "us-east-1".

IDE Setup

IntelliJ Setup

Create a run configuration setting the spring profiles and environment variables and selecting the correct pre-configured localstack AWS profile. The application runs precisely the same way as it would in production, which is achieved by the properties below.

Active Profiles: connector,dev-aws
- `connector` profile is always required, and it can be followed by the environment the application runs on (dev, test, QA, or production).
- `dev-aws` is a handy profile for local development with AWS. It enables the SDK to auto-start the queue and use some pre-configured values for development.
Environment Variables: SQS_BATCH=batch; SQS_EVENTS=events; SQS_NOTIFICATION=notification
- These variables give actual names to the queues, as these may vary per environment.
AWS credential profile/region: Select the localstack profile and set the region to US-EAST-1.
- Ensures the region matches with localstack and allows Spring to do the correct wiring of the AWS libraries.

For the IntelliJ community version, pass the spring profile configuration as JVM parameters:`-Dspring.profiles.active=connector,dev-aws`

Eclipse / STS Setup

Create a run configuration and set the spring profiles and the environment variables. No alt provided

Related content

Creating a new connector with the Connector SDK

Edited 588 days ago

Fluent Commerce

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Configuring secrets in your localstack

1docker exec -d localstack awslocal secretsmanager create-secret --name fc/connect/<FC-CONNECTOR>/api/fluent/activeAccounts --secret-string "{\"accounts\":[{\"name\":\"<FLUENT-ACCOUNT>\", \"region\":\"<FC-ACCOUNT-REGION>\" , \"retailers\":[<FLUENT-RETAILER1>,<FLUENT-RETAILER2>]}]}" ;
2docker exec -d localstack awslocal secretsmanager create-secret --name fc/connect/<FC-CONNECTOR>/<FLUENT-ACCOUNT>/api/fluent-account/<FLUENT-RETAILER> --secret-string "{\"retailer\":\"<FLUENT-RETAILER>\", \"userName\":\"<FC-USERNAME>\", \"password\":\"<FC-PASSWORD>\"}";

The property FC-CONNECTOR value must match the connector configuration name found at `application-connector.yml` (example below).`connector-name: <FC-CONNECTOR>`

Note

`awslocal secretsmanager create-secret --name fc/connect/<FC-CONNECTOR>/api/fluent/activeAccounts --secret-string "{\"accounts\":[{\"name\":\"<FLUENT-ACCOUNT>\", \"region\":\"<FC-ACCOUNT-REGION>\" , \"retailers\":[<FLUENT-RETAILER1>,<FLUENT-RETAILER2>]}]}" ;`

Use ctrl + d to exit the localstack session.

IntelliJ Setup

Active Profiles: connector,dev-aws
- `connector` profile is always required, and it can be followed by the environment the application runs on (dev, test, QA, or production).
- `dev-aws` is a handy profile for local development with AWS. It enables the SDK to auto-start the queue and use some pre-configured values for development.
Environment Variables: SQS_BATCH=batch; SQS_EVENTS=events; SQS_NOTIFICATION=notification
- These variables give actual names to the queues, as these may vary per environment.
AWS credential profile/region: Select the localstack profile and set the region to US-EAST-1.
- Ensures the region matches with localstack and allows Spring to do the correct wiring of the AWS libraries.

For the IntelliJ community version, pass the spring profile configuration as JVM parameters:`-Dspring.profiles.active=connector,dev-aws`

Dev Environment Setup for working with the Connect SDK

Key Points

Steps

Configuring secrets in your localstack

AWS CLI Configuration (Optional)

IDE Setup

IntelliJ Setup

Eclipse / STS Setup

Related content

Creating a new connector with the Connector SDK

Fluent Commerce

Building Blocks

By Type

Helpful Resources

Quick Links

Configuring secrets in your localstack

AWS CLI Configuration (Optional)

IntelliJ Setup

Eclipse / STS Setup