The highest tagged major version is v2.

jr

package

v0.8.2-alpha Latest Latest Go to latest Published: Nov 6, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/square/spincycle

Links

Open Source Insights

README ¶

Job Runner API

TODO: Fill this out

Running the Code

Update the import path of your jobs in spincycle/job/external/factory
In the root spincycle directory, run go get ./...
Run the JR web server: go run spincycle/job-runner/main.go
Send commands to the web server:

# POST a new chain
curl -H "Content-Type: application/json" -X POST -d '<CHAIN_PAYLOAD>' localhost:9999/api/v1/job-chains

# PUT a chain that is running to start it
curl -X PUT localhost:9999/api/v1/job-chains/<REQUEST_ID_OF_THE_CHAIN>/start

# PUT a chain that is running to stop it
curl -X PUT localhost:9999/api/v1/job-chains/<REQUEST_ID_OF_THE_CHAIN>/stop

# GET the status of a running chain
curl localhost:9999/api/v1/job-chains/<REQUEST_ID_OF_THE_CHAIN>/status

TODOs

When a traverser finishes, it should POST back to the Request Manager API the final status of the chain.
Make basic things configurable (ex: port for http server).
Simplify http routing stuff.

Documentation ¶

Overview ¶

Package client provides an HTTP client for interacting with the Job Runner (JR) API.

Index ¶

type Client
- func NewClient(c *http.Client, baseUrl string) Client

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	// NewJobChain takes a job chain, and sends it to the JR to be run immediately.
	NewJobChain(proto.JobChain) error
	// ResumeJobChain takes a suspended job chain and sends it to the JR to be resumed.
	ResumeJobChain(proto.SuspendedJobChain) error
	// StopRequest stops the job chain that corresponds to a given request Id.
	StopRequest(string) error
	// RequestStatus gets the status of the job chain that corresponds to a given request Id.
	RequestStatus(string) (proto.JobChainStatus, error)

	// SysStatRunning reports all running jobs.
	SysStatRunning() ([]proto.JobStatus, error)
}

A Client is an HTTP client used for interacting with the JR API.

func NewClient ¶

func NewClient(c *http.Client, baseUrl string) Client

NewClient takes an http.Client and base API URL and creates a Client.

Source Files ¶

View all Source files

client.go

Directories ¶

Path	Synopsis
api Package api provides controllers for each api endpoint.	Package api provides controllers for each api endpoint.
app
bin
chain Package chain implements a job chain.	Package chain implements a job chain.
runner Package runner implements running a job.	Package runner implements running a job.
server Package server bootstraps the Job Runner.	Package server bootstraps the Job Runner.
status Package status provides system-wide status.	Package status provides system-wide status.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL