diff --git a/README.md b/README.md index be611d8536..efd55fa40b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This project aims to explore and develop a unified delivery infrastructure for C  **Powerful** -- Unifed Deployment System: kubernetes (plain-yaml, helm, kustomize), terraform, lambda, cloudrun... +- Unified Deployment System: kubernetes (plain-yaml, helm, kustomize), terraform, lambda, cloudrun... - Progressive Deployment Strategies: canary, bluegreen, rolling update - Automated Analysis: by metrics, log, smoke test... - Automated Rollback diff --git a/docs/content/en/docs/examples/_index.md b/docs/content/en/docs/examples/_index.md index 001cc01f86..c19dbec66f 100755 --- a/docs/content/en/docs/examples/_index.md +++ b/docs/content/en/docs/examples/_index.md @@ -17,48 +17,48 @@ https://github.com/pipe-cd/examples | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/kubernetes/simple) | TBA | -| [helm-local-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-local-chart) | TBA | -| [helm-remote-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-chart) | TBA | -| [helm-remote-git-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-git-chart) | TBA | -| [kustomize-local-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-local-base) | TBA | -| [kustomize-remote-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-remote-base) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary) | TBA | -| [canary-by-config-change](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary-by-config-change) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/bluegreen) | TBA | -| [mesh-istio-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-canary) | TBA | -| [mesh-istio-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-bluegreen) | TBA | -| [mesh-envoy-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-envoy-canary) | TBA | -| [mesh-envoy-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-envoy-bluegreen) | TBA | -| [wait-approval](https://github.com/pipe-cd/examples/tree/master/kubernetes/wait-approval) | TBA | -| [multi-steps-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/multi-steps-canary) | TBA | -| [analysis-by-metrics](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-metrics) | TBA | -| [analysis-by-http](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-http) | TBA | -| [analysis-by-log](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-log) | TBA | -| [analysis-with-baseline](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-with-baseline) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/kubernetes/simple) | Deploy plain-yaml manifests in application configuration directory without using pipeline. | +| [helm-local-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-local-chart) | Deploy a helm chart sourced from the same Git repository. | +| [helm-remote-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-chart) | Deploy a helm chart sourced from a [Helm Chart Repository](https://helm.sh/docs/topics/chart_repository/). | +| [helm-remote-git-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-git-chart) | Deploy a helm chart sourced from another Git repository. | +| [kustomize-local-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-local-base) | Deploy a kustomize package that just uses the local bases from the same Git repository. | +| [kustomize-remote-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-remote-base) | Deploy a kustomize package that uses remote bases from other Git repositories. | +| [canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary) | Deloyment pipeline with canary strategy. | +| [canary-by-config-change](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary-by-config-change) | Deployment pipeline with canary strategy when ConfigMap was changed. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/bluegreen) | Deployment pipeline with bluegreen strategy. This also contains a manual approval stage. | +| [mesh-istio-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-canary) | Deployment pipeline with canary strategy by using Istio for traffic routing. | +| [mesh-istio-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-bluegreen) | Deployment pipeline with bluegreen strategy by using Istio for traffic routing. | +| [mesh-smi-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-smi-canary) | Deployment pipeline with canary strategy by using SMI for traffic routing. | +| [mesh-smi-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-smi-bluegreen) | Deployment pipeline with bluegreen strategy by using SMI for traffic routing. | +| [wait-approval](https://github.com/pipe-cd/examples/tree/master/kubernetes/wait-approval) | Deployment pipeline that contains a manual approval stage. | +| [multi-steps-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/multi-steps-canary) | Deployment pipeline with multiple canary steps. | +| [analysis-by-metrics](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-metrics) | Deployment pipeline with analysis stage by metrics. | +| [analysis-by-http](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-http) | Deployment pipeline with analysis stage by running http requests. | +| [analysis-by-log](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-log) | Deployment pipeline with analysis stage by checking logs. | +| [analysis-with-baseline](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-with-baseline) | Deployment pipeline with analysis stage by comparing baseline and canary. | ### Terraform Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/terraform/simple) | TBA | -| [local-module](https://github.com/pipe-cd/examples/tree/master/terraform/local-module) | TBA | -| [remote-module](https://github.com/pipe-cd/examples/tree/master/terraform/remote-module) | TBA | -| [wait-approval](https://github.com/pipe-cd/examples/tree/master/terraform/wait-approval) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/terraform/simple) | Automatically applies when any changes were detected. | +| [local-module](https://github.com/pipe-cd/examples/tree/master/terraform/local-module) | Deploy application that using local terraform modules from the same Git repository. | +| [remote-module](https://github.com/pipe-cd/examples/tree/master/terraform/remote-module) | Deploy application that using remote terraform modules from other Git repositories. | +| [wait-approval](https://github.com/pipe-cd/examples/tree/master/terraform/wait-approval) | Deployment pipeline that contains a manual approval stage. | ### CloudRun Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/cloudrun/simple) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/cloudrun/canary) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/cloudrun/bluegreen) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/cloudrun/simple) | Quick sync by rolling out the new version and switching all traffic to it. | +| [canary](https://github.com/pipe-cd/examples/tree/master/cloudrun/canary) | Deployment pipeline with canary strategy. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/cloudrun/bluegreen) | Deployment pipeline with bluegreen strategy. | ### Lambda Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/lambda/simple) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/lambda/canary) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/lambda/bluegreen) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/lambda/simple) | Quick sync by rolling out the new version and switching all traffic to it. | +| [canary](https://github.com/pipe-cd/examples/tree/master/lambda/canary) | Deployment pipeline with canary strategy. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/lambda/bluegreen) | Deployment pipeline with bluegreen strategy. | diff --git a/docs/content/en/docs/overview/_index.md b/docs/content/en/docs/overview/_index.md index 2ba123e76e..06f06492fb 100644 --- a/docs/content/en/docs/overview/_index.md +++ b/docs/content/en/docs/overview/_index.md @@ -8,9 +8,10 @@ description: > ## What Is PipeCD? -PipeCD provides a Continuous Delivery solution for Declarative Kubernetes Application, Serverless Application and Infrastructure. +{{% pageinfo %}} +PipeCD provides a Continuous Delivery solution for declarative Kubernetes, Serverless and Infrastructure applications. +{{% /pageinfo %}} -> TBA: Introduce your project, including what it does or lets you do, why you would use it, and its primary goal (and how it achieves it). This should be similar to your README description, though you can go into a little more detail here if you want. 
@@ -25,7 +26,7 @@ Deployment Details Screen ## Why PipeCD? **Powerful** -- Unifed Deployment System: kubernetes (plain-yaml, helm, kustomize), terraform, lambda, cloudrun... +- Unified Deployment System: kubernetes (plain-yaml, helm, kustomize), terraform, lambda, cloudrun... - Progressive Deployment Strategies: canary, bluegreen, rolling update - Automated Analysis: by metrics, log, smoke test... - Automated Rollback diff --git a/docs/content/en/docs/user-guide/examples.md b/docs/content/en/docs/user-guide/examples.md index 22595b20f3..19065fecf9 100755 --- a/docs/content/en/docs/user-guide/examples.md +++ b/docs/content/en/docs/user-guide/examples.md @@ -17,47 +17,48 @@ https://github.com/pipe-cd/examples | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/kubernetes/simple) | TBA | -| [helm-local-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-local-chart) | TBA | -| [helm-remote-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-chart) | TBA | -| [helm-remote-git-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-git-chart) | TBA | -| [kustomize-local-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-local-base) | TBA | -| [kustomize-remote-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-remote-base) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary) | TBA | -| [canary-by-config-change](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary-by-config-change) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/bluegreen) | TBA | -| [mesh-istio-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-canary) | TBA | -| [mesh-istio-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-bluegreen) | TBA | -| [mesh-envoy-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-envoy-canary) | TBA | -| [mesh-envoy-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-envoy-bluegreen) | TBA | -| [wait-approval](https://github.com/pipe-cd/examples/tree/master/kubernetes/wait-approval) | TBA | -| [multi-steps-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/multi-steps-canary) | TBA | -| [analysis-by-metrics](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-metrics) | TBA | -| [analysis-by-http](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-http) | TBA | -| [analysis-by-log](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-log) | TBA | -| [analysis-with-baseline](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-with-baseline) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/kubernetes/simple) | Deploy plain-yaml manifests in application configuration directory without using pipeline. | +| [helm-local-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-local-chart) | Deploy a helm chart sourced from the same Git repository. | +| [helm-remote-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-chart) | Deploy a helm chart sourced from a [Helm Chart Repository](https://helm.sh/docs/topics/chart_repository/). | +| [helm-remote-git-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-git-chart) | Deploy a helm chart sourced from another Git repository. | +| [kustomize-local-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-local-base) | Deploy a kustomize package that just uses the local bases from the same Git repository. | +| [kustomize-remote-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-remote-base) | Deploy a kustomize package that uses remote bases from other Git repositories. | +| [canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary) | Deloyment pipeline with canary strategy. | +| [canary-by-config-change](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary-by-config-change) | Deployment pipeline with canary strategy when ConfigMap was changed. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/bluegreen) | Deployment pipeline with bluegreen strategy. This also contains a manual approval stage. | +| [mesh-istio-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-canary) | Deployment pipeline with canary strategy by using Istio for traffic routing. | +| [mesh-istio-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-bluegreen) | Deployment pipeline with bluegreen strategy by using Istio for traffic routing. | +| [mesh-smi-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-smi-canary) | Deployment pipeline with canary strategy by using SMI for traffic routing. | +| [mesh-smi-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-smi-bluegreen) | Deployment pipeline with bluegreen strategy by using SMI for traffic routing. | +| [wait-approval](https://github.com/pipe-cd/examples/tree/master/kubernetes/wait-approval) | Deployment pipeline that contains a manual approval stage. | +| [multi-steps-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/multi-steps-canary) | Deployment pipeline with multiple canary steps. | +| [analysis-by-metrics](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-metrics) | Deployment pipeline with analysis stage by metrics. | +| [analysis-by-http](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-http) | Deployment pipeline with analysis stage by running http requests. | +| [analysis-by-log](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-log) | Deployment pipeline with analysis stage by checking logs. | +| [analysis-with-baseline](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-with-baseline) | Deployment pipeline with analysis stage by comparing baseline and canary. | ### Terraform Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/terraform/simple) | TBA | -| [local-module](https://github.com/pipe-cd/examples/tree/master/terraform/local-module) | TBA | -| [remote-module](https://github.com/pipe-cd/examples/tree/master/terraform/remote-module) | TBA | -| [wait-approval](https://github.com/pipe-cd/examples/tree/master/terraform/wait-approval) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/terraform/simple) | Automatically applies when any changes were detected. | +| [local-module](https://github.com/pipe-cd/examples/tree/master/terraform/local-module) | Deploy application that using local terraform modules from the same Git repository. | +| [remote-module](https://github.com/pipe-cd/examples/tree/master/terraform/remote-module) | Deploy application that using remote terraform modules from other Git repositories. | +| [wait-approval](https://github.com/pipe-cd/examples/tree/master/terraform/wait-approval) | Deployment pipeline that contains a manual approval stage. | ### CloudRun Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/cloudrun/simple) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/cloudrun/canary) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/cloudrun/bluegreen) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/cloudrun/simple) | Quick sync by rolling out the new version and switching all traffic to it. | +| [canary](https://github.com/pipe-cd/examples/tree/master/cloudrun/canary) | Deployment pipeline with canary strategy. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/cloudrun/bluegreen) | Deployment pipeline with bluegreen strategy. | ### Lambda Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/lambda/simple) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/lambda/canary) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/lambda/bluegreen) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/lambda/simple) | Quick sync by rolling out the new version and switching all traffic to it. | +| [canary](https://github.com/pipe-cd/examples/tree/master/lambda/canary) | Deployment pipeline with canary strategy. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/lambda/bluegreen) | Deployment pipeline with bluegreen strategy. | + diff --git a/examples/README.remote.md b/examples/README.remote.md index 4f306b5314..b38b9d519c 100644 --- a/examples/README.remote.md +++ b/examples/README.remote.md @@ -6,47 +6,48 @@ A repository contains some examples for PipeCD. | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/kubernetes/simple) | TBA | -| [helm-local-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-local-chart) | TBA | -| [helm-remote-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-chart) | TBA | -| [helm-remote-git-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-git-chart) | TBA | -| [kustomize-local-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-local-base) | TBA | -| [kustomize-remote-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-remote-base) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary) | TBA | -| [canary-by-config-change](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary-by-config-change) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/bluegreen) | TBA | -| [mesh-istio-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-canary) | TBA | -| [mesh-istio-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-bluegreen) | TBA | -| [mesh-envoy-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-envoy-canary) | TBA | -| [mesh-envoy-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-envoy-bluegreen) | TBA | -| [wait-approval](https://github.com/pipe-cd/examples/tree/master/kubernetes/wait-approval) | TBA | -| [multi-steps-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/multi-steps-canary) | TBA | -| [analysis-by-metrics](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-metrics) | TBA | -| [analysis-by-http](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-http) | TBA | -| [analysis-by-log](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-log) | TBA | -| [analysis-with-baseline](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-with-baseline) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/kubernetes/simple) | Deploy plain-yaml manifests in application configuration directory without using pipeline. | +| [helm-local-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-local-chart) | Deploy a helm chart sourced from the same Git repository. | +| [helm-remote-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-chart) | Deploy a helm chart sourced from a [Helm Chart Repository](https://helm.sh/docs/topics/chart_repository/). | +| [helm-remote-git-chart](https://github.com/pipe-cd/examples/tree/master/kubernetes/helm-remote-git-chart) | Deploy a helm chart sourced from another Git repository. | +| [kustomize-local-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-local-base) | Deploy a kustomize package that just uses the local bases from the same Git repository. | +| [kustomize-remote-base](https://github.com/pipe-cd/examples/tree/master/kubernetes/kustomize-remote-base) | Deploy a kustomize package that uses remote bases from other Git repositories. | +| [canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary) | Deloyment pipeline with canary strategy. | +| [canary-by-config-change](https://github.com/pipe-cd/examples/tree/master/kubernetes/canary-by-config-change) | Deployment pipeline with canary strategy when ConfigMap was changed. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/bluegreen) | Deployment pipeline with bluegreen strategy. This also contains a manual approval stage. | +| [mesh-istio-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-canary) | Deployment pipeline with canary strategy by using Istio for traffic routing. | +| [mesh-istio-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-istio-bluegreen) | Deployment pipeline with bluegreen strategy by using Istio for traffic routing. | +| [mesh-smi-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-smi-canary) | Deployment pipeline with canary strategy by using SMI for traffic routing. | +| [mesh-smi-bluegreen](https://github.com/pipe-cd/examples/tree/master/kubernetes/mesh-smi-bluegreen) | Deployment pipeline with bluegreen strategy by using SMI for traffic routing. | +| [wait-approval](https://github.com/pipe-cd/examples/tree/master/kubernetes/wait-approval) | Deployment pipeline that contains a manual approval stage. | +| [multi-steps-canary](https://github.com/pipe-cd/examples/tree/master/kubernetes/multi-steps-canary) | Deployment pipeline with multiple canary steps. | +| [analysis-by-metrics](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-metrics) | Deployment pipeline with analysis stage by metrics. | +| [analysis-by-http](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-http) | Deployment pipeline with analysis stage by running http requests. | +| [analysis-by-log](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-by-log) | Deployment pipeline with analysis stage by checking logs. | +| [analysis-with-baseline](https://github.com/pipe-cd/examples/tree/master/kubernetes/analysis-with-baseline) | Deployment pipeline with analysis stage by comparing baseline and canary. | ### Terraform Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/terraform/simple) | TBA | -| [local-module](https://github.com/pipe-cd/examples/tree/master/terraform/local-module) | TBA | -| [remote-module](https://github.com/pipe-cd/examples/tree/master/terraform/remote-module) | TBA | -| [wait-approval](https://github.com/pipe-cd/examples/tree/master/terraform/wait-approval) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/terraform/simple) | Automatically applies when any changes were detected. | +| [local-module](https://github.com/pipe-cd/examples/tree/master/terraform/local-module) | Deploy application that using local terraform modules from the same Git repository. | +| [remote-module](https://github.com/pipe-cd/examples/tree/master/terraform/remote-module) | Deploy application that using remote terraform modules from other Git repositories. | +| [wait-approval](https://github.com/pipe-cd/examples/tree/master/terraform/wait-approval) | Deployment pipeline that contains a manual approval stage. | ### CloudRun Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/cloudrun/simple) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/cloudrun/canary) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/cloudrun/bluegreen) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/cloudrun/simple) | Quick sync by rolling out the new version and switching all traffic to it. | +| [canary](https://github.com/pipe-cd/examples/tree/master/cloudrun/canary) | Deployment pipeline with canary strategy. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/cloudrun/bluegreen) | Deployment pipeline with bluegreen strategy. | ### Lambda Applications | Name | Description | |-----------------------------------------------------------------------------|-------------| -| [simple](https://github.com/pipe-cd/examples/tree/master/lambda/simple) | TBA | -| [canary](https://github.com/pipe-cd/examples/tree/master/lambda/canary) | TBA | -| [bluegreen](https://github.com/pipe-cd/examples/tree/master/lambda/bluegreen) | TBA | +| [simple](https://github.com/pipe-cd/examples/tree/master/lambda/simple) | Quick sync by rolling out the new version and switching all traffic to it. | +| [canary](https://github.com/pipe-cd/examples/tree/master/lambda/canary) | Deployment pipeline with canary strategy. | +| [bluegreen](https://github.com/pipe-cd/examples/tree/master/lambda/bluegreen) | Deployment pipeline with bluegreen strategy. | + diff --git a/examples/cloudrun/bluegreen/.pipe.yaml b/examples/cloudrun/bluegreen/.pipe.yaml index 00e1725f3b..710b46fb7c 100644 --- a/examples/cloudrun/bluegreen/.pipe.yaml +++ b/examples/cloudrun/bluegreen/.pipe.yaml @@ -1,3 +1,4 @@ +# Deployment pipeline with bluegreen strategy. # https://cloud.google.com/run/docs/rollouts-rollbacks-traffic-migration apiVersion: pipecd.dev/v1beta1 kind: CloudRunApp diff --git a/examples/cloudrun/canary/.pipe.yaml b/examples/cloudrun/canary/.pipe.yaml index 5f6a37b9a7..a9054fa75f 100644 --- a/examples/cloudrun/canary/.pipe.yaml +++ b/examples/cloudrun/canary/.pipe.yaml @@ -1,3 +1,4 @@ +# Deployment pipeline with canary strategy. # https://cloud.google.com/run/docs/rollouts-rollbacks-traffic-migration apiVersion: pipecd.dev/v1beta1 kind: CloudRunApp diff --git a/examples/cloudrun/simple/.pipe.yaml b/examples/cloudrun/simple/.pipe.yaml index 5e89537f98..f97550b76e 100644 --- a/examples/cloudrun/simple/.pipe.yaml +++ b/examples/cloudrun/simple/.pipe.yaml @@ -1,3 +1,4 @@ +# Quick sync by rolling out the new version and switching all traffic to it. apiVersion: pipecd.dev/v1beta1 kind: CloudRunApp spec: diff --git a/examples/kubernetes/bluegreen/.pipe.yaml b/examples/kubernetes/bluegreen/.pipe.yaml index edd06db9d1..280a1efd0d 100644 --- a/examples/kubernetes/bluegreen/.pipe.yaml +++ b/examples/kubernetes/bluegreen/.pipe.yaml @@ -1,5 +1,4 @@ -# Pipeline for a Kubernetes application. -# This makes a progressive delivery with BlueGreen strategy. +# Deploy progressively with bluegreen stragegy. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: diff --git a/examples/kubernetes/canary-by-config-change/.pipe.yaml b/examples/kubernetes/canary-by-config-change/.pipe.yaml index d4d94133d7..8eebfcd6b8 100644 --- a/examples/kubernetes/canary-by-config-change/.pipe.yaml +++ b/examples/kubernetes/canary-by-config-change/.pipe.yaml @@ -1,4 +1,4 @@ -# Progressive delivery with canary strategy because of config change. +# Deploy progressively with canary strategy when ConfigMap was changed. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: diff --git a/examples/kubernetes/canary/.pipe.yaml b/examples/kubernetes/canary/.pipe.yaml index 84509a9b45..8c1227a872 100644 --- a/examples/kubernetes/canary/.pipe.yaml +++ b/examples/kubernetes/canary/.pipe.yaml @@ -1,9 +1,7 @@ -# Progressive delivery with canary strategy. +# Deploy progressively with canary stragegy. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: - commitMatcher: - sync: "^Revert" pipeline: stages: # Deploy the workloads of CANARY variant. In this case, the number of diff --git a/examples/kubernetes/helm-local-chart/.pipe.yaml b/examples/kubernetes/helm-local-chart/.pipe.yaml index 2e1797bfa1..f86791a26b 100644 --- a/examples/kubernetes/helm-local-chart/.pipe.yaml +++ b/examples/kubernetes/helm-local-chart/.pipe.yaml @@ -1,3 +1,5 @@ +# Deploy a helm chart sourced from the same Git repository +# without using pipeline. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: diff --git a/examples/kubernetes/helm-remote-chart/.pipe.yaml b/examples/kubernetes/helm-remote-chart/.pipe.yaml index 572c55efad..315b207206 100644 --- a/examples/kubernetes/helm-remote-chart/.pipe.yaml +++ b/examples/kubernetes/helm-remote-chart/.pipe.yaml @@ -1,8 +1,10 @@ +# Deploy a helm chart sourced from a Helm Chart Repository +# without using pipeline. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: input: - # Helm chart sourced from a Helm repository. + # Helm chart sourced from a Helm Chart Repository. helmChart: repository: pipecd name: helloworld diff --git a/examples/kubernetes/helm-remote-git-chart/.pipe.yaml b/examples/kubernetes/helm-remote-git-chart/.pipe.yaml index 6ea6454e5d..924e505c53 100644 --- a/examples/kubernetes/helm-remote-git-chart/.pipe.yaml +++ b/examples/kubernetes/helm-remote-git-chart/.pipe.yaml @@ -1,8 +1,10 @@ +# Deploy a helm chart sourced from another Git repository +# without using pipeline. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: input: - # Helm chart sourced from another Git repo. + # Helm chart sourced from another Git repository. helmChart: gitRemote: git@github.com:pipe-cd/manifests.git ref: v0.1.4-4-g7d11bc9 diff --git a/examples/kubernetes/kustomize-local-base/.pipe.yaml b/examples/kubernetes/kustomize-local-base/.pipe.yaml index 6e1f21eac5..1c6b16221c 100644 --- a/examples/kubernetes/kustomize-local-base/.pipe.yaml +++ b/examples/kubernetes/kustomize-local-base/.pipe.yaml @@ -1,5 +1,5 @@ -# This configures a non-progressive delivery. -# This means the new version is applied directly to PRIMARY variant. +# Deploy a kustomize package that just uses the local bases from the same Git repository +# without using pipeline. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: diff --git a/examples/kubernetes/kustomize-remote-base/.pipe.yaml b/examples/kubernetes/kustomize-remote-base/.pipe.yaml index 6e1f21eac5..48b56339ef 100644 --- a/examples/kubernetes/kustomize-remote-base/.pipe.yaml +++ b/examples/kubernetes/kustomize-remote-base/.pipe.yaml @@ -1,5 +1,5 @@ -# This configures a non-progressive delivery. -# This means the new version is applied directly to PRIMARY variant. +# Deploy a kustomize package that uses remote bases from other Git repositories +# without using pipeline. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: diff --git a/examples/kubernetes/mesh-envoy-bluegreen/.pipe.yaml b/examples/kubernetes/mesh-smi-bluegreen/.pipe.yaml similarity index 100% rename from examples/kubernetes/mesh-envoy-bluegreen/.pipe.yaml rename to examples/kubernetes/mesh-smi-bluegreen/.pipe.yaml diff --git a/examples/kubernetes/mesh-envoy-canary/.pipe.yaml b/examples/kubernetes/mesh-smi-canary/.pipe.yaml similarity index 100% rename from examples/kubernetes/mesh-envoy-canary/.pipe.yaml rename to examples/kubernetes/mesh-smi-canary/.pipe.yaml diff --git a/examples/kubernetes/simple/.pipe.yaml b/examples/kubernetes/simple/.pipe.yaml index e59ac56374..c0883d620c 100644 --- a/examples/kubernetes/simple/.pipe.yaml +++ b/examples/kubernetes/simple/.pipe.yaml @@ -1,5 +1,5 @@ -# This configures a non-progressive delivery. -# This means the new version is applied directly to PRIMARY variant. +# Deploy plain-yaml manifests in the application configuration directory +# without using pipeline. apiVersion: pipecd.dev/v1beta1 kind: KubernetesApp spec: diff --git a/examples/lambda/bluegreen/.pipe.yaml b/examples/lambda/bluegreen/.pipe.yaml index e2ea137566..fdf26e682c 100644 --- a/examples/lambda/bluegreen/.pipe.yaml +++ b/examples/lambda/bluegreen/.pipe.yaml @@ -1,3 +1,4 @@ +# Deployment pipeline with bluegreen strategy. # Using version, alias, additional version to do canary, bluegreen. # https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html apiVersion: pipecd.dev/v1beta1 diff --git a/examples/lambda/canary/.pipe.yaml b/examples/lambda/canary/.pipe.yaml index ed707a35e6..aa07eeaf75 100644 --- a/examples/lambda/canary/.pipe.yaml +++ b/examples/lambda/canary/.pipe.yaml @@ -1,3 +1,4 @@ +# Deployment pipeline with canary strategy. # Using version, alias, additional version to do canary, bluegreen. # https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html apiVersion: pipecd.dev/v1beta1 diff --git a/examples/lambda/simple/.pipe.yaml b/examples/lambda/simple/.pipe.yaml index e9a7972159..b3bfb4898e 100644 --- a/examples/lambda/simple/.pipe.yaml +++ b/examples/lambda/simple/.pipe.yaml @@ -1,3 +1,4 @@ +# Quick sync by rolling out the new version and switching all traffic to it. # https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html apiVersion: pipecd.dev/v1beta1 kind: LambdaApp diff --git a/examples/terraform/local-module/.pipe.yaml b/examples/terraform/local-module/.pipe.yaml index e69de29bb2..9a2f45a736 100644 --- a/examples/terraform/local-module/.pipe.yaml +++ b/examples/terraform/local-module/.pipe.yaml @@ -0,0 +1 @@ +# Deploy applicaiton that using local terraform models from the same Git repository. diff --git a/examples/terraform/remote-module/.pipe.yaml b/examples/terraform/remote-module/.pipe.yaml index e69de29bb2..afb767264b 100644 --- a/examples/terraform/remote-module/.pipe.yaml +++ b/examples/terraform/remote-module/.pipe.yaml @@ -0,0 +1 @@ +# Deploy application that using remote terraform modules from other Git repositories. diff --git a/examples/terraform/simple/.pipe.yaml b/examples/terraform/simple/.pipe.yaml index 26719e2582..c949646661 100644 --- a/examples/terraform/simple/.pipe.yaml +++ b/examples/terraform/simple/.pipe.yaml @@ -1,3 +1,4 @@ +# Automatically applies when any changes were detected. apiVersion: pipecd.dev/v1beta1 kind: TerraformApp spec: diff --git a/examples/terraform/waitapproval/.pipe.yaml b/examples/terraform/waitapproval/.pipe.yaml index 2ef417fda6..be888cdb26 100644 --- a/examples/terraform/waitapproval/.pipe.yaml +++ b/examples/terraform/waitapproval/.pipe.yaml @@ -1,3 +1,4 @@ +# Deployment pipeline that contains a manual approval stage. apiVersion: pipecd.dev/v1beta1 kind: TerraformApp spec: diff --git a/pkg/model/stage.go b/pkg/model/stage.go index 63ebadc409..f70d146498 100644 --- a/pkg/model/stage.go +++ b/pkg/model/stage.go @@ -60,7 +60,7 @@ const ( StageTerraformApply Stage = "TERRAFORM_APPLY" // StageCloudRunSync does quick sync by rolling out the new version - // and switch all trafic to them. + // and switching all trafic to it. StageCloudRunSync Stage = "CLOUDRUN_SYNC" // StageCloudRunCanaryRollout represents the state where // the workloads of the new version has been rolled out. @@ -70,7 +70,7 @@ const ( StageCloudRunTrafficRouting Stage = "CLOUDRUN_TRAFFIC_ROUTING" // StageLambdaSync does quick sync by rolling out the new version - // and switch all trafic to them. + // and switching all trafic to it. StageLambdaSync Stage = "LAMBDA_SYNC" // StageLambdaCanaryRollout represents the state where // the workloads of the new version has been rolled out.