forked from argoproj/argo-cd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add more details to CONTRIBUTING.md. Describe how to run argo-cd locally
- 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.
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
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 | ||
``` |