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

docs: Update running-locally.md #4961

Merged
merged 1 commit into from
Jan 28, 2021
Merged

docs: Update running-locally.md #4961

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
43 changes: 6 additions & 37 deletions docs/running-locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@

We recommend using [K3D](https://k3d.io/) 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:

cp ~/.kube/config ~/.kube/config.bak
cat $(k3d kubeconfig get k3s-default) >> ~/.kube/config
k3d cluster start --wait

Alternatively, you can use [Minikube](https://github.com/kubernetes/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.

Expand All @@ -24,57 +23,27 @@ Add to /etc/hosts:
127.0.0.1 postgres
127.0.0.1 mysql

To install into the “argo” namespace of your cluster: Argo, MinIO (for saving artifacts and logs) and Postgres (for offloading or archiving):
To install into the “argo” namespace of your cluster: Argo and MinIO (for saving artifacts and logs):

make start

If you prefer MySQL:
If you want MySQL for the workflow archive:

make start DB=mysql
make start PROFILE=mysql

You’ll now have

* Argo on https://localhost:2746
* Argo Server API on https://localhost:2746
* UI on http://localhost:8080
* 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.

## User Interface

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.

## Debugging

If you want to run controller or argo-server in your IDE (e.g. so you can debug it):


Start with only components you don't want to debug;

make start COMPONENTS=controller

Or

make start COMPONENTS=argo-server

To find the command arguments you need to use, you’ll have to look at the `start` target in the `Makefile`.`

## Clean

To clean-up everything:
Expand Down