Add docs and example config for local development #4477
Merged
Conversation
This file contains 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
Signed-off-by: Kenta Kozuka <[email protected]>
Signed-off-by: Kenta Kozuka <[email protected]>
khanhtc1202
reviewed
Jul 11, 2023
cmd/piped/README.md
Outdated
Comment on lines
37
to
49
|
|
||
| ## How to add an application to PipeCD | ||
|
|
||
| 1. Access the console, go Application page and click `ADD` button, select a platform provider and application(e.g. `name: simple, repo example` if you use the example repository). Then, click `SAVE`. PipeCD automatically will run its deployment. | ||
|
|
||
| 2. You can see the deployment running on the Deployment list page on the console. When the deployment is done, you can check the application running in your cluster; | ||
|
|
||
| ``` console | ||
| > kubectl get pods | ||
| NAME READY STATUS RESTARTS AGE | ||
| simple-6b47c4c69b-9fmgg 1/1 Running 0 3m6s | ||
| simple-6b47c4c69b-qzpj8 1/1 Running 0 3m6s | ||
| ``` |
There was a problem hiding this comment.
This is not development docs for piped, I think we can remove this 🤔
khanhtc1202
reviewed
Jul 11, 2023
cmd/piped/README.md
Outdated
|
|
||
| ## How to run Piped agent locally | ||
|
|
||
| 1. Prepare the piped configuration file `piped-config.yaml` | ||
| 1. Prepare the piped configuration file `piped-config.yaml`. You can find an example config [here](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped/example/piped-config.yaml). |
There was a problem hiding this comment.
Directly placing piped-config.yaml file here could be better, readers can focus on the docs, not jumping around 😄
Signed-off-by: Kenta Kozuka <[email protected]>
|
@khanhtc1202 Fixed 👍 |
khanhtc1202
reviewed
Jul 11, 2023
cmd/piped/README.md
Outdated
|
|
||
| ## How to run Piped agent locally | ||
|
|
||
| 1. Prepare the piped configuration file `piped-config.yaml` | ||
| 1. Prepare the piped configuration file `piped-config.yaml`. You can find an example config [here](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped/piped-config.yaml). |
There was a problem hiding this comment.
@kentakozuka Sorry, I mean, lets add the content of the example piped-config.yaml file in this file instead of making it a separate file 🙏
Signed-off-by: Kenta Kozuka <[email protected]>
Signed-off-by: Kenta Kozuka <[email protected]>
|
@khanhtc1202 Fixed 👍 |
kentakozuka
commented
Jul 11, 2023
| config: | ||
| # FIXME: Replace here with your kubeconfig absolute file path. | ||
| kubeConfigPath: /path/to/.kube/config | ||
| ``` |
There was a problem hiding this comment.
@khanhtc1202 Is this what you meant?
khanhtc1202
reviewed
Jul 11, 2023
| apiVersion: pipecd.dev/v1beta1 | ||
| kind: Piped | ||
| spec: | ||
| projectID: quickstart |
There was a problem hiding this comment.
Suggested change
| projectID: quickstart | |
| # Replace with the project used when registering for piped ID/Key. | |
| projectID: quickstart |
khanhtc1202
reviewed
Jul 11, 2023
Signed-off-by: Kenta Kozuka <[email protected]>
|
@khanhtc1202 Fixed 👍 |
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #4476
Does this PR introduce a user-facing change?: