apis

Documentation

Index

• type BuildHandler
  • func NewBuildHandler() (BuildHandler, error)
• type BuildRequest
• type GenerateHandler
  • func NewGenerateHandler() (GenerateHandler, error)
• type GenerateManifestsRequest

Types

type BuildHandler

type BuildHandler interface {
	Handle(request *BuildRequest) error
}

Handler is an interface that is implemented by structs that implement the Handle method. A Handler takes BuildRequests as input and builds an operator-registry image from that input.

It downloads operator manifests from a specified app registry, decodes them into files and then calls docker build to generate the operator-registry image.

func NewBuildHandler

func NewBuildHandler() (BuildHandler, error)

NewHandler is a constructor for the Handler interface

type BuildRequest

type BuildRequest struct {
	AuthorizationToken string
	Endpoint           string
	Namespace          string
	Image              string
	ImageBuildArgs     string
}

BuildRequest is a struct to describe the API used by the command line package to make requests to the builder handler.

type GenerateHandler

type GenerateHandler interface {
	Handle(request *GenerateManifestsRequest) error
}

GenerateHandler is an interface that is implemented by structs that implement the Handle method. A GenerateHandler takes GenerateManifests requests as input and downloads operator manifests from an appregistry namespace.

func NewGenerateHandler

func NewGenerateHandler() (GenerateHandler, error)

type GenerateManifestsRequest

type GenerateManifestsRequest struct {
	AuthorizationToken string
	Endpoint           string
	Namespace          string
}