Code must be checked out into $(GOPATH)/src/github.com/argo-workflows.
We recommend using K3D to set up the local Kubernetes cluster since this will allow you to test RBAC set-up and is fast. You can set-up K3D to be part of your default kube config as follows:
k3d cluster start --wait
Alternatively, you can use Minikube to set up the local Kubernetes cluster.
Once a local Kubernetes cluster has started via minikube start, your kube config will use Minikube's context
automatically.
Add to /etc/hosts:
127.0.0.1 dex
127.0.0.1 minio
127.0.0.1 postgres
127.0.0.1 mysql
To install into the “argo” namespace of your cluster: Argo and MinIO (for saving artifacts and logs):
make start
If you want the UI:
make start UI=true
If you want MySQL for the workflow archive:
make start PROFILE=mysql
For testing SSO integration, you can start a Argo with sso profile which will deploy a pre-configured dex instance in argo namespace
make start PROFILE=sso
You’ll now have:
- MinIO on http:https://localhost:9000 (use admin/password)
- Argo Server API on https://localhost:2746
- UI on http:https://localhost:8080
- Postgres on http:https://localhost:5432, run
make postgres-clito access. - MySQL on http:https://localhost:3306, run
make mysql-clito access.
Before submitting/running workflows, build all the executor image:
make argoexec-image
Before you commit, run:
make pre-commit -B
Commits
- Sign-off your commits.
- Use Conventional Commit messages.
- Suffix the issue number.
Example:
git commit --signoff -m 'fix: Fixed broken thing. Fixes #1234'
- If you get a similar error when running one of the make pre-commit
tests
make: *** [pkg/apiclient/clusterworkflowtemplate/cluster-workflow-template.swagger.json] Error 1, ensure you are working within your $GOPATH (YOUR-GOPATH/src/github.com/argoproj/argo-workflows). - If you encounter out of heap issues when building UI through Docker, please validate resources allocated to Docker. Compilation may fail if allocated RAM is less than 4Gi