api

package
v0.0.0-...-3567eeb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 17, 2026 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChartHandler

type ChartHandler struct {
	Search web.HandlerFunc `path:"/search" auth:"chart.view" desc:"search charts"`
	Find   web.HandlerFunc `path:"/find" auth:"chart.view" desc:"find chart by id"`
	Save   web.HandlerFunc `path:"/save" method:"post" auth:"chart.edit" desc:"create or update chart"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"chart.delete" desc:"delete chart"`
}

ChartHandler encapsulates chart related handlers.

func NewChart

func NewChart(b biz.ChartBiz) *ChartHandler

NewChart creates an instance of ChartHandler

type ConfigHandler

type ConfigHandler struct {
	Search web.HandlerFunc `path:"/search" auth:"config.view" desc:"search configs"`
	Find   web.HandlerFunc `path:"/find" auth:"config.view" desc:"find config by name"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"config.delete" desc:"delete config"`
	Save   web.HandlerFunc `path:"/save" method:"post" auth:"config.edit" desc:"create or update config"`
}

ConfigHandler encapsulates config related handlers.

func NewConfig

func NewConfig(b biz.ConfigBiz) *ConfigHandler

NewConfig creates an instance of ConfigHandler

type ContainerHandler

type ContainerHandler struct {
	Search    web.HandlerFunc `path:"/search" auth:"container.view" desc:"search containers"`
	Find      web.HandlerFunc `path:"/find" auth:"container.view" desc:"find container by name"`
	Delete    web.HandlerFunc `path:"/delete" method:"post" auth:"container.delete" desc:"delete container"`
	FetchLogs web.HandlerFunc `path:"/fetch-logs" auth:"container.logs" desc:"fetch logs of container"`
	Connect   web.HandlerFunc `path:"/connect" auth:"container.execute" desc:"connect to a running container"`
	Prune     web.HandlerFunc `path:"/prune" method:"post" auth:"container.delete" desc:"delete unused containers"`
}

ContainerHandler encapsulates container related handlers.

func NewContainer

func NewContainer(b biz.ContainerBiz) *ContainerHandler

NewContainer creates an instance of ContainerHandler

type DashboardHandler

type DashboardHandler struct {
	Find      web.HandlerFunc `path:"/find" auth:"?" desc:"find dashboard by name and key"`
	Save      web.HandlerFunc `path:"/save" method:"post" auth:"dashboard.edit" desc:"save dashboard"`
	FetchData web.HandlerFunc `path:"/fetch-data" auth:"?" desc:"fetch data of dashboard charts"`
}

DashboardHandler encapsulates dashboard related handlers.

func NewDashboard

func NewDashboard(b biz.DashboardBiz) *DashboardHandler

NewDashboard creates an instance of DashboardHandler

type EventHandler

type EventHandler struct {
	Search web.HandlerFunc `path:"/search" auth:"event.view" desc:"search events"`
	Prune  web.HandlerFunc `path:"/prune" method:"post" auth:"event.delete" desc:"delete events"`
}

EventHandler encapsulates event related handlers.

func NewEvent

func NewEvent(b biz.EventBiz) *EventHandler

NewEvent creates an instance of EventHandler

type ImageHandler

type ImageHandler struct {
	Search web.HandlerFunc `path:"/search" auth:"image.view" desc:"search images"`
	Find   web.HandlerFunc `path:"/find" auth:"image.view" desc:"find image by id"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"image.delete" desc:"delete image"`
	Prune  web.HandlerFunc `path:"/prune" method:"post" auth:"image.delete" desc:"delete unused images"`
}

ImageHandler encapsulates image related handlers.

func NewImage

func NewImage(b biz.ImageBiz) *ImageHandler

NewImage creates an instance of ImageHandler

type NetworkHandler

type NetworkHandler struct {
	Search     web.HandlerFunc `path:"/search" auth:"network.view" desc:"search networks"`
	Find       web.HandlerFunc `path:"/find" auth:"network.view" desc:"find network by name"`
	Delete     web.HandlerFunc `path:"/delete" method:"post" auth:"network.delete" desc:"delete network"`
	Save       web.HandlerFunc `path:"/save" method:"post" auth:"network.edit" desc:"create or update network"`
	Disconnect web.HandlerFunc `path:"/disconnect" method:"post" auth:"network.disconnect" desc:"disconnect container from network"`
}

NetworkHandler encapsulates network related handlers.

func NewNetwork

func NewNetwork(nb biz.NetworkBiz) *NetworkHandler

NewNetwork creates an instance of NetworkHandler

type NodeHandler

type NodeHandler struct {
	List   web.HandlerFunc `path:"/list" auth:"node.view" desc:"list nodes"`
	Search web.HandlerFunc `path:"/search" auth:"node.view" desc:"search nodes"`
	Find   web.HandlerFunc `path:"/find" auth:"node.view" desc:"find node by name"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"node.delete" desc:"delete node"`
	Save   web.HandlerFunc `path:"/save" method:"post" auth:"node.edit" desc:"create or update node"`
}

NodeHandler encapsulates node related handlers.

func NewNode

func NewNode(nb biz.NodeBiz) *NodeHandler

NewNode creates an instance of NodeHandler

type RegistryHandler

type RegistryHandler struct {
	Search web.HandlerFunc `path:"/search" auth:"registry.view" desc:"search registries"`
	Find   web.HandlerFunc `path:"/find" auth:"registry.view" desc:"find registry by id"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"registry.delete" desc:"delete registry"`
	Save   web.HandlerFunc `path:"/save" method:"post" auth:"registry.edit" desc:"create or update registry"`
}

RegistryHandler encapsulates registry related handlers.

func NewRegistry

func NewRegistry(b biz.RegistryBiz) *RegistryHandler

NewRegistry creates an instance of RegistryHandler

type RoleHandler

type RoleHandler struct {
	Find   web.HandlerFunc `path:"/find" auth:"role.view" desc:"find role by id"`
	Search web.HandlerFunc `path:"/search" auth:"role.view" desc:"search roles"`
	Save   web.HandlerFunc `path:"/save" method:"post" auth:"role.edit" desc:"create or update role"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"role.delete" desc:"delete role"`
}

RoleHandler encapsulates role related handlers.

func NewRole

func NewRole(b biz.RoleBiz) *RoleHandler

NewRole creates an instance of RoleHandler

type SecretHandler

type SecretHandler struct {
	Search web.HandlerFunc `path:"/search" auth:"secret.view" desc:"search secrets"`
	Find   web.HandlerFunc `path:"/find" auth:"secret.view" desc:"find secret by name"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"secret.delete" desc:"delete secret"`
	Save   web.HandlerFunc `path:"/save" method:"post" auth:"secret.edit" desc:"create or update secret"`
}

SecretHandler encapsulates secret related handlers.

func NewSecret

func NewSecret(b biz.SecretBiz) *SecretHandler

NewSecret creates an instance of SecretHandler

type ServiceHandler

type ServiceHandler struct {
	Search    web.HandlerFunc `path:"/search" auth:"service.view" desc:"search services"`
	Find      web.HandlerFunc `path:"/find" auth:"service.view" desc:"find service by name"`
	Delete    web.HandlerFunc `path:"/delete" method:"post" auth:"service.delete" desc:"delete service"`
	Restart   web.HandlerFunc `path:"/restart" method:"post" auth:"service.restart" desc:"restart service"`
	Rollback  web.HandlerFunc `path:"/rollback" method:"post" auth:"service.rollback" desc:"rollback service"`
	Scale     web.HandlerFunc `path:"/scale" method:"post" auth:"service.edit" desc:"scale service"`
	Save      web.HandlerFunc `path:"/save" method:"post" auth:"service.edit" desc:"create or update service"`
	Deploy    web.HandlerFunc `path:"/deploy" method:"post" auth:"service.deploy" desc:"deploy service"`
	FetchLogs web.HandlerFunc `path:"/fetch-logs" auth:"service.logs" desc:"fetch logs of service"`
}

ServiceHandler encapsulates service related handlers.

func NewService

func NewService(b biz.ServiceBiz) *ServiceHandler

NewService creates an instance of ServiceHandler

type SettingHandler

type SettingHandler struct {
	Load web.HandlerFunc `path:"/load" auth:"setting.view" desc:"load setting"`
	Save web.HandlerFunc `path:"/save" method:"post" auth:"setting.edit" desc:"save setting"`
}

SettingHandler encapsulates setting related handlers.

func NewSetting

func NewSetting(b biz.SettingBiz) *SettingHandler

NewSetting creates an instance of SettingHandler

type StackHandler

type StackHandler struct {
	Search   web.HandlerFunc `path:"/search" auth:"stack.view" desc:"search stacks"`
	Find     web.HandlerFunc `path:"/find" auth:"stack.view" desc:"find stack by name"`
	Delete   web.HandlerFunc `path:"/delete" method:"post" auth:"stack.delete" desc:"delete stack"`
	Shutdown web.HandlerFunc `path:"/shutdown" method:"post" auth:"stack.shutdown" desc:"shutdown stack"`
	Deploy   web.HandlerFunc `path:"/deploy" method:"post" auth:"stack.deploy" desc:"deploy stack"`
	Save     web.HandlerFunc `path:"/save" method:"post" auth:"stack.edit" desc:"create or update stack"`
	Upload   web.HandlerFunc `path:"/upload" method:"post" auth:"*" desc:"upload compose file"`
}

StackHandler encapsulates stack related handlers.

func NewStack

func NewStack(b biz.StackBiz) *StackHandler

NewStack creates an instance of StackHandler

type SystemHandler

type SystemHandler struct {
	CheckState  web.HandlerFunc `path:"/check-state" auth:"*" desc:"check system state"`
	CreateAdmin web.HandlerFunc `path:"/create-admin" method:"post" auth:"*" desc:"initialize administrator account"`
	Version     web.HandlerFunc `path:"/version" auth:"*" desc:"fetch app version"`
	Summarize   web.HandlerFunc `path:"/summarize" auth:"?" desc:"fetch statistics data"`
}

SystemHandler encapsulates system related handlers.

func NewSystem

func NewSystem(d *docker.Docker, b biz.SystemBiz, ub biz.UserBiz) *SystemHandler

NewSystem creates an instance of SystemHandler

type TaskHandler

type TaskHandler struct {
	Search    web.HandlerFunc `path:"/search" auth:"task.view" desc:"search tasks"`
	Find      web.HandlerFunc `path:"/find" auth:"task.view" desc:"find task by id"`
	FetchLogs web.HandlerFunc `path:"/fetch-logs" auth:"task.logs" desc:"fetch logs of task"`
}

TaskHandler encapsulates node related handlers.

func NewTask

func NewTask(b biz.TaskBiz) *TaskHandler

NewTask creates an instance of TaskHandler

type UserHandler

type UserHandler struct {
	SignIn         web.HandlerFunc `path:"/sign-in" method:"post" auth:"*" desc:"user sign in"`
	Search         web.HandlerFunc `path:"/search" auth:"user.view" desc:"search users"`
	Save           web.HandlerFunc `path:"/save" method:"post" auth:"user.edit" desc:"create or update user"`
	Find           web.HandlerFunc `path:"/find" auth:"user.view" desc:"find user by id"`
	Delete         web.HandlerFunc `path:"/delete" method:"post" auth:"user.delete" desc:"delete user"`
	SetStatus      web.HandlerFunc `path:"/set-status" method:"post" auth:"user.edit" desc:"set user status"`
	ModifyPassword web.HandlerFunc `path:"/modify-password" method:"post" auth:"?" desc:"modify password"`
	ModifyProfile  web.HandlerFunc `path:"/modify-profile" method:"post" auth:"?" desc:"modify profile"`
}

UserHandler encapsulates user related handlers.

func NewUser

func NewUser(b biz.UserBiz, eb biz.EventBiz, auth *security.Identifier) *UserHandler

NewUser creates an instance of UserHandler

type VolumeHandler

type VolumeHandler struct {
	Search web.HandlerFunc `path:"/search" auth:"volume.view" desc:"search volumes"`
	Find   web.HandlerFunc `path:"/find" auth:"volume.view" desc:"find volume by name"`
	Delete web.HandlerFunc `path:"/delete" method:"post" auth:"volume.delete" desc:"delete volume"`
	Save   web.HandlerFunc `path:"/save" method:"post" auth:"volume.edit" desc:"create or update volume"`
	Prune  web.HandlerFunc `path:"/prune" method:"post" auth:"volume.delete" desc:"delete unused volumes"`
}

VolumeHandler encapsulates volume related handlers.

func NewVolume

func NewVolume(b biz.VolumeBiz) *VolumeHandler

NewVolume creates an instance of VolumeHandler

Source Files

  • api.go
  • chart.go
  • config.go
  • container.go
  • dashboard.go
  • event.go
  • image.go
  • network.go
  • node.go
  • registry.go
  • role.go
  • secret.go
  • service.go
  • setting.go
  • stack.go
  • system.go
  • task.go
  • user.go
  • volume.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL