diff --git a/docs/content/en/docs-dev/contribution-guidelines/architectural-overview.md b/docs/content/en/docs-dev/contribution-guidelines/architectural-overview.md index 0d83944b92..1d402ae900 100644 --- a/docs/content/en/docs-dev/contribution-guidelines/architectural-overview.md +++ b/docs/content/en/docs-dev/contribution-guidelines/architectural-overview.md @@ -24,6 +24,7 @@ authentication, showing deployment list/details, application list/details, deliv Control Plane contains the following components: - `server`: a service to provide api for piped, web and serve static assets for web. +- `ops`: a service to provide administrative features for Control Plane owner like adding/managing projects. - `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`, `Cloud SQL`... @@ -31,3 +32,5 @@ Control Plane contains the following components: - `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` + +For more information, see [Architecture overview of Control Plane](../operator-manual/control-plane/architecture-overview.md). diff --git a/docs/content/en/docs-dev/contribution-guidelines/development.md b/docs/content/en/docs-dev/contribution-guidelines/development.md index 4636198ac1..6e56af4ffe 100644 --- a/docs/content/en/docs-dev/contribution-guidelines/development.md +++ b/docs/content/en/docs-dev/contribution-guidelines/development.md @@ -25,6 +25,7 @@ description: > - `make test/web`: runs all unit tests of web. - `make test/integration`: runs integration tests. +- `make run/piped`: runs Piped locally (for more information, see [here](#how-to-run-piped-agent-locally)). - `make run/site`: runs PipeCD site locally (requires [hugo](https://github.com/gohugoio/hugo) with `_extended` version `0.92.1` or later to be installed). - `make gen/code`: generate Go and Typescript code from protos and mock configs. You need to run it if you modified any proto or mock definition files. @@ -63,7 +64,7 @@ For the full list of available commands, please see the Makefile at the root of 2. Ensure that your `kube-context` is connecting to the right kubernetes cluster -3. Run the following command to start running `piped` +3. Run the following command to start running `piped` (if you want to connect Piped to a locally running Control Plane, add `INSECURE=true` option) ``` console make run/piped CONFIG_FILE=piped-config.yaml