Documentation

Index

Constants

View Source
const (
	// ShowObjectConditionsAnnotation documents that the presentation layer should show all the conditions for the object.
	ShowObjectConditionsAnnotation = "tree.cluster.x-k8s.io.io/show-conditions"

	// ObjectMetaNameAnnotation contains the meta name that should be used for the object in the presentation layer,
	// e.g. control plane for KCP.
	ObjectMetaNameAnnotation = "tree.cluster.x-k8s.io.io/meta-name"

	// VirtualObjectAnnotation documents that the object does not correspond to any real object, but instead is
	// a virtual object introduced to provide a better representation of the cluster status, e.g. workers.
	VirtualObjectAnnotation = "tree.cluster.x-k8s.io.io/virtual-object"

	// GroupingObjectAnnotation is an annotation that should be applied to a node in order to trigger the grouping action
	// when adding the node's children. e.g. if you have a control-plane node, and you apply this annotation, then
	// the control-plane machines added as a children of this node will be grouped in case the ready condition
	// has the same Status, Severity and Reason.
	GroupingObjectAnnotation = "tree.cluster.x-k8s.io.io/grouping-object"

	// GroupObjectAnnotation is an annotation that documents that a node is the result of a grouping operation, and
	// thus the node is representing group of sibling nodes, e.g. a group of machines.
	GroupObjectAnnotation = "tree.cluster.x-k8s.io.io/group-object"

	// GroupItemsAnnotation contains the list of names for the objects included in a group object.
	GroupItemsAnnotation = "tree.cluster.x-k8s.io.io/group-items"

	// GroupItemsSeparator is the separator used in the GroupItemsAnnotation
	GroupItemsSeparator = ", "
)

Variables

This section is empty.

Functions

func GetGroupItems

func GetGroupItems(obj controllerutil.Object) string

    GetGroupItems return the list of names for the objects included in a group object.

    func GetMetaName

    func GetMetaName(obj controllerutil.Object) string

      GetMetaName returns the object meta name that should be used for the object in the presentation layer, if defined.

      func GetOtherConditions

      func GetOtherConditions(obj controllerutil.Object) []*clusterv1.Condition

        GetOtherConditions returns the other conditions (all the conditions except ready) for an object, if defined.

        func GetReadyCondition

        func GetReadyCondition(obj controllerutil.Object) *clusterv1.Condition

          GetReadyCondition returns the ReadyCondition for an object, if defined.

          func IsGroupObject

          func IsGroupObject(obj controllerutil.Object) bool

            IsGroupObject return true if the object is the result of a grouping operation, and thus the object is representing group of sibling object, e.g. a group of machines.

            func IsGroupingObject

            func IsGroupingObject(obj controllerutil.Object) bool

              IsGroupingObject returns true in case the object is responsible to trigger the grouping action when adding the object's children. e.g. A control-plane object, could be responsible of grouping the control-plane machines while added as a children objects.

              func IsShowConditionsObject

              func IsShowConditionsObject(obj controllerutil.Object) bool

                IsShowConditionsObject returns true if the presentation layer should show all the conditions for the object.

                func IsVirtualObject

                func IsVirtualObject(obj controllerutil.Object) bool

                  IsVirtualObject return true if the object does not correspond to any real object, but instead it is a virtual object introduced to provide a better representation of the cluster status.

                  func VirtualObject

                  func VirtualObject(namespace, kind, name string) *unstructured.Unstructured

                    VirtualObject return a new virtual object.

                    Types

                    type AddObjectOption

                    type AddObjectOption interface {
                    	ApplyToAdd(*addObjectOptions)
                    }

                      AddObjectOption define an option for the ObjectTree Add operation.

                      type DiscoverOptions

                      type DiscoverOptions struct {
                      	// ShowOtherConditions is a list of comma separated kind or kind/name for which we should add the ShowObjectConditionsAnnotation
                      	// to signal to the presentation layer to show all the conditions for the objects.
                      	ShowOtherConditions string
                      
                      	// DisableNoEcho disable hiding MachineInfrastructure or BootstrapConfig objects if the object's ready condition is true
                      	// or it has the same Status, Severity and Reason of the parent's object ready condition (it is an echo)
                      	DisableNoEcho bool
                      
                      	// DisableGrouping disable grouping machines objects in case the ready condition
                      	// has the same Status, Severity and Reason
                      	DisableGrouping bool
                      }

                        DiscoverOptions define options for the discovery process.

                        type GroupingObject

                        type GroupingObject bool

                          The GroupingObject option makes this node responsible of triggering the grouping action when adding the node's children.

                          func (GroupingObject) ApplyToAdd

                          func (n GroupingObject) ApplyToAdd(options *addObjectOptions)

                          type NoEcho

                          type NoEcho bool

                            The NoEcho options defines if the object should be hidden if the object's ready condition has the same Status, Severity and Reason of the parent's object ready condition (it is an echo).

                            func (NoEcho) ApplyToAdd

                            func (n NoEcho) ApplyToAdd(options *addObjectOptions)

                            type ObjectMetaName

                            type ObjectMetaName string

                              The ObjectMetaName option defines the meta name that should be used for the object in the presentation layer, e.g. control plane for KCP.

                              func (ObjectMetaName) ApplyToAdd

                              func (n ObjectMetaName) ApplyToAdd(options *addObjectOptions)

                              type ObjectTree

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

                                ObjectTree defines an object tree representing the status of a Cluster API cluster.

                                func Discovery

                                func Discovery(ctx context.Context, c client.Client, namespace, name string, options DiscoverOptions) (*ObjectTree, error)

                                  Discovery returns an object tree representing the status of a Cluster API cluster.

                                  func NewObjectTree

                                  func NewObjectTree(root controllerutil.Object, options ObjectTreeOptions) *ObjectTree

                                  func (ObjectTree) Add

                                  func (od ObjectTree) Add(parent, obj controllerutil.Object, opts ...AddObjectOption) (added bool, visible bool)

                                    Add a object to the object tree.

                                    func (ObjectTree) GetObject

                                    func (od ObjectTree) GetObject(id types.UID) controllerutil.Object

                                    func (ObjectTree) GetObjectsByParent

                                    func (od ObjectTree) GetObjectsByParent(id types.UID) []controllerutil.Object

                                    func (ObjectTree) GetRoot

                                    func (od ObjectTree) GetRoot() controllerutil.Object

                                    func (ObjectTree) IsObjectWithChild

                                    func (od ObjectTree) IsObjectWithChild(id types.UID) bool

                                    type ObjectTreeOptions

                                    type ObjectTreeOptions struct {
                                    	// ShowOtherConditions is a list of comma separated kind or kind/name for which we should add   the ShowObjectConditionsAnnotation
                                    	// to signal to the presentation layer to show all the conditions for the objects.
                                    	ShowOtherConditions string
                                    
                                    	// DisableNoEcho disables hiding objects if the object's ready condition has the
                                    	// same Status, Severity and Reason of the parent's object ready condition (it is an echo)
                                    	DisableNoEcho bool
                                    
                                    	// DisableGrouping disables grouping sibling objects in case the ready condition
                                    	// has the same Status, Severity and Reason
                                    	DisableGrouping bool
                                    }