summary

Documentation

Index

• Variables
• func NormalizeConditions(runtimeObj runtime.Object)
• type Condition
  • func GetUnstructuredConditions(obj map[string]interface{}) []Condition
  • func NewCondition(conditionType, status, reason, message string) Condition
  • func (c Condition) Equals(other Condition) bool
  • func (c Condition) Message() string
  • func (c Condition) Reason() string
  • func (c Condition) Status() string
  • func (c Condition) Type() string
• type Relationship
• type SummarizedObject
  • func Summarized(u runtime.Object) *SummarizedObject
  • func (in *SummarizedObject) DeepCopy() *SummarizedObject
  • func (in *SummarizedObject) DeepCopyInto(out *SummarizedObject)
  • func (in *SummarizedObject) DeepCopyObject() runtime.Object
• type SummarizedObjectList
  • func (in *SummarizedObjectList) DeepCopy() *SummarizedObjectList
  • func (in *SummarizedObjectList) DeepCopyInto(out *SummarizedObjectList)
  • func (in *SummarizedObjectList) DeepCopyObject() runtime.Object
• type Summarizer
• type Summary
  • func Summarize(runtimeObj runtime.Object) Summary
  • func (s *Summary) DeepCopy() *Summary
  • func (s *Summary) DeepCopyInto(v *Summary)
  • func (s Summary) IsReady() bool
  • func (s Summary) String() string

Variables

var (
	// True ==
	// False == error
	// Unknown == transitioning
	TransitioningUnknown = map[string]string{
		"Active":                      "activating",
		"AddonDeploy":                 "provisioning",
		"AgentDeployed":               "provisioning",
		"BackingNamespaceCreated":     "configuring",
		"Built":                       "building",
		"CertsGenerated":              "provisioning",
		"ConfigOK":                    "configuring",
		"Created":                     "creating",
		"CreatorMadeOwner":            "configuring",
		"DefaultNamespaceAssigned":    "configuring",
		"DefaultNetworkPolicyCreated": "configuring",
		"DefaultProjectCreated":       "configuring",
		"DockerProvisioned":           "provisioning",
		"Deployed":                    "deploying",
		"Drained":                     "draining",
		"Downloaded":                  "downloading",
		"etcd":                        "provisioning",
		"Inactive":                    "deactivating",
		"Initialized":                 "initializing",
		"Installed":                   "installing",
		"NodesCreated":                "provisioning",
		"Pending":                     "pending",
		"PodScheduled":                "scheduling",
		"Provisioned":                 "provisioning",
		"Reconciled":                  "reconciling",
		"Refreshed":                   "refreshed",
		"Registered":                  "registering",
		"Removed":                     "removing",
		"Saved":                       "saving",
		"Updated":                     "updating",
		"Updating":                    "updating",
		"Upgraded":                    "upgrading",
		"Waiting":                     "waiting",
		"InitialRolesPopulated":       "activating",
		"ScalingActive":               "pending",
		"AbleToScale":                 "pending",
		"RunCompleted":                "running",
		"Processed":                   "processed",
	}

	// True == error
	// False ==
	// Unknown ==
	ErrorTrue = map[string]bool{
		"OutOfDisk":           true,
		"MemoryPressure":      true,
		"DiskPressure":        true,
		"NetworkUnavailable":  true,
		"KernelHasNoDeadlock": true,
		"Unschedulable":       true,
		"ReplicaFailure":      true,
		"Stalled":             true,
	}

	// True ==
	// False == error
	// Unknown ==
	ErrorFalse = map[string]bool{
		"Failed": true,
	}

	// True ==
	// False == transitioning
	// Unknown == error
	TransitioningFalse = map[string]string{
		"Completed":           "activating",
		"Ready":               "unavailable",
		"Available":           "updating",
		"BootstrapReady":      reason,
		"InfrastructureReady": reason,
		"NodeHealthy":         reason,
	}

	// True == transitioning
	// False ==
	// Unknown == error
	TransitioningTrue = map[string]string{
		"Reconciling": "reconciling",
	}

	Summarizers          []Summarizer
	ConditionSummarizers []Summarizer
)

Functions

func NormalizeConditions

func NormalizeConditions(runtimeObj runtime.Object)

Types

type Condition

type Condition struct {
	data.Object
}

func GetUnstructuredConditions

func GetUnstructuredConditions(obj map[string]interface{}) []Condition

func NewCondition

func NewCondition(conditionType, status, reason, message string) Condition

func (Condition) Equals

func (c Condition) Equals(other Condition) bool

func (Condition) Message

func (c Condition) Message() string

func (Condition) Reason

func (c Condition) Reason() string

func (Condition) Status

func (c Condition) Status() string

func (Condition) Type

func (c Condition) Type() string

type Relationship

type Relationship struct {
	Name         string
	Namespace    string
	ControlledBy bool
	Kind         string
	APIVersion   string
	Inbound      bool
	Type         string
	Selector     *metav1.LabelSelector
}

type SummarizedObject

type SummarizedObject struct {
	metav1.PartialObjectMetadata
	Summary
}

func Summarized

func Summarized(u runtime.Object) *SummarizedObject

func (*SummarizedObject) DeepCopy

func (in *SummarizedObject) DeepCopy() *SummarizedObject

func (*SummarizedObject) DeepCopyInto

func (in *SummarizedObject) DeepCopyInto(out *SummarizedObject)

func (*SummarizedObject) DeepCopyObject

func (in *SummarizedObject) DeepCopyObject() runtime.Object

type SummarizedObjectList

type SummarizedObjectList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	Items           []SummarizedObject `json:"items" protobuf:"bytes,2,rep,name=items"`
}

func (*SummarizedObjectList) DeepCopy

func (in *SummarizedObjectList) DeepCopy() *SummarizedObjectList

func (*SummarizedObjectList) DeepCopyInto

func (in *SummarizedObjectList) DeepCopyInto(out *SummarizedObjectList)

func (*SummarizedObjectList) DeepCopyObject

func (in *SummarizedObjectList) DeepCopyObject() runtime.Object

type Summarizer

type Summarizer func(obj data.Object, conditions []Condition, summary Summary) Summary

type Summary

type Summary struct {
	State         string                 `json:"state,omitempty"`
	Error         bool                   `json:"error,omitempty"`
	Transitioning bool                   `json:"transitioning,omitempty"`
	Message       []string               `json:"message,omitempty"`
	Attributes    map[string]interface{} `json:"-"`
	Relationships []Relationship         `json:"-"`
}

func Summarize

func Summarize(runtimeObj runtime.Object) Summary

func (*Summary) DeepCopy

func (s *Summary) DeepCopy() *Summary

func (*Summary) DeepCopyInto

func (s *Summary) DeepCopyInto(v *Summary)

func (Summary) IsReady

func (s Summary) IsReady() bool

func (Summary) String

func (s Summary) String() string