types

type Controller interface {
	// Owns returns true if the controller manages resources of the specified GroupVersionKind.
	Owns(gvk schema.GroupVersionKind) bool

	// GetClient returns a controller-runtime client used to interact with the Kubernetes API.
	GetClient() client.Client

	// GetDiscoveryClient returns a client-go discovery client used to discover API resources on the cluster.
	GetDiscoveryClient() discovery.DiscoveryInterface

	// GetDynamicClient returns a client-go dynamic client for working with unstructured resources.
	GetDynamicClient() dynamic.Interface
}

type ManifestInfo struct {
	Path       string
	ContextDir string
	SourcePath string
}

type ReconciliationRequest struct {
	Client     client.Client
	Controller Controller
	Conditions *conditions.Manager
	Instance   common.PlatformObject
	DSCI       *dsciv1.DSCInitialization
	Release    common.Release
	Manifests  []ManifestInfo

	//
	// TODO: unify templates and resources.
	//
	// Unfortunately, the kustomize APIs do not yet support a FileSystem that is
	// backed by golang's fs.Fs so it is not simple to have a single abstraction
	// for both the manifests types.
	//
	// it would be nice to have a structure like:
	//
	// struct {
	//   FS  fs.FS
	//   URI net.URL
	// }
	//
	// where the URI could be something like:
	// - kustomize:///path/to/overlay
	// - template:///path/to/resource.tmpl.yaml
	//
	// and use the scheme as discriminator for the rendering engine
	//
	Templates []TemplateInfo
	Resources []unstructured.Unstructured

	// TODO: this has been added to reduce GC work and only run when
	//       resources have been generated. It should be removed and
	//       replaced with a better way of describing resources and
	//       their origin
	Generated bool
}

type ResourceObject interface {
	client.Object
	common.WithStatus
}

type TemplateInfo struct {
	FS   fs.FS
	Path string

	Labels      map[string]string
	Annotations map[string]string
}

type WithLogger interface {
	GetLogger() logr.Logger
}