service

Documentation

Index

• Variables
• type Add
• type Logs
• type PortConfig
• type Redeploy
• type Scale
• type VolumeConfig

Variables

var Cmd = &cobra.Command{
	Use:     "service",
	Short:   "Service commands: sail service --help",
	Long:    `Service commands: sail service <command>`,
	Aliases: []string{"services"},
}

Cmd service

Types

type Add

type Add struct {
	Service              string                         `json:"-"`
	Volumes              map[string]VolumeConfig        `json:"volumes,omitempty"`
	Repository           string                         `json:"repository"`
	ContainerUser        string                         `json:"container_user,omitempty"`
	RestartPolicy        string                         `json:"restart_policy"`
	ContainerCommand     []string                       `json:"container_command,omitempty"`
	ContainerNetwork     map[string]map[string][]string `json:"container_network"`
	ContainerEntrypoint  []string                       `json:"container_entrypoint,omitempty"`
	ContainerNumber      int                            `json:"container_number"`
	RepositoryTag        string                         `json:"repository_tag"`
	Links                map[string]string              `json:"links"`
	Application          string                         `json:"namespace"`
	ContainerWorkdir     string                         `json:"container_workdir,omitempty"`
	ContainerEnvironment []string                       `json:"container_environment"`
	ContainerModel       string                         `json:"container_model"`
	ContainerPorts       map[string][]PortConfig        `json:"container_ports"`
	Pool                 string                         `json:"pool,omitempty"`
}

Add struct holds all parameters sent to /applications/%s/services/%s

type Logs

type Logs struct {
	Application string `url:"-"`
	Service     string `url:"-"`

	Repository string `url:"repository,omitempty"`
	Tail       int    `url:"tail,omitempty"`
	Head       int    `url:"head,omitempty"`
	Offset     int    `url:"offset,omitempty"`
	Period     string `url:"period,omitempty"`
	Search     string `url:"search,omitempty"`
}

Logs struct holds all parameters sent to /applications/%s/services/%s/logs

type PortConfig

type PortConfig struct {
	PublishedPort    int      `json:"published_port"`
	WhitelistedCidrs []string `json:"whitelisted_cidrs"`
	Network          string   `json:"network,omitempty"`
}

PortConfig is a parameter of Add to modify exposed container ports

type Redeploy

type Redeploy struct {
	Service              string                         `json:"-"`
	Volumes              map[string]VolumeConfig        `json:"volumes,omitempty"`
	Repository           string                         `json:"repository,omitempty"`
	ContainerUser        string                         `json:"container_user,omitempty"`
	RestartPolicy        string                         `json:"restart_policy,omitempty"`
	ContainerCommand     []string                       `json:"container_command,omitempty"`
	ContainerNetwork     map[string]map[string][]string `json:"container_network,omitempty"`
	ContainerEntrypoint  []string                       `json:"container_entrypoint,omitempty"`
	RepositoryTag        string                         `json:"repository_tag,omitempty"`
	Links                map[string]string              `json:"links,omitempty"`
	Application          string                         `json:"namespace,omitempty"`
	ContainerWorkdir     string                         `json:"container_workdir,omitempty"`
	ContainerEnvironment []string                       `json:"container_environment,omitempty"`
	ContainerModel       string                         `json:"container_model,omitempty"`
	ContainerPorts       map[string][]PortConfig        `json:"container_ports,omitempty"`
	Pool                 string                         `json:"pool,omitempty"`
}

Redeploy struct holds all parameters sent to /applications/%s/services/%s/redeploy

type Scale

type Scale struct {
	Number  int  `json:"container_number"`
	Destroy bool `json:"destroy"`
}

Scale json data arguments

type VolumeConfig

type VolumeConfig struct {
	Size string `json:"size"`
}

VolumeConfig is a parameter of Add to modify mounted volumes