1a15c4a5aa
* 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.
2 KiB
2 KiB
How to leverage the library (based on the sample client)
For a more complete look at the API, please visit https://godoc.org/github.com/paypal/gorealis
- Create a default configuration file (alternatively, manually create your own Config):
config, err := realis.NewDefaultConfig(*url)
- Create a new Realis client by passing the configuration struct in:
r := realis.NewClient(config)
defer r.Close()
- Construct a job using a Job struct:
job = realis.NewJob().
Environment("prod").
Role("vagrant").
Name("docker-compose").
ExecutorName("docker-compose-executor").
ExecutorData("{}").
CPU(1).
RAM(64).
Disk(100).
IsService(false).
InstanceCount(1).
AddPorts(1).
AddLabel("fileName", "sample-app/docker-compose.yml").
AddURIs(true, true, "https://github.com/mesos/docker-compose-executor/releases/download/0.1.0/sample-app.tar.gz")
- Use client to send a job to Aurora:
r.CreateJob(job)
- Killing an Aurora Job:
r.KillJob(job.GetKey())
- Restarting all instances of an Aurora Job:
r.RestartJob(job.GetKey())
- Adding instances (based on config of instance 0) to Aurora:
r.AddInstances(&aurora.InstanceKey{job.GetKey(),0}, 5)
- Updating the job configuration of a service job:
updateJob := realis.NewUpdateJob(job)
updateJob.InstanceCount(1)
updateJob.Ram(128)
msg, err := r.UpdateJob(updateJob, "")
- Handling a timeout scenario:
When sending an API call to Aurora, the call may timeout at the client side.
This means that the time limit has been reached while waiting for the scheduler
to reply. In such a case it is recommended that the timeout is increased through
the use of the realis.TimeoutMS() option.
As these timeouts cannot be totally avoided, there exists a mechanism to mitigate such
scenarios. The StartJobUpdate and CreateService API will return an error that
implements the Timeout interface.
An error can be checked to see if it is a Timeout error by using the realis.IsTimeout()
function.