webui

Documentation

Index

• type ExecutionRecord
• type WebUIConfig
  • func DefaultWebUIConfig() *WebUIConfig
• type WebUIServer
  • func NewWebUIServer(addr string) *WebUIServer
  • func (s *WebUIServer) AddExecution(execution *ExecutionRecord)
  • func (s *WebUIServer) AddModule(module *core.Module)
  • func (s *WebUIServer) Start() error
  • func (s *WebUIServer) Stop() error

Types

type ExecutionRecord

type ExecutionRecord struct {
	ID         string    `json:"id"`
	ModuleName string    `json:"module_name"`
	Action     string    `json:"action"`
	Status     string    `json:"status"`
	StartTime  time.Time `json:"start_time"`
	EndTime    time.Time `json:"end_time,omitempty"`
	User       string    `json:"user"`
	Error      string    `json:"error,omitempty"`
	Duration   string    `json:"duration,omitempty"`
}

ExecutionRecord represents an execution record for the UI

type WebUIConfig

type WebUIConfig struct {
	Enabled bool   `yaml:"enabled" json:"enabled"`
	Address string `yaml:"address" json:"address"`
	Port    int    `yaml:"port" json:"port"`
}

WebUIConfig represents web UI configuration

func DefaultWebUIConfig

func DefaultWebUIConfig() *WebUIConfig

DefaultWebUIConfig returns default web UI configuration

type WebUIServer

type WebUIServer struct {
	// contains filtered or unexported fields
}

WebUIServer provides a web interface for Chisel

func NewWebUIServer

func NewWebUIServer(addr string) *WebUIServer

NewWebUIServer creates a new web UI server

func (*WebUIServer) AddExecution

func (s *WebUIServer) AddExecution(execution *ExecutionRecord)

AddExecution adds an execution record to the UI

func (*WebUIServer) AddModule

func (s *WebUIServer) AddModule(module *core.Module)

AddModule adds a module to the UI

func (*WebUIServer) Start

func (s *WebUIServer) Start() error

Start starts the web UI server

func (*WebUIServer) Stop

func (s *WebUIServer) Stop() error

Stop stops the web UI server