Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs: add guide to add env and piped, update control-plane installation guide #899

Merged
merged 2 commits into from
Oct 2, 2020
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Control Plane"
linkTitle: "Control Plane"
weight: 2
weight: 1
description: >
This guide is for administrators and operators wanting to install and configure PipeCD for other developers.
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Adding an environment"
linkTitle: "Adding an environment"
weight: 4
description: >
This page describes how to add a new environment to a project.
---

An environment is a logical group of applications, pipeds inside a project. A project can have multiple environments.
Each application must belong to one and only one environment. While each piped must belong to at least one environment.

The list of environments is shown in the Settings page. Anyone who has the project admin role can add a new environment by clicking on the `+ADD` button.

</br>

![](/images/settings-add-environment.png)
<p style="text-align: center;">
Adding a new environment
</p>
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Authentication and authorization"
linkTitle: "Authentication and authorization"
weight: 4
weight: 6
description: >
This page describes about PipeCD Authentication and Authorization.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Configuration reference"
linkTitle: "Configuration reference"
weight: 6
weight: 8
description: >
This page describes all configurable fields in the control-plane configuration.
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,22 @@ kubectl port-forward svc/pipecd 8080:443
```

Now go to [http://localhost:8080](http://localhost:8080) on your browser, you will see a page to login to your project. But before logging in, you need to initialize a new project by following the [next section](/docs/operator-manual/control-plane/adding-a-project/).

## Production Hardening

This part provides guidance for a production hardened deployment of the control plane.

- Publishing the control plane

You can allow external access to the control plane by enabling the [ingress](https://github.com/pipe-cd/manifests/blob/master/manifests/pipecd/values.yaml#L6) configuration.

- End-to-End TLS

After switching to HTTPs, do not forget to change the above `api.args.insecureCookie` to be `false` to disallow using cookie on unsecured HTTP connection.

Alternatively, PipeCD also requires a TLS certificate for internal use. This can be a self-signed one and generated by this command:

``` console
openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout tls.key -out tls.crt -subj "/CN=YOUR_DOMAIN"
```
Those key and cert can be configured via [`secret.internalTLSKey.data`](https://github.com/pipe-cd/manifests/blob/master/manifests/pipecd/values.yaml#L83) and [`secret.internalTLSCert.data`](https://github.com/pipe-cd/manifests/blob/master/manifests/pipecd/values.yaml#L86).
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Metrics"
linkTitle: "Metrics"
weight: 5
weight: 7
description: >
This page describes how to enable monitoring system for collecting PipeCD' metrics.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Registering a piped"
linkTitle: "Registering a piped"
weight: 5
description: >
This page describes how to register a new piped to a project.
---

The list of pipeds are shown in the Settings page. Anyone who has the project admin role can register a new piped by clicking on the `+ADD` button.

</br>

![](/images/settings-add-piped.png)
<p style="text-align: center;">
Registering a new piped
</p>
2 changes: 1 addition & 1 deletion docs/content/en/docs/operator-manual/piped/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Piped"
linkTitle: "Piped"
weight: 1
weight: 2
description: >
This guide is for administrators and operators wanting to install and configure piped for other developers.
---
6 changes: 3 additions & 3 deletions docs/content/en/docs/operator-manual/piped/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ description: >

## Prerequisites

##### Registering piped
- Ensure that the `piped` has been registered from PipeCD web UI and you have copied its ID and Key strings.
- Please note that only project admin can register a new `piped` at Settings tab.
##### Having piped's ID and Key strings
- Ensure that the `piped` has been registered and you are having its PIPED_ID and PIPED_KEY strings.
- If you are not having them, this [page](/docs/operator-manual/control-plane/registering-a-piped/) guides you how to register a new one.

##### Preparing a SSH key
- If your Git repositories are private, `piped` requires a private SSH key to access those repositories.
Expand Down
5 changes: 3 additions & 2 deletions docs/content/en/docs/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@ Component Architecture

## Where should I go next?

If you are an **operator** wanting to install and configure PipeCD (control-plane and piped) for other developers.
If you are an **operator** wanting to install and configure PipeCD for other developers.
- [Quickstart](/docs/quickstart/)
- [Operator Manual](/docs/operator-manual/)
- [Operating Control Plane](/docs/operator-manual/control-plane/)
- [Operating Piped](/docs/operator-manual/piped/)

If you are an **user** using PipeCD to deploy your application/infrastructure:
- [User Guide](/docs/user-guide/)
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/settings-add-piped.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.