Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
* Update controlplane overview Grafana dashboad (#4898)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Support PipelineSync on OUT_OF_SYNC (#4892)

* Support PipelineSync on OUT_OF_SYNC

Signed-off-by: golemiso <3282656+golemiso@users.noreply.github.com>

* apply same fix to pipedv1

Signed-off-by: golemiso <3282656+golemiso@users.noreply.github.com>

---------

Signed-off-by: golemiso <3282656+golemiso@users.noreply.github.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Remove decrecated template (#4901)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* [doc] Added note that Canary or Blue/Green for ECS Service Connect is not supported yet (#4900)

* Add NOTE of not supporting Canary,Blue/Green with ECS Service Connect

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add NOTE of not supporting Canary,Blue/Green with ECS Service Connect: older versions

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add 'yet'

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Add new adopter (#4897)

Signed-off-by: yutsuki miyashita <yutsukimiya@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Update _index.md (#4893)

* [doc] Added note that Canary or Blue/Green for ECS Service Connect is not supported yet (#4900)

* Add NOTE of not supporting Canary,Blue/Green with ECS Service Connect

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add NOTE of not supporting Canary,Blue/Green with ECS Service Connect: older versions

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add 'yet'

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: Andrew Anderson <andy@clubanderson.com>

* updates to all versions of index

Signed-off-by: Andrew Anderson <andy@clubanderson.com>

* updates to all versions of index

Signed-off-by: Andrew Anderson <andy@clubanderson.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: Andrew Anderson <andy@clubanderson.com>
Co-authored-by: Tetsuya Kikuchi <97105818+t-kikuc@users.noreply.github.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* [blog] Fix links (#4904)

* Fix links

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix links: control-plane-on-ecs.md

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix links: remove domain

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

---------

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>
Signed-off-by: golemiso <3282656+golemiso@users.noreply.github.com>
Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: yutsuki miyashita <yutsukimiya@gmail.com>
Signed-off-by: Andrew Anderson <andy@clubanderson.com>
Co-authored-by: golemiso <3282656+golemiso@users.noreply.github.com>
Co-authored-by: Yoshiki Fujikane <40124947+ffjlabo@users.noreply.github.com>
Co-authored-by: Tetsuya Kikuchi <97105818+t-kikuc@users.noreply.github.com>
Co-authored-by: yutsuki miyashita <yutsukimiya@gmail.com>
Co-authored-by: Andy Anderson <andy@clubanderson.com>
  • Loading branch information
6 people committed May 13, 2024
1 parent 9b13636 commit ee2011f
Show file tree
Hide file tree
Showing 22 changed files with 301 additions and 167 deletions.
1 change: 1 addition & 0 deletions ADOPTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ This list is arranged in the order of organizations being added to it.

| Organization | Contact | Description of Use |
| --- | --- | --- |
| [Canary Inc.](https://corp.canary-app.jp/) | @mytheta | We are deploying microservices on Kubernetes using PipeCD. |
| [PITS Global Data Recovery Services](https://www.pitsdatarecovery.net/) | @benjx1990 | PipeCD provides an easy-to-use interface and reliable solutions for CI. |
| [CyberAgent, Inc.](https://www.cyberagent.co.jp/) | @kentakozuka | PipeCD is used as an internal CD infrastructure, supporting over 20 projects. About 80 active piped agents are deploying about 2,900 applications in all dev, staging, and production environments. |
5 changes: 2 additions & 3 deletions docs/content/en/blog/control-plane-local-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "This blog shows you how to install a PipeCD Control Plane on local
author: Tetsuya Kikuchi ([@t-kikuc](https://github.com/t-kikuc))
---

Currently, you can deploy and operate a PipeCD Control Plane on a Kubernetes cluster or [on Amazon ECS](./control-plane-on-ecs.md).
Currently, you can deploy and operate a PipeCD Control Plane on a Kubernetes cluster or [on Amazon ECS](/blog/2023/02/07/pipecd-best-practice-02-control-plane-on-ecs/).
However, some developers would like to build a Control Plane more easily for introduction or development.
This blog shows you how to install a PipeCD Control Plane on local machine easily.

Expand All @@ -19,8 +19,7 @@ This blog is for those who would like to:
The general architecture of PipeCD Control Plane is as below.
![](/images/control-plane-components.png)

> Note: See [Architecture Overview](docs/user-guide/managing-controlplane/architecture-overview/) doc for details.
> Note: See [Architecture Overview](/docs/user-guide/managing-controlplane/architecture-overview/) doc for details.
In this blog, you will build a Control Plane by these containers:

- Server: pipecd server
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/blog/control-plane-on-ecs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This blog is a part of PipeCD best practice series, a guideline for you to opera
Currently, you can deploy and operate the PipeCD control plane on a Kubernetes cluster easily, but some developers that would like to introduce PipeCD can not prepare Kubernetes environments. If you have the same problem, this blog is for you. We will show you how to deploy the PipeCD control plane on Amazon ECS.

### Architecture
> Note: Please refer to [architecture-overview](docs/user-guide/managing-controlplane/architecture-overview/) docs for definitions of PipeCD components such as server, ops, cache, datastore and filestore.
> Note: Please refer to [architecture-overview](/docs/user-guide/managing-controlplane/architecture-overview/) docs for definitions of PipeCD components such as server, ops, cache, datastore and filestore.
![](/images/control-plane-on-ecs.png)

Expand Down
10 changes: 5 additions & 5 deletions docs/content/en/docs-dev/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,15 @@ We can simply use __pipectl quickstart__ command to start the PipeCD installatio
pipectl quickstart --version {{< blocks/latest_version >}}
```

Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically on your browser.
Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically in your browser.

To login, you can use the configured static admin account as below:
- username: `hello-pipecd`
- password: `hello-pipecd`

![](/images/quickstart-login-form.png)

After logged in successfully, the browser will redirect you to the PipeCD console settings page at `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).
After successfully logging in, the browser will redirect you to the PipeCD console settings page at the `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).

![](/images/quickstart-adding-piped.png)

Expand All @@ -94,15 +94,15 @@ GitRemoteRepo: https://github.com/{FORKED_GITHUB_ORG}/examples.git

That's all!

Note: The __pipectl quickstart__ command will keep running to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command
Note: The __pipectl quickstart__ command will run continuously to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not be lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command

```console
kubectl -n pipecd port-forward svc/pipecd 8080
```

### 2. Deploy a kubernetes application with PipeCD

Above are all we need to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.
Above is all that is necessary to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.

#### 2.1. Registering a Kubernetes application
Navigate to the `Applications` page, click on the `+ADD` button on the top left corner.
Expand All @@ -115,7 +115,7 @@ You should see a lot of suggested applications. Select the `canary` application

![](/images/quickstart-adding-application-from-suggestions.png)

After a bit, the first deployment would be complete automatically to sync the application to the state specified in the current Git commit.
After a bit, the first deployment is complete and will automatically sync the application to the state specified in the current Git commit.

![](/images/quickstart-first-deployment.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ spec:
## NOTE
- When you use an ELB for deployments, all listener rules that have the same target groups as configured in app.pipecd.yaml will be controlled.
- For more information and diagrams, see [Issue#4733 [ECS] Modify ELB listener rules other than defaults without adding config](https://github.com/pipe-cd/pipecd/pull/4733).
- For more information and diagrams, see [Issue#4733 [ECS] Modify ELB listener rules other than defaults without adding config](https://github.com/pipe-cd/pipecd/pull/4733).
- When you use [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html), you cannot use Canary or Blue/Green deployment yet because Service Connect does not support the external deployment yet.
## Reference
Expand Down
10 changes: 5 additions & 5 deletions docs/content/en/docs-v0.39.x/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ We can simply use __pipectl quickstart__ command to start the PipeCD installatio
pipectl quickstart --version {{< blocks/latest_version >}}
```

Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically on your browser.
Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically in your browser.

To login, you can use the configured static admin account as below:
- username: `hello-pipecd`
- password: `hello-pipecd`

![](/images/quickstart-login-form.png)

After logged in successfully, the browser will redirect you to the PipeCD console settings page at `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).
After successfully logging in, the browser will redirect you to the PipeCD console settings page at the `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).

![](/images/quickstart-adding-piped.png)

Expand All @@ -75,15 +75,15 @@ GitRemoteRepo: https://github.com/{FORKED_GITHUB_ORG}/examples.git

That's all!

Note: The __pipectl quickstart__ command will keep running to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command
Note: The __pipectl quickstart__ command will run continuously to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not be lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command

```console
kubectl -n pipecd port-forward svc/pipecd 8080
```

### 2. Deploy a kubernetes application with PipeCD

Above are all we need to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.
Above is all that is necessary to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.

#### 2.1. Registering a Kubernetes application
Navigate to the `Applications` page, click on the `+ADD` button on the top left corner.
Expand All @@ -96,7 +96,7 @@ You should see a lot of suggested applications. Select the `canary` application

![](/images/quickstart-adding-application-from-suggestions.png)

After a bit, the first deployment would be complete automatically to sync the application to the state specified in the current Git commit.
After a bit, the first deployment is complete and will automatically sync the application to the state specified in the current Git commit.

![](/images/quickstart-first-deployment.png)

Expand Down
10 changes: 5 additions & 5 deletions docs/content/en/docs-v0.40.x/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ We can simply use __pipectl quickstart__ command to start the PipeCD installatio
pipectl quickstart --version {{< blocks/latest_version >}}
```

Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically on your browser.
Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically in your browser.

To login, you can use the configured static admin account as below:
- username: `hello-pipecd`
- password: `hello-pipecd`

![](/images/quickstart-login-form.png)

After logged in successfully, the browser will redirect you to the PipeCD console settings page at `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).
After successfully logging in, the browser will redirect you to the PipeCD console settings page at the `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).

![](/images/quickstart-adding-piped.png)

Expand All @@ -75,15 +75,15 @@ GitRemoteRepo: https://github.com/{FORKED_GITHUB_ORG}/examples.git

That's all!

Note: The __pipectl quickstart__ command will keep running to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command
Note: The __pipectl quickstart__ command will run continuously to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not be lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command

```console
kubectl -n pipecd port-forward svc/pipecd 8080
```

### 2. Deploy a kubernetes application with PipeCD

Above are all we need to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.
Above is all that is necessary to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.

#### 2.1. Registering a Kubernetes application
Navigate to the `Applications` page, click on the `+ADD` button on the top left corner.
Expand All @@ -96,7 +96,7 @@ You should see a lot of suggested applications. Select the `canary` application

![](/images/quickstart-adding-application-from-suggestions.png)

After a bit, the first deployment would be complete automatically to sync the application to the state specified in the current Git commit.
After a bit, the first deployment is complete and will automatically sync the application to the state specified in the current Git commit.

![](/images/quickstart-first-deployment.png)

Expand Down
10 changes: 5 additions & 5 deletions docs/content/en/docs-v0.41.x/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ We can simply use __pipectl quickstart__ command to start the PipeCD installatio
pipectl quickstart --version {{< blocks/latest_version >}}
```

Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically on your browser.
Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically in your browser.

To login, you can use the configured static admin account as below:
- username: `hello-pipecd`
- password: `hello-pipecd`

![](/images/quickstart-login-form.png)

After logged in successfully, the browser will redirect you to the PipeCD console settings page at `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).
After successfully logging in, the browser will redirect you to the PipeCD console settings page at the `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).

![](/images/quickstart-adding-piped.png)

Expand All @@ -75,15 +75,15 @@ GitRemoteRepo: https://github.com/{FORKED_GITHUB_ORG}/examples.git

That's all!

Note: The __pipectl quickstart__ command will keep running to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command
Note: The __pipectl quickstart__ command will run continuously to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not be lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command

```console
kubectl -n pipecd port-forward svc/pipecd 8080
```

### 2. Deploy a kubernetes application with PipeCD

Above are all we need to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.
Above is all that is necessary to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.

#### 2.1. Registering a Kubernetes application
Navigate to the `Applications` page, click on the `+ADD` button on the top left corner.
Expand All @@ -96,7 +96,7 @@ You should see a lot of suggested applications. Select the `canary` application

![](/images/quickstart-adding-application-from-suggestions.png)

After a bit, the first deployment would be complete automatically to sync the application to the state specified in the current Git commit.
After a bit, the first deployment is complete and will automatically sync the application to the state specified in the current Git commit.

![](/images/quickstart-first-deployment.png)

Expand Down
10 changes: 5 additions & 5 deletions docs/content/en/docs-v0.42.x/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ We can simply use __pipectl quickstart__ command to start the PipeCD installatio
pipectl quickstart --version {{< blocks/latest_version >}}
```

Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically on your browser.
Follow the instruction, the PipeCD control plane will be installed with a default project named `quickstart`. You can access to the PipeCD console at [http://localhost:8080](http://localhost:8080?project=quickstart) and pipectl command will open the PipeCD console automatically in your browser.

To login, you can use the configured static admin account as below:
- username: `hello-pipecd`
- password: `hello-pipecd`

![](/images/quickstart-login-form.png)

After logged in successfully, the browser will redirect you to the PipeCD console settings page at `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).
After successfully logging in, the browser will redirect you to the PipeCD console settings page at the `piped` settings tab. You will find the `+ADD` button on the top of this page, click there and insert information to register the deployment runner for PipeCD (called `piped`).

![](/images/quickstart-adding-piped.png)

Expand All @@ -82,15 +82,15 @@ GitRemoteRepo: https://github.com/{FORKED_GITHUB_ORG}/examples.git

That's all!

Note: The __pipectl quickstart__ command will keep running to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command
Note: The __pipectl quickstart__ command will run continuously to expose your PipeCD console on `localhost:8080`. If you stop the process, the installed PipeCD components will not be lost, you can access to the PipeCD console anytime using __kubectl port-forward__ command

```console
kubectl -n pipecd port-forward svc/pipecd 8080
```

### 2. Deploy a kubernetes application with PipeCD

Above are all we need to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.
Above is all that is necessary to set up your own PipeCD (both control plane and agent), let's use the installed one to deploy your first Kubernetes application with PipeCD.

#### 2.1. Registering a Kubernetes application
Navigate to the `Applications` page, click on the `+ADD` button on the top left corner.
Expand All @@ -103,7 +103,7 @@ You should see a lot of suggested applications. Select the `canary` application

![](/images/quickstart-adding-application-from-suggestions.png)

After a bit, the first deployment would be complete automatically to sync the application to the state specified in the current Git commit.
After a bit, the first deployment is complete and will automatically sync the application to the state specified in the current Git commit.

![](/images/quickstart-first-deployment.png)

Expand Down
Loading

0 comments on commit ee2011f

Please sign in to comment.