From 89d8e37c7c11abc0e98fffd1338d25748e9ca0a9 Mon Sep 17 00:00:00 2001 From: wyike <77846369+wangyikewxgm@users.noreply.github.com> Date: Thu, 1 Jul 2021 13:38:05 +0800 Subject: [PATCH] disable rollout and deploy docs (#1860) --- docs/en/end-user/scopes/advanced-rollout.md | 238 -------------------- docs/en/end-user/scopes/appdeploy.md | 230 ------------------- docs/en/end-user/scopes/rollout-plan.md | 5 - docs/en/quick-start.md | 2 +- docs/sidebars.js | 1 - 5 files changed, 1 insertion(+), 475 deletions(-) delete mode 100644 docs/en/end-user/scopes/advanced-rollout.md delete mode 100644 docs/en/end-user/scopes/appdeploy.md diff --git a/docs/en/end-user/scopes/advanced-rollout.md b/docs/en/end-user/scopes/advanced-rollout.md deleted file mode 100644 index f41c96568..000000000 --- a/docs/en/end-user/scopes/advanced-rollout.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -title: Advanced Rollout Plan ---- - -The rollout plan feature in KubeVela is essentially provided by `AppRollout` API. - -## AppRollout - -Below is an example for rolling update an application from v1 to v2 in three batches. The -first batch contains only 1 pod while the rest of the batches split the rest. - -```yaml -apiVersion: core.oam.dev/v1beta1 -kind: AppRollout -metadata: - name: rolling-example -spec: - sourceAppRevisionName: test-rolling-v1 - targetAppRevisionName: test-rolling-v2 - componentList: - - metrics-provider - rolloutPlan: - rolloutStrategy: "IncreaseFirst" - rolloutBatches: - - replicas: 1 - - replicas: 50% - - replicas: 50% - batchPartition: 1 -``` -## Basic Usage - -1. Deploy application - ```yaml - apiVersion: core.oam.dev/v1beta1 - kind: Application - metadata: - name: test-rolling - annotations: - "app.oam.dev/rolling-components": "metrics-provider" - "app.oam.dev/rollout-template": "true" - spec: - components: - - name: metrics-provider - type: worker - properties: - cmd: - - ./podinfo - - stress-cpu=1 - image: stefanprodan/podinfo:4.0.6 - port: 8080 - replicas: 5 - ``` - Verify AppRevision `test-rolling-v1` have generated - ```shell - $ kubectl get apprev test-rolling-v1 - NAME AGE - test-rolling-v1 9s - ``` - -2. Attach the following rollout plan to upgrade the application to v1 - ```yaml - apiVersion: core.oam.dev/v1beta1 - kind: AppRollout - metadata: - name: rolling-example - spec: - # application (revision) reference - targetAppRevisionName: test-rolling-v1 - componentList: - - metrics-provider - rolloutPlan: - rolloutStrategy: "IncreaseFirst" - rolloutBatches: - - replicas: 10% - - replicas: 40% - - replicas: 50% - targetSize: 5 - ``` - Use can check the status of the ApplicationRollout and wait for the rollout to complete. - -3. User can continue to modify the application image tag and apply.This will generate new AppRevision `test-rolling-v2` - ```yaml - apiVersion: core.oam.dev/v1beta1 - kind: Application - metadata: - name: test-rolling - annotations: - "app.oam.dev/rolling-components": "metrics-provider" - "app.oam.dev/rollout-template": "true" - spec: - components: - - name: metrics-provider - type: worker - properties: - cmd: - - ./podinfo - - stress-cpu=1 - image: stefanprodan/podinfo:5.0.2 - port: 8080 - replicas: 5 - ``` - - Verify AppRevision `test-rolling-v2` have generated - ```shell - $ kubectl get apprev test-rolling-v2 - NAME AGE - test-rolling-v2 7s - ``` - -4. Apply the application rollout that upgrade the application from v1 to v2 - ```yaml - apiVersion: core.oam.dev/v1beta1 - kind: AppRollout - metadata: - name: rolling-example - spec: - # application (revision) reference - sourceAppRevisionName: test-rolling-v1 - targetAppRevisionName: test-rolling-v2 - componentList: - - metrics-provider - rolloutPlan: - rolloutStrategy: "IncreaseFirst" - rolloutBatches: - - replicas: 1 - - replicas: 2 - - replicas: 2 - ``` - User can check the status of the ApplicationRollout and see the rollout completes, and the - ApplicationRollout's "Rolling State" becomes `rolloutSucceed` - -## Advanced Usage - -Using `AppRollout` separately can enable some advanced use case. - -### Revert - -5. Apply the application rollout that revert the application from v2 to v1 - - ```yaml - apiVersion: core.oam.dev/v1beta1 - kind: AppRollout - metadata: - name: rolling-example - spec: - # application (revision) reference - sourceAppRevisionName: test-rolling-v2 - targetAppRevisionName: test-rolling-v1 - componentList: - - metrics-provider - rolloutPlan: - rolloutStrategy: "IncreaseFirst" - rolloutBatches: - - replicas: 1 - - replicas: 2 - - replicas: 2 - ``` - -### Skip Revision Rollout - -6. User can apply this yaml continue to modify the application image tag.This will generate new AppRevision `test-rolling-v3` - ```yaml - apiVersion: core.oam.dev/v1beta1 - kind: Application - metadata: - name: test-rolling - annotations: - "app.oam.dev/rolling-components": "metrics-provider" - "app.oam.dev/rollout-template": "true" - spec: - components: - - name: metrics-provider - type: worker - properties: - cmd: - - ./podinfo - - stress-cpu=1 - image: stefanprodan/podinfo:5.2.0 - port: 8080 - replicas: 5 - ``` - - Verify AppRevision `test-rolling-v3` have generated - ```shell - $ kubectl get apprev test-rolling-v3 - NAME AGE - test-rolling-v3 7s - ``` - -7. Apply the application rollout that rollout the application from v1 to v3 - ```yaml - apiVersion: core.oam.dev/v1beta1 - kind: AppRollout - metadata: - name: rolling-example - spec: - # application (revision) reference - sourceAppRevisionName: test-rolling-v1 - targetAppRevisionName: test-rolling-v3 - componentList: - - metrics-provider - rolloutPlan: - rolloutStrategy: "IncreaseFirst" - rolloutBatches: - - replicas: 1 - - replicas: 2 - - replicas: 2 - ``` - -## More Details About `AppRollout` - -### Design Principles and Goals - -There are several attempts at solving rollout problem in the cloud native community. However, none -of them provide a true rolling style upgrade. For example, flagger supports Blue/Green, Canary -and A/B testing. Therefore, we decide to add support for batch based rolling upgrade as -our first style to support in KubeVela. - -We design KubeVela rollout solutions with the following principles in mind -- First, we want all flavors of rollout controllers share the same core rollout - related logic. The trait and application related logic can be easily encapsulated into its own - package. -- Second, the core rollout related logic is easily extensible to support different type of - workloads, i.e. Deployment, CloneSet, Statefulset, DaemonSet or even customized workloads. -- Thirdly, the core rollout related logic has a well documented state machine that - does state transition explicitly. -- Finally, the controllers can support all the rollout/upgrade needs of an application running - in a production environment including Blue/Green, Canary and A/B testing. - - -### State Transition -Here is the high level state transition graph - -![](../../resources/approllout-status-transition.jpg) - -### Roadmap - -Our recent roadmap for rollout plan is [here](./roadmap). \ No newline at end of file diff --git a/docs/en/end-user/scopes/appdeploy.md b/docs/en/end-user/scopes/appdeploy.md deleted file mode 100644 index 965ba0feb..000000000 --- a/docs/en/end-user/scopes/appdeploy.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -title: Placement ---- - -## Introduction - -In this section, we will introduce how to use KubeVela to place application across multiple clusters with traffic management enabled. For traffic management, KubeVela currently allows you to split the traffic onto both the old and new revisions during rolling update and verify the new version while preserving service availability. - -### AppDeployment - -The `AppDeployment` API in KubeVela is provided to satisfy such requirements. Here's an overview of the API: - -```yaml -apiVersion: core.oam.dev/v1beta1 -kind: AppDeployment -metadata: - name: sample-appdeploy -spec: - traffic: - hosts: - - example.com - - http: - - match: - # match any requests to 'example.com/example-app' - - uri: - prefix: "/example-app" - - # split traffic 50/50 on v1/v2 versions of the app - weightedTargets: - - revisionName: example-app-v1 - componentName: testsvc - port: 80 - weight: 50 - - revisionName: example-app-v2 - componentName: testsvc - port: 80 - weight: 50 - - appRevisions: - - # Name of the AppRevision. - # Each modification to Application would generate a new AppRevision. - revisionName: example-app-v1 - - # Cluster specific workload placement config - placement: - - clusterSelector: - # You can select Clusters by name or labels. - # If multiple clusters is selected, one will be picked via a unique hashing algorithm. - labels: - tier: production - name: prod-cluster-1 - - distribution: - replicas: 5 - - - # If no clusterSelector is given, it will use the host cluster in which this CR exists - distribution: - replicas: 5 - - - revisionName: example-app-v2 - placement: - - clusterSelector: - labels: - tier: production - name: prod-cluster-1 - distribution: - replicas: 5 - - distribution: - replicas: 5 -``` - -### Cluster - -The clusters selected in the `placement` part from above is defined in Cluster CRD. Here's what it looks like: - -```yaml -apiVersion: core.oam.dev/v1beta1 -kind: Cluster -metadata: - name: prod-cluster-1 - labels: - tier: production -spec: - kubeconfigSecretRef: - name: kubeconfig-cluster-1 # the secret name -``` - -The secret must contain the kubeconfig credentials in `config` field: - -```yaml -apiVersion: v1 -kind: Secret -metadata: - name: kubeconfig-cluster-1 -data: - config: ... # kubeconfig data -``` - -## Quickstart - -Here's a step-by-step tutorial for you to try out. All of the yaml files are from [`docs/examples/appdeployment/`](https://github.com/oam-dev/kubevela/tree/master/docs/examples/appdeployment). -You must run all commands in that directory. - -1. Create an Application - - ```bash - $ cat < Note: with `app.oam.dev/revision-only: "true"` annotation, above `Application` resource won't create any pod instances and leave the real deployment process to `AppDeployment`. - -1. Then use the above AppRevision to create an AppDeployment. - - ```bash - $ kubectl apply -f appdeployment-1.yaml - ``` - - > Note: in order to AppDeployment to work, your workload object must have a `spec.replicas` field for scaling. - -1. Now you can check that there will 1 deployment and 2 pod instances deployed - - ```bash - $ kubectl get deploy - NAME READY UP-TO-DATE AVAILABLE AGE - testsvc-v1 2/2 2 0 27s - ``` - -1. Update Application properties: - - ```bash - $ cat < 8080 - Forwarding from [::1]:8080 -> 8080 - - # The command should return pages of either docker whale or nginx in 50/50 - $ curl -H "Host: example-app.example.com" http://localhost:8080/ - ``` - -1. Cleanup: - - ```bash - kubectl delete appdeployments.core.oam.dev --all - kubectl delete applications.core.oam.dev --all - ``` diff --git a/docs/en/end-user/scopes/rollout-plan.md b/docs/en/end-user/scopes/rollout-plan.md index 2bdc13cea..72ddc7d6b 100644 --- a/docs/en/end-user/scopes/rollout-plan.md +++ b/docs/en/end-user/scopes/rollout-plan.md @@ -62,10 +62,5 @@ spec: User can check the status of the application and see the rollout completes, and the application's `status.rollout.rollingState` becomes `rolloutSucceed`. -## Advanced Usage - -If you want to control and rollout the specific application revisions, or do revert, please refer to [Advanced Usage](advanced-rollout) to learn more details. - - diff --git a/docs/en/quick-start.md b/docs/en/quick-start.md index 5c90e3351..36782ecaf 100644 --- a/docs/en/quick-start.md +++ b/docs/en/quick-start.md @@ -62,4 +62,4 @@ Here are some recommended next steps: - Learn KubeVela's [core concepts](./concepts) - Learn more details about [`Application`](end-user/application) and what it can do for you. -- Learn how to attach [rollout plan](end-user/scopes/rollout-plan) to this application, or [place it to multiple runtime clusters](end-user/scopes/appdeploy). +- Learn how to attach [rollout plan](end-user/scopes/rollout-plan) to this application. diff --git a/docs/sidebars.js b/docs/sidebars.js index 5b5b1ccf1..150822ef6 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -44,7 +44,6 @@ module.exports = { 'end-user/traits/more', ] }, - 'end-user/scopes/appdeploy', 'end-user/scopes/rollout-plan', { 'Observability': [