Skip to content

Commit

Permalink
Fix
Browse files Browse the repository at this point in the history
  • Loading branch information
nakabonne committed Sep 4, 2020
1 parent eed7904 commit 1bb7038
Showing 1 changed file with 19 additions and 28 deletions.
47 changes: 19 additions & 28 deletions docs/content/en/docs/quickstart/_index.md
Expand Up @@ -8,43 +8,36 @@ description: >

This guides you to install PipeCD in your kubernetes and deploy a `helloworld` application to that Kubernetes cluster.

### Requirements
### Prerequisites
- Have a cluster running a compatible version of Kubernetes
- Installed [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- Installed [helm3](https://helm.sh/docs/intro/install/)

- Forked the [Examples](https://github.com/pipe-cd/examples) repository

### 1. Cloning pipe repository

Navigate to the root of the repository once cloned.

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

### 2. Installing control plane
First up, add pipecd helm chart repository.
```bash
helm repo add pipecd https://pipecd-charts.storage.googleapis.com
```

Then you can install with:

```bash
helm install pipecd pipecd/pipecd --values ./quickstart/values.yaml
helm install pipecd ./manifests/pipecd --values ./quickstart/values.yaml
```

### 3. Accessing the API server
Connect to the API server you just installed with kubectl port-forwarding:
### 3. Accessing the PipeCD web
PipeCD comes with an embedded web based UI.
First up, you connect to the control-plane you just installed with kubectl port-forwarding:

```bash
kubectl port-forward svc/pipecd 8080:443
```

### 4. Logging in with static admin user
PipeCD comes with an embedded web based UI.
Point your web browser to [http://localhost:8080](http://localhost:8080) ensure the API server has started successfully.
Point your web browser to [http://localhost:8080](http://localhost:8080) to login with static admin user.

![](/images/login.png)

Expand All @@ -53,35 +46,33 @@ Enter the project name, username and password. Be sure to give the following:
- Username: `hello-pipecd`
- Password: `hello-pipecd`

### 5. Adding an environment
### 4. Adding an environment
To add a new [Environment](http://localhost:1313/docs/concepts/#environment), go to the `Environment` tab at `Settings` page and click on the `Add` button to add a new environment to the project.

Then you give the environment name and its description as shown below:

![](/images/adding-environment.png)


### 6. Registering a `piped`
Before installing the `piped`, you have to register it on the Web.
Navigate to the `Piped` tab on the same page as before, and then click on the `Add` button.
### 5. Installing a `piped`
First up, you need to take a piped-id and a secret-key on the Web.

Navigate to the `Piped` tab on the same page as before, then click on the `Add` button.

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

Click on the `Save` button, and then you can see the piped-id and secret key.
Click on the `Save` button, and then you can see the piped-id and secret-key.
Be sure to keep a copy for later use.

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

### 7. Installing a `piped`

Fork the [Examples](https://github.com/pipe-cd/examples) repository.

Once a repository named `YOUR_USERNAME/examples` has been created,
open [`./quickstart/piped-config.yaml`](https://github.com/pipe-cd/pipe/blob/master/quickstart/piped-config.yaml) and:
Open [`./quickstart/piped-config.yaml`](https://github.com/pipe-cd/pipe/blob/master/quickstart/piped-config.yaml) and:
- replace `YOUR_USERNAME` with your git username
- 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 yours:
You can complete the installation by running the following after replacing `YOUR_PIPED_SECRET_KEY` with what you just got:

```bash
helm install dev-piped pipecd/piped \
Expand All @@ -90,16 +81,16 @@ helm install dev-piped pipecd/piped \
--set-file config.data=./quickstart/piped-config.yaml
```

### 8. Configuring a kubernetes application
### 6. Configuring a kubernetes application

> TBA
### 9. Let's deploy!
### 7. Let's deploy!

> TBA

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

```bash
Expand Down

0 comments on commit 1bb7038

Please sign in to comment.