Documentation
¶
Index ¶
- Constants
- func ComposeDeploy(req *DockerComposeDeploy, ws *websocket.Conn) error
- func ComposeDown(req *DockerComposeDown, ws *websocket.Conn) error
- func ComposeDownNoStreaming(req *DockerComposeDownNoStreaming) error
- func ComposeLogs(req *DockerComposeLogs, ws *websocket.Conn) error
- func ComposePull(req *DockerComposePull, ws *websocket.Conn) error
- func ComposeUp(req *DockerComposeUp, ws *websocket.Conn) error
- func ContainerLogs(req *DockerContainerLogs, ws *websocket.Conn) error
- func ContainerRefreshStaleStatus() error
- func ContainerRemove(req *DockerContainerRemove) error
- func ContainerRestart(req *DockerContainerRestart) error
- func ContainerScheduleRefreshStaleStatus()
- func ContainerStart(req *DockerContainerStart) error
- func ContainerStop(req *DockerContainerStop) error
- func ContainerTerminal(req *DockerContainerTerminal, wsBrowser *websocket.Conn) error
- func ImageRemove(req *DockerImageRemove) error
- func NetworkRemove(req *DockerNetworkRemove) error
- func VolumeRemove(req *DockerVolumeRemove) error
- type BuildCachePruneReport
- type BuildCachePruneRequest
- type ClusterInfo
- type ClusterSwarmNodeList
- type ClusterSwarmNodeListResponse
- type ComposeContainer
- type ComposeContainerInternal
- type ComposeItem
- type ComposeItemInternal
- type Container
- type DiskUsageCategory
- type DiskUsageSummary
- type DockerBuildCachePrune
- type DockerComposeContainerList
- type DockerComposeContainerListResponse
- type DockerComposeDeploy
- type DockerComposeDown
- type DockerComposeDownNoStreaming
- type DockerComposeGet
- type DockerComposeList
- type DockerComposeListResponse
- type DockerComposeLogs
- type DockerComposeProjectCreate
- type DockerComposeProjectDefinition
- type DockerComposeProjectDefinitionResponse
- type DockerComposeProjectDelete
- type DockerComposeProjectUnique
- type DockerComposeProjectUpdate
- type DockerComposePull
- type DockerComposeUp
- type DockerContainerList
- type DockerContainerListResponse
- type DockerContainerLogs
- type DockerContainerRemove
- type DockerContainerRestart
- type DockerContainerStart
- type DockerContainerStop
- type DockerContainerTerminal
- type DockerImageList
- type DockerImageListResponse
- type DockerImagePull
- type DockerImageRemove
- type DockerImagesPrune
- type DockerImagesPruneDeletedItem
- type DockerImagesPruneResponse
- type DockerNetworkCreate
- type DockerNetworkCreateResponse
- type DockerNetworkList
- type DockerNetworkListResponse
- type DockerNetworkRemove
- type DockerNetworksPrune
- type DockerNetworksPruneResponse
- type DockerVolumeCreate
- type DockerVolumeCreateResponse
- type DockerVolumeList
- type DockerVolumeListResponse
- type DockerVolumeRemove
- type DockerVolumesPrune
- type DockerVolumesPruneResponse
- type IPAMConfig
- type IPAMPool
- type Image
- type Network
- type Port
- type ResourceStats
- type SwarmNodeInfo
- type SwarmNodeInfoDetailsResponse
- type SwarmNodeInfoId
- type Volume
Constants ¶
View Source
const ( StaleStatusProcessing = "processing" StaleStatusYes = "yes" StaleStatusNo = "no" StaleStatusError = "error" )
Variables ¶
This section is empty.
Functions ¶
func ComposeDeploy ¶
func ComposeDeploy(req *DockerComposeDeploy, ws *websocket.Conn) error
func ComposeDown ¶
func ComposeDown(req *DockerComposeDown, ws *websocket.Conn) error
func ComposeDownNoStreaming ¶
func ComposeDownNoStreaming(req *DockerComposeDownNoStreaming) error
func ComposeLogs ¶
func ComposeLogs(req *DockerComposeLogs, ws *websocket.Conn) error
func ComposePull ¶
func ComposePull(req *DockerComposePull, ws *websocket.Conn) error
func ContainerLogs ¶
func ContainerLogs(req *DockerContainerLogs, ws *websocket.Conn) error
func ContainerRefreshStaleStatus ¶
func ContainerRefreshStaleStatus() error
func ContainerRemove ¶
func ContainerRemove(req *DockerContainerRemove) error
func ContainerRestart ¶
func ContainerRestart(req *DockerContainerRestart) error
func ContainerScheduleRefreshStaleStatus ¶
func ContainerScheduleRefreshStaleStatus()
func ContainerStart ¶
func ContainerStart(req *DockerContainerStart) error
func ContainerStop ¶
func ContainerStop(req *DockerContainerStop) error
func ContainerTerminal ¶
func ContainerTerminal(req *DockerContainerTerminal, wsBrowser *websocket.Conn) error
func ImageRemove ¶
func ImageRemove(req *DockerImageRemove) error
func NetworkRemove ¶
func NetworkRemove(req *DockerNetworkRemove) error
func VolumeRemove ¶
func VolumeRemove(req *DockerVolumeRemove) error
Types ¶
type BuildCachePruneReport ¶
type BuildCachePruneReport struct {
CachesDeleted []string `json:"cachesDeleted"`
SpaceReclaimed uint64 `json:"spaceReclaimed"`
}
func BuildCacheRemove ¶
func BuildCacheRemove(req *BuildCachePruneRequest) (*BuildCachePruneReport, error)
type BuildCachePruneRequest ¶
type ClusterInfo ¶
type ClusterInfo struct {
ID string `json:"id"`
Name string `json:"name"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
Version string `json:"version"`
TLSInfo string `json:"tls_info"`
RootRotationInProgress bool `json:"root_rotation_in_progress"`
DefaultAddrPool []string `json:"default_addr_pool"`
SubnetSize uint32 `json:"subnet_size"`
DataPathPort uint32 `json:"data_path_port"`
Spec string `json:"spec"`
NodeCount int `json:"node_count"`
ManagerCount int `json:"manager_count"`
WorkerCount int `json:"worker_count"`
}
func GetSwarmClusterInfo ¶
func GetSwarmClusterInfo() (*ClusterInfo, error)
type ClusterSwarmNodeList ¶
type ClusterSwarmNodeListResponse ¶
type ClusterSwarmNodeListResponse struct {
Nodes []*SwarmNodeInfo `json:"nodes"`
Count int `json:"count"`
}
func GetSwarmClusterNodesList ¶
func GetSwarmClusterNodesList(req *ClusterSwarmNodeList) (*ClusterSwarmNodeListResponse, error)
type ComposeContainer ¶
type ComposeItem ¶
type ComposeItem struct {
Name string `json:"name"`
Status string `json:"status"`
ConfigFiles string `json:"configFiles"`
Stale string `json:"stale"`
}
func ComposeGet ¶
func ComposeGet(req *DockerComposeGet) (*ComposeItem, error)
Note: Returns nil if project not found. Does not return error.
type ComposeItemInternal ¶
type DiskUsageCategory ¶
type DiskUsageSummary ¶
type DiskUsageSummary struct {
Categories []DiskUsageCategory `json:"categories"`
}
func GetDiskUsage ¶
func GetDiskUsage() (*DiskUsageSummary, error)
type DockerBuildCachePrune ¶
type DockerBuildCachePrune struct {
All bool `json:"all"`
}
type DockerComposeContainerList ¶
type DockerComposeContainerList struct {
ProjectName string `json:"projectName"`
}
type DockerComposeContainerListResponse ¶
type DockerComposeContainerListResponse struct {
Items []ComposeContainer `json:"items"`
}
func ComposeContainerList ¶
func ComposeContainerList(req *DockerComposeContainerList) (*DockerComposeContainerListResponse, error)
type DockerComposeDeploy ¶
type DockerComposeDeploy struct {
Variables map[string]store.VariableValue `json:"variables"`
ProjectName string `json:"projectName"`
Definition string `json:"definition"`
}
type DockerComposeDown ¶
type DockerComposeDown struct {
ProjectName string `json:"projectName"`
}
type DockerComposeDownNoStreaming ¶
type DockerComposeDownNoStreaming struct {
ProjectName string `json:"projectName"`
}
type DockerComposeGet ¶
type DockerComposeGet struct {
ProjectName string `json:"projectName"`
}
type DockerComposeList ¶
type DockerComposeList struct{}
type DockerComposeListResponse ¶
type DockerComposeListResponse struct {
Items []ComposeItem `json:"items"`
}
func ComposeList ¶
func ComposeList(req *DockerComposeList) (*DockerComposeListResponse, error)
type DockerComposeLogs ¶
type DockerComposeLogs struct {
ProjectName string `json:"projectName"`
}
type DockerComposeProjectDefinition ¶
type DockerComposeProjectDefinition struct {
ProjectName string `json:"projectName"`
}
type DockerComposeProjectDelete ¶
type DockerComposeProjectDelete struct {
ProjectName string `json:"projectName"`
}
type DockerComposeProjectUnique ¶
type DockerComposeProjectUnique struct {
ProjectName string `json:"projectName"`
}
type DockerComposePull ¶
type DockerComposePull struct {
Variables map[string]store.VariableValue `json:"variables"`
ProjectName string `json:"projectName"`
Definition string `json:"definition"`
}
type DockerComposeUp ¶
type DockerComposeUp struct {
Variables map[string]store.VariableValue `json:"variables"`
ProjectName string `json:"projectName"`
Definition string `json:"definition"`
}
type DockerContainerList ¶
type DockerContainerList struct {
All bool `json:"all"`
}
type DockerContainerListResponse ¶
type DockerContainerListResponse struct {
Items []Container `json:"items"`
}
func ContainerList ¶
func ContainerList(req *DockerContainerList) (*DockerContainerListResponse, error)
type DockerContainerLogs ¶
type DockerContainerLogs struct {
Id string `json:"id"`
}
type DockerContainerRemove ¶
type DockerContainerRestart ¶
type DockerContainerRestart struct {
Id string `json:"id"`
}
type DockerContainerStart ¶
type DockerContainerStart struct {
Id string `json:"id"`
}
type DockerContainerStop ¶
type DockerContainerStop struct {
Id string `json:"id"`
}
type DockerContainerTerminal ¶
type DockerContainerTerminal struct {
Id string `json:"id"`
}
type DockerImageList ¶
type DockerImageList struct {
All bool `json:"all"`
}
type DockerImageListResponse ¶
type DockerImageListResponse struct {
Items []Image `json:"items"`
}
func ImageList ¶
func ImageList(req *DockerImageList) (*DockerImageListResponse, error)
type DockerImagePull ¶
type DockerImageRemove ¶
type DockerImagesPrune ¶
type DockerImagesPrune struct {
All bool `json:"all"` // Remove all unused images, not just dangling
}
type DockerImagesPruneResponse ¶
type DockerImagesPruneResponse struct {
ImagesDeleted []DockerImagesPruneDeletedItem `json:"imagesDeleted"`
SpaceReclaimed uint64 `json:"spaceReclaimed"`
}
func ImagesPrune ¶
func ImagesPrune(req *DockerImagesPrune) (*DockerImagesPruneResponse, error)
type DockerNetworkCreate ¶
type DockerNetworkCreateResponse ¶
func NetworkCreate ¶
func NetworkCreate(req *DockerNetworkCreate) (*DockerNetworkCreateResponse, error)
type DockerNetworkList ¶
type DockerNetworkList struct{}
type DockerNetworkListResponse ¶
type DockerNetworkListResponse struct {
Items []Network `json:"items"`
}
func NetworkList ¶
func NetworkList(req *DockerNetworkList) (*DockerNetworkListResponse, error)
type DockerNetworkRemove ¶
type DockerNetworkRemove struct {
Id string `json:"id"`
}
type DockerNetworksPrune ¶
type DockerNetworksPrune struct{}
type DockerNetworksPruneResponse ¶
type DockerNetworksPruneResponse struct {
NetworksDeleted []string `json:"networksDeleted"`
}
func NetworksPrune ¶
func NetworksPrune(req *DockerNetworksPrune) (*DockerNetworksPruneResponse, error)
type DockerVolumeCreate ¶
type DockerVolumeCreate struct {
DriverOpts map[string]string
Labels map[string]string
Name string
Driver string
}
DockerVolumeCreate contains volume creation parameters
type DockerVolumeCreateResponse ¶
DockerVolumeCreateResponse contains created volume info
func VolumeCreate ¶
func VolumeCreate(req *DockerVolumeCreate) (*DockerVolumeCreateResponse, error)
type DockerVolumeList ¶
type DockerVolumeList struct{}
type DockerVolumeListResponse ¶
type DockerVolumeListResponse struct {
Items []Volume `json:"items"`
}
func VolumeList ¶
func VolumeList(req *DockerVolumeList) (*DockerVolumeListResponse, error)
type DockerVolumeRemove ¶
type DockerVolumeRemove struct {
Name string `json:"name"`
}
type DockerVolumesPrune ¶
type DockerVolumesPrune struct {
All bool `json:"all"` // Remove all unused volumes, not just anonymous ones
}
type DockerVolumesPruneResponse ¶
type DockerVolumesPruneResponse struct {
VolumesDeleted []string `json:"volumesDeleted"`
SpaceReclaimed uint64 `json:"spaceReclaimed"`
}
func VolumesPrune ¶
func VolumesPrune(req *DockerVolumesPrune) (*DockerVolumesPruneResponse, error)
type IPAMConfig ¶
type ResourceStats ¶
type SwarmNodeInfo ¶
type SwarmNodeInfoDetailsResponse ¶
type SwarmNodeInfoDetailsResponse struct {
Name string `json:"name"`
OSInfo string `json:"os"`
CPU int64 `json:"cpu"`
Memory int64 `json:"memory"`
Version string `json:"version"`
VolumeType string `json:"volume"`
NetworkPlugin string `json:"network"`
Role string `json:"role"`
Availability string `json:"availability"`
Status string `json:"status"`
Labels []string `json:"labels"`
}
func GetSwarmNodeByID ¶
func GetSwarmNodeByID(req *SwarmNodeInfoId) (*SwarmNodeInfoDetailsResponse, error)
type SwarmNodeInfoId ¶
type SwarmNodeInfoId struct {
Id string `json:"id" validate:"required,max=100"`
}
Click to show internal directories.
Click to hide internal directories.