Skip to content

Commit

Permalink
docs(feature-flags): add guidance when to use vs env vars vs parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
heitorlessa committed Aug 11, 2021
1 parent 1a21b3f commit f627b02
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) fo
* **deps:** bump poetry to latest ([#592](https://github.com/awslabs/aws-lambda-powertools-python/issues/592))
* **feature-flags:** bug handling multiple conditions ([#599](https://github.com/awslabs/aws-lambda-powertools-python/issues/599))
* **parser:** API Gateway WebSocket validation under check_message_id; plus some housekeeping ([#553](https://github.com/awslabs/aws-lambda-powertools-python/issues/553))
* **feature-toggles:** correct cdk example ([#601](https://github.com/awslabs/aws-lambda-powertools-python/issues/601))

### Code Refactoring

Expand All @@ -30,6 +31,7 @@ This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) fo
* **tracer:** update wording that it auto-disables on non-Lambda env
* **feature-flags:** fix SAM infra, convert CDK to Python
* **feature-flags:** fix sample feature name in evaluate method
* **feature-flags:** add guidance when to use vs env vars vs parameters
### Features

* **api-gateway:** add support for custom serializer ([#568](https://github.com/awslabs/aws-lambda-powertools-python/issues/568))
Expand Down
8 changes: 8 additions & 0 deletions docs/utilities/feature_flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,3 +644,11 @@ You can unit test your feature flags locally and independently without setting u
# THEN
assert flag == expected_value
```

## Feature flags vs Parameters vs env vars

Method | When to use | Requires new deployment on changes | Supported services
------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------
**[Environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html){target="_blank"}** | Simple configuration that will rarely if ever change, because changing it requires a Lambda function deployment. | Yes | Lambda
**[Parameters utility](parameters.md)** | Access to secrets, or fetch parameters in different formats from AWS System Manager Parameter Store or Amazon DynamoDB. | No | Parameter Store, DynamoDB, Secrets Manager, AppConfig
**Feature flags utility** | Rule engine to define when one or multiple features should be enabled depending on the input. | No | AppConfig

0 comments on commit f627b02

Please sign in to comment.