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
docs: Updates docs for CII. See #2641 #2643
Changes from 3 commits
9f6b11b
2c880a5
5fcda6c
7ef1436
d2099b7
31b5b4a
bf17332
98214c8
6680de8
47e1d0d
e531e90
844ab69
12ff49d
52e4837
44a189b
56b0036
059479d
1d4d9a4
694664c
2c2b12a
313b33d
3f0688a
744df4b
ab6f453
82da6a9
dd7d724
e63dfa9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,7 @@ Checklist: | |
|
||
* [ ] Either (a) I've created an [enhancement proposal](https://github.com/argoproj/argo/issues/new/choose) and discussed it with the community, (b) this is a bug fix, or (c) this is a chore. | ||
* [ ] The title of the PR is (a) [conventional](https://www.conventionalcommits.org/en/v1.0.0/), (b) states what changed, and (c) suffixes the related issues number. E.g. `"fix(controller): Updates such and such. Fixes #1234"`. | ||
* [ ] I have written unit and/or e2e tests for my change. PRs without these are unlike to be merged. | ||
* [ ] Optional. I've added My organization is added to the USERS.md. | ||
* [ ] I've signed the CLA and required builds are green. | ||
* [ ] I've signed the CLA. | ||
* [ ] I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged. | ||
* [ ] My builds are green. Try syncing with master if they are not. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Provide a nudge on what to do if the build fails. |
||
* [ ] My organization is added to USERS.md. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,85 +1,24 @@ | ||
# How to setup your dev environment | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is a completely new file |
||
## Pre-requisites: | ||
# Contributing | ||
|
||
* Dep. `brew install dep` | ||
* Golang | ||
* Yarn. `brew install yarn` | ||
* Docker | ||
* [Kustomize](https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md) | ||
* [protoc](http://google.github.io/proto-lens/installing-protoc.html) `brew install protoc` | ||
* `jq` | ||
* [Swagger codegen](https://swagger.io/docs/open-source-tools/swagger-codegen/) `brew install swagger-codegen` | ||
* Kubernetes Cluster (we recommend Docker for Desktop + K3D, as this will allow you to test RBAC set-up, and is also fast) | ||
## How To Provide Feedback | ||
|
||
Useful: | ||
Please [raise an issue in Github](https://github.com/argoproj/argo/issues). | ||
|
||
* For a PS1 prompt showing your current kube context: kube-ps1 to help. `brew install kube-ps1` | ||
* For tailing logs: Stern. `brew install stern` | ||
## Code of Conduct | ||
|
||
K3D tip: You can set-up K3D to be part of your default kube config as follows | ||
See [code of conduct](../CODE_OF_CONDUCT.md). | ||
|
||
cp ~/.kube/config ~/.kube/config.bak | ||
cat $(k3d get-kubeconfig --name='k3s-default') >> ~/.kube/config | ||
## How To Contribute | ||
|
||
To install into the “argo” namespace of your cluster: Argo, MinIO (for saving artifacts and logs) and Postgres (for offloading or archiving): | ||
We're always looking for contributors. | ||
|
||
make start | ||
* Documentation - something missing or unclear? Please submit a pull request! | ||
* Code contribution - investigate a [help wanted issue](https://github.com/argoproj/argo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22good+first+issue%22), or anything labelled with "good first issue"? | ||
|
||
If you prefer MySQL: | ||
### Running Locally | ||
|
||
make start DB=mysql | ||
To run Argo Workflows locally for development: [running locally](running-locally.md). | ||
|
||
To expose the services port forwards: | ||
### Test Policy | ||
|
||
make pf | ||
|
||
You’ll now have | ||
|
||
* Argo on http://localhost:2746 (see below) | ||
* MinIO http://localhost:9000 (use admin/password) | ||
|
||
Either: | ||
|
||
* Postgres on http://localhost:5432, run `make postgres-cli` to access. | ||
* MySQL on http://localhost:3306, run `make mysql-cli` to access. | ||
|
||
You need the token to access the CLI or UI: | ||
|
||
eval $(make env) | ||
|
||
./dist/argo auth token | ||
|
||
At this point you’ll have everything you need to use the CLI and UI. | ||
|
||
Tip: If you want to make UI changes without a time-consuming build: | ||
|
||
cd ui | ||
yarn install | ||
yarn start | ||
|
||
The UI will start up on http://localhost:8080. | ||
|
||
If you want to run controller or argo-server in your IDE (e.g. so you can debug it): | ||
|
||
Add to /etc/hosts: | ||
|
||
127.0.0.1 postgres | ||
127.0.0.1 mysql | ||
|
||
Scale down the services you want to debug: | ||
|
||
kubectl -n argo scale deploy/workflow-controller --replicas 0 | ||
kubectl -n argo scale deploy/argo-server --replicas 0 | ||
|
||
Restart the port forwarding: | ||
|
||
make pf | ||
|
||
To find the command arguments you need to use, you’ll have to look at dist/postgres.yaml (or dist/mysql.yaml for MySQL aficionados). | ||
|
||
## Clean | ||
|
||
To clean-up everything: | ||
|
||
kubectl delete ns argo | ||
make clean | ||
Changes without either unit or e2e tests are unlikely to be accepted. See [the pull request template](../.github/pull_request_template.md.) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Public API | ||
|
||
Argo Workflows public API is defined by the following: | ||
|
||
* The file `api/openapi-spec/swagger.json` | ||
* The schema of the table `argo_archived_workflows`. | ||
|
||
See: | ||
|
||
* [Versioning](versioning.md) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
# How to setup your dev environment | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is lift-and-shift of CONTRUBITING.md |
||
## Pre-requisites: | ||
|
||
* Dep. `brew install dep` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. On a different note, should we provide a dev container images that folks can use if they want so they don't have to install all these tools? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. someday, but not today |
||
* Golang | ||
* Yarn. `brew install yarn` | ||
* Docker | ||
* [Kustomize](https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md) | ||
* [protoc](http://google.github.io/proto-lens/installing-protoc.html) `brew install protoc` | ||
* `jq` | ||
* [Swagger codegen](https://swagger.io/docs/open-source-tools/swagger-codegen/) `brew install swagger-codegen` | ||
* Kubernetes Cluster (we recommend Docker for Desktop + K3D, as this will allow you to test RBAC set-up, and is also fast) | ||
|
||
Useful: | ||
|
||
* For a PS1 prompt showing your current kube context: kube-ps1 to help. `brew install kube-ps1` | ||
* For tailing logs: Stern. `brew install stern` | ||
|
||
K3D tip: You can set-up K3D to be part of your default kube config as follows | ||
|
||
cp ~/.kube/config ~/.kube/config.bak | ||
cat $(k3d get-kubeconfig --name='k3s-default') >> ~/.kube/config | ||
|
||
To install into the “argo” namespace of your cluster: Argo, MinIO (for saving artifacts and logs) and Postgres (for offloading or archiving): | ||
|
||
make start | ||
|
||
If you prefer MySQL: | ||
|
||
make start DB=mysql | ||
|
||
To expose the services port forwards: | ||
|
||
make pf | ||
|
||
You’ll now have | ||
|
||
* Argo on http://localhost:2746 (see below) | ||
* MinIO http://localhost:9000 (use admin/password) | ||
|
||
Either: | ||
|
||
* Postgres on http://localhost:5432, run `make postgres-cli` to access. | ||
* MySQL on http://localhost:3306, run `make mysql-cli` to access. | ||
|
||
You need the token to access the CLI or UI: | ||
|
||
eval $(make env) | ||
|
||
./dist/argo auth token | ||
|
||
At this point you’ll have everything you need to use the CLI and UI. | ||
|
||
Tip: If you want to make UI changes without a time-consuming build: | ||
|
||
cd ui | ||
yarn install | ||
yarn start | ||
|
||
The UI will start up on http://localhost:8080. | ||
|
||
If you want to run controller or argo-server in your IDE (e.g. so you can debug it): | ||
|
||
Add to /etc/hosts: | ||
|
||
127.0.0.1 postgres | ||
127.0.0.1 mysql | ||
|
||
Scale down the services you want to debug: | ||
|
||
kubectl -n argo scale deploy/workflow-controller --replicas 0 | ||
kubectl -n argo scale deploy/argo-server --replicas 0 | ||
|
||
Restart the port forwarding: | ||
|
||
make pf | ||
|
||
To find the command arguments you need to use, you’ll have to look at dist/postgres.yaml (or dist/mysql.yaml for MySQL aficionados). | ||
|
||
## Clean | ||
|
||
To clean-up everything: | ||
|
||
kubectl delete ns argo | ||
make clean |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Versioning | ||
|
||
Argo Workflows does not use Semantic Versioning yet. This is because we have not introduced any breaking changes since v2.0. | ||
|
||
See: | ||
|
||
* [Public API](public-api.md) |
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.
spelling