...
Log in to the Synapse Prod AWS Console with the Developer Role
Navigate to the AWS AppConfig dashboard
Choose the application that maps to the release you wish to update. If updating production, staging should also be updated!
Create a new hosted configuration version and update the JSON document to toggle the desired flag(s).
Click “Start Deployment”, select the portal environment, desired strategy (e.g. AllAtOnce), and click “Start Deployment” to push out the feature flag.
Update the Synapse-Stack-Builder
appconfig-config.json
file to ensure future stacks have the updated default feature flag configuration.
The AppConfigServlet will serve the newly deployed configurations after the 5 minute cache expires
How to create Feature Flags
...
Navigate to
appconfig-config.json
inside the Synapse-Stack-Builder repo:Inside the appConfigDescriptors JSON array, locate the object with the respective “appConfigName” (portal, repo, etc.) where a new feature flag will be added.
Edit the value of "appConfigDefaultConfiguration" with the additional feature flag configurations while maintaining the JSON string format.
Navigate to
appconfig-data-test.json
. (This file acts as a safeguard for when the stack builder generates unexpected AWS CloudFormation templates and for engineers to double check that the templates are generated as expected).Edit the JSON file to reflect the AWS AppConfig CloudFormation template that should be generated while making sure that no JSON syntax errors exists
Run
mvn test
to verify that correct AppConfig templates are generated through the stack builder. (running mvn test DOES NOT guarantee that the AppConfig template is free of JSON syntax errors)
The actual output generated from the stack builder could be seen in the logs or by debuggingRepositoryTemplateBuilderImplTest
with breakpoint at lines that creates a JSONObject like belowCode Block JSONObject templateJson = new JSONObject(bodyJSONString);
An engineer should further verify that creating this new feature flag will not break the stack builder builds by running their own Jenkins build.
Copy one of the existing builds by the name
stackbuilder-dev...
inside JenkinsClick Configure and replace “Repository URL” and “Default Value” for BRANCH String parameter with your respective GitHub Repository and the branch that includes the change
Build the Jenkins build and validate that the build completes
If an engineer wants to delete a feature flag, follow the steps above with changes to step 3 as needed.
How to utilize Feature Flags
Toggling the feature
Sign into the AWS Management Console, and go to AWS AppConfig
Access the AppConfig Application that corresponds to your application name
Click the FreeForm configuration profile under Configuration Profiles and Feature Flags
Click Create
Edit the JSON configuration as wanted (e.g. true → false)
Create hosted configuration version
Select the newly created configuration version under the Version dropdown menu if not already set
Click on Start Deployment
Double check that the hosted configuration version matches the newly created version and select AllAtOnce under deployment strategy
Click on Start Deployment
...
Applying Feature Flag in SWC
...