Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ See [ConfigurationReference](/docs/operator-manual/control-plane/configuration-r
After all, install the control-plane as bellow:

``` console
helm install pipecd pipecd/pipecd --version={VERSION} --namespace={NAMESPACE} \
helm install pipecd pipecd/pipecd --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \
--set-file config.data=path-to-control-plane-configuration-file \
--set-file secret.encryptionKey.data=path-to-encryption-key-file \
--set-file secret.firestoreServiceAccount.data=path-to-service-account-file \
Expand Down
32 changes: 12 additions & 20 deletions docs/content/en/docs-dev/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,16 @@ This guides you to install PipeCD in your kubernetes and deploy a `helloworld` a
- Installed [helm3](https://helm.sh/docs/intro/install/)
- Forked the [Examples](https://github.com/pipe-cd/examples) repository

### 1. Cloning pipe-cd/manifests repository

Navigate to the root of the repository once cloned.
### 1. Installing control plane

``` console
git clone https://github.com/pipe-cd/manifests.git
cd manifests
```

### 2. Installing control plane
helm repo add pipecd https://charts.pipecd.dev

``` console
helm -n pipecd install pipecd ./manifests/pipecd --dependency-update --create-namespace \
--values ./quickstart/control-plane-values.yaml
helm install pipecd pipecd/pipecd -n pipecd --dependency-update --create-namespace \
--values https://raw.githubusercontent.com/pipe-cd/manifests/{{< blocks/latest_version >}}/quickstart/control-plane-values.yaml
```

### 3. Accessing the PipeCD web
### 2. Accessing the PipeCD web
PipeCD comes with an embedded web-based UI.
First up, using kubectl port-forward to expose the installed control-plane on your localhost:

Expand All @@ -47,7 +40,7 @@ Enter the project name, username and password. Be sure to give the following:
- Username: `hello-pipecd`
- Password: `hello-pipecd`

### 4. Adding an environment
### 3. Adding an environment
Go to the `Environment` tab at `Settings` page and click on the `Add` button to add a new [Environment](/docs/concepts/#environment) to the project.

Then you give the environment name and its description as shown below:
Expand All @@ -56,7 +49,7 @@ Then you give the environment name and its description as shown below:

After filling out the form, click on the `Save` button.

### 5. Installing a `piped`
### 4. Installing a `piped`
Before running a piped, you have to register it on the web and take the generated ID and Key strings.

Navigate to the `Piped` tab on the same page as before, click on the `Add` button. Then you enter as:
Expand All @@ -69,20 +62,19 @@ Be sure to keep a copy for later use.
![](/images/quickstart-piped-registered.png)



Open [`./quickstart/piped-values.yaml`](https://github.com/pipe-cd/manifests/blob/master/quickstart/piped-values.yaml) with your editor and:
- replace `FORKED_REPO_URL` with forked repository of [Examples](https://github.com/pipe-cd/examples), such as `https://github.com/YOUR_ORG/examples.git`
- replace `YOUR_PIPED_ID` with the piped-id you have copied before

You can complete the installation by running the following after replacing `{YOUR_PIPED_SECRET_KEY}` with what you just got:

``` console
helm -n pipecd install piped ./manifests/piped \
--values ./quickstart/piped-values.yaml \
helm install piped pipecd/piped -n pipecd \
--values https://raw.githubusercontent.com/pipe-cd/manifests/{{< blocks/latest_version >}}/quickstart/piped-values.yaml \
--set secret.pipedKey.data={YOUR_PIPED_SECRET_KEY}
```

### 6. Configuring a kubernetes application
### 5. Configuring a kubernetes application
Navigate to the `Application` page, click on the `Add` button. Then give as:

![](/images/quickstart-adding-application.png)
Expand All @@ -93,7 +85,7 @@ After a bit, the first deployment would be complete automatically to sync the ap

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

### 7. Let's deploy!
### 6. Let's deploy!
Let's get started with deployment! All you have to do is to make a PR to update the image tag, scale the replicas, or change the manifests.

For instance, open the `kubernetes/canary/deployment.yaml` under the forked examples' repository, then change the tag from `v0.1.0` to `v0.2.0`.
Expand All @@ -104,7 +96,7 @@ After a short wait, a new deployment will be started to update to `v0.2.0`.

![](/images/quickstart-deploying.png)

### 8. Cleanup
### 7. Cleanup
When you’re finished experimenting with PipeCD, you can uninstall with:

``` console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,24 @@ spec:
namespace: pipecd
environment: dev
project: {YOUR_GCP_PROJECT_NAME}
# Must be a service account with "Cloud Datastore User" and "Cloud Datastore Index Admin" roles.
# Must be a service account with "Cloud Datastore User" and "Cloud Datastore Index Admin" roles
# since PipeCD needs them to creates the needed Firestore composite indexes in the background.
credentialsFile: /etc/pipecd-secret/firestore-service-account
filestore:
type: GCS
config:
bucket: {YOUR_BUCKET_NAME}
# Must be a service account with "Storage Object Admin (roles/storage.objectAdmin)" role on the given bucket
# since PipeCD need to write file object such as deployment log file to that bucket.
credentialsFile: /etc/pipecd-secret/gcs-service-account
```

PipeCD automatically creates needed Firestore composite indexes in the background. So you have to prepare the service account with not only `Cloud Datastore User` but `Cloud Datastore Index Admin` roles to perform this behavior.

See [ConfigurationReference](/docs/operator-manual/control-plane/configuration-reference/) for the full configuration.

After all, install the control-plane as bellow:

``` console
helm install pipecd pipecd/pipecd --version={VERSION} --namespace={NAMESPACE} \
helm install pipecd pipecd/pipecd --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \
--set-file config.data=path-to-control-plane-configuration-file \
--set-file secret.encryptionKey.data=path-to-encryption-key-file \
--set-file secret.firestoreServiceAccount.data=path-to-service-account-file \
Expand Down
32 changes: 12 additions & 20 deletions docs/content/en/docs-v0.18.x/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,16 @@ This guides you to install PipeCD in your kubernetes and deploy a `helloworld` a
- Installed [helm3](https://helm.sh/docs/intro/install/)
- Forked the [Examples](https://github.com/pipe-cd/examples) repository

### 1. Cloning pipe-cd/manifests repository

Navigate to the root of the repository once cloned.
### 1. Installing control plane

``` console
git clone https://github.com/pipe-cd/manifests.git
cd manifests
```

### 2. Installing control plane
helm repo add pipecd https://charts.pipecd.dev

``` console
helm -n pipecd install pipecd ./manifests/pipecd --dependency-update --create-namespace \
--values ./quickstart/control-plane-values.yaml
helm install pipecd pipecd/pipecd -n pipecd --dependency-update --create-namespace \
--values https://raw.githubusercontent.com/pipe-cd/manifests/{{< blocks/latest_version >}}/quickstart/control-plane-values.yaml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will show v0.21.1 but let me fix that problem later.

```

### 3. Accessing the PipeCD web
### 2. Accessing the PipeCD web
PipeCD comes with an embedded web-based UI.
First up, using kubectl port-forward to expose the installed control-plane on your localhost:

Expand All @@ -47,7 +40,7 @@ Enter the project name, username and password. Be sure to give the following:
- Username: `hello-pipecd`
- Password: `hello-pipecd`

### 4. Adding an environment
### 3. Adding an environment
Go to the `Environment` tab at `Settings` page and click on the `Add` button to add a new [Environment](/docs/concepts/#environment) to the project.

Then you give the environment name and its description as shown below:
Expand All @@ -56,7 +49,7 @@ Then you give the environment name and its description as shown below:

After filling out the form, click on the `Save` button.

### 5. Installing a `piped`
### 4. Installing a `piped`
Before running a piped, you have to register it on the web and take the generated ID and Key strings.

Navigate to the `Piped` tab on the same page as before, click on the `Add` button. Then you enter as:
Expand All @@ -69,20 +62,19 @@ Be sure to keep a copy for later use.
![](/images/quickstart-piped-registered.png)



Open [`./quickstart/piped-values.yaml`](https://github.com/pipe-cd/manifests/blob/master/quickstart/piped-values.yaml) with your editor and:
- replace `FORKED_REPO_URL` with forked repository of [Examples](https://github.com/pipe-cd/examples), such as `https://github.com/YOUR_ORG/examples.git`
- replace `YOUR_PIPED_ID` with the piped-id you have copied before

You can complete the installation by running the following after replacing `{YOUR_PIPED_SECRET_KEY}` with what you just got:

``` console
helm -n pipecd install piped ./manifests/piped \
--values ./quickstart/piped-values.yaml \
helm install piped pipecd/piped -n pipecd \
--values https://raw.githubusercontent.com/pipe-cd/manifests/{{< blocks/latest_version >}}/quickstart/piped-values.yaml \
--set secret.pipedKey.data={YOUR_PIPED_SECRET_KEY}
```

### 6. Configuring a kubernetes application
### 5. Configuring a kubernetes application
Navigate to the `Application` page, click on the `Add` button. Then give as:

![](/images/quickstart-adding-application.png)
Expand All @@ -93,7 +85,7 @@ After a bit, the first deployment would be complete automatically to sync the ap

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

### 7. Let's deploy!
### 6. Let's deploy!
Let's get started with deployment! All you have to do is to make a PR to update the image tag, scale the replicas, or change the manifests.

For instance, open the `kubernetes/canary/deployment.yaml` under the forked examples' repository, then change the tag from `v0.1.0` to `v0.2.0`.
Expand All @@ -104,7 +96,7 @@ After a short wait, a new deployment will be started to update to `v0.2.0`.

![](/images/quickstart-deploying.png)

### 8. Cleanup
### 7. Cleanup
When you’re finished experimenting with PipeCD, you can uninstall with:

``` console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,24 @@ spec:
namespace: pipecd
environment: dev
project: {YOUR_GCP_PROJECT_NAME}
# Must be a service account with "Cloud Datastore User" and "Cloud Datastore Index Admin" roles.
# Must be a service account with "Cloud Datastore User" and "Cloud Datastore Index Admin" roles
# since PipeCD needs them to creates the needed Firestore composite indexes in the background.
credentialsFile: /etc/pipecd-secret/firestore-service-account
filestore:
type: GCS
config:
bucket: {YOUR_BUCKET_NAME}
# Must be a service account with "Storage Object Admin (roles/storage.objectAdmin)" role on the given bucket
# since PipeCD need to write file object such as deployment log file to that bucket.
credentialsFile: /etc/pipecd-secret/gcs-service-account
```

PipeCD automatically creates needed Firestore composite indexes in the background. So you have to prepare the service account with not only `Cloud Datastore User` but `Cloud Datastore Index Admin` roles to perform this behavior.

See [ConfigurationReference](/docs/operator-manual/control-plane/configuration-reference/) for the full configuration.

After all, install the control-plane as bellow:

``` console
helm install pipecd pipecd/pipecd --version={VERSION} --namespace={NAMESPACE} \
helm install pipecd pipecd/pipecd --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \
--set-file config.data=path-to-control-plane-configuration-file \
--set-file secret.encryptionKey.data=path-to-encryption-key-file \
--set-file secret.firestoreServiceAccount.data=path-to-service-account-file \
Expand Down
32 changes: 12 additions & 20 deletions docs/content/en/docs-v0.20.x/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,16 @@ This guides you to install PipeCD in your kubernetes and deploy a `helloworld` a
- Installed [helm3](https://helm.sh/docs/intro/install/)
- Forked the [Examples](https://github.com/pipe-cd/examples) repository

### 1. Cloning pipe-cd/manifests repository

Navigate to the root of the repository once cloned.
### 1. Installing control plane

``` console
git clone https://github.com/pipe-cd/manifests.git
cd manifests
```

### 2. Installing control plane
helm repo add pipecd https://charts.pipecd.dev

``` console
helm -n pipecd install pipecd ./manifests/pipecd --dependency-update --create-namespace \
--values ./quickstart/control-plane-values.yaml
helm install pipecd pipecd/pipecd -n pipecd --dependency-update --create-namespace \
--values https://raw.githubusercontent.com/pipe-cd/manifests/{{< blocks/latest_version >}}/quickstart/control-plane-values.yaml
```

### 3. Accessing the PipeCD web
### 2. Accessing the PipeCD web
PipeCD comes with an embedded web-based UI.
First up, using kubectl port-forward to expose the installed control-plane on your localhost:

Expand All @@ -47,7 +40,7 @@ Enter the project name, username and password. Be sure to give the following:
- Username: `hello-pipecd`
- Password: `hello-pipecd`

### 4. Adding an environment
### 3. Adding an environment
Go to the `Environment` tab at `Settings` page and click on the `Add` button to add a new [Environment](/docs/concepts/#environment) to the project.

Then you give the environment name and its description as shown below:
Expand All @@ -56,7 +49,7 @@ Then you give the environment name and its description as shown below:

After filling out the form, click on the `Save` button.

### 5. Installing a `piped`
### 4. Installing a `piped`
Before running a piped, you have to register it on the web and take the generated ID and Key strings.

Navigate to the `Piped` tab on the same page as before, click on the `Add` button. Then you enter as:
Expand All @@ -69,20 +62,19 @@ Be sure to keep a copy for later use.
![](/images/quickstart-piped-registered.png)



Open [`./quickstart/piped-values.yaml`](https://github.com/pipe-cd/manifests/blob/master/quickstart/piped-values.yaml) with your editor and:
- replace `FORKED_REPO_URL` with forked repository of [Examples](https://github.com/pipe-cd/examples), such as `https://github.com/YOUR_ORG/examples.git`
- replace `YOUR_PIPED_ID` with the piped-id you have copied before

You can complete the installation by running the following after replacing `{YOUR_PIPED_SECRET_KEY}` with what you just got:

``` console
helm -n pipecd install piped ./manifests/piped \
--values ./quickstart/piped-values.yaml \
helm install piped pipecd/piped -n pipecd \
--values https://raw.githubusercontent.com/pipe-cd/manifests/{{< blocks/latest_version >}}/quickstart/piped-values.yaml \
--set secret.pipedKey.data={YOUR_PIPED_SECRET_KEY}
```

### 6. Configuring a kubernetes application
### 5. Configuring a kubernetes application
Navigate to the `Application` page, click on the `Add` button. Then give as:

![](/images/quickstart-adding-application.png)
Expand All @@ -93,7 +85,7 @@ After a bit, the first deployment would be complete automatically to sync the ap

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

### 7. Let's deploy!
### 6. Let's deploy!
Let's get started with deployment! All you have to do is to make a PR to update the image tag, scale the replicas, or change the manifests.

For instance, open the `kubernetes/canary/deployment.yaml` under the forked examples' repository, then change the tag from `v0.1.0` to `v0.2.0`.
Expand All @@ -104,7 +96,7 @@ After a short wait, a new deployment will be started to update to `v0.2.0`.

![](/images/quickstart-deploying.png)

### 8. Cleanup
### 7. Cleanup
When you’re finished experimenting with PipeCD, you can uninstall with:

``` console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ See [ConfigurationReference](/docs/operator-manual/control-plane/configuration-r
After all, install the control-plane as bellow:

``` console
helm install pipecd pipecd/pipecd --version={VERSION} --namespace={NAMESPACE} \
helm install pipecd pipecd/pipecd --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \
--set-file config.data=path-to-control-plane-configuration-file \
--set-file secret.encryptionKey.data=path-to-encryption-key-file \
--set-file secret.firestoreServiceAccount.data=path-to-service-account-file \
Expand Down
Loading