rpaas

Documentation

Index

• func IsConflictError(err error) bool
• func IsNotFoundError(err error) bool
• func IsValidationError(err error) bool
• type BindAppArgs
• type CacheManager
• type ConfigurationBlock
• type ConfigurationBlockHandler
• type ConflictError
  • func (e ConflictError) Error() string
  • func (ConflictError) IsConflict() bool
• type CreateArgs
• type ExtraFileHandler
• type File
  • func (f File) MarshalJSON() ([]byte, error)
  • func (f File) SHA256() string
• type NotFoundError
  • func (e NotFoundError) Error() string
  • func (NotFoundError) IsNotFound() bool
• type PodStatus
• type PodStatusMap
• type PurgeCacheArgs
• type Route
• type RouteHandler
• type RpaasManager
  • func NewK8S(mgr manager.Manager) (RpaasManager, error)
• type ValidationError
  • func (e ValidationError) Error() string
  • func (ValidationError) IsValidation() bool

Functions

func IsConflictError

func IsConflictError(err error) bool

func IsNotFoundError

func IsNotFoundError(err error) bool

func IsValidationError

func IsValidationError(err error) bool

Types

type BindAppArgs

type BindAppArgs struct {
	AppName string `form:"app-name"`
	AppHost string `form:"app-host"`
	User    string `form:"user"`
	EventID string `form:"eventid"`
}

type CacheManager

type CacheManager interface {
	PurgeCache(host, path string, preservePath bool) error
}

type ConfigurationBlock

type ConfigurationBlock struct {
	Name    string `form:"block_name" json:"block_name"`
	Content string `form:"content" json:"content"`
}

type ConfigurationBlockHandler

type ConfigurationBlockHandler interface {
	// DeleteBlock removes the configuration block named by blockName. It returns
	// a nil error meaning it was successful, otherwise a non-nil one which
	// describes the reached problem.
	DeleteBlock(ctx context.Context, instanceName, blockName string) error

	// ListBlocks returns all custom configuration blocks from instance (which
	// name is instanceName). It returns a nil error meaning it was successful,
	// otherwise a non-nil one which describes the reached problem.
	ListBlocks(ctx context.Context, instanceName string) ([]ConfigurationBlock, error)

	// UpdateBlock overwrites the older configuration block content with the one.
	// Whether the configuration block entry does not exist, it will already be
	// created with the new content. It returns a nil error meaning it was
	// successful, otherwise a non-nil one which describes the reached problem.
	UpdateBlock(ctx context.Context, instanceName string, block ConfigurationBlock) error
}

ConfigurationBlockHandler defines some functions to handle the custom configuration blocks from an instance.

type ConflictError

type ConflictError struct {
	Msg string
}

func (ConflictError) Error

func (e ConflictError) Error() string

func (ConflictError) IsConflict

func (ConflictError) IsConflict() bool

type CreateArgs

type CreateArgs struct {
	Name         string   `json:"name" form:"name"`
	Plan         string   `json:"plan" form:"plan"`
	Team         string   `json:"team" form:"team"`
	User         string   `json:"user" form:"user"`
	Tags         []string `json:"tags" form:"tags"`
	EventID      string   `json:"eventid" form:"eventid"`
	Description  string   `json:"description" form:"description"`
	Flavor       string   `json:"flavor" form:"flavor"`
	IP           string   `json:"ip" form:"ip"`
	PlanOverride string   `json:"plan-override" form:"plan-override"`
}

type ExtraFileHandler

type ExtraFileHandler interface {
	CreateExtraFiles(ctx context.Context, instanceName string, files ...File) error
	DeleteExtraFiles(ctx context.Context, instanceName string, filenames ...string) error
	GetExtraFiles(ctx context.Context, instanceName string) ([]File, error)
	UpdateExtraFiles(ctx context.Context, instanceName string, files ...File) error
}

type File

type File struct {
	Name    string
	Content []byte
}

func (File) MarshalJSON

func (f File) MarshalJSON() ([]byte, error)

func (File) SHA256

func (f File) SHA256() string

type NotFoundError

type NotFoundError struct {
	Msg string
}

func (NotFoundError) Error

func (e NotFoundError) Error() string

func (NotFoundError) IsNotFound

func (NotFoundError) IsNotFound() bool

type PodStatus

type PodStatus struct {
	Running bool   `json:"running"`
	Status  string `json:"status"`
	Address string `json:"address"`
}

type PodStatusMap

type PodStatusMap map[string]PodStatus

type PurgeCacheArgs

type PurgeCacheArgs struct {
	Path         string `json:"path" form:"path"`
	PreservePath bool   `json:"preserve_path" form:"preserve_path"`
}

type Route

type Route struct {
	Path        string `json:"path" form:"path"`
	Destination string `json:"destination" form:"destination"`
	Content     string `json:"content" form:"content"`
	HTTPSOnly   bool   `json:"https_only" form:"https_only"`
}

type RouteHandler

type RouteHandler interface {
	DeleteRoute(ctx context.Context, instanceName, path string) error
	GetRoutes(ctx context.Context, instanceName string) ([]Route, error)
	UpdateRoute(ctx context.Context, instanceName string, route Route) error
}

type RpaasManager

type RpaasManager interface {
	ConfigurationBlockHandler
	ExtraFileHandler
	RouteHandler

	UpdateCertificate(ctx context.Context, instance, name string, cert tls.Certificate) error
	CreateInstance(ctx context.Context, args CreateArgs) error
	DeleteInstance(ctx context.Context, name string) error
	GetInstance(ctx context.Context, name string) (*v1alpha1.RpaasInstance, error)
	GetInstanceAddress(ctx context.Context, name string) (string, error)
	GetInstanceStatus(ctx context.Context, name string) (PodStatusMap, error)
	Scale(ctx context.Context, name string, replicas int32) error
	GetPlans(ctx context.Context) ([]v1alpha1.RpaasPlan, error)
	BindApp(ctx context.Context, instanceName string, args BindAppArgs) error
	UnbindApp(ctx context.Context, instanceName string) error
	PurgeCache(ctx context.Context, instanceName string, args PurgeCacheArgs) (int, error)
}

func NewK8S

func NewK8S(mgr manager.Manager) (RpaasManager, error)

type ValidationError

type ValidationError struct {
	Msg string
}

func (ValidationError) Error

func (e ValidationError) Error() string

func (ValidationError) IsValidation

func (ValidationError) IsValidation() bool