Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the layout of configuring-application docs #621

Merged
merged 1 commit into from
Aug 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/content/en/docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,17 @@ PipeCD supports multiple kinds of applications such as `KUBERNETES`, `TERRAFORM`
### Environment

An environment is a logical group of applications of a project. A project can have multiple environments.
Each application/piped must belong to one and only one enviroment.
Each application must belong to one and only one enviroment. While each piped must belong to at least one environment.

### Deployment

Deployment is a process that does transition from the current state (running state) to the desired state (specified state in Git) of a specific application.
A deployment is a process that does transition from the current state (running state) to the desired state (specified state in Git) of a specific application.
When the deployment is success, it means the running state is synced with the desired state specified in the target commit.

### Deployment Configuration

A `.pipe.yaml` yaml file that contains configuration data to define how to deploy the application.
Each application has one deployment configuration file in Git repository at application directory.
Each application requires one deployment configuration file at application directory in the Git repository.

### Application Configuration Directory

Expand All @@ -55,11 +55,15 @@ Each application must has one application configuration directory.

### Quick Sync

Quick sync is a fast way to sync application to the state specified in a Git commit without any progressive strategy or manual approving. Its pipeline contains just only one `SYNC` stage. For examples:
Quick sync is a fast way to sync application to the state specified in a Git commit without any progressive strategy or manual approving. Its pipeline contains just only one predefined `SYNC` stage. For examples:
- quick sync a Kubernetes application is just applying all manifests
- quick sync a Terraform application is automatically applying all detected changes
- quick sync a CloudRun/Lambda application is rolling out the new version and routing all traffic to it

### Pipeline

A list of stages specified by user in the deployment configuration file that tells `piped` how the application should be deployed. When the pipeline was not specified, the application will be deployed by Quick Sync way.

### Stage

A temporary middle state between current state and desired state of a deployment process.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "CloudRun"
linkTitle: "CloudRun"
weight: 3
description: >
Specific guide for configuring CloudRun applications.
---

> TBA

## Quick Sync

> TBA

## Sync with Specified Pipeline

### Canary

> TBA

### BlueGreen

> TBA

## Reference

Checkout [Configuration Reference](/docs/user-guide/configuration-reference/#cloudrun-application) to see full configuration.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: "Kubernetes"
linkTitle: "Kubernetes"
weight: 1
description: >
Specific guide for configuring Kubernetes applications.
---

> TBA

## Quick Sync

``` yaml
apiVersion: pipecd.dev/v1beta1
kind: Kubernetes
spec:
input:
helmChart:
repository: pipecd
name: helloworld
version: v0.3.0
```

## Sync with Specified Pipeline

Each Kubernetes application can has 3 variants: primary (aka stable), baseline, canary.
- `primary` runs the current version of code and configuration.
- `baseline` runs the same version of code and configuration as the primary variant. (Creating a brand new baseline workload ensures that the metrics produced are free of any effects caused by long-running processes.)
- `canary` runs the proposed changed of code or configuration.


Kubernetes Stages:

- `K8S_PRIMARY_ROLLOUT`
- `K8S_CANARY_ROLLOUT`
- `K8S_CANARY_CLEAN`
- `K8S_BASELINE_ROLLOUT`
- `K8S_BASELINE_CLEAN`
- `K8S_TRAFFIC_ROUTING`

Common Stages:
- `WAIT`
- `WAIT_APPROVAL`
- `ANALYSIS`


### Canary

> TBA

Canary deployment for a non-mesh Kubernetes application is done by manipulating pod selector in the Service resource.

### Canary with Istio

> TBA

### Canary with SMI

> TBA

### BlueGreen

> TBA

### BlueGreen with Istio

> TBA

### BlueGreen with SMI

> TBA

## Manifest Templating

> TBA

### Plain YAML

> TBA

### Helm

> TBA

### Kustomize

> TBA

## Reference

Go to [Configuration Reference](/docs/user-guide/configuration-reference/#kubernetes-application) to see the full configuration.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Lambda"
linkTitle: "Lambda"
weight: 4
description: >
Specific guide for configuring Lambda applications.
---

> TBA

## Quick Sync

> TBA

## Sync with Specified Pipeline

### Canary

> TBA

### BlueGreen

> TBA

## Reference

Checkout [Configuration Reference](/docs/user-guide/configuration-reference/#lambda-application) to see full configuration.
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Terraform"
linkTitle: "Terraform"
weight: 2
description: >
Specific guide for configurating Terraform applications.
---

> TBA

## Quick Sync

> TBA

## Sync with Specified Pipeline

> TBA

## Chart location

## Reference

Go to [Configuration Reference](/docs/user-guide/configuration-reference/#terraform-application) to see the full configuration.

This file was deleted.