api

Documentation

Index

• Constants
• func InitRoutes(useLogger bool, handler *PcApi) *gin.Engine
• func StartHttpServer(useLogger bool, port int, project app.IProject)
• type LogMessage
• type PcApi
  • func NewPcApi(project app.IProject) *PcApi
  • func (api *PcApi) GetHostName(c *gin.Context)
  • func (api *PcApi) GetProcess(c *gin.Context)
  • func (api *PcApi) GetProcessInfo(c *gin.Context)
  • func (api *PcApi) GetProcessLogs(c *gin.Context)
  • func (api *PcApi) GetProcessPorts(c *gin.Context)
  • func (api *PcApi) GetProcesses(c *gin.Context)
  • func (api *PcApi) GetProjectState(c *gin.Context)
  • func (api *PcApi) HandleLogsStream(c *gin.Context)
  • func (api *PcApi) IsAlive(c *gin.Context)
  • func (api *PcApi) RestartProcess(c *gin.Context)
  • func (api *PcApi) ScaleProcess(c *gin.Context)
  • func (api *PcApi) ShutDownProject(c *gin.Context)
  • func (api *PcApi) StartProcess(c *gin.Context)
  • func (api *PcApi) StopProcess(c *gin.Context)
  • func (api *PcApi) StopProcesses(c *gin.Context)

Constants

const EnvDebugMode = "PC_DEBUG_MODE"

Functions

func InitRoutes

func InitRoutes(useLogger bool, handler *PcApi) *gin.Engine

InitRoutes initialize routing information

func StartHttpServer

func StartHttpServer(useLogger bool, port int, project app.IProject)

Types

type LogMessage

type LogMessage struct {
	Message     string `json:"message"`
	ProcessName string `json:"process_name"`
}

type PcApi

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

func NewPcApi

func NewPcApi(project app.IProject) *PcApi

func (*PcApi) GetHostName

func (api *PcApi) GetHostName(c *gin.Context)

@Schemes @Description Get process compose hostname @Tags Hostname @Summary Get Hostname @Produce json @Success 200 @Router /hostname [get]

func (*PcApi) GetProcess

func (api *PcApi) GetProcess(c *gin.Context)

@Schemes @Description Retrieves the given process and its status @Tags Process @Summary Get process state @Produce json @Param name path string true "Process Name" @Success 200 {object} object "Process State" @Router /process/{name} [get]

func (*PcApi) GetProcessInfo

func (api *PcApi) GetProcessInfo(c *gin.Context)

@Schemes @Description Retrieves the given process and its config @Tags Process @Summary Get process config @Produce json @Param name path string true "Process Name" @Success 200 {object} object "Process Config" @Router /process/info/{name} [get]

func (*PcApi) GetProcessLogs

func (api *PcApi) GetProcessLogs(c *gin.Context)

@Schemes @Description Retrieves the process logs @Tags Process @Summary Get process logs @Produce json @Param name path string true "Process Name" @Param endOffset path int true "Offset from the end of the log" @Param limit path int true "Limit of lines to get (0 will get all the lines till the end)" @Success 200 {object} object "Process Logs" @Router /process/logs/{name}/{endOffset}/{limit} [get]

func (*PcApi) GetProcessPorts

func (api *PcApi) GetProcessPorts(c *gin.Context)

@Schemes @Description Retrieves process open ports @Tags Process @Summary Get process ports @Produce json @Param name path string true "Process Name" @Success 200 {object} object "Process Ports" @Router /process/ports/{name} [get]

func (*PcApi) GetProcesses

func (api *PcApi) GetProcesses(c *gin.Context)

@Schemes @Description Retrieves all the configured processes and their status @Tags Process @Summary Get all processes @Produce json @Success 200 {object} object "Processes Status" @Router /processes [get]

func (*PcApi) GetProjectState

func (api *PcApi) GetProjectState(c *gin.Context)

@Schemes @Description Retrieves project state information @Tags Project @Summary Get project state @Produce json @Success 200 {object} object "Project State" @Router /project/state [get]

func (*PcApi) HandleLogsStream

func (api *PcApi) HandleLogsStream(c *gin.Context)

func (*PcApi) IsAlive

func (api *PcApi) IsAlive(c *gin.Context)

@Schemes @Description Check if server is responding @Tags Liveness @Summary Liveness Check @Produce json @Success 200 @Router /live [get]

func (*PcApi) RestartProcess

func (api *PcApi) RestartProcess(c *gin.Context)

@Schemes @Description Restarts the process @Tags Process @Summary Restart a process @Produce json @Param name path string true "Process Name" @Success 200 {string} string "Restarted Process Name" @Router /process/restart/{name} [post]

func (*PcApi) ScaleProcess

func (api *PcApi) ScaleProcess(c *gin.Context)

@Schemes @Description Scale a process @Tags Process @Summary Scale a process to a given replicas count @Produce json @Param name path string true "Process Name" @Param scale path int true "New amount of process replicas" @Success 200 {string} string "Scaled Process Name" @Router /process/scale/{name}/{scale} [patch]

func (*PcApi) ShutDownProject

func (api *PcApi) ShutDownProject(c *gin.Context)

@Schemes @Description Shuts down the server @Tags Project @Summary Stops all the processes and the server @Produce json @Success 200 @Router /project/stop [post]

func (*PcApi) StartProcess

func (api *PcApi) StartProcess(c *gin.Context)

@Schemes @Description Starts the process if the state is not 'running' or 'pending' @Tags Process @Summary Start a process @Produce json @Param name path string true "Process Name" @Success 200 {string} string "Started Process Name" @Router /process/start/{name} [post]

func (*PcApi) StopProcess

func (api *PcApi) StopProcess(c *gin.Context)

@Schemes @Description Sends kill signal to the process @Tags Process @Summary Stop a process @Produce json @Param name path string true "Process Name" @Success 200 {string} string "Stopped Process Name" @Router /process/stop/{name} [patch]

func (*PcApi) StopProcesses

func (api *PcApi) StopProcesses(c *gin.Context)

@Schemes @Description Sends kill signal to the processes list @Tags Process @Summary Stop processes @Produce json @Param []string body []string true "Processes Names" @Success 200 {object} string "Stopped Processes Names" @Router /processes/stop [patch]