summary

package
v3.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 4, 2026 License: Apache-2.0 Imports: 18 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source
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",
	}

	// For given GVK, This condition Type and this Status, indicates an error or not
	// e.g.: GVK: helm.cattle.io/v1, HelmChart
	//		--> JobCreated: [], indicates True or False are not errors
	//		--> Failed: ["True"], indicates "True" status is considered error
	//		--> Worked: ["False"], indicates "False" status is considered error
	//		--> Unknown: ["True", "False"] indicated "True" or "False" are considered errors
	GVKConditionErrorMapping = ConditionTypeStatusErrorMapping{
		{Group: "helm.cattle.io", Version: "v1", Kind: "HelmChart"}: {
			"JobCreated": sets.New[metav1.ConditionStatus](),
			"Failed":     sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
		},
		{Group: "", Version: "v1", Kind: "Node"}: {
			"OutOfDisk":          sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
			"MemoryPressure":     sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
			"DiskPressure":       sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
			"NetworkUnavailable": sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
		},
		{Group: "apps", Version: "v1", Kind: "Deployment"}: {
			"ReplicaFailure": sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
			"Progressing":    sets.New[metav1.ConditionStatus](metav1.ConditionFalse),
		},
		{Group: "apps", Version: "v1", Kind: "ReplicaSet"}: {
			"ReplicaFailure": sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
		},

		{Group: "", Version: "", Kind: ""}: {
			"Stalled": sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
			"Failed":  sets.New[metav1.ConditionStatus](metav1.ConditionTrue),
		},
	}

	// 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 ConditionTypeStatusErrorMapping added in v3.2.1

type ConditionTypeStatusErrorMapping map[schema.GroupVersionKind]map[string]sets.Set[metav1.ConditionStatus]

func (ConditionTypeStatusErrorMapping) MarshalJSON added in v3.2.1

func (m ConditionTypeStatusErrorMapping) MarshalJSON() ([]byte, error)

func (ConditionTypeStatusErrorMapping) UnmarshalJSON added in v3.2.1

func (m ConditionTypeStatusErrorMapping) UnmarshalJSON(data []byte) error

type Relationship

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

type SummarizeOptions added in v3.2.3

type SummarizeOptions struct {
	HasObservedGeneration bool
}

type SummarizedObject

type SummarizedObject struct {
	metav1.PartialObjectMetadata
	Summary
}

func Summarized

func Summarized(u runtime.Object) *SummarizedObject

func SummarizedWithOptions added in v3.2.3

func SummarizedWithOptions(u runtime.Object, opts *SummarizeOptions) *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 (*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:"-"`
	HasObservedGeneration bool                   `json:"-"`
}

func Summarize

func Summarize(runtimeObj runtime.Object) Summary

func SummarizeWithOptions added in v3.2.3

func SummarizeWithOptions(runtimeObj runtime.Object, opts *SummarizeOptions) 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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL