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.

Sign up for GitHub

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

Jump to bottom

Add docs for quickstart with raw manifests on README #5152

Merged
merged 1 commit into from
Aug 20, 2024
Merged

Add docs for quickstart with raw manifests on README #5152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,39 @@
This directory contains configuration files for `control-plane` and `piped` for [Quickstart](https://pipecd.dev/docs/quickstart) Guide.



### Quickstart with raw manifests

1. create namespace `pipecd`

```
kubectl create namespace pipecd
```

2. deploy Control Plane to the namespace: pipecd

```
kubectl apply -n pipecd -f ./manifests/control-plane.yaml
```

3. create piped on the Web UI
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's nice for users to show kubectl port-forward command and URL of the Web UI.
WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Warashi
It's a nice idea. But I wonder if I should do so 🤔
For me, this doc is like a memo to describe whats the manifest is.
Also there is the actual process of the quickstart on the docs. https://pipecd.dev/docs-v0.48.x/quickstart/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I got it. I agree that we have other documents about these manifests and don't have to show detailed commands here.


4. overwrite some values in quickstart/manifests/piped.yaml

| placeholder | description |
| ---- | ---- |
| <YOUR_PIPED_ID> | piped id |
| <YOUR_PIPED_KEY> | base64-encoded piped key |
| <YOUR_MANIFESTS_REPO> | the manifest repo url |

5. deploy piped to the namespace: pipecd

```
kubectl apply -n pipecd -f ./manifests/piped.yaml
```

**About the Manifests**

The manifests directory contains raw Kubernetes manifests files. The 2 files are built using `helm template` command.

For `control-plane.yaml`
Expand Down
Loading