From 953576a6c86cc40daa3349a015ade3de498c48c5 Mon Sep 17 00:00:00 2001 From: LiZhenCheng9527 Date: Thu, 19 Sep 2024 14:42:22 +0800 Subject: [PATCH] add three subdir in rollout doc Signed-off-by: LiZhenCheng9527 --- .../fleet-manager/rollout/abtest/_index.md | 18 ++++++++++++++++++ .../rollout/{ => abtest}/abtest.md | 19 ++++--------------- .../rollout/{ => abtest}/image/abtesting.svg | 0 .../rollout/blue-green/_index.md | 18 ++++++++++++++++++ .../rollout/{ => blue-green}/blue-green.md | 19 ++++--------------- .../image/blue-green-failed.svg | 0 .../image/blue-green-successful.svg | 0 .../fleet-manager/rollout/canary/_index.md | 18 ++++++++++++++++++ .../rollout/{ => canary}/canary.md | 17 +++-------------- .../rollout/{ => canary}/image/canary.svg | 0 10 files changed, 65 insertions(+), 44 deletions(-) create mode 100644 docs/content/en/docs/fleet-manager/rollout/abtest/_index.md rename docs/content/en/docs/fleet-manager/rollout/{ => abtest}/abtest.md (92%) rename docs/content/en/docs/fleet-manager/rollout/{ => abtest}/image/abtesting.svg (100%) create mode 100644 docs/content/en/docs/fleet-manager/rollout/blue-green/_index.md rename docs/content/en/docs/fleet-manager/rollout/{ => blue-green}/blue-green.md (92%) rename docs/content/en/docs/fleet-manager/rollout/{ => blue-green}/image/blue-green-failed.svg (100%) rename docs/content/en/docs/fleet-manager/rollout/{ => blue-green}/image/blue-green-successful.svg (100%) create mode 100644 docs/content/en/docs/fleet-manager/rollout/canary/_index.md rename docs/content/en/docs/fleet-manager/rollout/{ => canary}/canary.md (93%) rename docs/content/en/docs/fleet-manager/rollout/{ => canary}/image/canary.svg (100%) diff --git a/docs/content/en/docs/fleet-manager/rollout/abtest/_index.md b/docs/content/en/docs/fleet-manager/rollout/abtest/_index.md new file mode 100644 index 000000000..6042a8153 --- /dev/null +++ b/docs/content/en/docs/fleet-manager/rollout/abtest/_index.md @@ -0,0 +1,18 @@ +--- +title: "A/B Testing" +linkTitle: "A/B Testing" +weight: 50 +description: > + A comprehensive guide on Kurator's A/B Testing, providing an overview and quick start guide. +--- + +## Introduction + +A/B Testing is a method of comparing two versions of an application to validate which performs better. +It essentially involves a controlled experiment where users are randomly allocated into groups at the same time, with each group experiencing a different version of the application. +The metrics from their usage are then analyzed to select the superior version based on the results. The A/B Testing can also be used to route selective users to the new version, allowing their real-world feedback on the new release to be gathered. + +- **Use Case**: There are two application services with identical backend functionality but different frontend UIs. It is now necessary to validate which UI design leads to a better user experience. In this scenario, A/B Testing should be used to deploy both versions of the service in a live environment. The UI that demonstrates superior user metrics and outcomes can then be selected for full release. +- **Functionality**: Provide configuration of A/B Testing and trigger an A/B Testing on new release. + +By allowing users to deploy applications and their A/B Testing configurations in a single place, Kurator streamlines A/B Testing through automated GitOps workflows for unified deployment and validation. diff --git a/docs/content/en/docs/fleet-manager/rollout/abtest.md b/docs/content/en/docs/fleet-manager/rollout/abtest/abtest.md similarity index 92% rename from docs/content/en/docs/fleet-manager/rollout/abtest.md rename to docs/content/en/docs/fleet-manager/rollout/abtest/abtest.md index 81f9a6fc7..5f719d40f 100644 --- a/docs/content/en/docs/fleet-manager/rollout/abtest.md +++ b/docs/content/en/docs/fleet-manager/rollout/abtest/abtest.md @@ -1,22 +1,11 @@ --- -title: "A/B Testing" -linkTitle: "A/B Testing" -weight: 30 +title: "Istio A/B Testing" +linkTitle: "Istio A/B Testing" +weight: 20 description: > - A comprehensive guide on Kurator's A/B Testing, providing an overview and quick start guide. + A comprehensive guide on Kurator's A/B Testing uses Istio as ingress, providing an overview and quick start guide. --- -## Introduction - -A/B Testing is a method of comparing two versions of an application to validate which performs better. -It essentially involves a controlled experiment where users are randomly allocated into groups at the same time, with each group experiencing a different version of the application. -The metrics from their usage are then analyzed to select the superior version based on the results. The A/B Testing can also be used to route selective users to the new version, allowing their real-world feedback on the new release to be gathered. - -- **Use Case**: There are two application services with identical backend functionality but different frontend UIs. It is now necessary to validate which UI design leads to a better user experience. In this scenario, A/B Testing should be used to deploy both versions of the service in a live environment. The UI that demonstrates superior user metrics and outcomes can then be selected for full release. -- **Functionality**: Provide configuration of A/B Testing and trigger an A/B Testing on new release. - -By allowing users to deploy applications and their A/B Testing configurations in a single place, Kurator streamlines A/B Testing through automated GitOps workflows for unified deployment and validation. - ## Prerequisites In the subsequent sections, we'll guide you through a hands-on demonstration. diff --git a/docs/content/en/docs/fleet-manager/rollout/image/abtesting.svg b/docs/content/en/docs/fleet-manager/rollout/abtest/image/abtesting.svg similarity index 100% rename from docs/content/en/docs/fleet-manager/rollout/image/abtesting.svg rename to docs/content/en/docs/fleet-manager/rollout/abtest/image/abtesting.svg diff --git a/docs/content/en/docs/fleet-manager/rollout/blue-green/_index.md b/docs/content/en/docs/fleet-manager/rollout/blue-green/_index.md new file mode 100644 index 000000000..d19e0450a --- /dev/null +++ b/docs/content/en/docs/fleet-manager/rollout/blue-green/_index.md @@ -0,0 +1,18 @@ +--- +title: "Blue/Green Deployment" +linkTitle: "Blue/Green Deployment" +weight: 50 +description: > + A comprehensive guide on Kurator's Blue/Green Deployment, providing an overview and quick start guide. +--- + +## Introduction + +In Blue/Green Deployment, there are two separate live production environments - the blue environment and the green environment. The blue environment runs the existing version receiving real-time traffic, while the green environment hosts the new release. At any given time, only one of the environments is live with real traffic. + +The key benefit of Blue/Green Deployment is that if issues arise in the new version, traffic can be instantaneously switched back to the blue environment running the old version, avoiding any downtime and resulting losses. This allows seamless rollback to the previous known-good release in the event validation fails. + +- **Use Case**: If issues are encountered that prevent the new version from functioning properly, the testing process should immediately switch the traffic back to the previously stable legacy release. This ensures users continue receiving an optimal service experience without interruption while the new release issues are addressed. +- **Functionality**: Provides configuration of Blue/Green Deployment and triggers a Blue/Green Deploymenton new release. + +By allowing users to deploy applications and their Blue/Green Deployment configurations in a single place, Kurator streamlines Blue/Green Deployment through automated GitOps workflows for unified deployment and validation. diff --git a/docs/content/en/docs/fleet-manager/rollout/blue-green.md b/docs/content/en/docs/fleet-manager/rollout/blue-green/blue-green.md similarity index 92% rename from docs/content/en/docs/fleet-manager/rollout/blue-green.md rename to docs/content/en/docs/fleet-manager/rollout/blue-green/blue-green.md index c8af99422..dc6673337 100644 --- a/docs/content/en/docs/fleet-manager/rollout/blue-green.md +++ b/docs/content/en/docs/fleet-manager/rollout/blue-green/blue-green.md @@ -1,22 +1,11 @@ --- -title: "Blue/Green Deployment" -linkTitle: "Blue/Green Deployment" -weight: 40 +title: "Istio Blue/Green Deployment" +linkTitle: "Istio Blue/Green Deployment" +weight: 20 description: > - A comprehensive guide on Kurator's Blue/Green Deployment, providing an overview and quick start guide. + A comprehensive guide on Kurator's Blue/Green Deployment uses Istio as ingress, providing an overview and quick start guide. --- -## Introduction - -In Blue/Green Deployment, there are two separate live production environments - the blue environment and the green environment. The blue environment runs the existing version receiving real-time traffic, while the green environment hosts the new release. At any given time, only one of the environments is live with real traffic. - -The key benefit of Blue/Green Deployment is that if issues arise in the new version, traffic can be instantaneously switched back to the blue environment running the old version, avoiding any downtime and resulting losses. This allows seamless rollback to the previous known-good release in the event validation fails. - -- **Use Case**: If issues are encountered that prevent the new version from functioning properly, the testing process should immediately switch the traffic back to the previously stable legacy release. This ensures users continue receiving an optimal service experience without interruption while the new release issues are addressed. -- **Functionality**: Provides configuration of Blue/Green Deployment and triggers a Blue/Green Deploymenton new release. - -By allowing users to deploy applications and their Blue/Green Deployment configurations in a single place, Kurator streamlines Blue/Green Deployment through automated GitOps workflows for unified deployment and validation. - ## Prerequisites In the subsequent sections, we'll guide you through a hands-on demonstration. diff --git a/docs/content/en/docs/fleet-manager/rollout/image/blue-green-failed.svg b/docs/content/en/docs/fleet-manager/rollout/blue-green/image/blue-green-failed.svg similarity index 100% rename from docs/content/en/docs/fleet-manager/rollout/image/blue-green-failed.svg rename to docs/content/en/docs/fleet-manager/rollout/blue-green/image/blue-green-failed.svg diff --git a/docs/content/en/docs/fleet-manager/rollout/image/blue-green-successful.svg b/docs/content/en/docs/fleet-manager/rollout/blue-green/image/blue-green-successful.svg similarity index 100% rename from docs/content/en/docs/fleet-manager/rollout/image/blue-green-successful.svg rename to docs/content/en/docs/fleet-manager/rollout/blue-green/image/blue-green-successful.svg diff --git a/docs/content/en/docs/fleet-manager/rollout/canary/_index.md b/docs/content/en/docs/fleet-manager/rollout/canary/_index.md new file mode 100644 index 000000000..de72458a0 --- /dev/null +++ b/docs/content/en/docs/fleet-manager/rollout/canary/_index.md @@ -0,0 +1,18 @@ +--- +title: "Canary Deployment" +linkTitle: "Canary Deployment" +weight: 50 +description: > + A comprehensive guide on Kurator's Canary Deployment, providing an overview and quick start guide. +--- + +## Introduction + +Canary Deployment is a software release strategy. +It refers to releasing a new software version to only a very small percentage of users first for testing, to observe if there are any issues. Based on the test results, determine whether to gradually roll out the release to more users. +It aims to maximize reducing the impact on users after a new version goes live. It is considered a safer and more reliable method of software updates. + +- **Use Case**: When the system undergoes API changes that require validation through real-world usage, a Canary Deployment should be leveraged to gradually roll out and validate the changes. This incremental approach helps ensure any potential issues are identified and addressed before being exposed to all services/traffic. +- **Functionality**: Provides configuration of Canary Deployment and triggers a Canary Deployment on new release. + +By allowing users to deploy applications and their canary configurations in a single place, Kurator streamlines Canary Deployment through automated GitOps workflows for unified deployment and validation. diff --git a/docs/content/en/docs/fleet-manager/rollout/canary.md b/docs/content/en/docs/fleet-manager/rollout/canary/canary.md similarity index 93% rename from docs/content/en/docs/fleet-manager/rollout/canary.md rename to docs/content/en/docs/fleet-manager/rollout/canary/canary.md index 1407c265e..e86a22951 100644 --- a/docs/content/en/docs/fleet-manager/rollout/canary.md +++ b/docs/content/en/docs/fleet-manager/rollout/canary/canary.md @@ -1,22 +1,11 @@ --- -title: "Canary Deployment" -linkTitle: "Canary Deployment" +title: "Istio Canary Deployment" +linkTitle: "Istio Canary Deployment" weight: 20 description: > - A comprehensive guide on Kurator's Canary Deployment, providing an overview and quick start guide. + A comprehensive guide on Kurator's Canary Deployment uses Istio as ingress, providing an overview and quick start guide. --- -## Introduction - -Canary Deployment is a software release strategy. -It refers to releasing a new software version to only a very small percentage of users first for testing, to observe if there are any issues. Based on the test results, determine whether to gradually roll out the release to more users. -It aims to maximize reducing the impact on users after a new version goes live. It is considered a safer and more reliable method of software updates. - -- **Use Case**: When the system undergoes API changes that require validation through real-world usage, a Canary Deployment should be leveraged to gradually roll out and validate the changes. This incremental approach helps ensure any potential issues are identified and addressed before being exposed to all services/traffic. -- **Functionality**: Provides configuration of Canary Deployment and triggers a Canary Deployment on new release. - -By allowing users to deploy applications and their canary configurations in a single place, Kurator streamlines Canary Deployment through automated GitOps workflows for unified deployment and validation. - ## prerequisites In the subsequent sections, we'll guide you through a hands-on demonstration. diff --git a/docs/content/en/docs/fleet-manager/rollout/image/canary.svg b/docs/content/en/docs/fleet-manager/rollout/canary/image/canary.svg similarity index 100% rename from docs/content/en/docs/fleet-manager/rollout/image/canary.svg rename to docs/content/en/docs/fleet-manager/rollout/canary/image/canary.svg