resources.go

package receptor

import "github.com/cloudfoundry-incubator/bbs/models"

const AuthorizationCookieName = "receptor_authorization"

type EnvironmentVariable struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type PortMapping struct {
	ContainerPort uint16 `json:"container_port"`
	HostPort      uint16 `json:"host_port,omitempty"`
}

const (
	TaskStateInvalid   = "INVALID"
	TaskStatePending   = "PENDING"
	TaskStateRunning   = "RUNNING"
	TaskStateCompleted = "COMPLETED"
	TaskStateResolving = "RESOLVING"
)

type TaskCreateRequest struct {
	Action                *models.Action                `json:"action"`
	Annotation            string                        `json:"annotation,omitempty"`
	CompletionCallbackURL string                        `json:"completion_callback_url"`
	CPUWeight             uint                          `json:"cpu_weight"`
	DiskMB                int                           `json:"disk_mb"`
	Domain                string                        `json:"domain"`
	LogGuid               string                        `json:"log_guid"`
	LogSource             string                        `json:"log_source"`
	MetricsGuid           string                        `json:"metrics_guid"`
	MemoryMB              int                           `json:"memory_mb"`
	ResultFile            string                        `json:"result_file"`
	TaskGuid              string                        `json:"task_guid"`
	RootFS                string                        `json:"rootfs"`
	Privileged            bool                          `json:"privileged"`
	EnvironmentVariables  []*models.EnvironmentVariable `json:"env,omitempty"`
	EgressRules           []*models.SecurityGroupRule   `json:"egress_rules,omitempty"`
}

type TaskResponse struct {
	Action                *models.Action                `json:"action"`
	Annotation            string                        `json:"annotation,omitempty"`
	CompletionCallbackURL string                        `json:"completion_callback_url"`
	CPUWeight             uint                          `json:"cpu_weight"`
	DiskMB                int                           `json:"disk_mb"`
	Domain                string                        `json:"domain"`
	LogGuid               string                        `json:"log_guid"`
	LogSource             string                        `json:"log_source"`
	MetricsGuid           string                        `json:"metrics_guid"`
	MemoryMB              int                           `json:"memory_mb"`
	ResultFile            string                        `json:"result_file"`
	TaskGuid              string                        `json:"task_guid"`
	RootFS                string                        `json:"rootfs"`
	Privileged            bool                          `json:"privileged"`
	EnvironmentVariables  []*models.EnvironmentVariable `json:"env,omitempty"`
	CellID                string                        `json:"cell_id"`
	CreatedAt             int64                         `json:"created_at"`
	Failed                bool                          `json:"failed"`
	FailureReason         string                        `json:"failure_reason"`
	Result                string                        `json:"result"`
	State                 string                        `json:"state"`
	EgressRules           []*models.SecurityGroupRule   `json:"egress_rules,omitempty"`
}

type RoutingInfo models.Routes

type DesiredLRPCreateRequest struct {
	ProcessGuid          string                      `json:"process_guid"`
	Domain               string                      `json:"domain"`
	RootFS               string                      `json:"rootfs"`
	Instances            int                         `json:"instances"`
	EnvironmentVariables []EnvironmentVariable       `json:"env,omitempty"`
	Setup                *models.Action              `json:"setup"`
	Action               *models.Action              `json:"action"`
	Monitor              *models.Action              `json:"monitor"`
	StartTimeout         uint                        `json:"start_timeout"`
	DiskMB               int                         `json:"disk_mb"`
	MemoryMB             int                         `json:"memory_mb"`
	CPUWeight            uint                        `json:"cpu_weight"`
	Privileged           bool                        `json:"privileged"`
	Ports                []uint16                    `json:"ports"`
	Routes               RoutingInfo                 `json:"routes,omitempty"`
	LogGuid              string                      `json:"log_guid"`
	LogSource            string                      `json:"log_source"`
	MetricsGuid          string                      `json:"metrics_guid"`
	Annotation           string                      `json:"annotation,omitempty"`
	EgressRules          []*models.SecurityGroupRule `json:"egress_rules,omitempty"`
}

type DesiredLRPUpdateRequest struct {
	Instances  *int        `json:"instances,omitempty"`
	Routes     RoutingInfo `json:"routes,omitempty"`
	Annotation *string     `json:"annotation,omitempty"`
}

type DesiredLRPResponse struct {
	ProcessGuid          string                      `json:"process_guid"`
	Domain               string                      `json:"domain"`
	RootFS               string                      `json:"rootfs"`
	Instances            int                         `json:"instances"`
	EnvironmentVariables []EnvironmentVariable       `json:"env,omitempty"`
	Setup                *models.Action              `json:"setup"`
	Action               *models.Action              `json:"action"`
	Monitor              *models.Action              `json:"monitor"`
	StartTimeout         uint                        `json:"start_timeout"`
	DiskMB               int                         `json:"disk_mb"`
	MemoryMB             int                         `json:"memory_mb"`
	CPUWeight            uint                        `json:"cpu_weight"`
	Privileged           bool                        `json:"privileged"`
	Ports                []uint16                    `json:"ports"`
	Routes               RoutingInfo                 `json:"routes,omitempty"`
	LogGuid              string                      `json:"log_guid"`
	LogSource            string                      `json:"log_source"`
	MetricsGuid          string                      `json:"metrics_guid"`
	Annotation           string                      `json:"annotation,omitempty"`
	EgressRules          []*models.SecurityGroupRule `json:"egress_rules,omitempty"`
	ModificationTag      ModificationTag             `json:"modification_tag"`
}

type ActualLRPState string

const (
	ActualLRPStateInvalid   ActualLRPState = "INVALID"
	ActualLRPStateUnclaimed ActualLRPState = "UNCLAIMED"
	ActualLRPStateClaimed   ActualLRPState = "CLAIMED"
	ActualLRPStateRunning   ActualLRPState = "RUNNING"
	ActualLRPStateCrashed   ActualLRPState = "CRASHED"
)

type ActualLRPResponse struct {
	ProcessGuid     string          `json:"process_guid"`
	InstanceGuid    string          `json:"instance_guid"`
	CellID          string          `json:"cell_id"`
	Domain          string          `json:"domain"`
	Index           int             `json:"index"`
	Address         string          `json:"address"`
	Ports           []PortMapping   `json:"ports"`
	State           ActualLRPState  `json:"state"`
	CrashCount      int             `json:"crash_count"`
	CrashReason     string          `json:"crash_reason,omitempty"`
	PlacementError  string          `json:"placement_error,omitempty"`
	Since           int64           `json:"since"`
	Evacuating      bool            `json:"evacuating"`
	ModificationTag ModificationTag `json:"modification_tag"`
}

type ModificationTag struct {
	Epoch string `json:"epoch"`
	Index uint   `json:"index"`
}

func (m *ModificationTag) Equal(other ModificationTag) bool {
	if m.Epoch == "" || other.Epoch == "" {
		return false
	}

	return m.Epoch == other.Epoch && m.Index == other.Index
}

func (m *ModificationTag) SucceededBy(other ModificationTag) bool {
	if m.Epoch == "" || other.Epoch == "" {
		return true
	}

	return m.Epoch != other.Epoch || m.Index < other.Index
}

type CellResponse struct {
	CellID          string              `json:"cell_id"`
	Zone            string              `json:"zone"`
	Capacity        CellCapacity        `json:"capacity"`
	RootFSProviders map[string][]string `json:"rootfs_providers"`
}

type CellCapacity struct {
	MemoryMB   int `json:"memory_mb"`
	DiskMB     int `json:"disk_mb"`
	Containers int `json:"containers"`
}

type Event interface {
	EventType() EventType
	Key() string
}

type EventType string

const (
	EventTypeInvalid EventType = ""

	EventTypeDesiredLRPCreated EventType = "desired_lrp_created"
	EventTypeDesiredLRPChanged EventType = "desired_lrp_changed"
	EventTypeDesiredLRPRemoved EventType = "desired_lrp_removed"
	EventTypeActualLRPCreated  EventType = "actual_lrp_created"
	EventTypeActualLRPChanged  EventType = "actual_lrp_changed"
	EventTypeActualLRPRemoved  EventType = "actual_lrp_removed"
)

type DesiredLRPCreatedEvent struct {
	DesiredLRPResponse DesiredLRPResponse `json:"desired_lrp"`
}

func NewDesiredLRPCreatedEvent(desiredLRP DesiredLRPResponse) DesiredLRPCreatedEvent {
	return DesiredLRPCreatedEvent{
		DesiredLRPResponse: desiredLRP,
	}
}

func (DesiredLRPCreatedEvent) EventType() EventType { return EventTypeDesiredLRPCreated }
func (e DesiredLRPCreatedEvent) Key() string        { return e.DesiredLRPResponse.ProcessGuid }

type DesiredLRPChangedEvent struct {
	Before DesiredLRPResponse `json:"desired_lrp_before"`
	After  DesiredLRPResponse `json:"desired_lrp_after"`
}

func NewDesiredLRPChangedEvent(before, after DesiredLRPResponse) DesiredLRPChangedEvent {
	return DesiredLRPChangedEvent{
		Before: before,
		After:  after,
	}
}

func (DesiredLRPChangedEvent) EventType() EventType { return EventTypeDesiredLRPChanged }
func (e DesiredLRPChangedEvent) Key() string        { return e.Before.ProcessGuid }

type DesiredLRPRemovedEvent struct {
	DesiredLRPResponse DesiredLRPResponse `json:"desired_lrp"`
}

func NewDesiredLRPRemovedEvent(desiredLRP DesiredLRPResponse) DesiredLRPRemovedEvent {
	return DesiredLRPRemovedEvent{
		DesiredLRPResponse: desiredLRP,
	}
}

func (DesiredLRPRemovedEvent) EventType() EventType { return EventTypeDesiredLRPRemoved }
func (e DesiredLRPRemovedEvent) Key() string        { return e.DesiredLRPResponse.ProcessGuid }

type ActualLRPCreatedEvent struct {
	ActualLRPResponse ActualLRPResponse `json:"actual_lrp"`
}

func NewActualLRPCreatedEvent(actualLRP ActualLRPResponse) ActualLRPCreatedEvent {
	return ActualLRPCreatedEvent{
		ActualLRPResponse: actualLRP,
	}
}

func (ActualLRPCreatedEvent) EventType() EventType { return EventTypeActualLRPCreated }
func (e ActualLRPCreatedEvent) Key() string        { return e.ActualLRPResponse.InstanceGuid }

type ActualLRPChangedEvent struct {
	Before ActualLRPResponse `json:"actual_lrp_before"`
	After  ActualLRPResponse `json:"actual_lrp_after"`
}

func NewActualLRPChangedEvent(before, after ActualLRPResponse) ActualLRPChangedEvent {
	return ActualLRPChangedEvent{
		Before: before,
		After:  after,
	}
}

func (ActualLRPChangedEvent) EventType() EventType { return EventTypeActualLRPChanged }
func (e ActualLRPChangedEvent) Key() string        { return e.Before.InstanceGuid }

type ActualLRPRemovedEvent struct {
	ActualLRPResponse ActualLRPResponse `json:"actual_lrp"`
}

func NewActualLRPRemovedEvent(actualLRP ActualLRPResponse) ActualLRPRemovedEvent {
	return ActualLRPRemovedEvent{
		ActualLRPResponse: actualLRP,
	}
}

func (ActualLRPRemovedEvent) EventType() EventType { return EventTypeActualLRPRemoved }
func (e ActualLRPRemovedEvent) Key() string        { return e.ActualLRPResponse.InstanceGuid }

type VersionResponse struct {
	CFRelease           string `json:"cf_release,omitempty"`
	CFRoutingRelease    string `json:"cf_routing_release,omitempty"`
	DiegoRelease        string `json:"diego_release,omitempty"`
	GardenLinuxRelease  string `json:"garden_linux_release,omitempty"`
	LatticeRelease      string `json:"lattice_release,omitempty"`
	LatticeReleaseImage string `json:"lattice_release_image,omitempty"`
	LTC                 string `json:"ltc,omitempty"`
	Receptor            string `json:"receptor,omitempty"`
}