Documentation
¶
Index ¶
- Constants
- func CheckResourceStatus(obj unstructured.Unstructured) (*types.HealthStatus, error)
- func Install(p providers.Providers, cli client.Client, cfg *rest.Config)
- type AppCollector
- func (c *AppCollector) CollectResourceFromApp() ([]Resource, error)
- func (c *AppCollector) FindResourceFromAppliedResourcesField(app *v1beta1.Application) ([]Resource, error)
- func (c *AppCollector) FindResourceFromResourceTrackerSpec(app *v1beta1.Application) ([]Resource, error)
- func (c *AppCollector) ListApplicationResources(app *v1beta1.Application, queryTree bool) ([]*types.AppliedResource, error)
- type ChildrenResourcesRule
- type CustomSelector
- type FilterOption
- type GroupResourceType
- type Option
- type Resource
- type ResourceType
- type RuleList
- type SubResourceSelector
- type SubResources
- type WorkloadUnstructured
Constants ¶
const (
// ProviderName is provider name for install.
ProviderName = "query"
// HelmReleaseKind is the kind of HelmRelease
HelmReleaseKind = "HelmRelease"
)
Variables ¶
This section is empty.
Functions ¶
func CheckResourceStatus ¶ added in v1.6.0
func CheckResourceStatus(obj unstructured.Unstructured) (*types.HealthStatus, error)
CheckResourceStatus return object status data
Types ¶
type AppCollector ¶
type AppCollector struct {
// contains filtered or unexported fields
}
AppCollector collect resource created by application
func NewAppCollector ¶
func NewAppCollector(cli client.Client, opt Option) *AppCollector
NewAppCollector create a app collector
func (*AppCollector) CollectResourceFromApp ¶
func (c *AppCollector) CollectResourceFromApp() ([]Resource, error)
CollectResourceFromApp collect resources created by application
func (*AppCollector) FindResourceFromAppliedResourcesField ¶
func (c *AppCollector) FindResourceFromAppliedResourcesField(app *v1beta1.Application) ([]Resource, error)
FindResourceFromAppliedResourcesField find resources from AppliedResources field
func (*AppCollector) FindResourceFromResourceTrackerSpec ¶
func (c *AppCollector) FindResourceFromResourceTrackerSpec(app *v1beta1.Application) ([]Resource, error)
FindResourceFromResourceTrackerSpec find resources from ResourceTracker spec
func (*AppCollector) ListApplicationResources ¶ added in v1.3.0
func (c *AppCollector) ListApplicationResources(app *v1beta1.Application, queryTree bool) ([]*types.AppliedResource, error)
ListApplicationResources list application applied resources from tracker
type ChildrenResourcesRule ¶ added in v1.4.0
type ChildrenResourcesRule struct {
// GroupResourceType the root resource type
GroupResourceType GroupResourceType
// every subResourceType can have a specified genListOptionFunc.
SubResources *SubResources
// if specified genListOptionFunc is nil will use use default genListOptionFunc to generate listOption.
DefaultGenListOptionFunc genListOptionFunc
// DisableFilterByOwnerReference means don't use parent resource's UID filter the result.
DisableFilterByOwnerReference bool
}
ChildrenResourcesRule define the relationShip between parentObject and children resource
type CustomSelector ¶ added in v1.5.0
type CustomSelector struct {
ResourceType `json:",inline"`
// defaultLabelSelector means read the label selector condition from the spec.selector.
DefaultLabelSelector bool `json:"defaultLabelSelector"`
}
CustomSelector the custom resource selector configuration in configmap. support set the default label selector policy
type FilterOption ¶
type FilterOption struct {
Cluster string `json:"cluster,omitempty"`
ClusterNamespace string `json:"clusterNamespace,omitempty"`
Components []string `json:"components,omitempty"`
APIVersion string `json:"apiVersion,omitempty"`
Kind string `json:"kind,omitempty"`
}
FilterOption filter resource created by component
type GroupResourceType ¶ added in v1.4.0
type GroupResourceType struct {
Group string `json:"group"`
Kind string `json:"kind"`
}
GroupResourceType define the parent resource type
type Option ¶
type Option struct {
Name string `json:"name"`
Namespace string `json:"namespace"`
Filter FilterOption `json:"filter,omitempty"`
// WithStatus means query the object from the cluster and get the latest status
// This field only suitable for ListResourcesInApp
WithStatus bool `json:"withStatus,omitempty"`
// WithTree means recursively query the resource tree.
WithTree bool `json:"withTree,omitempty"`
}
Option is the query option
type Resource ¶
type Resource struct {
Cluster string `json:"cluster"`
Component string `json:"component"`
Revision string `json:"revision"`
Object *unstructured.Unstructured `json:"object"`
}
Resource refer to an object with cluster info
type ResourceType ¶ added in v1.4.0
type ResourceType struct {
APIVersion string `json:"apiVersion,omitempty"`
Kind string `json:"kind,omitempty"`
}
ResourceType define the children resource type
type SubResourceSelector ¶ added in v1.5.0
type SubResourceSelector struct {
ResourceType
// contains filtered or unexported fields
}
SubResourceSelector the sub resource selector configuration
type SubResources ¶ added in v1.5.0
type SubResources []*SubResourceSelector
SubResources the sub resource definitions
type WorkloadUnstructured ¶ added in v1.5.0
type WorkloadUnstructured struct {
unstructured.Unstructured
}
WorkloadUnstructured the workload unstructured, such as Deployment、Job、StatefulSet、ReplicaSet and DaemonSet
func (*WorkloadUnstructured) GetSelector ¶ added in v1.5.0
func (w *WorkloadUnstructured) GetSelector() (labels.Selector, error)
GetSelector get the selector from the field path: spec.selector
Source Files
Directories