-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add three subdir in rollout doc (#693)
Signed-off-by: LiZhenCheng9527 <[email protected]>
- Loading branch information
1 parent
edd2ba6
commit 178ec11
Showing
10 changed files
with
65 additions
and
44 deletions.
There are no files selected for viewing
18 changes: 18 additions & 0 deletions
18
docs/content/en/docs/fleet-manager/rollout/abtest/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
19 changes: 4 additions & 15 deletions
19
...t/en/docs/fleet-manager/rollout/abtest.md → ...cs/fleet-manager/rollout/abtest/abtest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
18 changes: 18 additions & 0 deletions
18
docs/content/en/docs/fleet-manager/rollout/blue-green/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
19 changes: 4 additions & 15 deletions
19
.../docs/fleet-manager/rollout/blue-green.md → ...-manager/rollout/blue-green/blue-green.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
18 changes: 18 additions & 0 deletions
18
docs/content/en/docs/fleet-manager/rollout/canary/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
17 changes: 3 additions & 14 deletions
17
...t/en/docs/fleet-manager/rollout/canary.md → ...cs/fleet-manager/rollout/canary/canary.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes