http

Documentation

Index

• Constants
• func GenericAPIServer(port int, cfg *config.Config) manager.Runnable
• func MockAPIServer(port int) manager.Runnable
• func SetupProfiling(r *gin.Engine)
• func StaticFileServer(port int, cfg *config.Config) manager.Runnable
• type Event
  • func (e *Event) Type() string
  • func (e *Event) Validate() error
• type PostServer
  • func (s *PostServer) HealthzCheck() healthz.Checker
  • func (s *PostServer) InjectConfig(cfg *config.Config)
  • func (s *PostServer) InjectController(c lifecycle.Controller)
  • func (s *PostServer) InjectEventRecorder(er record.EventRecorder)
  • func (s *PostServer) InjectReader(reader client.Reader)
  • func (s *PostServer) Name() string
  • func (s *PostServer) ReadyzCheck() healthz.Checker
  • func (s *PostServer) SaveFile(executionID, name string, data []byte) (string, error)
• type Server
  • func (s *Server) HealthzCheck() healthz.Checker
  • func (s *Server) Name() string
  • func (s *Server) ReadyzCheck() healthz.Checker
  • func (s *Server) Start(ctx context.Context) error

Constants

const (
	// CallbackBasePath callback path
	CallbackBasePath = "/report/:node/:executionID"
	// CallbackBaseResultSubPath result sub path
	CallbackBaseResultSubPath = "/result"
	// CallbackBaseFileSubPath file sub path
	CallbackBaseFileSubPath = "/file"
	// CallbackBaseEventSubPath event sub path
	CallbackBaseEventSubPath = "/event"

	// FileName query parameter name
	FileName = "name"
)

Functions

func GenericAPIServer

func GenericAPIServer(port int, cfg *config.Config) manager.Runnable

GenericAPIServer prepare the generic api server

func MockAPIServer

func MockAPIServer(port int) manager.Runnable

MockAPIServer prepare the mock api server

func SetupProfiling

func SetupProfiling(r *gin.Engine)

SetupProfiling setup profiling

func StaticFileServer

func StaticFileServer(port int, cfg *config.Config) manager.Runnable

StaticFileServer prepare the static file server

Types

type Event

type Event struct {
	Waring  bool     `json:"warning"`
	Reason  string   `json:"reason" validate:"required,first_char_must_be_uppercase"`
	Message string   `json:"message,omitempty" validate:"required"`
	Args    []string `json:"args,omitempty"`
}

Event to be sent as k8s event

func (*Event) Type

func (e *Event) Type() string

Type get the warning type

func (*Event) Validate

func (e *Event) Validate() error

Validate the event

type PostServer

type PostServer struct {
	*Server
	Controller    lifecycle.Controller
	Config        *config.Config
	EventRecorder record.EventRecorder
	Client        client.Reader
}

PostServer post server

func (*PostServer) HealthzCheck

func (s *PostServer) HealthzCheck() healthz.Checker

HealthzCheck check if server is running

func (*PostServer) InjectConfig

func (s *PostServer) InjectConfig(cfg *config.Config)

InjectConfig inject the config

func (*PostServer) InjectController

func (s *PostServer) InjectController(c lifecycle.Controller)

InjectController inject the controller

func (*PostServer) InjectEventRecorder

func (s *PostServer) InjectEventRecorder(er record.EventRecorder)

InjectEventRecorder inject the event recorder

func (*PostServer) InjectReader

func (s *PostServer) InjectReader(reader client.Reader)

InjectReader inject the client reader

func (*PostServer) Name

func (s *PostServer) Name() string

Name the name of the server

func (*PostServer) ReadyzCheck

func (s *PostServer) ReadyzCheck() healthz.Checker

ReadyzCheck check if server is running

func (*PostServer) SaveFile

func (s *PostServer) SaveFile(executionID, name string, data []byte) (string, error)

SaveFile save a received file

type Server

type Server struct {
	Port    int
	Kind    string
	Handler http.Handler
	Log     logr.Logger
	Config  *config.Config
}

Server default server

func (*Server) HealthzCheck

func (s *Server) HealthzCheck() healthz.Checker

HealthzCheck check if server is running

func (*Server) Name

func (s *Server) Name() string

Name the name of the server

func (*Server) ReadyzCheck

func (s *Server) ReadyzCheck() healthz.Checker

ReadyzCheck check if server is running

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

Start the server