pipe-cd · khanhtc1202 · Feb 27, 2023 · Feb 27, 2023 · Feb 27, 2023 · Feb 27, 2023
@@ -1,4 +1,4 @@
-tag: v0.41.4
+tag: v0.42.0
 
 releaseNoteGenerator:
   showCommitter: false

@@ -163,6 +163,10 @@ no = 'Sorry to hear that. Please <a href="https://github.com/pipe-cd/pipecd/issu
   githubbranch = "master"
   url = "/docs-dev/"
 
+[[params.versions]]
+  version = "v0.42.x"
+  url = "/docs-v0.42.x/"
+
 [[params.versions]]
   version = "v0.41.x"
   url = "/docs-v0.41.x/"

@@ -0,0 +1,59 @@
+---
+title: "Release v0.42.0"
+linkTitle: "Release v0.42.0"
+date: 2023-02-27
+description: >
+ Release v0.42.0
+---
+
+## Changes since v0.41.4
+
+### New Features
+
+* Add last use of api key on webui ([#4124](https://github.com/pipe-cd/pipecd/pull/4124))
+* Add pipectl deployment list ([#4182](https://github.com/pipe-cd/pipecd/pull/4182))
+* Add diff details with terraform dritf detection ([#4167](https://github.com/pipe-cd/pipecd/pull/4167))
+
+### Notable Changes
+
+* Support installing pipectl via asdf ([#4185](https://github.com/pipe-cd/pipecd/pull/4185))
+* Fix unable to delete resource that removed from git for k8s apps ([#4207](https://github.com/pipe-cd/pipecd/pull/4207))
+* Allow pipectl command to specify number of fetching applications ([#4189](https://github.com/pipe-cd/pipecd/pull/4189))
+* Support pipectl to list applications by Label. ([#4186](https://github.com/pipe-cd/pipecd/pull/4186))
+
+### Internal Changes
+
+* Release v0.42.0
+* Bump golang.org/x/oauth2 to v0.5.0 ([#4225](https://github.com/pipe-cd/pipecd/pull/4225))
+* Bump golang.org/x/net for vulnerable to request smuggling attack ([#4224](https://github.com/pipe-cd/pipecd/pull/4224))
+* Update api key list UI ([#4221](https://github.com/pipe-cd/pipecd/pull/4221))
+* Update runtime go version for tools ([#4222](https://github.com/pipe-cd/pipecd/pull/4222))
+* Bump golang.org/x/crypto ([#4219](https://github.com/pipe-cd/pipecd/pull/4219))
+* Small changes on refactor APIKeyLastUseCache get ([#4216](https://github.com/pipe-cd/pipecd/pull/4216))
+* Bump golang.org/x/net in /tool/actions-plan-preview ([#4218](https://github.com/pipe-cd/pipecd/pull/4218))
+* Bump golang.org/x/text from 0.3.7 to 0.3.8 ([#4217](https://github.com/pipe-cd/pipecd/pull/4217))
+* Add last used time cron updater ([#4201](https://github.com/pipe-cd/pipecd/pull/4201))
+* Display namespace of the resources on stage logs ([#4211](https://github.com/pipe-cd/pipecd/pull/4211))
+* Remove the old version docs ([#4209](https://github.com/pipe-cd/pipecd/pull/4209))
+* Update the contributions list ([#4210](https://github.com/pipe-cd/pipecd/pull/4210))
+* Fix error ([#4208](https://github.com/pipe-cd/pipecd/pull/4208))
+* Remove cloud-provider word in piped logs ([#4205](https://github.com/pipe-cd/pipecd/pull/4205))
+* Change diff detail's header ([#4199](https://github.com/pipe-cd/pipecd/pull/4199))
+* Missing go deps update ([#4200](https://github.com/pipe-cd/pipecd/pull/4200))
+* Revert SameSite cookie for SSO login ([#4195](https://github.com/pipe-cd/pipecd/pull/4195))
+* Update Lax to Strict for SameSite cookies ([#4191](https://github.com/pipe-cd/pipecd/pull/4191))
+* Bump github.com/prometheus/client_golang from 1.11.0 to 1.11.1 ([#4187](https://github.com/pipe-cd/pipecd/pull/4187))
+* Update release note for v0.41.0 ([#4184](https://github.com/pipe-cd/pipecd/pull/4184))
+* Update the interval for Terraform's drift detection ([#4181](https://github.com/pipe-cd/pipecd/pull/4181))
+* Make log view auto scroll to the end on log line added ([#4179](https://github.com/pipe-cd/pipecd/pull/4179))
+* Get deployment's stage logs from deployment-id ([#4158](https://github.com/pipe-cd/pipecd/pull/4158))
+* Make the deploying symbol rotate in reverse ([#4177](https://github.com/pipe-cd/pipecd/pull/4177))
+* Remove all generated go files before regenerating ([#4178](https://github.com/pipe-cd/pipecd/pull/4178))
+* Update file header - bash file ([#4176](https://github.com/pipe-cd/pipecd/pull/4176))
+* Enable to diagnose the performance for piped ([#4175](https://github.com/pipe-cd/pipecd/pull/4175))
+* Update file header ([#4173](https://github.com/pipe-cd/pipecd/pull/4173))
+* Modify terraform drift detection's diff detail ([#4170](https://github.com/pipe-cd/pipecd/pull/4170))
+* Add a new differential expression for drift detection ([#4168](https://github.com/pipe-cd/pipecd/pull/4168))
+* Bump github.com/emicklei/go-restful ([#4171](https://github.com/pipe-cd/pipecd/pull/4171))
+* Revise .env.example.env to .env.exapmle ([#4169](https://github.com/pipe-cd/pipecd/pull/4169))
+* Update contributor list ([#4165](https://github.com/pipe-cd/pipecd/pull/4165))
@@ -0,0 +1,5 @@
+---
+title: "Welcome to PipeCD"
+linkTitle: "Documentation [v0.42.x]"
+type: docs
+---
@@ -0,0 +1,75 @@
+---
+title: "Concepts"
+linkTitle: "Concepts"
+weight: 2
+description: >
+  This page describes several core concepts in PipeCD.
+---
+
+![](/images/architecture-overview.png)
+<p style="text-align: center;">
+Component Architecture
+</p>
+
+### Piped
+
+`piped` is a single binary component you run as an agent in your cluster, your local network to handle the deployment tasks.
+It can be run inside a Kubernetes cluster by simply starting a Pod or a Deployment.
+This component is designed to be stateless, so it can also be run in a single VM or even your local machine.
+
+### Control Plane
+
+A centralized component managing deployment data and provides gPRC API for connecting `piped`s as well as all web-functionalities of PipeCD such as
+authentication, showing deployment list/details, application list/details, delivery insights...
+
+### Project
+
+A project is a logical group of applications to be managed by a group of users.
+Each project can have multiple `piped` instances from different clouds or environments.
+
+There are three types of project roles:
+
+- **Viewer** has only permissions of viewing to deployment and application in the project.
+- **Editor** has all viewer permissions, plus permissions for actions that modify state such as manually trigger/cancel the deployment.
+- **Admin** has all editor permissions, plus permissions for managing project data, managing project `piped`.
+
+### Application
+
+A collect of resources (containers, services, infrastructure components...) and configurations that are managed together.
+PipeCD supports multiple kinds of applications such as `KUBERNETES`, `TERRAFORM`, `ECS`, `CLOUDRUN`, `LAMBDA`...
+
+### Application Configuration
+
+A YAML file that contains information to define and configure application.
+Each application requires one file at application directory stored in the Git repository.
+The default file name is `app.pipecd.yaml`.
+
+### Application Directory
+
+A directory in Git repository containing application configuration file and application manifests.
+Each application must have one application directory.
+
+### Deployment
+
+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 being synced with the desired state specified in the target commit.
+
+### Sync Strategy
+
+There are 3 strategies that PipeCD supports while syncing your application state with its configuration stored in Git. Which are:
+- Quick Sync: a fast way to make the running application state as same as its Git stored configuration. The generated pipeline contains only one predefined `SYNC` stage.
+- Pipeline Sync: sync the running application state with its Git stored configuration through a pipeline defined in its application configuration.
+- Auto Sync: depends on your defined application configuration, `piped` will decide the best way to sync your application state with its Git stored configuration.
+
+### Platform Provider
+
+Note: The previous name of this concept was Cloud Provider.
+
+PipeCD supports multiple platforms and multiple kinds of applications.
+Platform Provider defines which platform, cloud and where application should be deployed to.
+
+Currently, PipeCD is supporting these five platform providers: `KUBERNETES`, `ECS`, `TERRAFORM`, `CLOUDRUN`, `LAMBDA`.
+
+### Analysis Provider
+An external product that provides metrics/logs to evaluate deployments, such as `Prometheus`, `Datadog`, `Stackdriver`, `CloudWatch` and so on.
+It is mainly used in the [Automated deployment analysis](../user-guide/managing-application/customizing-deployment/automated-deployment-analysis/) context.
@@ -0,0 +1,7 @@
+---
+title: "Contributor Guide"
+linkTitle: "Contributor Guide"
+weight: 6
+description: >
+  This guide is for anyone who want to contribute to PipeCD project. We are so excited to have you!
+---
@@ -0,0 +1,36 @@
+---
+title: "Architectural overview"
+linkTitle: "Architectural overview"
+weight: 3
+description: >
+  This page describes the architecture of PipeCD.
+---
+
+![](/images/architecture-overview.png)
+<p style="text-align: center;">
+Component Architecture
+</p>
+
+### Piped
+
+A single binary component runs in your cluster, your local network to handle the deployment tasks.
+It can be run inside a Kubernetes cluster by simply starting a Pod or a Deployment.
+This component is designed to be stateless, so it can also be run in a single VM or even your local machine.
+
+### Control Plane
+
+A centralized component manages deployment data and provides gPRC API for connecting `piped`s as well as all web-functionalities of PipeCD such as
+authentication, showing deployment list/details, application list/details, delivery insights...
+
+Control Plane contains the following components:
+- `server`: a service to provide api for piped, web and serve static assets for web.
+- `ops`: a service to provide administrative features for Control Plane owner like adding/managing projects.
+- `cache`: a redis cache service for caching internal data.
+- `datastore`: data storage for storing deployment, application data
+  - this can be a fully-managed service such as `Firestore`, `Cloud SQL`...
+  - or a self-managed such as `MySQL`
+- `filestore`: file storage for storing logs, application states
+  - this can a fully-managed service such as `GCS`, `S3`...
+  - or a self-managed service such as `Minio`
+
+For more information, see [Architecture overview of Control Plane](../../user-guide/managing-controlplane/architecture-overview/).
@@ -0,0 +1,33 @@
+---
+title: "Contributing"
+linkTitle: "Contributing"
+weight: 1
+description: >
+  This page describes how to contribute to PipeCD.
+---
+
+PipeCD is an open source project that anyone in the community can use, improve, and enjoy. We'd love you to join us! 
+
+## Contributor License Agreement
+
+Contributions to this project must be accompanied by a Contributor License Agreement ("CLA") described at [pipe-cd/pipecd/master/CLA.md](https://github.com/pipe-cd/pipecd/blob/master/CLA.md). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.
+
+You generally only need to sign a CLA once, so if you've already signed one, you probably don't need to do it again.
+
+In case you have not signed yet, [pipecd-bot](https://github.com/pipecd-bot) will guide you to sign the CLA _when you send the first pull request to [pipe-cd/pipecd](https://github.com/pipe-cd/pipecd) repository_.
+
+## Creating an issue
+
+If you've found a problem, please create an issue in the [pipe-cd/pipecd](https://github.com/pipe-cd/pipecd/issues) repository.
+
+## Creating a pull request
+
+Look at our [help wanted issues](https://github.com/pipe-cd/pipecd/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") or our [good first issues](https://github.com/pipe-cd/pipecd/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") for finding some good issues for your first pull request.
+
+### Small tips
+
+The pull request title is used to generate our release changelog. Therefore, it would be great if you write the title that is easier to understand from the user's point of view.
+
+## Code reviews
+
+All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) for more information on using pull requests.
@@ -0,0 +1,94 @@
+---
+title: "Development"
+linkTitle: "Development"
+weight: 2
+description: >
+  This page describes how to build, test PipeCD source code at your local environment.
+---
+
+## Prerequisites
+
+- [Go 1.19](https://go.dev/)
+- [Docker](https://www.docker.com/)
+- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) (If you want to run Control Plane locally)
+- [helm 3.8](https://helm.sh/docs/intro/install/) (If you want to run Control Plane locally)
+
+## Repositories
+- [pipecd](https://github.com/pipe-cd/pipecd): contains all source code and documentation of PipeCD project.
+- [examples](https://github.com/pipe-cd/examples): contains various generated examples to demonstrate how to use PipeCD.
+
+## Commands
+
+- `make build/go`: builds all go modules including pipecd, piped, pipectl.
+- `make build/web`: builds the static files for web.
+
+- `make test/go`: runs all unit tests of go modules.
+- `make test/web`: runs all unit tests of web.
+- `make test/integration`: runs integration tests.
+
+- `make run/piped`: runs Piped locally (for more information, see [here](#how-to-run-piped-agent-locally)).
+- `make run/site`: runs PipeCD site locally (requires [hugo](https://github.com/gohugoio/hugo) with `_extended` version `0.92.1` or later to be installed).
+
+- `make gen/code`: generate Go and Typescript code from protos and mock configs. You need to run it if you modified any proto or mock definition files.
+
+For the full list of available commands, please see the Makefile at the root of repository.
+
+## How to run Control Plane locally
+
+1. Start running a Kubernetes cluster
+
+    ``` console
+    make kind-up
+    ```
+
+    Once it is no longer used, run `make kind-down` to delete it.
+
+2. Install Control Plane into the local cluster
+
+    ``` console
+    make run/pipecd
+    ```
+
+    Once all components are running up, use `kubectl port-forward` to expose the installed Control Plane on your localhost:
+
+    ``` console
+    kubectl -n pipecd port-forward svc/pipecd 8080
+    ```
+
+3. Access to the local Control Plane web console
+
+    Point your web browser to [http://localhost:8080](http://localhost:8080) to login with the configured static admin account: project = `quickstart`, username = `hello-pipecd`, password = `hello-pipecd`.
+
+## How to run Piped agent locally
+
+1. Prepare the piped configuration file `piped-config.yaml`
+
+2. Ensure that your `kube-context` is connecting to the right kubernetes cluster
+
+3. Run the following command to start running `piped` (if you want to connect Piped to a locally running Control Plane, add `INSECURE=true` option)
+
+    ``` console
+    make run/piped CONFIG_FILE=piped-config.yaml
+    ```
+
+## Docs and workaround with docs
+
+PipeCD official site contains multiple versions of documentation, all placed under the `/docs/content/en` directory, which are:
+- `/docs`: stable version docs, usually synced with the latest released version docs.
+- `/docs-dev`: experimental version docs, contains docs for not yet released features or changes.
+- `/docs-v0.x.x`: contains docs for specified version family (a version family is all versions which in the same major release).
+
+Basically, we have two simple rules:
+- Do not touch to the `/docs` content directly.
+- Keep stable docs version synced with the latest released docs version.
+
+Here are the flow of docs contribution regard some known scenarios:
+1. Update docs that are related to a specified version (which is not the latest released version):
+In such case, update the docs under `/docs-v0.x.x` is enough.
+2. Update docs for not yet released features or changes:
+In such case, update the docs under `/docs-dev` is enough.
+3. Update docs that are related to the latest released docs version:
+- Change the docs' content that fixes the issue under `/docs-dev` and `/docs-v0.x.x`, they share the same file structure so you should find the right files in both directories.
+- Use `make gen/stable-docs` command to sync the latest released version docs under `/docs-v0.x.x` to `/docs`
+
+If you find any issues related to the docs, we're happy to accept your help.