ridv/gorealis
1
0
Fork 0
Code Issues Pull requests Projects Releases 23 Packages Wiki Activity Actions

Added docs for using dce-go and json client.

Browse source
This commit is contained in:
Pradyumna Kaushik 2018-06-21 20:51:11 -07:00
parent b1992ba6d0
commit 7cb3efd784
1 changed files with 29 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/getting-started.md
View file

@ -94,6 +94,15 @@ client must be used in order to launch tasks using a custom executor. In this ca
we will be using [gorealis](https://github.com/paypal/gorealis) to launch a task with we will be using [gorealis](https://github.com/paypal/gorealis) to launch a task with
the compose executor on Aurora. the compose executor on Aurora.
## Using [dce-go](https://github.com/paypal/dce-go)
Instead of manually configuring Aurora to run the docker-compose executor, one can follow the instructions provided [here](https://github.com/paypal/dce-go/blob/develop/docs/environment.md) to quickly create a DCE environment that would include mesos, aurora, golang1.7, docker, docker-compose and DCE installed.
Please note that when using dce-go, the endpoints are going to be as shown below,
```
Aurora endpoint --> http://192.168.33.8:8081
Mesos endpoint --> http://192.168.33.8:5050
```
## Configuring the system to run a custom client and docker-compose executor ## Configuring the system to run a custom client and docker-compose executor
### Installing Go ### Installing Go
@ -162,7 +171,7 @@ $ source $HOME/.profile
Download and run the msi installer from https://golang.org/dl/ Download and run the msi installer from https://golang.org/dl/
## Installing Docker Compose ## Installing Docker Compose (if manually configured Aurora)
To show Aurora's new multi executor feature, we need to use at least one custom executor. To show Aurora's new multi executor feature, we need to use at least one custom executor.
In this case we will be using the [docker-compose-executor](https://github.com/mesos/docker-compose-executor). In this case we will be using the [docker-compose-executor](https://github.com/mesos/docker-compose-executor).
@ -298,7 +307,7 @@ To stop the jobs we've launched, we need to send a job kill request to Aurora.
It should be noted that although we can't create jobs using a custom executor using the default Aurora client, It should be noted that although we can't create jobs using a custom executor using the default Aurora client,
we ~can~ use the default Aurora client to kill them. Additionally, we can use gorealis perform the clean up as well. we ~can~ use the default Aurora client to kill them. Additionally, we can use gorealis perform the clean up as well.
## Using the Default Client ## Using the Default Client (if manually configured Aurora)
``` ```
$ aurora job killall devcluster/www-data/prod/hello $ aurora job killall devcluster/www-data/prod/hello
@ -307,7 +316,25 @@ $ aurora job killall devcluster/vagrant/prod/docker-compose
## Using gorealis ## Using gorealis
If manually configured Aurora to use docker-compose executor,
``` ```
$ go run $GOPATH/src/github.com/paypal/gorealis/examples/client.go -executor=compose -url=http://192.168.33.7:8081 -cmd=kill $ go run $GOPATH/src/github.com/paypal/gorealis/examples/client.go -executor=compose -url=http://192.168.33.7:8081 -cmd=kill
$ go run $GOPATH/src/github.com/paypal/gorealis/examples/client.go -executor=thermos -url=http://192.168.33.7:8081 -cmd=kill $ go run $GOPATH/src/github.com/paypal/gorealis/examples/client.go -executor=thermos -url=http://192.168.33.7:8081 -cmd=kill
``` ```
If using _dce-go_, then update the scheduler URL in the above commands to `http://192.168.33.8:8081`.
### Json Client
```
$ cd $GOPATH/src/github.com/paypal/gorealis/examples
```
To launch a job using the Thermos executor,
```
$ go run jsonClient.go -job=job_thermos.json -config=config.json
```
To launch a job using docker-compose executor,
```
$ go run jsonClient.go -job=job_dce.json -config=config.json
```