generic

Documentation

Index

• type Context
  • func NewContext(ctx context.Context) *Context
  • func (c *Context) Cancel()
  • func (c *Context) Context() context.Context
• type FailMode
• type Resource
  • func NewResource(ctx context.Context, spec *Spec, client kubernetes.Interface, ...) *Resource
• type ResourceState
• type Spec
  • func (s *Spec) Init() error
• type State
  • func NewState() *State
  • func (s *State) BumpFailuresCount()
  • func (s *State) FailedReason() string
  • func (s *State) FailuresCount() int
  • func (s *State) LastPrintedStatus() *generic.ResourceStatus
  • func (s *State) LastStatus() *generic.ResourceStatus
  • func (s *State) ResourceState() ResourceState
  • func (s *State) SetFailedReason(reason string)
  • func (s *State) SetLastPrintedStatus(status *generic.ResourceStatus)
  • func (s *State) SetLastStatus(status *generic.ResourceStatus)
  • func (s *State) SetResourceState(status ResourceState)
• type TrackTerminationMode

Types

type Context

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

func NewContext

func NewContext(ctx context.Context) *Context

func (*Context) Cancel

func (c *Context) Cancel()

func (*Context) Context

func (c *Context) Context() context.Context

type FailMode

type FailMode string

const (
	IgnoreAndContinueDeployProcess    FailMode = "IgnoreAndContinueDeployProcess"
	FailWholeDeployProcessImmediately FailMode = "FailWholeDeployProcessImmediately"
	HopeUntilEndOfDeployProcess       FailMode = "HopeUntilEndOfDeployProcess"
)

type Resource

type Resource struct {
	Spec    *Spec
	State   *State
	Feed    *generic.Feed
	Context *Context
}

func NewResource

func NewResource(
	ctx context.Context,
	spec *Spec,
	client kubernetes.Interface,
	dynClient dynamic.Interface,
	discClient discovery.CachedDiscoveryInterface,
	mapper meta.RESTMapper,
) *Resource

type ResourceState

type ResourceState string

const (
	ResourceStateActive            ResourceState = "ResourceStateActive"
	ResourceStateSucceeded         ResourceState = "ResourceStateSucceeded"
	ResourceStateFailed            ResourceState = "ResourceStateFailed"
	ResourceStateHoping            ResourceState = "ResourceStateHoping"
	ResourceStateActiveAfterHoping ResourceState = "ResourceStateActiveAfterHoping"
)

type Spec

type Spec struct {
	*resid.ResourceID

	Timeout              time.Duration
	NoActivityTimeout    *time.Duration
	TrackTerminationMode TrackTerminationMode
	FailMode             FailMode
	AllowFailuresCount   *int
	ShowServiceMessages  bool
	HideEvents           bool
	StatusProgressPeriod time.Duration
}

func (*Spec) Init

func (s *Spec) Init() error

type State

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

func NewState

func NewState() *State

func (*State) BumpFailuresCount

func (s *State) BumpFailuresCount()

func (*State) FailedReason

func (s *State) FailedReason() string

func (*State) FailuresCount

func (s *State) FailuresCount() int

func (*State) LastPrintedStatus

func (s *State) LastPrintedStatus() *generic.ResourceStatus

func (*State) LastStatus

func (s *State) LastStatus() *generic.ResourceStatus

func (*State) ResourceState

func (s *State) ResourceState() ResourceState

func (*State) SetFailedReason

func (s *State) SetFailedReason(reason string)

func (*State) SetLastPrintedStatus

func (s *State) SetLastPrintedStatus(status *generic.ResourceStatus)

func (*State) SetLastStatus

func (s *State) SetLastStatus(status *generic.ResourceStatus)

func (*State) SetResourceState

func (s *State) SetResourceState(status ResourceState)

type TrackTerminationMode

type TrackTerminationMode string

const (
	WaitUntilResourceReady TrackTerminationMode = "WaitUntilResourceReady"
	NonBlocking            TrackTerminationMode = "NonBlocking"
)