Commit graph

27 commits

Author SHA1 Message Date
Renan DelValle
df8fc2fba1
Documentation and linting improvements (#108)
* Simplifying documentation for getting started: Removed outdated information about install Golang on different platforms and instead included a link to the official Golang website which has more up to date information. Instructions for installing docker-compose have also been added.

* Added documentation to all exported functions and structs.

* Unexported some structures and functions that were needlessly exported.

* Adding golang CI default configuration which can be useful while developing and may be turned on later in the CI.

* Moving build process in CI to xenial.

* Reducing line size. in some files and shadowing in some test cases.
2019-06-12 11:22:59 -07:00
Renan DelValle
1a15c4a5aa
V1 CreateService and StartJobUpdate Timeout signal and cleanup (#105)
* Bumped up version to 1.21.1

* Moving admin functions to a new file. They are still part of the same pointer receiver type.

* Removing dead code and fixing some comments to add space between backslash and comment.

* Adding set up and tear down to run tests script. It sets up a pod, runs all tests, and then tears down the pod.

* Added `--rm` to run tests Mac script.

* Removing cookie jar from transport layer as it's not needed.

* Changing all error messages to start with a lower case letter. Changing some messages around to be more descriptive.

* Adding an argument to allow the retry mechanism to stop if a timeout has been encountered. This is useful for mutating API calls. Only StartUpdate and CreateService have enabled by default stop at timeout.

* Added 2 tests for when a call goes through despite the client timing out. One is with a good payload, one is with a bad payload.

* Updating changelog with information about the error type returned.

* Adding test for duplicate metadata.

* Refactored JobUpdateStatus monitor to use a new monitor called JobUpdateQuery. Update monitor will now still continue if it does not find an update to monitor. Furthermore, it has been optimized to reduce returning payloads from the scheduler as much as possible. This is through using the GetJobUpdateSummaries API instead of JobUpdateDetails and by including a the statuses we're searching for as part of the query.


* Added documentation as to how to handle a timeout on an API request.

* Optimized GetInstancesIds to create a copy of the JobKey being passed down in order to avoid unexpected behavior. Instead of setting every variable name separately, now a JobKey array is being created.
2019-05-05 11:46:22 -07:00
Renan DelValle
1c2b1c5079
Continous integration through Travis CI (#71)
* Adding Travis CI badge

* Modifying end to end tests to reflect testing against docker-compose setup in Travis CI.

* Adding bash script to run simple container with tests within bridge network for Mac.

* Adding documentation for setting up a developer environment.

* Decreasing amount of CPU needed for CreateJobWithPulse because a higher value causes Travis CI to hang.
2018-08-13 20:09:25 -07:00
PRADYUMNA KAUSHIK
0e4a0d726b Fix JSON client example and Update documentation. (#67)
* Updated the JSON client to be consistent with the library.
The JSON client requires two JSONs,
1. JOB json -- contains job description.
2. Config json -- contains configuration information such as username,
	password, schedulerUrl, zookeeper cluster configuration etc.

* Job json using docker-compose executor.

Used https://github.com/paypal/dce-go/blob/develop/examples/client.go#L50
to create a json file for a job that uses the docker-compose executor.
The current job json file (examples/job.json) uses an outdated version
of docker-compose executor. Once examples/client.go has been modified
to use examples/job_dce.json, it should be okay to get rid of
examples/job.json.

* Run thermos jobs using json client.

Added an extra field to JobJson, ExecutorDataFile, that holds
the path to the json file representing the executor configuration
data.
Added a new example job json file (examples/job_thermos.json) that
is to be passed to the json client along with the config file to
run a thermos job.

* Using scheduler URL instead of leader from zk.

The endpoints returned by ZKEndpoints(...) is not reachable
from outside the vagrant box. Hence, using the scheduler URL
directly.

* Added docs for using dce-go and json client.

* Place json client docs in separate subsection.

* Config now embeds realis.Cluster to be backwards compatible with
the python client cluster.json file.
Changed the type of Transport to string to stay flexible if new
transport types come up. JSON is used as the default transport option
is not transport is provided with the config.
2018-07-13 11:14:11 +02:00
Renan DelValle
8d445c1c77
Moving from govendor to dep, updated dependencies (#48)
* Moving from govendor to dep.

* Making the pull request template more friendly.

* Fixing akward space in PR template.

* goimports run on whole project using ` goimports -w $(find . -type f -name '*.go' -not -path "./vendor/*" -not -path "./gen-go/*")`

source of command: https://gist.github.com/bgentry/fd1ffef7dbde01857f66
2018-01-07 13:13:47 -08:00
PRADYUMNA KAUSHIK
ff545e8aa6 Fixing semantic errors in docs/getting-started.md (#44)
* fixed semantics. Earlier mentioned that 'Pystachio does yet support...'. Changed now to mention 'Pystachio does not yet support...'

* fixed grammatical mistake.

* Ran gofmt on project.
2017-12-22 08:53:05 -08:00
Renan DelValle
a1350c6d55 out with the old (address) in with the new (address) 2017-10-12 17:11:01 -07:00
mbdas
2c7dd3468f Update getting-started.md 2016-12-20 23:07:46 -08:00
Mothiki
a8fa05869c fix typo in the docs/using-the-sample-client.md 2016-10-07 12:59:08 -07:00
Renan DelValle
3fd957fe5c Updating library for compatibility with Aurora 0.16.0 final. Thrift API differs from main Aurora one due to TaskUpdateQuery fields resulting in errors when serialized by thrift as non-optionals. 2016-09-29 20:45:24 -04:00
Renan DelValle
917bdca354 Changed return of activeCount. Updated client usage docs 2016-08-26 16:39:56 -07:00
Renan DelValle
01b700554a Added the ability to monitor job updates.
Added the ability to kill and restart specific instances.
Fixed incorrect documentation on using-the-sample-client.
Added helper functions under the response package to extract fields from
aurora.Response.
2016-08-25 18:56:55 -07:00
Renan DelValle
f4ac7abe1b Updating documentation on client usage 2016-08-18 14:35:58 -07:00
Renan DelValle
c62e5ab750 Fixing a typo on the cleaning up section 2016-08-15 14:43:53 -07:00
Renan DelValle
2f410e98d2 Adding example on what to do if user (role) doesn't exist on the Agent on which the task will run 2016-08-15 14:41:37 -07:00
Renan DelValle
1e284baaf3 Minor changes to documentation to make it more complete 2016-08-15 12:29:38 -07:00
Renan DelValle
c610974208 Moved Realis to be an interface for future testing classes. Removed AddURI API as AddURIs is able to do the same thing 2016-08-12 12:48:42 -07:00
Misho Krastev
80f11cf78b minor corrections to documentation and comments 2016-08-11 21:21:47 -07:00
Renan DelValle
4c21757dae Reformatting 2016-08-11 12:45:32 -07:00
Renan DelValle
4dd0029d0d Fixing the formatting and some incorrect info 2016-08-11 12:38:26 -07:00
Renan DelValle
c3a29f4940 Integrated information from using the sample client document and reframed the sample client document. Added a link from the README to the getting-started page. 2016-08-11 11:43:47 -07:00
Renan DelValle
a258b75b15 Fixing mistakes in how to configure Aurora installation from deb file 2016-08-10 16:07:19 -07:00
Renan DelValle
c2acbe0b36 Numerous changes to documentation to make it more accurate. 2016-08-10 15:25:02 -07:00
Renan DelValle
d85eae05b7 Fixing link to the wrong guide 2016-08-10 12:04:19 -07:00
Renan DelValle
7aa6c07c66 Cleaned up the README and added new information to Getting_Started.
Made client point to new location of docker-compose-executor release
2016-08-10 11:46:08 -07:00
Renan DelValle
4e818fdd30 Rearranging documentation to make it more easily digestible 2016-08-09 17:10:02 -07:00
Renan DelValle
8f85c75b94 Starting point for getting started 2016-08-09 16:29:37 -07:00