app

Documentation

Index

• func IsFetch(err error) bool
• func IsInvalidConfig(err error) bool
• func IsInvalidType(err error) bool
• func IsNoMatch(err error) bool
• func IsNoResources(err error) bool
• func IsNotFound(err error) bool
• type App
  • func (a *App) Object() runtime.Object
• type Collection
  • func (cc *Collection) Object() runtime.Object
• type Config
• type GetOptions
• type Interface
• type PatchOptions
• type Resource
• type Service
  • func New(config Config) (*Service, error)
  • func (s *Service) Get(ctx context.Context, options GetOptions) (Resource, error)
  • func (s *Service) Patch(ctx context.Context, options PatchOptions) ([]string, error)

Functions

func IsFetch

func IsFetch(err error) bool

IsFetch asserts fetchError.

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsInvalidType

func IsInvalidType(err error) bool

IsInvalidType asserts invalidTypeError.

func IsNoMatch

func IsNoMatch(err error) bool

IsNoMatch asserts noMatchError.

func IsNoResources

func IsNoResources(err error) bool

IsNoResources asserts noResourcesError.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound asserts notFoundError.

Types

type App

type App struct {
	CR *applicationv1alpha1.App
}

App abstracts away the custom resource so it can be returned as a runtime object or a typed custom resource.

func (*App) Object

func (a *App) Object() runtime.Object

type Collection

type Collection struct {
	Items []App
}

Collection wraps a list of apps.

func (*Collection) Object

func (cc *Collection) Object() runtime.Object

type Config

type Config struct {
	Client client.Client
}

Config represent the input parameters that New takes to produce a valid app getter Service.

type GetOptions

type GetOptions struct {
	LabelSelector string
	Name          string
	Namespace     string
}

GetOptions are the parameters that the Get method takes.

type Interface

type Interface interface {
	Get(context.Context, GetOptions) (Resource, error)
	Patch(context.Context, PatchOptions) ([]string, error)
}

Interface represents the contract for the app data service. Using this instead of a regular 'struct' makes mocking the service in tests much simpler.

type PatchOptions

type PatchOptions struct {
	Name                  string
	Namespace             string
	SuspendReconciliation bool
	Version               string
}

PatchOptions are the parameters that the Patch method takes.

type Resource

type Resource interface {
	Object() runtime.Object
}

type Service

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

Service is the object we'll hang the app getter methods on.

func New

func New(config Config) (*Service, error)

New returns a new app getter Service.

func (*Service) Get

func (s *Service) Get(ctx context.Context, options GetOptions) (Resource, error)

Get fetches a list of app CRs filtered by namespace and optionally by name.

func (*Service) Patch

func (s *Service) Patch(ctx context.Context, options PatchOptions) ([]string, error)

Patch patches an app CR given its name and namespace.