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

Updating documentation for release

Browse source 
Moving godoc reference button

changing casing of top title
This commit is contained in:
Renan DelValle 2016-08-09 16:18:30 -07:00
parent 8e7d7b72d4
commit bf890bf9b0
5 changed files with 48 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,4 +1,4 @@
# GoRealis
# gorealis [![GoDoc](https://godoc.org/github.com/rdelval/gorealis?status.svg)](https://godoc.org/github.com/rdelval/gorealis)
Go library for communicating with Apache Aurora.
Named after the northern lights (Aurora Borealis).
@ -118,17 +118,6 @@ updateJob.Ram(128)
msg, err := r.UpdateJob(updateJob, "")
```
### Methods:
|Method | Arguments | Description|
|----------|------------|------------|
|CreateJob | `*Job` | Sends a job create request to Apache Aurora |
|KillJob | `*aurora.JobKey` | Attempts to kill all active instances running in Aurora. Only needs environment, role, name |
|RestartJob| `*aurora.JobKey` | Attempts to restart all active instances running in Aurora |
|AddInstances|`*aurora.InstanceKey`, `int32`| Launches the specified number of new instances based on existing job config |
|StartUpdateJob|`*UpdateJob`, `string`| Updates a service job with a new configuration |
|AbortUpdateJob|`*aurora.Jobkey`, `string`, `string`| Abort the job update that matches the ID |
## To Do
* Create or import a custom transport that uses https://github.com/jmcvetta/napping to improve efficiency
* Allow library to use ZK to find the master