apiv1

Documentation

Index

• Variables
• type GuestConfig
• type InitConfig
• type MachineAPI
  • func NewMachineAPI(httpClient *hreq.Client, endpoint string) *MachineAPI
  • func (a *MachineAPI) CreateMachine(req MachineCreateOrUpdateRequest, app string, res *MachineResponse) error
  • func (a *MachineAPI) DeleteMachine(app string, id string, maxRetries int) error
  • func (a *MachineAPI) LockMachine(app string, id string, timeout int) (*MachineLease, error)
  • func (a *MachineAPI) ReadMachine(app string, id string, res *MachineResponse) (*hreq.Response, error)
  • func (a *MachineAPI) ReleaseMachine(lease MachineLease, app string, id string) error
  • func (a *MachineAPI) UpdateMachine(req MachineCreateOrUpdateRequest, app string, id string, res *MachineResponse) error
  • func (a *MachineAPI) WaitForMachine(app string, id string, instanceID string) error
• type MachineConfig
• type MachineCreateOrUpdateRequest
• type MachineLease
• type MachineMount
• type MachineResponse
• type Port
• type Service

Variables

var NonceHeader = "fly-machine-lease-nonce"

Types

type GuestConfig

type GuestConfig struct {
	Cpus     int    `json:"cpus,omitempty"`
	MemoryMb int    `json:"memory_mb,omitempty"`
	CpuType  string `json:"cpu_kind,omitempty"`
}

type InitConfig

type InitConfig struct {
	Cmd        []string `json:"cmd,omitempty"`
	Entrypoint []string `json:"entrypoint,omitempty"`
	Exec       []string `json:"exec,omitempty"`
}

type MachineAPI

type MachineAPI struct {
	// contains filtered or unexported fields
}

func NewMachineAPI

func NewMachineAPI(httpClient *hreq.Client, endpoint string) *MachineAPI

func (*MachineAPI) CreateMachine

func (a *MachineAPI) CreateMachine(req MachineCreateOrUpdateRequest, app string, res *MachineResponse) error

CreateMachine takes a MachineCreateOrUpdateRequest and creates the requested machine in the given app and then writes the response into the `res` param

func (*MachineAPI) DeleteMachine

func (a *MachineAPI) DeleteMachine(app string, id string, maxRetries int) error

func (*MachineAPI) LockMachine

func (a *MachineAPI) LockMachine(app string, id string, timeout int) (*MachineLease, error)

func (*MachineAPI) ReadMachine

func (a *MachineAPI) ReadMachine(app string, id string, res *MachineResponse) (*hreq.Response, error)

func (*MachineAPI) ReleaseMachine

func (a *MachineAPI) ReleaseMachine(lease MachineLease, app string, id string) error

func (*MachineAPI) UpdateMachine

func (a *MachineAPI) UpdateMachine(req MachineCreateOrUpdateRequest, app string, id string, res *MachineResponse) error

func (*MachineAPI) WaitForMachine

func (a *MachineAPI) WaitForMachine(app string, id string, instanceID string) error

type MachineConfig

type MachineConfig struct {
	Image    string            `json:"image"`
	Env      map[string]string `json:"env"`
	Init     InitConfig        `json:"init,omitempty"`
	Mounts   []MachineMount    `json:"mounts,omitempty"`
	Services []Service         `json:"services"`
	Guest    GuestConfig       `json:"guest,omitempty"`
}

type MachineCreateOrUpdateRequest

type MachineCreateOrUpdateRequest struct {
	Name   string        `json:"name"`
	Region string        `json:"region"`
	Config MachineConfig `json:"config"`
}

type MachineLease

type MachineLease struct {
	Status string `json:"status"`
	Data   struct {
		Nonce     string `json:"nonce"`
		ExpiresAt int64  `json:"expires_at"`
		Owner     string `json:"owner"`
	}
}

type MachineMount

type MachineMount struct {
	Encrypted bool   `json:"encrypted,omitempty"`
	Path      string `json:"path"`
	SizeGb    int    `json:"size_gb,omitempty"`
	Volume    string `json:"volume"`
}

type MachineResponse

type MachineResponse struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	State      string `json:"state"`
	Region     string `json:"region"`
	InstanceID string `json:"instance_id"`
	PrivateIP  string `json:"private_ip"`
	Config     struct {
		Env  map[string]string `json:"env"`
		Init struct {
			Exec       []string `json:"exec"`
			Entrypoint []string `json:"entrypoint"`
			Cmd        []string `json:"cmd"`
		} `json:"init"`
		Image    string      `json:"image"`
		Metadata interface{} `json:"metadata"`
		Restart  struct {
			Policy string `json:"policy"`
		} `json:"restart"`
		Services []Service      `json:"services"`
		Mounts   []MachineMount `json:"mounts"`
		Guest    struct {
			CPUKind  string `json:"cpu_kind"`
			Cpus     int    `json:"cpus"`
			MemoryMb int    `json:"memory_mb"`
		} `json:"guest"`
	} `json:"config"`
	ImageRef struct {
		Registry   string `json:"registry"`
		Repository string `json:"repository"`
		Tag        string `json:"tag"`
		Digest     string `json:"digest"`
		Labels     struct {
		} `json:"labels"`
	} `json:"image_ref"`
	CreatedAt time.Time `json:"created_at"`
}

type Port

type Port struct {
	Port     int64    `json:"port"`
	Handlers []string `json:"handlers"`
}

type Service

type Service struct {
	Ports        []Port `json:"ports"`
	Protocol     string `json:"protocol"`
	InternalPort int64  `json:"internal_port"`
}