resources

type GVKs ¶ added in v0.5.1

type GVKs struct {
	Deployment   schema.GroupVersionKind
	Kafka        schema.GroupVersionKind
	KafkaTopic   schema.GroupVersionKind
	KafkaConnect schema.GroupVersionKind
}

type Resource ¶

type Resource struct {
	Status            ResourceStatus
	Metadata          ResourceMetadata
	Conditions        []map[string]string
	ReadyRequirements []ResourceConditionReadyRequirements
}

Represents a k8s resource in a type-neutral way We used to have lots of repeated code because we needed to perform the same operations on different resources, which are represented by the go k8s sdk as different types. This type provides a single type that can represent any kind of resource and perform common actions

func MakeResource(source unstructured.Unstructured) Resource

func (r *Resource) AddReadyRequirements(requirements ResourceConditionReadyRequirements)

func (r *Resource) IsOwnedBy(ownerUID string) bool

func (r *Resource) IsReady() bool

type ResourceConditionReadyRequirements ¶

type ResourceConditionReadyRequirements struct {
	Type   string
	Status string
}

In order to status check resources we check their status conditions for a condition with a specific type and status. This type lets us define and pass those values around

type ResourceCounter ¶

type ResourceCounter struct {
	CountManaged      int
	CountReady        int
	BrokenLog         []string
	Query             ResourceCounterQuery
	ReadyRequirements []ResourceConditionReadyRequirements
}

Provides a simple API for getting common figures on Resources and ResourceLists The Count method returns a ResourceCounterResults instance

func MakeResourceCounterForType(typeSpecimen client.Object, scheme runtime.Scheme, namespaces []string, uid types.UID, readyRequirements []ResourceConditionReadyRequirements) (ResourceCounter, error)

func (r *ResourceCounter) Count(ctx context.Context, pClient client.Client) (ResourceCounterResults, error)

func (r *ResourceCounter) GetResourceList(ctx context.Context, pClient client.Client, namespace string) (ResourceList, error)

type ResourceCounterQuery ¶

type ResourceCounterQuery struct {
	GVK        schema.GroupVersionKind
	Namespaces []string
	OwnerGUID  string
}

Represents a resource query for a count We count resources of a given GVK (which derive from OfType ), in a given set of namespaces, owned by a given guid

func MakeQuery(typeSpecimen client.Object, scheme runtime.Scheme, namespaces []string, uid types.UID) (ResourceCounterQuery, error)

type ResourceCounterResults ¶

type ResourceCounterResults struct {
	Managed       int
	Ready         int
	BrokenMessage string
}

Results that a resource counter provides back when its count method is called

type ResourceFigures ¶

type ResourceFigures struct {
	Total int32
	Ready int32
}

An operator is interested in how many of a resource it manages and how many are ready

type ResourceList ¶

type ResourceList struct {
	Resources []Resource
	// contains filtered or unexported fields
}

The pattern other k8s SDKs follow is that resources are queried by some criteria resulting in a list object that then can be iterated over or acted on. ResourceList can query k8s for a list of resources by GVK and namespace which it then parses into Resource instances.

func (r *ResourceList) AddReadyRequirementsFromSlice(reqsList []ResourceConditionReadyRequirements)

func (r *ResourceList) Count() int

func (r *ResourceList) CountReady() int

func (r *ResourceList) FilterByOwnerUID(ownerUID string) ResourceList

func (r *ResourceList) GetByGVKAndNamespace(ctx context.Context, pClient client.Client, namespace string, gvk schema.GroupVersionKind) error

func (r *ResourceList) GetResourceStatusBuckets() ResourceStatusBuckets

func (r *ResourceList) SetListAndParse(uList unstructured.UnstructuredList)

type ResourceMetadata ¶

type ResourceMetadata struct {
	Generation      int64
	Namespace       string
	Name            string
	UID             string
	ResourceVersion string
	OwnerUIDs       []string
}

Represents the metadata we pull off the unstructured resource

type ResourceStatus ¶

type ResourceStatus struct {
	ObservedGeneration int64
}

Represents the status we pull off the unstructured resource I only parse what I need to reduce the oppurtunity for bugs

type ResourceStatusBuckets ¶

type ResourceStatusBuckets struct {
	Ready  []Resource
	Broken []Resource
}