-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
18 changed files
with
172 additions
and
110 deletions.
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Security | ||
|
||
## Reporting Vulnerabilities | ||
|
||
Please report security vulnerabilities by e-mailing: | ||
|
||
* [Jesse_Suen@intuit.com](mailto:Jesse_Suen@intuit.com) | ||
* [Alex_Collins@intuit.com](mailto:Alex_Collins@intuit.com) | ||
* [Edward_Lee@intuit.com](mailto:Edward_Lee@intuit.com) | ||
|
||
## Public Disclosure | ||
|
||
Security vulnerabilities will be disclosed via [release notes](docs/releasing.md). | ||
|
||
## Vulnerability Scanning | ||
|
||
See [static code analysis](static-code-analysis.md). |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,85 +1,25 @@ | ||
# How to setup your dev environment | ||
## 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"? | ||
* Join the #argo-devs channel on [our Slack](https://argoproj.github.io/community/join-slack). | ||
|
||
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.) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Argo Server | ||
|
||
![alpha](assets/alpha.svg) | ||
![GA](assets/ga.svg) | ||
|
||
> v2.5 and after | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,7 +8,7 @@ argo --help | |
|
||
# Argo Server | ||
|
||
![alpha](assets/alpha.svg) | ||
![GA](assets/ga.svg) | ||
|
||
> v2.5 and after | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Cron Workflows | ||
|
||
![alpha](assets/alpha.svg) | ||
![GA](assets/ga.svg) | ||
|
||
> v2.5 and after | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Managed Namespace | ||
|
||
![alpha](assets/alpha.svg) | ||
![GA](assets/ga.svg) | ||
|
||
> v2.5 and after | ||
|
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
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) |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
|
||
## Argo Server API | ||
|
||
![alpha](assets/alpha.svg) | ||
![GA](assets/ga.svg) | ||
|
||
> v2.5 and after | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
# How to setup your dev environment | ||
## Pre-requisites: | ||
|
||
* 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) | ||
|
||
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 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Static Code Analysis | ||
|
||
We use the following static code analysis tools: | ||
|
||
* golangci-lint and tslint for compile time linting | ||
* [codecov.io](https://codecov.io/gh/argoproj/argo) - for code coverage | ||
* [snyk.io](https://app.snyk.io/org/argoproj/projects) - for image scanning | ||
* [sonarcloud.io](https://sonarcloud.io/organizations/argoproj/projects) - for code scans and security alerts | ||
|
||
These are at least run daily or on each pull request. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Versioning | ||
|
||
Argo Workflows does not use Semantic Versioning, even though we have not introduced any breaking changes since v2. | ||
|
||
Breaking changes will be communicated in the release notes. | ||
|
||
See: | ||
|
||
* [Public API](public-api.md) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Workflow Archive | ||
|
||
![alpha](assets/alpha.svg) | ||
![beta](assets/beta.svg) | ||
|
||
> v2.5 and after | ||
|