object

Documentation

Overview

+kubebuilder:object:generate=true

Index

• func HasFinalizer(o metav1.Object, finalizer string) bool
• func RemoveFinalizer(o metav1.Object, finalizer string)
• func SetFinalizer(o metav1.Object, finalizer string)
• type AWSEvent
  • func (in *AWSEvent) DeepCopy() *AWSEvent
  • func (in *AWSEvent) DeepCopyInto(out *AWSEvent)
• type AWSStatus
  • func (in *AWSStatus) DeepCopy() *AWSStatus
  • func (in *AWSStatus) DeepCopyInto(out *AWSStatus)
• type Principal
• type PrincipalLister
• type SecretNamer
• type Service
• type State
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)
  • func (s *Status) GetState() State
  • func (s *Status) GetStatus() Status
  • func (s *Status) SetState(state State)
  • func (s *Status) SetStatus(status Status)
• type StatusReader
• type StatusWriter

Functions

func HasFinalizer

func HasFinalizer(o metav1.Object, finalizer string) bool

HasFinalizer is a helper for checking if finalizer exists

func RemoveFinalizer

func RemoveFinalizer(o metav1.Object, finalizer string)

RemoveFinalizer removes finalizer from object if it exists

func SetFinalizer

func SetFinalizer(o metav1.Object, finalizer string)

SetFinalizer adds finalizer to object if not exists

Types

type AWSEvent

type AWSEvent struct {
	// Status of the currently running instance.
	Status string `json:"status,omitempty"`
	// Reason for the current status of the instance.
	Reason string `json:"reason,omitempty"`
	// Time of the event cast.
	Time *metav1.Time `json:"time,omitempty"`
}

AWSEvent is a single action taken against the resource at any given time.

func (*AWSEvent) DeepCopy

func (in *AWSEvent) DeepCopy() *AWSEvent

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSEvent.

func (*AWSEvent) DeepCopyInto

func (in *AWSEvent) DeepCopyInto(out *AWSEvent)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AWSStatus

type AWSStatus struct {
	// ID of an instance for a reference.
	ID string `json:"id,omitempty"`
	// Name of an instance for a reference.
	Name string `json:"name,omitempty"`
	// Status of the currently running instance.
	Status string `json:"status,omitempty"`
	// Reason for the current status of the instance.
	Reason string `json:"reason,omitempty"`
	// Events will hold more in-depth details of the current state of the instance.
	Events []AWSEvent `json:"events,omitempty"`
	// Info shows any outputs returned from GetStackOutputWhitelist
	Info map[string]string `json:"info,omitempty"`
}

AWSStatus a cloudformation Stack

func (*AWSStatus) DeepCopy

func (in *AWSStatus) DeepCopy() *AWSStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSStatus.

func (*AWSStatus) DeepCopyInto

func (in *AWSStatus) DeepCopyInto(out *AWSStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Principal

type Principal interface {
	GetRoleName() string
	StatusReader
}

Principal is the interface shared by all principal types

type PrincipalLister

type PrincipalLister interface {
	runtime.Object
	GetPrincipals() []Principal
}

PrincipalLister declares that a type can return a list of principals

type SecretNamer

type SecretNamer interface {
	GetSecretName() string
}

SecretNamer names a Secret to hold sensitive details

type Service

type Service interface {
	runtime.Object
	metav1.Object
	schema.ObjectKind
	StatusReader
	StatusWriter
}

Service is the interface shared by all service resources

type State

type State string

var (
	ErrorState       State = "ERROR"
	DeletingState    State = "DELETE_IN_PROGRESS"
	ReadyState       State = "READY"
	ReconcilingState State = "RECONCILE_IN_PROGRESS"
)

type Status

type Status struct {
	// Generic service state
	State State `json:"state,omitempty"`
	// AWS specific status
	AWS AWSStatus `json:"aws,omitempty"`
}

Status is the type shared by most service resources

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status.

func (*Status) DeepCopyInto

func (in *Status) DeepCopyInto(out *Status)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Status) GetState

func (s *Status) GetState() State

GetState returns the status

func (*Status) GetStatus

func (s *Status) GetStatus() Status

GetStatus returns the status

func (*Status) SetState

func (s *Status) SetState(state State)

SetState returns the status

func (*Status) SetStatus

func (s *Status) SetStatus(status Status)

SetStatus updates status fields

type StatusReader

type StatusReader interface {
	GetStatus() Status
	GetState() State
}

StatusReader can fetch a status

type StatusWriter

type StatusWriter interface {
	SetStatus(Status)
	SetState(State)
}

StatusWriter can set status fields