Skip to content

Commit ee007ee

Browse files
mohammedfirdoussmohammedfirdouss
authored
Merge branch 'master' into dependabot/go_modules/tool/actions-plan-preview/golang.org/x/crypto-0.52.0
2 parents 1a6cccc + ab83eaf commit ee007ee

3 files changed

Lines changed: 119 additions & 107 deletions

File tree

‎.github/workflows/first-time-contributor.yaml‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,15 @@ jobs:
2020
const prAuthor = context.payload.pull_request.user.login;
2121
const prNumber = context.payload.pull_request.number;
2222
23-
// List PRs created by this user in this repo
24-
const { data: pulls } = await github.rest.pulls.list({
25-
owner,
26-
repo,
27-
state: "all",
28-
creator: prAuthor,
23+
// Search PRs created by this user in this repo
24+
const query = `repo:${owner}/${repo} type:pr author:${prAuthor}`;
25+
const { data: result } = await github.request("GET /search/issues", {
26+
q: query,
2927
per_page: 2,
3028
});
3129
3230
// If more than one PR exists, this is not the first one
33-
if (pulls.length > 1) {
31+
if (result.total_count > 1) {
3432
console.log(`User ${prAuthor} is not a first-time contributor.`);
3533
return;
3634
}

‎docs/content/en/docs-dev/quickstart/_index.md‎

Lines changed: 57 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -6,119 +6,126 @@ description: >
66
This page describes how to quickly get started with PipeCD on Kubernetes.
77
---
88

9-
PipeCD is constructed by two components: the Control plane and the piped (agent) (ref: [PipeCD concepts](../concepts/)). The control plane can be thought of as a regular web service application that can be installed anywhere, while the piped agent is a single binary that can run as a pod in a Kubernetes cluster, a container on ECS, a serverless function like Lambda, Cloud Run, or a process running directly on your local machine.
9+
PipeCD consists of two components: the Control Plane and the piped agent (see [PipeCD concepts](../concepts/)). The Control Plane is a regular web service application that can be installed anywhere, while the piped agent is a single binary that can run as a pod in a Kubernetes cluster, a container on ECS, a serverless function on Lambda or Cloud Run, or a process running directly on your local machine.
1010

11-
This page is a guideline for installing PipeCD (both two components) into your Kubernetes cluster and deploying a "hello world" application to that same Kubernetes cluster.
11+
This page walks you through installing both components into your Kubernetes cluster and deploying a "hello world" application to that same Kubernetes cluster.
1212

13-
Note:
14-
15-
- It's not required to install the PipeCD control plane to the cluster where your applications are running. Please read this [blog post](/blog/2021/12/29/pipecd-best-practice-01-operate-your-own-pipecd-cluster/) to understand more about PipeCD in real life use cases.
16-
- If you want to experiment with PipeCD freely or don't have a Kubernetes cluster, we recommend [this Tutorial](https://github.com/pipe-cd/tutorial).
13+
> **Note:**
14+
> - You don't need to install the PipeCD Control Plane on the cluster where your applications are running. See this [blog post](/blog/2021/12/29/pipecd-best-practice-01-operate-your-own-pipecd-cluster/) to understand how PipeCD is operated in real life use cases.
15+
> - If you want to experiment with PipeCD freely or don't have a Kubernetes cluster, we recommend [this Tutorial](https://github.com/pipe-cd/tutorial).
1716
1817
### Prerequisites
19-
- Having a Kubernetes cluster and connect to it via [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
18+
- A running Kubernetes cluster, such as [minikube](https://minikube.sigs.k8s.io/docs/start/) or [kind](https://kind.sigs.k8s.io/docs/user/quick-start/).
19+
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed and connected to the cluster.
2020

2121
### 1. Installing PipeCD in quickstart mode
2222

23-
Across the [PipeCD concepts](/docs/concepts/), PipeCD platform is constructed by 2 components: Control Plane and Piped (the agent).
24-
2523
#### 1.1. Installing PipeCD Control Plane
2624

27-
```console
28-
$ kubectl create namespace pipecd
29-
$ kubectl apply -n pipecd -f https://raw.githubusercontent.com/pipe-cd/pipecd/master/quickstart/manifests/control-plane.yaml
25+
```bash
26+
kubectl create namespace pipecd
27+
kubectl apply -n pipecd -f https://raw.githubusercontent.com/pipe-cd/pipecd/master/quickstart/manifests/control-plane.yaml
3028
```
3129

32-
The PipeCD control plane will be installed with a default project named `quickstart`. To access the PipeCD Control Plane UI, run the following command
30+
The Control Plane pods pull their container images on the first run, which can take a few minutes. Wait until all pods are `1/1 Running` with `kubectl get pod -n pipecd`.
31+
32+
The PipeCD Control Plane is installed with a default project named `quickstart`. To access the PipeCD console, run:
3333

34-
```console
35-
$ kubectl port-forward -n pipecd svc/pipecd 8080
34+
```bash
35+
kubectl port-forward -n pipecd svc/pipecd 8080
3636
```
3737

38-
You can access the PipeCD console at [http://localhost:8080?project=quickstart](http://localhost:8080?project=quickstart)
38+
You can access the PipeCD console at [http://localhost:8080?project=quickstart](http://localhost:8080?project=quickstart).
3939

4040
For this quickstart setup, the project name is fixed to `quickstart`. If you open `http://localhost:8080` directly, enter `quickstart` on the login screen.
4141

42-
To login, you can use the configured static admin account as below:
43-
- username: `hello-pipecd`
44-
- password: `hello-pipecd`
42+
To log in, use the configured static admin account:
43+
- **username**: `hello-pipecd`
44+
- **password**: `hello-pipecd`
4545

46-
And you will access the main page of PipeCD Control Plane console, which looks like this
46+
After logging in, you will see the main page of the PipeCD console, which looks like this:
4747

4848
![](/images/pipecd-control-plane-mainpage.png)
4949

50-
For more about PipeCD control plane management, please check [Managing Control Plane](/docs/user-guide/managing-controlplane/).
50+
For more about PipeCD Control Plane management, see [Managing Control Plane](../user-guide/managing-controlplane/).
5151

5252
#### 1.2. Installing Piped
5353

54-
Next, in order to perform CD tasks, you need to install a Piped agent to the cluster.
54+
Next, install a piped agent to the cluster to perform CD tasks.
5555

56-
From your logged in tab, navigate to the PipeCD setting page at [http://localhost:8080/settings/piped?project=quickstart](http://localhost:8080/settings/piped?project=quickstart).
56+
From your logged in tab, navigate to the piped settings page at [http://localhost:8080/settings/piped?project=quickstart](http://localhost:8080/settings/piped?project=quickstart).
5757

58-
You will find the `+ADD` button around the top left of this page, click there and insert information to register the Piped agent (for example, `dev`).
58+
Click the `+ADD` button at the top left of the page and enter a name for the piped agent (for example, `dev`).
5959

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

62-
Click on the `Save` button, and then you can see the piped-id and secret-key.
62+
Click the `Save` button, and then you can see the generated piped ID and secret key.
6363

6464
![](/images/quickstart-piped-registered.png)
6565

66-
You need to copy two values, `Piped Id` and `Base64 Encoded Piped Key`, and fill in `<COPIED_PIPED_ID>` and `<COPIED_ENCODED_PIPED_KEY>` respectively this below command
66+
> **Note:** The `Piped Id` is the UUID generated after you click `Save` (for example, `7c17c8f8-...`), not the name you entered while registering. Using the name instead of the UUID causes an `unable to find piped from datastore` error in the piped logs.
6767
68-
```console
69-
$ curl -s https://raw.githubusercontent.com/pipe-cd/pipecd/master/quickstart/manifests/piped.yaml | \
68+
Copy the two values, `Piped Id` and `Base64 Encoded Piped Key`, and fill them in `<COPIED_PIPED_ID>` and `<COPIED_ENCODED_PIPED_KEY>` respectively in the command below:
69+
70+
```bash
71+
curl -s https://raw.githubusercontent.com/pipe-cd/pipecd/master/quickstart/manifests/piped.yaml | \
7072
sed -e 's/<YOUR_PIPED_ID>/<COPIED_PIPED_ID>/g' \
7173
-e 's/<YOUR_PIPED_KEY_DATA>/<COPIED_ENCODED_PIPED_KEY>/g' | \
7274
kubectl apply -n pipecd -f -
7375
```
7476

75-
For more about Piped management, please check [Managing Piped](/docs/user-guide/managing-piped/).
77+
For more about Piped management, see [Managing Piped](../user-guide/managing-piped/).
7678

7779
That's all! You are ready to use PipeCD to manage your application's deployment.
7880

79-
You can check the readiness of all PipeCD components via command
80-
81-
```console
82-
$ kubectl get pod -n pipecd
83-
NAME READY STATUS RESTARTS AGE
84-
pipecd-cache-56c7c65ddc-xqcst 1/1 Running 0 38m
85-
pipecd-gateway-58589b55f9-9nbrv 1/1 Running 0 38m
86-
pipecd-minio-677999d5bb-xnb78 1/1 Running 0 38m
87-
pipecd-mysql-6fff49fbc7-hkvt4 1/1 Running 0 38m
88-
pipecd-ops-779d6844db-nvbwn 1/1 Running 0 38m
89-
pipecd-server-5769df7fcb-9hc45 1/1 Running 1 (38m ago) 38m
90-
piped-8477b5d55d-74s5v 1/1 Running 0 97s
81+
You can check the readiness of all PipeCD components via command:
82+
83+
```bash
84+
kubectl get pod -n pipecd
85+
```
86+
87+
```
88+
NAME READY STATUS RESTARTS AGE
89+
pipecd-cache-56c7c65ddc-xqcst 1/1 Running 0 38m
90+
pipecd-gateway-58589b55f9-9nbrv 1/1 Running 0 38m
91+
pipecd-minio-677999d5bb-xnb78 1/1 Running 0 38m
92+
pipecd-mysql-6fff49fbc7-hkvt4 1/1 Running 0 38m
93+
pipecd-ops-779d6844db-nvbwn 1/1 Running 0 38m
94+
pipecd-server-5769df7fcb-9hc45 1/1 Running 0 38m
95+
piped-8477b5d55d-74s5v 1/1 Running 0 97s
9196
```
9297

9398
### 2. Deploy a Kubernetes application with PipeCD
9499

95-
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.
100+
Your PipeCD installation (both Control Plane and agent) is now complete. Let's use it to deploy your first Kubernetes application with PipeCD.
96101

97102
Navigate to the `Applications` page, click on the `+ADD` button on the top left corner.
98103

99104
Go to the `ADD FROM SUGGESTIONS` tab, then select:
100105
- Piped that you have just registered (e.g. `dev`)
101106
- PlatformProvider: `kubernetes-default`
102107

103-
You should see a lot of suggested applications. Select one of listed applications and click the `SAVE` button to register.
108+
> **Note:** The piped agent needs a minute or two after connecting to clone the examples repository and discover applications. If the list is empty, wait a moment and reload the page.
109+
110+
You should see a list of suggested applications. Select one and click the `SAVE` button to register it.
104111

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

107-
After a bit, the first deployment is complete and will automatically sync the application to the state specified in the current Git commit.
114+
The first deployment starts automatically and syncs the application to the state specified in the current Git commit.
108115

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

111-
For more about managing applications' deployment with PipeCD, refer to [Managing application](/docs/user-guide/managing-application/)
118+
For more about managing applications' deployment with PipeCD, see [Managing application](../user-guide/managing-application/).
112119

113120
### 3. Cleanup
114-
When you’re finished experimenting with PipeCD quickstart mode, you can uninstall it using:
121+
When you're finished experimenting with PipeCD quickstart mode, you can uninstall it using:
115122

116-
``` console
117-
$ kubectl delete ns pipecd
123+
```bash
124+
kubectl delete ns pipecd
118125
```
119126

120127
### What's next?
121128

122-
To prepare your PipeCD for a production environment, please visit the [Installation](../installation/) guideline. For guidelines to use PipeCD to deploy your application in daily usage, please visit the [User guide](../user-guide/) docs.
129+
To prepare your PipeCD for a production environment, see the [Installation](../installation/) guide. For guidelines to use PipeCD to deploy your application in daily usage, see the [User guide](../user-guide/) docs.
123130

124-
To set up the development environment and start contributing to PipeCD, please visit the [Contributor guide](../contribution-guidelines/) docs.
131+
To set up the development environment and start contributing to PipeCD, see the [Contributor guide](../contribution-guidelines/) docs.

0 commit comments

Comments
 (0)