From c975f5dc24f7ad776b3eb1d399a5a85596183130 Mon Sep 17 00:00:00 2001 From: Pierre Tessier Date: Wed, 17 Aug 2022 16:53:57 -0400 Subject: [PATCH] document feature flags --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index cd063c14d1..aa8620c70f 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,18 @@ Once the images are built and containers are started you can access: - Grafana: - Feature Flags UI: +#### Enable Feature Flags + +This demo comes with 2 feature flags which control failure conditions in the +Product Catalog and Shipping services. By default the flags are disabled. Using +the Feature Flags UI you will be able to control the +status of these feature flags. + +| Feature Flag | Description | +|-------------------------|---------------------------------------------------------------------------| +| `productCatalogFailure` | Generate an error for `GetProduct` requests with product id: `OLJCESPC7Z` | +| `shippingFailure` | Induce very long latency when shipping outside of USA | + #### Bring your own backend Likely you want to use the Webstore as a demo application for an observability