Documentation
¶
Index ¶
- Variables
- type App
- type Apps
- type Build
- type Builds
- type Client
- func (c *Client) AddRegistry(server, username, password, email string) (*Registry, error)
- func (c *Client) Auth() error
- func (c *Client) CreateApp(name string) (*App, error)
- func (c *Client) CreateBuildSource(app string, source []byte, cache bool, config string) (*Build, error)
- func (c *Client) CreateBuildUrl(app string, url string, cache bool, config string) (*Build, error)
- func (c *Client) CreateLink(app, name string) (*Service, error)
- func (c *Client) CreateSSL(app, process, port, body, key string, chain string, secure bool) (*SSL, error)
- func (c *Client) CreateService(kind string, options map[string]string) (*Service, error)
- func (c *Client) Delete(path string, out interface{}) error
- func (c *Client) DeleteApp(name string) (*App, error)
- func (c *Client) DeleteEnvironment(app, key string) (Environment, string, error)
- func (c *Client) DeleteLink(app, name string) (*Service, error)
- func (c *Client) DeleteResponse(path string, out interface{}) (*http.Response, error)
- func (c *Client) DeleteSSL(app, process, port string) (*SSL, error)
- func (c *Client) DeleteService(name string) (*Service, error)
- func (c *Client) ExecProcessAttached(app, pid, command string, in io.Reader, out io.WriteCloser) (int, error)
- func (c *Client) Get(path string, out interface{}) error
- func (c *Client) GetApp(name string) (*App, error)
- func (c *Client) GetApps() (Apps, error)
- func (c *Client) GetBuild(app, id string) (*Build, error)
- func (c *Client) GetBuilds(app string) (Builds, error)
- func (c *Client) GetEnvironment(app string) (Environment, error)
- func (c *Client) GetInstances() ([]*Instance, error)
- func (c *Client) GetProcesses(app string, stats bool) (Processes, error)
- func (c *Client) GetRelease(app, id string) (*Release, error)
- func (c *Client) GetReleases(app string) (Releases, error)
- func (c *Client) GetService(name string) (*Service, error)
- func (c *Client) GetServices() (Services, error)
- func (c *Client) GetSystem() (*System, error)
- func (c *Client) GetSystemReleases() (Releases, error)
- func (c *Client) InstanceKeyroll() error
- func (c *Client) ListFormation(app string) (Formation, error)
- func (c *Client) ListRegistries() (*Registries, error)
- func (c *Client) ListSSL(app string) (*SSLs, error)
- func (c *Client) Post(path string, params Params, out interface{}) error
- func (c *Client) PostBody(path string, body io.Reader, out interface{}) error
- func (c *Client) PostBodyResponse(path string, body io.Reader, out interface{}) (*http.Response, error)
- func (c *Client) PostMultipart(path string, files map[string][]byte, params Params, out interface{}) error
- func (c *Client) PromoteRelease(app, id string) (*Release, error)
- func (c *Client) Put(path string, params Params, out interface{}) error
- func (c *Client) PutBody(path string, body io.Reader, out interface{}) error
- func (c *Client) RemoveRegistry(server string) (*Registry, error)
- func (c *Client) RunProcessAttached(app, process, command string, in io.Reader, out io.WriteCloser) (int, error)
- func (c *Client) RunProcessDetached(app, process, command string) error
- func (c *Client) SSHInstance(id, cmd string, height, width int, isTerm bool, in io.Reader, ...) (int, error)
- func (c *Client) ScaleSystem(count int, typ string) (*System, error)
- func (c *Client) SetEnvironment(app string, body io.Reader) (Environment, string, error)
- func (c *Client) SetFormation(app, process, count, memory string) error
- func (c *Client) StopProcess(app, id string) (*Process, error)
- func (c *Client) Stream(path string, headers map[string]string, in io.Reader, out io.WriteCloser) error
- func (c *Client) StreamAppLogs(app string, output io.WriteCloser) error
- func (c *Client) StreamBuildLogs(app, id string, output io.WriteCloser) error
- func (c *Client) StreamReleaseLogs(app, id string, output io.WriteCloser) error
- func (c *Client) Switch(rackName string) (success map[string]string, err error)
- func (c *Client) TerminateInstance(id string) error
- func (c *Client) UpdateSSL(app, process, port, body, key string, chain string) (*SSL, error)
- func (c *Client) UpdateSystem(version string) (*System, error)
- func (c *Client) UpdateSystemOriginal(version string) (*System, error)
- func (c *Client) WithoutVersionCheck(fn func(c *Client))
- type Environment
- type Error
- type Formation
- type FormationEntry
- type Instance
- type NotifyEvent
- type Params
- type Process
- type Processes
- type Registries
- type Registry
- type Release
- type Releases
- type SSL
- type SSLs
- type Service
- type Services
- type System
Constants ¶
This section is empty.
Variables ¶
View Source
var MinimumServerVersion = "20151023042141"
View Source
var StatusCodePrefix = "F1E49A85-0AD7-4AEF-A618-C249C6E6568D:"
this just needs to be random enough to never show up again in a byte stream
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
Host string
Password string
Version string
// contains filtered or unexported fields
}
func (*Client) AddRegistry ¶
func (*Client) CreateBuildSource ¶
func (*Client) CreateBuildUrl ¶
func (*Client) CreateService ¶
func (*Client) DeleteEnvironment ¶
func (c *Client) DeleteEnvironment(app, key string) (Environment, string, error)
func (*Client) DeleteResponse ¶
func (*Client) ExecProcessAttached ¶
func (*Client) GetEnvironment ¶
func (c *Client) GetEnvironment(app string) (Environment, error)
func (*Client) GetInstances ¶
func (*Client) GetProcesses ¶
func (*Client) GetServices ¶
func (*Client) GetSystemReleases ¶
func (*Client) InstanceKeyroll ¶
func (*Client) ListRegistries ¶
func (c *Client) ListRegistries() (*Registries, error)
func (*Client) PostBodyResponse ¶
func (*Client) PostMultipart ¶
func (*Client) RunProcessAttached ¶
func (*Client) RunProcessDetached ¶
func (*Client) SSHInstance ¶
func (*Client) SetEnvironment ¶
func (*Client) SetFormation ¶
func (*Client) StreamAppLogs ¶
func (c *Client) StreamAppLogs(app string, output io.WriteCloser) error
func (*Client) StreamBuildLogs ¶
func (c *Client) StreamBuildLogs(app, id string, output io.WriteCloser) error
func (*Client) StreamReleaseLogs ¶
func (c *Client) StreamReleaseLogs(app, id string, output io.WriteCloser) error
func (*Client) TerminateInstance ¶
func (*Client) UpdateSystemOriginal ¶
func (*Client) WithoutVersionCheck ¶
type Environment ¶
type Formation ¶
type Formation []FormationEntry
type FormationEntry ¶
type NotifyEvent ¶
type NotifyEvent struct {
Action string `json:"action"`
Status string `json:"status"`
Data map[string]string `json:"data"`
Timestamp time.Time `json:"timestamp"`
}
a NotifyEvent is the payload of any webhook services it is serialized to json
type Process ¶
type Process struct {
Id string `json:"id"`
App string `json:"app"`
Command string `json:"command"`
Host string `json:"host"`
Image string `json:"image"`
Name string `json:"name"`
Ports []string `json:"ports"`
Release string `json:"release"`
Size int64 `json:"size"`
Cpu float64 `json:"cpu"`
Memory float64 `json:"memory"`
Started time.Time `json:"started"`
}
type Registries ¶
Mirrors Docker AuthConfiguration119 https://godoc.org/github.com/fsouza/go-dockerclient#AuthConfigurations119
type Registry ¶
type Registry struct {
Username string `json:"username,omitempty"`
Password string `json:"password,omitempty"`
Email string `json:"email,omitempty"`
ServerAddress string `json:"serveraddress,omitempty"`
}
Mirrors Docker AuthConfiguration https://godoc.org/github.com/fsouza/go-dockerclient#AuthConfiguration
type Service ¶
type Service struct {
Name string `json:"name"`
Status string `json:"status"`
StatusReason string `json:"status-reason"`
Type string `json:"type"`
Exports map[string]string `json:"exports"`
// DEPRECATED: should inject any data in Exports
// we only set this on the outgoing response for old clients
URL string `json:"url"`
Outputs map[string]string `json:"-"`
Parameters map[string]string `json:"-"`
Tags map[string]string `json:"-"`
}
Click to show internal directories.
Click to hide internal directories.