Documentation
¶
Index ¶
- Variables
- type ComposeConfig
- type ComposeService
- type Container
- type ContainerImageDetails
- type ContainerMount
- type ContainerNetwork
- type CreateStackRequest
- type CreateStackResponse
- type EnvironmentVariable
- type Handler
- func (h *Handler) CreateStack(c echo.Context) error
- func (h *Handler) GetContainerImageDetails(c echo.Context) error
- func (h *Handler) GetStackDetails(c echo.Context) error
- func (h *Handler) GetStackEnvironmentVariables(c echo.Context) error
- func (h *Handler) GetStackNetworks(c echo.Context) error
- func (h *Handler) GetStackVolumes(c echo.Context) error
- func (h *Handler) GetStacksSummary(c echo.Context) error
- func (h *Handler) ListStacks(c echo.Context) error
- type HealthLog
- type HealthStatus
- type ImageConfig
- type ImageHistoryLayer
- type ImageInspectInfo
- type Network
- type NetworkEndpoint
- type NetworkIPAM
- type NetworkIPAMConfig
- type Port
- type ResourceLimits
- type RestartPolicy
- type RootFS
- type Service
- func (s *Service) CreateStack(name string) (*Stack, error)
- func (s *Service) GetContainerImageDetails(stackName string) ([]ContainerImageDetails, error)
- func (s *Service) GetContainerInfo(stackName string) (map[string][]Container, error)
- func (s *Service) GetStackDetails(name string) (*StackDetails, error)
- func (s *Service) GetStackEnvironmentVariables(name string, unmask bool) (map[string][]ServiceEnvironment, error)
- func (s *Service) GetStackNetworks(name string) ([]Network, error)
- func (s *Service) GetStackVolumes(name string) ([]Volume, error)
- func (s *Service) GetStacksSummary(patterns []string) (*StackStatistics, error)
- func (s *Service) ListStacks() ([]Stack, error)
- type ServiceCountCache
- type ServiceEnvironment
- type Stack
- type StackDetails
- type StackStatistics
- type Volume
- type VolumeMount
- type VolumeUsage
Constants ¶
This section is empty.
Variables ¶
View Source
var Module = fx.Options( fx.Provide(NewService), fx.Provide(NewHandler), )
Functions ¶
This section is empty.
Types ¶
type ComposeConfig ¶
type ComposeService ¶
type Container ¶
type Container struct {
Name string `json:"name"`
Image string `json:"image"`
State string `json:"state"`
Ports []Port `json:"ports,omitempty"`
Created string `json:"created,omitempty"`
Started string `json:"started,omitempty"`
Finished string `json:"finished,omitempty"`
ExitCode *int `json:"exit_code,omitempty"`
RestartPolicy *RestartPolicy `json:"restart_policy,omitempty"`
ResourceLimits *ResourceLimits `json:"resource_limits,omitempty"`
Health *HealthStatus `json:"health,omitempty"`
Command []string `json:"command,omitempty"`
WorkingDir string `json:"working_dir,omitempty"`
User string `json:"user,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
Networks []ContainerNetwork `json:"networks,omitempty"`
Mounts []ContainerMount `json:"mounts,omitempty"`
}
type ContainerImageDetails ¶
type ContainerImageDetails struct {
ContainerName string `json:"container_name"`
ImageID string `json:"image_id"`
ImageName string `json:"image_name"`
ImageInfo ImageInspectInfo `json:"image_info"`
ImageHistory []ImageHistoryLayer `json:"image_history"`
}
type ContainerMount ¶
type ContainerNetwork ¶
type CreateStackRequest ¶
type CreateStackRequest struct {
Name string `json:"name" validate:"required"`
}
type CreateStackResponse ¶
type EnvironmentVariable ¶
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
func (*Handler) GetContainerImageDetails ¶
func (*Handler) GetStackEnvironmentVariables ¶
type HealthStatus ¶
type ImageConfig ¶
type ImageConfig struct {
User string `json:"user,omitempty"`
Env []string `json:"env,omitempty"`
Cmd []string `json:"cmd,omitempty"`
Entrypoint []string `json:"entrypoint,omitempty"`
WorkingDir string `json:"working_dir,omitempty"`
ExposedPorts map[string]struct{} `json:"exposed_ports,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
}
type ImageHistoryLayer ¶
type ImageInspectInfo ¶
type ImageInspectInfo struct {
Architecture string `json:"architecture"`
OS string `json:"os"`
Size int64 `json:"size"`
VirtualSize int64 `json:"virtual_size"`
Author string `json:"author"`
Created string `json:"created"`
DockerVersion string `json:"docker_version"`
Config ImageConfig `json:"config"`
RootFS RootFS `json:"rootfs"`
Parent string `json:"parent,omitempty"`
RepoTags []string `json:"repo_tags,omitempty"`
RepoDigests []string `json:"repo_digests,omitempty"`
}
type Network ¶
type Network struct {
Name string `json:"name"`
Driver string `json:"driver,omitempty"`
External bool `json:"external,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
Options map[string]string `json:"options,omitempty"`
IPAM *NetworkIPAM `json:"ipam,omitempty"`
Containers map[string]NetworkEndpoint `json:"containers,omitempty"`
Exists bool `json:"exists"`
Created string `json:"created,omitempty"`
}
type NetworkEndpoint ¶
type NetworkIPAM ¶
type NetworkIPAM struct {
Driver string `json:"driver,omitempty"`
Config []NetworkIPAMConfig `json:"config,omitempty"`
}
type NetworkIPAMConfig ¶
type ResourceLimits ¶
type RestartPolicy ¶
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func (*Service) GetContainerImageDetails ¶
func (s *Service) GetContainerImageDetails(stackName string) ([]ContainerImageDetails, error)
func (*Service) GetContainerInfo ¶
func (*Service) GetStackDetails ¶
func (s *Service) GetStackDetails(name string) (*StackDetails, error)
func (*Service) GetStackEnvironmentVariables ¶
func (*Service) GetStackNetworks ¶
func (*Service) GetStacksSummary ¶
func (s *Service) GetStacksSummary(patterns []string) (*StackStatistics, error)
func (*Service) ListStacks ¶
type ServiceCountCache ¶
type ServiceCountCache struct {
// contains filtered or unexported fields
}
func NewServiceCountCache ¶
func NewServiceCountCache(stackLocation string) *ServiceCountCache
func (*ServiceCountCache) GetServiceCount ¶
func (c *ServiceCountCache) GetServiceCount(stackName string) (int, bool)
func (*ServiceCountCache) Start ¶
func (c *ServiceCountCache) Start() error
func (*ServiceCountCache) Stop ¶
func (c *ServiceCountCache) Stop()
type ServiceEnvironment ¶
type ServiceEnvironment struct {
ServiceName string `json:"service_name"`
Variables []EnvironmentVariable `json:"variables"`
}
type StackDetails ¶
type StackDetails struct {
Name string `json:"name"`
Path string `json:"path"`
ComposeFile string `json:"compose_file"`
Services []ComposeService `json:"services"`
}
type StackStatistics ¶
type Volume ¶
type Volume struct {
Name string `json:"name"`
Driver string `json:"driver,omitempty"`
External bool `json:"external,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
DriverOpts map[string]string `json:"driver_opts,omitempty"`
Exists bool `json:"exists"`
Created string `json:"created,omitempty"`
Mountpoint string `json:"mountpoint,omitempty"`
Scope string `json:"scope,omitempty"`
UsedBy []VolumeUsage `json:"used_by,omitempty"`
}
type VolumeMount ¶
type VolumeUsage ¶
type VolumeUsage struct {
ContainerName string `json:"container_name"`
ServiceName string `json:"service_name"`
Mounts []VolumeMount `json:"mounts"`
}
Click to show internal directories.
Click to hide internal directories.