-
Notifications
You must be signed in to change notification settings - Fork 204
V1-Docs (UserGuide): Add Managing Piped Section #6347
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
Open
eeshaanSA
wants to merge
6
commits into
pipe-cd:master
Choose a base branch
from
eeshaanSA:userguide/managingPiped
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2703ca6
ADD userguide/managingPiped
eeshaanSA e99c651
delete: remove adding Helm chart repository or registry page
eeshaanSA 7452a6a
fix: update analysis provider configuration in documentation
eeshaanSA 15a71dc
docs: update remote upgrade and remote config features note
eeshaanSA 5d91498
docs: correct usage command for Piped in runtime options
eeshaanSA 6f35e3e
docs: add configuring-a-plugin.md
eeshaanSA File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
docs/content/en/docs-v1.0.x/user-guide/managing-piped/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: "Managing Piped" | ||
| linkTitle: "Managing Piped" | ||
| weight: 3 | ||
| description: > | ||
| This guide is for administrators and operators wanting to install and configure piped for other developers. | ||
| --- | ||
|
|
||
| In order to use Piped you will need to register a piped through the PipeCD control plane. Check out [how to register a Piped](../managing-controlplane/registering-a-piped/) if you have not have already. After registering successfully, you can monitor your Piped live state via the PipeCD console on the settings page. | ||
|
|
||
|  |
41 changes: 41 additions & 0 deletions
41
docs/content/en/docs-v1.0.x/user-guide/managing-piped/adding-a-git-repository.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: "Adding a git repository" | ||
| linkTitle: "Adding git repository" | ||
| weight: 2 | ||
| description: > | ||
| This page describes how to add a new Git repository. | ||
| --- | ||
|
|
||
| In the `piped` configuration file, we specify the list of Git repositories should be handled by the `piped`. | ||
| A Git repository contains one or more deployable applications where each application is put inside a directory called as [application directory](../../../concepts/#application-directory). | ||
| That directory contains an application configuration file as well as application manifests. | ||
| The `piped` periodically checks the new commits and fetches the needed manifests from those repositories for executing the deployment. | ||
|
|
||
| A single `piped` can be configured to handle one or more Git repositories. | ||
| In order to enable a new Git repository, let's add a new [GitRepository](../configuration-reference/#gitrepository) block to the `repositories` field in the `piped` configuration file. | ||
|
|
||
| For example, with the following snippet, `piped` will take the `master` branch of [pipe-cd/examples](https://github.com/pipe-cd/examples) repository as a target Git repository for doing deployments. | ||
|
|
||
| ``` yaml | ||
| apiVersion: pipecd.dev/v1beta1 | ||
| kind: Piped | ||
| spec: | ||
| ... | ||
| repositories: | ||
| - repoId: examples | ||
| remote: git@github.com:pipe-cd/examples.git | ||
| branch: master | ||
| ``` | ||
|
|
||
| In most of the cases, we want to deal with private Git repositories. For accessing those private repositories, `piped` needs a private SSH key, which can be configured while [installing](../../../installation/install-piped/installing-on-kubernetes/) with `secret.sshKey` in the Helm chart. | ||
|
|
||
| ``` console | ||
| helm install dev-piped pipecd/piped --version={VERSION} \ | ||
| --set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \ | ||
| --set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \ | ||
| --set-file secret.data.ssh-key={PATH_TO_PRIVATE_SSH_KEY_FILE} | ||
| ``` | ||
|
|
||
| You can see this [configuration reference](../configuration-reference/#git) for more configurable fields about Git commands. | ||
|
|
||
| Currently, `piped` allows configuring only one private SSH key for all specified Git repositories. So you can configure the same SSH key for all of those private repositories, or break them into separate `piped`s. In the near future, we also want to update `piped` to support loading multiple SSH keys. |
68 changes: 68 additions & 0 deletions
68
...content/en/docs-v1.0.x/user-guide/managing-piped/adding-an-analysis-provider.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: "Adding an analysis provider" | ||
| linkTitle: "Adding analysis provider" | ||
| weight: 6 | ||
| description: > | ||
| This page describes how to add an Analysis Provider to analyize the metrics of your deployment. | ||
| --- | ||
|
|
||
| To enable [Automated deployment analysis](../../managing-application/customizing-deployment/automated-deployment-analysis/) feature, you have to set the needed information for Piped to connect to the [Analysis Provider](../../../concepts/#analysis-provider). | ||
|
|
||
| Currently, PipeCD supports the following providers: | ||
|
|
||
| - [Prometheus](https://prometheus.io/) | ||
| - [Datadog](https://datadoghq.com/) | ||
|
|
||
| ## Prometheus | ||
|
|
||
| Piped queries the [range query endpoint](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) to obtain metrics used to evaluate the deployment. | ||
|
|
||
| You need to define the Prometheus server address so that it can be accessed by your `piped`. | ||
|
|
||
| ```yaml | ||
| apiVersion: pipecd.dev/v1beta1 | ||
| kind: Piped | ||
| spec: | ||
| plugins: | ||
| - name: analysis | ||
| port: | ||
| url: | ||
| config: | ||
| analysisProviders: | ||
| - name: prometheus-dev | ||
| type: PROMETHEUS | ||
| config: | ||
| address: https://your-prometheus.dev | ||
| ``` | ||
|
|
||
| To know more, see the full list of [configurable fields](configuration-reference/#analysisproviderdatadogconfig). | ||
|
|
||
| ## Datadog | ||
|
|
||
| Piped queries the [MetricsApi.QueryMetrics](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-points) endpoint to obtain metrics used to evaluate the deployment. | ||
|
|
||
| ```yaml | ||
| apiVersion: pipecd.dev/v1beta1 | ||
| kind: Piped | ||
| spec: | ||
| plugins: | ||
| - name: analysis | ||
| port: | ||
| url: | ||
| config: | ||
| analysisProviders: | ||
| - name: datadog-dev | ||
| type: DATADOG | ||
| config: | ||
| apiKeyFile: /etc/piped-secret/datadog-api-key | ||
| applicationKeyFile: /etc/piped-secret/datadog-application-key | ||
| ``` | ||
|
|
||
| To know more, see the full list of [configurable fields](configuration-reference/#analysisproviderdatadogconfig). | ||
|
|
||
| If you choose `Helm` as the installation method, we recommend using `--set-file` to mount the key files while performing the [upgrading process](../../../installation/install-piped/installing-on-kubernetes/#in-the-cluster-wide-mode). | ||
|
|
||
| ```bash | ||
| --set-file secret.data.datadog-api-key={PATH_TO_API_KEY_FILE} \ | ||
| --set-file secret.data.datadog-application-key={PATH_TO_APPLICATION_KEY_FILE} | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be part of plugin docs instead of piped docs, wdyt?