Merge pull request aws-samples#332 from aws-samples/ijemmy/export-output-for-local-run

feat: Add cfn output of env vars for local development (docker-compose)

Author: BastLeblanc

Developer-Instructions.md

@@ -18,7 +18,7 @@ Save your access token in a secure location.
 
 The Retail Demo Store provides several options for managing deployments.  Here are the most common ones:
 
-### Deploy via an S3 Staging Bucket
+### Option 3.1 Deploy via an S3 Staging Bucket
 
 If you want to modify deployment templates and manage the whole deployment process yourself, you will need to configure an S3 bucket for staging Retail Demo Store deployment templates and resources prior to deployment in your own AWS account.  This bucket must be in the region in which you plan to deploy.
 
@@ -69,12 +69,43 @@ The [stage.sh](stage.sh) script at the root of the repository must be used to up
 Example on how to stage your project to a custom bucket and path (note the path is optional but, if specified, must end with '/'):
 
 ```bash
-./stage.sh mycustombucket path/
+./stage.sh MY_CUSTOM_BUCKET S3_PATH/
 ```
 
-The stage script will output a path to your master deployment CloudFormation template.  You can use this link to your S3 bucket to start a new deployment via the CloudFormation console in your AWS Console.
+The stage script will output a path to your master deployment CloudFormation template.  You can use this link to your S3 bucket to start a new deployment via the CloudFormation console in your AWS Console or use the command line below.  (replace REGION, MY_CUSTOM_BUCKET and S3_PATH value)
 
-### Deploy Infrastructure from the Main Repo, Deploy Application and Services via GitHub
+```bash
+aws cloudformation deploy \
+  --template-file ./aws/cloudformation-templates/template.yaml \
+  --stack-name retaildemostore \
+  --capabilities CAPABILITY_NAMED_IAM \
+  --region REGION \
+  --parameter-overrides \
+  ResourceBucket=MY_CUSTOM_BUCKET \ 
+  ResourceBucketRelativePath=S3_PATH \ 
+  SourceDeploymentType="CodeCommit" \
+  AlexaSkillId="" \
+  AlexaAmazonPayDefaultSandboxEmail="" \
+  ResourceBucketRelativePath="" \
+  mParticleSecretKey="" \
+  AmazonPayPublicKeyId="" \
+  mParticleApiKey="" \
+  mParticleS2SSecretKey="" \
+  mParticleS2SApiKey="" \
+  mParticleOrgId="" \
+  GoogleAnalyticsMeasurementId="" \
+  PinpointSMSLongCode="" \
+  PinpointEmailFromAddress="" \
+  SegmentWriteKey="" \
+  AmazonPayPrivateKey="" \
+  AmazonPayStoreId="" \
+  AmazonPayMerchantId="" \
+  OptimizelySdkKey="" \
+  GitHubToken="" \
+  AmplitudeApiKey=""
+```
+
+### Option 3.2 Deploy Infrastructure from the Main Repo, Deploy Application and Services via GitHub
 
 If you only want to modify the web user interface, or the Retail Demo Store backend services, you can deploy Retail Demo Store using the options below, and issue commits in your own fork via GitHub to trigger a re-deploy.  This will allow you to push changes to the Retail Demo Store services and web user interface using a CodeDeploy pipeline.
 

aws/cloudformation-templates/template.yaml

@@ -771,3 +771,35 @@ Outputs:
   OffersServiceUrl:
     Description: Offers service load balancer URL.
     Value: !GetAtt Services.Outputs.OffersServiceUrl
+
+  ExportEnvVarScript:
+    Description: A script to export all required environment variable for running docker-compose locally, but connecting to Cloud resources. Replace the existing .env file with this output.
+    Value: !Sub |
+        # Products service
+        DDB_TABLE_PRODUCTS=${Base.Outputs.ProductsTable}
+        DDB_TABLE_CATEGORIES=${Base.Outputs.CategoriesTable}
+        IMAGE_ROOT_URL="${Base.Outputs.WebUICDNURL}/images/"
+        WEB_ROOT_URL="${Base.Outputs.WebUICDNURL}"
+
+        # Recommendations service
+        PRODUCT_SERVICE_HOST="${Services.Outputs.ProductsServiceUrl}"
+        PRODUCT_SERVICE_PORT=80
+        OFFERS_SERVICE_HOST="${Services.Outputs.OffersServiceUrl}"
+        OFFERS_SERVICE_PORT=80
+        AWS_XRAY_DAEMON_ADDRESS=xray:2000
+
+        # Search service
+        ES_SEARCH_DOMAIN_SCHEME=https
+        ES_SEARCH_DOMAIN_HOST="${Base.Outputs.ElasticsearchDomainEndpoint}"
+        ES_SEARCH_DOMAIN_PORT=9200
+
+        # Users service
+        AWS_REGION=${AWS::Region}
+
+        # Locations service
+        RESOURCE_BUCKET=${ResourceBucket}
+        AWS_DEFAULT_REGION=${AWS::Region}
+
+        # Videos service
+        PARAMETER_IVS_VIDEO_CHANNEL_MAP=${Base.Outputs.ParameterIVSVideoChannelMap}
+        USE_DEFAULT_IVS_STREAMS=true

src/README.md

@@ -10,6 +10,17 @@ Besides cloning this repository to your local system, you also need to have the
 
 Docker Compose will load the [.env](.env) file to resolve environment variables referenced in the [docker-compose.yml](./docker-compose.yml) file. You can copy the [.env.template](.env.template) file to [.env](.env) as a starting point. This is where you can customize variables to match your desired configuration.
 
+You can find the common environment variables from your deployed stack in the CloudFormation output name `ExportEnvVarScript`. Use this CLI to get the output in a proper format.
+
+```sh
+aws cloudformation describe-stacks --stack-name retaildemostore \
+  --region REGION \
+  --query "Stacks[0].Outputs[?OutputKey=='ExportEnvVarScript'].OutputValue" 
+  --output text
+```
+
+Then you can copy and override variables for each service in your [.env](.env) file.
+
 ### AWS credentials
 
 Some services, such as the [products](./products) and [recommendations](./recommendations) services, need to access AWS services running in your AWS account from your local machine. Given the differences between these container setups, different approaches are needed to pass in the AWS credentials needed to make these connections. For example, for the recommendations service we can map your local `~./.aws` configuration directory into the container's `/root` directory so the AWS SDK in the container can pick up the credentials it needs. Alternatively, since the products service is packaged from a [scratch image](https://hub.docker.com/_/scratch), credentials must be passed using the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN` environment variables. In this case, rather than setting these variables in `.env` and risk exposing these values, consider setting these three variables in your shell environment. The following command can be used to obtain a session token which can be used to set your environment variables in your shell.