From 0ffb1120635a6aa689842bb4b2dee8d20cf2708c Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Wed, 3 Apr 2019 14:49:21 +0200 Subject: [PATCH] move FAQ into separate file, add links --- README.md | 22 +--------------------- docs/gitbook/SUMMARY.md | 1 + docs/gitbook/faq.md | 21 +++++++++++++++++++++ 3 files changed, 23 insertions(+), 21 deletions(-) create mode 100644 docs/gitbook/faq.md diff --git a/README.md b/README.md index 228a43bc..eecedb00 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ Flagger documentation can be found at [docs.flagger.app](https://docs.flagger.ap * [Alerting](https://docs.flagger.app/usage/alerting) * Tutorials * [Canary deployments with Helm charts and Weave Flux](https://docs.flagger.app/tutorials/canary-helm-gitops) +* [Frequently asked questions](https://docs.flagger.app/faq) ## Canary CRD @@ -162,27 +163,6 @@ For more details on how the canary analysis and promotion works please [read the | Custom promql checks | :heavy_check_mark: | :heavy_check_mark: | | Ingress gateway (CORS, retries and timeouts) | :heavy_check_mark: | :heavy_minus_sign: | -## Frequently asked questions - -**Can Flagger be part of my integration tests?** -> Yes, Flagger supports webhooks to do integration testing. - -**What if I only want to target beta testers?** -> That's a feature in Flagger, not in App Mesh. It's on the App Mesh roadmap. - -**When do I use A/B testing when Canary?** -> One advantage of using A/B testing is that each version remains separated and routes aren't mixed. -> -> Using a Canary deployment can lead to behaviour like this one observed by a -> user: -> -> [..] during a canary deployment of our nodejs app, the version that is being served <50% traffic reports mime type mismatch errors in the browser (js as "text/html") -> When the deployment Passes/ Fails (doesn't really matter) the version that stays alive works as expected. If anyone has any tips or direction I would greatly appreciate it. Even if its as simple as I'm looking in the wrong place. Thanks in advance! -> -> The issue was that we were not maintaining session affinity while serving files for our frontend. Which resulted in any redirects or refreshes occasionally returning a mismatched app.*.js file (generated from vue) -> -> Read up on [A/B testing](https://docs.flagger.app/usage/ab-testing). - ## Roadmap * Integrate with other service mesh technologies like Linkerd v2, Super Gloo or Consul Mesh diff --git a/docs/gitbook/SUMMARY.md b/docs/gitbook/SUMMARY.md index 4ce8974e..856e9985 100644 --- a/docs/gitbook/SUMMARY.md +++ b/docs/gitbook/SUMMARY.md @@ -2,6 +2,7 @@ * [Introduction](README.md) * [How it works](how-it-works.md) +* [Frequently asked questions](faq.md) ## Install diff --git a/docs/gitbook/faq.md b/docs/gitbook/faq.md new file mode 100644 index 00000000..bc2e1b8a --- /dev/null +++ b/docs/gitbook/faq.md @@ -0,0 +1,21 @@ +# Frequently asked questions + +**Can Flagger be part of my integration tests?** +> Yes, Flagger supports webhooks to do integration testing. + +**What if I only want to target beta testers?** +> That's a feature in Flagger, not in App Mesh. It's on the App Mesh roadmap. + +**When do I use A/B testing when Canary?** +> One advantage of using A/B testing is that each version remains separated and routes aren't mixed. +> +> Using a Canary deployment can lead to behaviour like this one observed by a +> user: +> +> [..] during a canary deployment of our nodejs app, the version that is being served <50% traffic reports mime type mismatch errors in the browser (js as "text/html") +> When the deployment Passes/ Fails (doesn't really matter) the version that stays alive works as expected. If anyone has any tips or direction I would greatly appreciate it. Even if its as simple as I'm looking in the wrong place. Thanks in advance! +> +> The issue was that we were not maintaining session affinity while serving files for our frontend. Which resulted in any redirects or refreshes occasionally returning a mismatched app.*.js file (generated from vue) +> +> Read up on [A/B testing](https://docs.flagger.app/usage/ab-testing). +