http

Documentation

Index

• type APIResponse
• type APIResponseCode
  • func (this *APIResponseCode) MarshalJSON() ([]byte, error)
  • func (this *APIResponseCode) String() string
• type HttpAPI
  • func (this *HttpAPI) AbortSeed(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Agent(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentActiveSeeds(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentCreateSnapshot(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentMountLV(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentMySQLStart(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentMySQLStop(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentRecentSeeds(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentRemoveLV(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentSeed(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentSeedDetails(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentSeedStates(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) AgentUnmount(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Agents(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Audit(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) BeginMaintenance(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Cluster(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) Clusters(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) ClustersInfo(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) Discover(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) EndMaintenance(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) EndMaintenanceByInstanceKey(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Forget(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Headers(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) Instance(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) KillQuery(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) LongQueries(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) Maintenance(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) MakeCoMaster(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) MakeLocalMaster(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) MakeMaster(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) MatchBelow(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) MoveBelow(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) MoveUp(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Problems(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) Refresh(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) RegisterRequests(m *martini.ClassicMartini)
  • func (this *HttpAPI) ResetHostnameResolveCache(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) ResetSlave(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) Resolve(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) Search(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAPI) Seeds(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) SetReadOnly(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) SetWriteable(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) StartSlave(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) StopSlave(params martini.Params, r render.Render, req *http.Request, user auth.User)
  • func (this *HttpAPI) StopSlaveNicely(params martini.Params, r render.Render, req *http.Request, user auth.User)
• type HttpAgentsAPI
  • func (this *HttpAgentsAPI) AgentsHosts(params martini.Params, r render.Render, req *http.Request) string
  • func (this *HttpAgentsAPI) AgentsInstances(params martini.Params, r render.Render, req *http.Request) string
  • func (this *HttpAgentsAPI) GetHostAttributeByAttributeName(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAgentsAPI) RegisterRequests(m *martini.ClassicMartini)
  • func (this *HttpAgentsAPI) SetHostAttribute(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpAgentsAPI) SubmitAgent(params martini.Params, r render.Render)
• type HttpWeb
  • func (this *HttpWeb) About(params martini.Params, r render.Render)
  • func (this *HttpWeb) Agent(params martini.Params, r render.Render)
  • func (this *HttpWeb) AgentSeedDetails(params martini.Params, r render.Render)
  • func (this *HttpWeb) Agents(params martini.Params, r render.Render)
  • func (this *HttpWeb) Audit(params martini.Params, r render.Render)
  • func (this *HttpWeb) Cluster(params martini.Params, r render.Render)
  • func (this *HttpWeb) Clusters(params martini.Params, r render.Render)
  • func (this *HttpWeb) Discover(params martini.Params, r render.Render)
  • func (this *HttpWeb) FAQ(params martini.Params, r render.Render)
  • func (this *HttpWeb) Home(params martini.Params, r render.Render)
  • func (this *HttpWeb) LongQueries(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpWeb) RegisterRequests(m *martini.ClassicMartini)
  • func (this *HttpWeb) Search(params martini.Params, r render.Render, req *http.Request)
  • func (this *HttpWeb) Seeds(params martini.Params, r render.Render)

Types

type APIResponse

type APIResponse struct {
	Code    APIResponseCode
	Message string
	Details interface{}
}

APIResponse is a response returned as JSON to various requests.

type APIResponseCode

type APIResponseCode int

APIResponseCode is an OK/ERROR response code

const (
	ERROR APIResponseCode = iota
	OK
)

func (*APIResponseCode) MarshalJSON

func (this *APIResponseCode) MarshalJSON() ([]byte, error)

func (*APIResponseCode) String

func (this *APIResponseCode) String() string

type HttpAPI

type HttpAPI struct{}

var API HttpAPI = HttpAPI{}

func (*HttpAPI) AbortSeed

func (this *HttpAPI) AbortSeed(params martini.Params, r render.Render, req *http.Request, user auth.User)

AbortSeed instructs agents to abort an active seed

func (*HttpAPI) Agent

func (this *HttpAPI) Agent(params martini.Params, r render.Render, req *http.Request, user auth.User)

Agent returns complete information of a given agent

func (*HttpAPI) AgentActiveSeeds

func (this *HttpAPI) AgentActiveSeeds(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentActiveSeeds lists active seeds and their state

func (*HttpAPI) AgentCreateSnapshot

func (this *HttpAPI) AgentCreateSnapshot(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentCreateSnapshot instructs an agent to create a new snapshot. Agent's DIY implementation.

func (*HttpAPI) AgentMountLV

func (this *HttpAPI) AgentMountLV(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentMountLV instructs an agent to mount a given volume on the designated mount point

func (*HttpAPI) AgentMySQLStart

func (this *HttpAPI) AgentMySQLStart(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentMySQLStart starts MySQL service on agent

func (*HttpAPI) AgentMySQLStop

func (this *HttpAPI) AgentMySQLStop(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentMySQLStop stops MySQL service on agent

func (*HttpAPI) AgentRecentSeeds

func (this *HttpAPI) AgentRecentSeeds(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentRecentSeeds lists recent seeds of a given agent

func (*HttpAPI) AgentRemoveLV

func (this *HttpAPI) AgentRemoveLV(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentRemoveLV instructs an agent to remove a logical volume

func (*HttpAPI) AgentSeed

func (this *HttpAPI) AgentSeed(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentSeed completely seeds a host with another host's snapshots. This is a complex operation governed by orchestrator and executed by the two agents involved.

func (*HttpAPI) AgentSeedDetails

func (this *HttpAPI) AgentSeedDetails(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentSeedDetails provides details of a given seed

func (*HttpAPI) AgentSeedStates

func (this *HttpAPI) AgentSeedStates(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentSeedStates returns the breakdown of states (steps) of a given seed

func (*HttpAPI) AgentUnmount

func (this *HttpAPI) AgentUnmount(params martini.Params, r render.Render, req *http.Request, user auth.User)

AgentUnmount instructs an agent to unmount the designated mount point

func (*HttpAPI) Agents

func (this *HttpAPI) Agents(params martini.Params, r render.Render, req *http.Request, user auth.User)

Agents provides complete list of registered agents (See https://github.com/outbrain/orchestrator-agent)

func (*HttpAPI) Audit

func (this *HttpAPI) Audit(params martini.Params, r render.Render, req *http.Request)

Audit provides list of audit entries by given page number

func (*HttpAPI) BeginMaintenance

func (this *HttpAPI) BeginMaintenance(params martini.Params, r render.Render, req *http.Request, user auth.User)

BeginMaintenance begins maintenance mode for given instance

func (*HttpAPI) Cluster

func (this *HttpAPI) Cluster(params martini.Params, r render.Render, req *http.Request)

Cluster provides list of instances in given cluster

func (*HttpAPI) Clusters

func (this *HttpAPI) Clusters(params martini.Params, r render.Render, req *http.Request)

Clusters provides list of known clusters

func (*HttpAPI) ClustersInfo

func (this *HttpAPI) ClustersInfo(params martini.Params, r render.Render, req *http.Request)

ClustersInfo provides list of known clusters, along with some added metadata per cluster

func (*HttpAPI) Discover

func (this *HttpAPI) Discover(params martini.Params, r render.Render, req *http.Request, user auth.User)

Discover starts an asynchronuous discovery for an instance

func (*HttpAPI) EndMaintenance

func (this *HttpAPI) EndMaintenance(params martini.Params, r render.Render, req *http.Request, user auth.User)

EndMaintenance terminates maintenance mode

func (*HttpAPI) EndMaintenanceByInstanceKey

func (this *HttpAPI) EndMaintenanceByInstanceKey(params martini.Params, r render.Render, req *http.Request, user auth.User)

EndMaintenanceByInstanceKey terminates maintenance mode for given instance

func (*HttpAPI) Forget

func (this *HttpAPI) Forget(params martini.Params, r render.Render, req *http.Request, user auth.User)

Forget removes an instance entry fro backend database

func (*HttpAPI) Headers

func (this *HttpAPI) Headers(params martini.Params, r render.Render, req *http.Request)

Headers is a self-test call which returns HTTP headers

func (*HttpAPI) Instance

func (this *HttpAPI) Instance(params martini.Params, r render.Render, req *http.Request)

Instance reads and returns an instance's details.

func (*HttpAPI) KillQuery

func (this *HttpAPI) KillQuery(params martini.Params, r render.Render, req *http.Request, user auth.User)

KillQuery kills a query running on a server

func (*HttpAPI) LongQueries

func (this *HttpAPI) LongQueries(params martini.Params, r render.Render, req *http.Request)

LongQueries lists queries running for a long time, on all instances, optionally filtered by arbitrary text

func (*HttpAPI) Maintenance

func (this *HttpAPI) Maintenance(params martini.Params, r render.Render, req *http.Request)

Maintenance provides list of instance under active maintenance

func (*HttpAPI) MakeCoMaster

func (this *HttpAPI) MakeCoMaster(params martini.Params, r render.Render, req *http.Request, user auth.User)

MakeCoMaster attempts to make an instance co-master with its own master

func (*HttpAPI) MakeLocalMaster

func (this *HttpAPI) MakeLocalMaster(params martini.Params, r render.Render, req *http.Request, user auth.User)

MakeLocalMaster attempts to make the given instance a local master: take over its master by enslaving its siblings and replicating from its grandparent.

func (*HttpAPI) MakeMaster

func (this *HttpAPI) MakeMaster(params martini.Params, r render.Render, req *http.Request, user auth.User)

MakeMaster attempts to make the given instance a master, and match its siblings to be its slaves

func (*HttpAPI) MatchBelow

func (this *HttpAPI) MatchBelow(params martini.Params, r render.Render, req *http.Request, user auth.User)

MatchBelow attempts to move an instance below another via pseudo GTID matching of binlog entries

func (*HttpAPI) MoveBelow

func (this *HttpAPI) MoveBelow(params martini.Params, r render.Render, req *http.Request, user auth.User)

MoveBelow attempts to move an instance below its supposed sibling

func (*HttpAPI) MoveUp

func (this *HttpAPI) MoveUp(params martini.Params, r render.Render, req *http.Request, user auth.User)

MoveUp attempts to move an instance up the topology

func (*HttpAPI) Problems

func (this *HttpAPI) Problems(params martini.Params, r render.Render, req *http.Request)

Problems provides list of instances with known problems

func (*HttpAPI) Refresh

func (this *HttpAPI) Refresh(params martini.Params, r render.Render, req *http.Request, user auth.User)

Refresh synchronuously re-reads a topology instance

func (*HttpAPI) RegisterRequests

func (this *HttpAPI) RegisterRequests(m *martini.ClassicMartini)

RegisterRequests makes for the de-facto list of known API calls

func (*HttpAPI) ResetHostnameResolveCache

func (this *HttpAPI) ResetHostnameResolveCache(params martini.Params, r render.Render, req *http.Request)

Audit provides list of audit entries by given page number

func (*HttpAPI) ResetSlave

func (this *HttpAPI) ResetSlave(params martini.Params, r render.Render, req *http.Request, user auth.User)

ResetSlave makes a slave forget about its master, effectively breaking the replication

func (*HttpAPI) Resolve

func (this *HttpAPI) Resolve(params martini.Params, r render.Render, req *http.Request)

Resolve tries to resolve hostname and then checks to see if port is open on that host.

func (*HttpAPI) Search

func (this *HttpAPI) Search(params martini.Params, r render.Render, req *http.Request)

Search provides list of instances matching given search param via various criteria.

func (*HttpAPI) Seeds

func (this *HttpAPI) Seeds(params martini.Params, r render.Render, req *http.Request, user auth.User)

Seeds retruns all recent seeds

func (*HttpAPI) SetReadOnly

func (this *HttpAPI) SetReadOnly(params martini.Params, r render.Render, req *http.Request, user auth.User)

SetReadOnly sets the global read_only variable

func (*HttpAPI) SetWriteable

func (this *HttpAPI) SetWriteable(params martini.Params, r render.Render, req *http.Request, user auth.User)

SetWriteable clear the global read_only variable

func (*HttpAPI) StartSlave

func (this *HttpAPI) StartSlave(params martini.Params, r render.Render, req *http.Request, user auth.User)

StartSlave starts replication on given instance

func (*HttpAPI) StopSlave

func (this *HttpAPI) StopSlave(params martini.Params, r render.Render, req *http.Request, user auth.User)

StopSlave stops replication on given instance

func (*HttpAPI) StopSlaveNicely

func (this *HttpAPI) StopSlaveNicely(params martini.Params, r render.Render, req *http.Request, user auth.User)

StopSlaveNicely stops replication on given instance, such that sql thead is aligned with IO thread

type HttpAgentsAPI

type HttpAgentsAPI struct{}

var AgentsAPI HttpAgentsAPI = HttpAgentsAPI{}

func (*HttpAgentsAPI) AgentsHosts

func (this *HttpAgentsAPI) AgentsHosts(params martini.Params, r render.Render, req *http.Request) string

AgentsHosts provides list of agent host names

func (*HttpAgentsAPI) AgentsInstances

func (this *HttpAgentsAPI) AgentsInstances(params martini.Params, r render.Render, req *http.Request) string

AgentsInstances provides list of assumed MySQL instances (host:port)

func (*HttpAgentsAPI) GetHostAttributeByAttributeName

func (this *HttpAgentsAPI) GetHostAttributeByAttributeName(params martini.Params, r render.Render, req *http.Request)

GetHostAttributeByAttributeName returns a host attribute

func (*HttpAgentsAPI) RegisterRequests

func (this *HttpAgentsAPI) RegisterRequests(m *martini.ClassicMartini)

RegisterRequests makes for the de-facto list of known API calls

func (*HttpAgentsAPI) SetHostAttribute

func (this *HttpAgentsAPI) SetHostAttribute(params martini.Params, r render.Render, req *http.Request)

SetHostAttribute is a utility method that allows per-host key-value store.

func (*HttpAgentsAPI) SubmitAgent

func (this *HttpAgentsAPI) SubmitAgent(params martini.Params, r render.Render)

SubmitAgent registeres an agent. It is initiated by an agent to register itself.

type HttpWeb

type HttpWeb struct{}

HttpWeb is the web requests server, mapping each request to a web page

var Web HttpWeb = HttpWeb{}

func (*HttpWeb) About

func (this *HttpWeb) About(params martini.Params, r render.Render)

func (*HttpWeb) Agent

func (this *HttpWeb) Agent(params martini.Params, r render.Render)

func (*HttpWeb) AgentSeedDetails

func (this *HttpWeb) AgentSeedDetails(params martini.Params, r render.Render)

func (*HttpWeb) Agents

func (this *HttpWeb) Agents(params martini.Params, r render.Render)

func (*HttpWeb) Audit

func (this *HttpWeb) Audit(params martini.Params, r render.Render)

func (*HttpWeb) Cluster

func (this *HttpWeb) Cluster(params martini.Params, r render.Render)

func (*HttpWeb) Clusters

func (this *HttpWeb) Clusters(params martini.Params, r render.Render)

func (*HttpWeb) Discover

func (this *HttpWeb) Discover(params martini.Params, r render.Render)

func (*HttpWeb) FAQ

func (this *HttpWeb) FAQ(params martini.Params, r render.Render)

func (*HttpWeb) Home

func (this *HttpWeb) Home(params martini.Params, r render.Render)

func (*HttpWeb) LongQueries

func (this *HttpWeb) LongQueries(params martini.Params, r render.Render, req *http.Request)

func (*HttpWeb) RegisterRequests

func (this *HttpWeb) RegisterRequests(m *martini.ClassicMartini)

RegisterRequests makes for the de-facto list of known Web calls

func (*HttpWeb) Search

func (this *HttpWeb) Search(params martini.Params, r render.Render, req *http.Request)

func (*HttpWeb) Seeds

func (this *HttpWeb) Seeds(params martini.Params, r render.Render)