Skip to content

Commit

Permalink
Add more details to CONTRIBUTING.md. Describe how to run argo-cd locally
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Matyushentsev authored and Alexander Matyushentsev committed Mar 12, 2018
1 parent cb4a9ac commit 1247c22
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,39 @@

## Requirements
Make sure you have following tools installed [golang](https://golang.org/), [dep](https://github.com/golang/dep), [protobuf](https://developers.google.com/protocol-buffers/),
[kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).

```
brew install go dep protobuf
$ brew install go dep protobuf kubectl
```

Nice to have [gometaliter](https://github.com/alecthomas/gometalinter) and [goreman](https://github.com/mattn/goreman):

```
$ go get -u gopkg.in/alecthomas/gometalinter.v2 github.com/mattn/goreman && gometalinter.v2 --install
```

## Building

```
$ go get -u github.com/argoproj/argo-cd
$ dep ensure
$ make
```

## Running locally

You need to have access to kubernetes cluster (including [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or [docker edge](https://docs.docker.com/docker-for-mac/install/) ) in order to run Argo CD on your laptop:

* install kubectl: `brew install kubectl`
* make sure `kubectl` is connected to your cluster (e.g. `kubectl get pods` should work).
* install application CRD using following command:

```
$ kubectl create -f install/manifests/01_application-crd.yaml
```

* start Argo CD services using [goreman](https://github.com/mattn/goreman):

```
$ goreman start
```
go get -u github.com/argoproj/argo-cd
dep ensure
make
```

0 comments on commit 1247c22

Please sign in to comment.