pipe-cd · pipecd-bot · Aug 4, 2020 · Jul 27, 2020
@@ -50,7 +50,7 @@ anchor = "smart"
 [services]
 [services.googleAnalytics]
 # Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
-id = "UA-00000000-0"
+#id = "UA-00000000-0"
 
 # Language configuration
 
@@ -131,7 +131,7 @@ no = 'Sorry to hear that. Please <a href="https://github.com/pipe-cd/pipe/issues
         desc = "Discussion and help from your fellow users"
 [[params.links.user]]
 	name ="Twitter"
-	url = "https://twitter.com/pipecd"
+	url = "https://twitter.com/pipecd_dev"
 	icon = "fab fa-twitter"
         desc = "Follow us on Twitter to get the latest news!"
 [[params.links.user]]
@@ -142,7 +142,7 @@ no = 'Sorry to hear that. Please <a href="https://github.com/pipe-cd/pipe/issues
 # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
 [[params.links.developer]]
 	name = "GitHub"
-	url = "https://github.com/pipe-cd/pipe"
+	url = "https://github.com/pipe-cd"
 	icon = "fab fa-github"
         desc = "Development takes place here!"
 [[params.links.developer]]

@@ -20,7 +20,7 @@
 
 <div class="row">
 	<div class="col">
-		<h1 class="text-center">Why PipeCD?</h1>
+		<h1 class="text-center">TBA</h1>
 	</div>
 </div>
 
@@ -43,11 +43,10 @@ <h1 class="text-center">Why PipeCD?</h1>
 {{% /blocks/feature %}}
 
 
-{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/pipe-cd" %}}
+{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/pipecd_dev" %}}
 Don't miss out!
 
 Follow us for feature announcements and other news.
 {{% /blocks/feature %}}
 
 {{< /blocks/section >}}
-
@@ -1,6 +1,6 @@
 ---
-title: "Architectual Overview"
-linkTitle: "Architectual Overview"
+title: "Architectual overview"
+linkTitle: "Architectual overview"
 weight: 3
 description: >
   This page describes the architecture of PipeCD.
@@ -9,6 +9,9 @@ description: >
 > TBA
 
 ![](/images/architecture-overview.png)
+<p style="text-align: center;">
+Component Architecture
+</p>
 
 ### Piped
 
@@ -23,5 +26,7 @@ authentication, showing deployment list/details, application list/details, deliv
 
 Control Plane contains the following components:
 - `api`: A service to provide api for external service like web and hook requests.
-- `cache`: A redis cache service for caching internal data.
 - `web`: A service for serving static files for web.
+- `cache`: A redis cache service for caching internal data.
+- `datastore`: Data storage for storing deployment, application data. This can be a fully-managed service such as `Firestore`, `DynamoDB`... or a self-managed such as `MongoDB`.
+- `filestore`: File storage for storing logs, application states. This can a fully-managed service such as `GCS`, `S3`... or a self-managed service such as `Minio`.
@@ -3,7 +3,7 @@ title: "Contributing"
 linkTitle: "Contributing"
 weight: 1
 description: >
-  This page guides how to contribute to PipeCD.
+  This page describes how to contribute to PipeCD.
 ---
 
 PipeCD is an open source project that anyone in the community can use, improve, and enjoy. We'd love you to join us! 

@@ -1,20 +1,20 @@
 ---
-title: "Control Plane Development"
-linkTitle: "Control Plane Development"
+title: "Control plane development"
+linkTitle: "Control plane development"
 weight: 5
 description: >
   This page describes where to find control-plane source code and how to run it locally for debugging.
 ---
 
 ## Source code structure
 
-- [pkg/app/api](https://github.com/pipe-cd/pipe/tree/master/pkg/app/api): Contains source code for control-plane api. 
-- [cmd/api](https://github.com/pipe-cd/pipe/tree/master/cmd/api): Entrypoint for binary of control-plane api.
+- [pkg/app/api](https://github.com/pipe-cd/pipe/tree/master/pkg/app/api): contains source code for control-plane api.
+- [cmd/api](https://github.com/pipe-cd/pipe/tree/master/cmd/api): entrypoint for binary of control-plane api.
 
-- [pkg/app/web](https://github.com/pipe-cd/pipe/tree/master/pkg/app/web): Contains source code for control-plane web. 
-- [cmd/web](https://github.com/pipe-cd/pipe/tree/master/cmd/web): Entrypoint for binary of control-plane web.
+- [pkg/app/web](https://github.com/pipe-cd/pipe/tree/master/pkg/app/web): contains source code for control-plane web.
+- [cmd/web](https://github.com/pipe-cd/pipe/tree/master/cmd/web): entrypoint for binary of control-plane web.
 
-- [pkg](https://github.com/pipe-cd/pipe/tree/master/pkg): Contains shared source code for all components of both `piped` and `control-plane`.
+- [pkg](https://github.com/pipe-cd/pipe/tree/master/pkg): contains shared source code for all components of both `piped` and `control-plane`.
 
 ## How to run API locally
 

@@ -1,16 +1,16 @@
 ---
-title: "Piped Development"
-linkTitle: "Piped Development"
+title: "Piped development"
+linkTitle: "Piped development"
 weight: 4
 description: >
   This page describes where to find piped source code and how to run it locally for debugging.
 ---
 
 ## Source code structure
 
-- [pkg/app/piped](https://github.com/pipe-cd/pipe/tree/master/pkg/app/piped): Contains source code for only `piped`. 
-- [cmd/piped](https://github.com/pipe-cd/pipe/tree/master/cmd/piped): Entrypoint for `piped` binary.
-- [pkg](https://github.com/pipe-cd/pipe/tree/master/pkg): Contains shared source code for all components of both `piped` and `control-plane`.
+- [pkg/app/piped](https://github.com/pipe-cd/pipe/tree/master/pkg/app/piped): contains source code for only `piped`.
+- [cmd/piped](https://github.com/pipe-cd/pipe/tree/master/cmd/piped): entrypoint for `piped` binary.
+- [pkg](https://github.com/pipe-cd/pipe/tree/master/pkg): contains shared source code for all components of both `piped` and `control-plane`.
 
 ## How to run it locally
 

@@ -18,4 +18,4 @@ Currently, PipeCD is supporting `Helm` and `Kustomize` as templating method for
 
 ### 3. Istio is supported now?
 
-Yes, you can use PipeCD for both mesh (Istio) applications and non-mesh applications.
+Yes, you can use PipeCD for both mesh (Istio, SMI) applications and non-mesh applications.
@@ -1,6 +1,6 @@
 ---
-title: "Adding a Project"
-linkTitle: "Adding a Project"
+title: "Adding a project"
+linkTitle: "Adding a project"
 weight: 2
 description: >
   This page describes how to set up a new project.

@@ -1,6 +1,6 @@
 ---
-title: "Architecture Overview"
-linkTitle: "Architecture Overview"
+title: "Architecture overview"
+linkTitle: "Architecture overview"
 weight: 1
 description: >
   This page describes the architecture of PipeCD.

@@ -1,6 +1,6 @@
 ---
-title: "Authentication and Authorization"
-linkTitle: "Authentication and Authorization"
+title: "Authentication and authorization"
+linkTitle: "Authentication and authorization"
 weight: 4
 description: >
   This page describes about PipeCD Authentication and Authorization.

@@ -0,0 +1,50 @@
+---
+title: "Configuration reference"
+linkTitle: "Configuration reference"
+weight: 6
+description: >
+  This page describes all configurable fields in the control-plane configuration.
+---
+
+> TBA
+
+``` yaml
+apiVersion: pipecd.dev/v1beta1
+kind: ControlPlane
+spec:
+```
+
+### Control Plane Configuration
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| apiURL | string | The address of control-plane api | Yes |
+| stateKey | string | A randomly generated string used to sign oauth state | Yes |
+| dataStore | [DataStore](/docs/operator-manual/control-plane/configuration-reference/#datastore) | Storage for storing application, deployment data | Yes |
+| fileStore | [FileStore](/docs/operator-manual/control-plane/configuration-reference/#filestore) | File storage for storing deployment logs and application states | Yes |
+| cache | [Cache](/docs/operator-manual/control-plane/configuration-reference/#cache) | List of cloud providers can be used by this piped | No |
+| projects | [][Project](/docs/operator-manual/control-plane/configuration-reference/#project) | List of debugging/quickstart projects | No |
+
+### DataStore
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| type | string | Which type of data store should be used. Can be one of the following values<br>`FIRESTORE`, `DYNAMODB`, `MONGODB` | Yes |
+
+### FileStore
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| type | string | Which type of file store should be used. Can be one of the following values<br>`GCS`, `S3`, `MINIO` | Yes |
+
+### Cache
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| ttl | duration | The name of the chart repository | Yes |
+
+### Project
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| id | string | The unique identifier of the project | Yes |
@@ -1,6 +1,6 @@
 ---
-title: "Persisting Control Plane Data"
-linkTitle: "Persisting Control Plane Data"
+title: "Persisting control plane data"
+linkTitle: "Persisting control plane data"
 weight: 3
 description: >
   This page describes how to set up control plane to persist its data.

@@ -1,6 +1,6 @@
 ---
-title: "Adding a CloudRun Cloud Provider"
-linkTitle: "Adding a CloudRun Cloud Provider"
+title: "Adding a CloudRun cloud provider"
+linkTitle: "Adding a CloudRun cloud provider"
 weight: 5
 description: >
   This page describes how to add a CloudRun cloud provider to enable CloudRun applications.

@@ -1,6 +1,6 @@
 ---
-title: "Adding a Git Repository"
-linkTitle: "Adding a Git Repository"
+title: "Adding a Git repository"
+linkTitle: "Adding a Git repository"
 weight: 2
 description: >
   This page describes how to add a new git repository.

@@ -1,6 +1,6 @@
 ---
-title: "Adding a Kubernetes Cloud Provider"
-linkTitle: "Adding a Kubernetes Cloud Provider"
+title: "Adding a Kubernetes cloud provider"
+linkTitle: "Adding a Kubernetes cloud provider"
 weight: 3
 description: >
   This page describes how to add a Kubernetes cloud provider to enable Kubernetes applications.

@@ -1,6 +1,6 @@
 ---
-title: "Adding a Lambda Cloud Provider"
-linkTitle: "Adding a Lambda Cloud Provider"
+title: "Adding a Lambda cloud provider"
+linkTitle: "Adding a Lambda cloud provider"
 weight: 6
 description: >
   This page describes how to add a Lambda cloud provider to enable Lambda applications.

@@ -1,6 +1,6 @@
 ---
-title: "Adding a Terraform Cloud Provider"
-linkTitle: "Adding a Terraform Cloud Provider"
+title: "Adding a Terraform cloud provider"
+linkTitle: "Adding a Terraform cloud provider"
 weight: 4
 description: >
   This page describes how to add a Terraform cloud provider to enable Terraform applications.

@@ -1,6 +1,6 @@
 ---
-title: "Adding an Analysis Provider"
-linkTitle: "Adding an Analysis Provider"
+title: "Adding an analysis provider"
+linkTitle: "Adding an analysis provider"
 weight: 7
 description: >
   This page describes how to add an analysis provider for doing deployment analysis.

@@ -0,0 +1,9 @@
+---
+title: "Adding an image provider"
+linkTitle: "Adding an image provider"
+weight: 9
+description: >
+  This page describes how to add a new container image provider.
+---
+
+> TBA
@@ -1,6 +1,6 @@
 ---
-title: "Adding a Helm Chart Repository"
-linkTitle: "Adding a Helm Chart Repository"
+title: "Adding a helm chart repository"
+linkTitle: "Adding a helm chart repository"
 weight: 8
 description: >
   This page describes how to add a new Helm chart repository.

@@ -0,0 +1,76 @@
+---
+title: "Configuration reference"
+linkTitle: "Configuration reference"
+weight: 11
+description: >
+  This page describes all configurable fields in the piped configuration.
+---
+
+> TBA
+
+``` yaml
+apiVersion: pipecd.dev/v1beta1
+kind: Piped
+spec:
+  projectID: ...
+  pipedID: ...
+  ...
+```
+
+### Piped Configuration
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| projectID | string | The project ID this piped belongs to | Yes |
+| pipedID | string | The generated ID for this piped | Yes |
+| pipedKeyFile | string | The path to the file containing generated Key for this piped | Yes |
+| webURL | string | The URL address of PipeCD web | Yes |
+| syncInterval | duration | How offten to check whether an application should be synced. Default is `1m` | No |
+| git | [Git](/docs/operator-manual/piped/configuration-reference/#git) | Git configuration needed for Git commands  | No |
+| repositories | [][Repository](/docs/operator-manual/piped/configuration-reference/#repository) | List of Git repositories this piped will handle | No |
+| chartRepositories | [][ChartRepository](/docs/operator-manual/piped/configuration-reference/#chartrepository) | List of Helm chart repositories that should be added while starting up | No |
+| cloudProviders | [][CloudProvider](/docs/operator-manual/piped/configuration-reference/#cloudprovider) | List of cloud providers can be used by this piped | No |
+| analysisProviders | [][CloudProvider](/docs/operator-manual/piped/configuration-reference/#analysisprovider) | List of analysis providers can be used by this piped | No |
+| notifications | [Notifications](/docs/operator-manual/piped/configuration-reference/#notifications) | Notification to Slack, Webhook... | No |
+
+### Git
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| Username | string | The username that will be configured to `git` | No |
+
+### Repository
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| repoID | string | Unique identifier to the repository. This must be unique in the piped scope | Yes |
+
+### ChartRepository
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| name | string | The name of the chart repository | Yes |
+
+### CLoudProvider
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| Name | string | The name of the cloud provider | Yes |
+
+### AnalysisProvider
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| Name | string | The name of the analysis provider | Yes |
+
+### Notifications
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| routes | [][Notification.Route](/docs/operator-manual/piped/configuration-reference/#notificationroute) | List of notification routes | No |
+
+### Notification.Route
+
+| Field | Type | Description | Required |
+|-|-|-|-|
+| Name | string | The name of the analysis provider | Yes |
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,4 +18,4 @@ Currently, PipeCD is supporting `Helm` and `Kustomize` as templating method for

		### 3. Istio is supported now?

		Yes, you can use PipeCD for both mesh (Istio) applications and non-mesh applications.
		Yes, you can use PipeCD for both mesh (Istio, SMI) applications and non-mesh applications.