Add the Bundle Go type to the public API

api/v1alpha1/bundle.go

@@ -16,6 +16,8 @@ limitations under the License.
 
 package v1alpha1
 
+import "cuelang.org/go/cue"
+
 const (
 	// BundleAPIVersionSelector is the CUE path for the Timoni's bundle API version.
 	BundleAPIVersionSelector Selector = "bundle.apiVersion"
@@ -66,3 +68,35 @@ import "strings"
 
 bundle: #Bundle
 `
+
+// Bundle holds the information about the bundle name and the list of instances.
+// +k8s:deepcopy-gen=false
+type Bundle struct {
+	// Name is the name of the bundle.
+	Name string `json:"name"`
+
+	// Instances is a list of instances defined in the bundle.
+	Instances []*BundleInstance `json:"instances"`
+}
+
+// BundleInstance holds the information about the instance name, namespace, module and values.
+// +k8s:deepcopy-gen=false
+type BundleInstance struct {
+	// Bundle is the name of the bundle this instance belongs to.
+	Bundle string `json:"bundle"`
+
+	// Cluster is the name of the cluster this instance belongs to.
+	Cluster string `json:"cluster,omitempty"`
+
+	// Name is the name of the instance.
+	Name string `json:"name"`
+
+	// Namespace is the namespace where the instance will be installed.
+	Namespace string `json:"namespace"`
+
+	// Module is a reference to the module's artifact in the registry.
+	Module ModuleReference `json:"module"`
+
+	// Values hold the user-supplied configuration of this instance.
+	Values cue.Value `json:"values,omitempty"`
+}

cmd/timoni/apply.go

@@ -239,7 +239,7 @@ func runApplyCmd(cmd *cobra.Command, args []string) error {
 	ctx, cancel := context.WithTimeout(cmd.Context(), rootArgs.timeout)
 	defer cancel()
 
-	instance := &engine.BundleInstance{
+	instance := &apiv1.BundleInstance{
 		Name:      applyArgs.name,
 		Namespace: *kubeconfigArgs.Namespace,
 		Module:    *mod,

cmd/timoni/bundle_apply.go

@@ -242,7 +242,7 @@ func runBundleApplyCmd(cmd *cobra.Command, _ []string) error {
 	return nil
 }
 
-func fetchBundleInstanceModule(ctx context.Context, instance *engine.BundleInstance, rootDir string) error {
+func fetchBundleInstanceModule(ctx context.Context, instance *apiv1.BundleInstance, rootDir string) error {
 	modDir := path.Join(rootDir, instance.Name)
 	if err := os.MkdirAll(modDir, os.ModePerm); err != nil {
 		return err
@@ -279,7 +279,7 @@ func fetchBundleInstanceModule(ctx context.Context, instance *engine.BundleInsta
 	return nil
 }
 
-func applyBundleInstance(ctx context.Context, cuectx *cue.Context, instance *engine.BundleInstance, kubeVersion string, rootDir string, diffOutput io.Writer) error {
+func applyBundleInstance(ctx context.Context, cuectx *cue.Context, instance *apiv1.BundleInstance, kubeVersion string, rootDir string, diffOutput io.Writer) error {
 	log := loggerBundleInstance(ctx, instance.Bundle, instance.Cluster, instance.Name, true)
 
 	modDir := path.Join(rootDir, instance.Name, "module")
@@ -363,7 +363,7 @@ func saveReaderToFile(reader io.Reader) (string, error) {
 	return f.Name(), nil
 }
 
-func bundleInstancesOwnershipConflicts(bundleInstances []*engine.BundleInstance) error {
+func bundleInstancesOwnershipConflicts(bundleInstances []*apiv1.BundleInstance) error {
 	var conflicts reconciler.InstanceOwnershipConflictErr
 	rm, err := runtime.NewResourceManager(kubeconfigArgs)
 	if err != nil {

cmd/timoni/bundle_build.go

@@ -187,7 +187,7 @@ func runBundleBuildCmd(cmd *cobra.Command, _ []string) error {
 	return nil
 }
 
-func buildBundleInstance(cuectx *cue.Context, instance *engine.BundleInstance, rootDir string) (string, error) {
+func buildBundleInstance(cuectx *cue.Context, instance *apiv1.BundleInstance, rootDir string) (string, error) {
 	modDir := path.Join(rootDir, instance.Name, "module")
 
 	builder := engine.NewModuleBuilder(

cmd/timoni/bundle_delete.go

@@ -133,7 +133,7 @@ func runBundleDelCmd(cmd *cobra.Command, args []string) error {
 			instance := instances[index]
 			log.Info(fmt.Sprintf("deleting instance %s in namespace %s",
 				logger.ColorizeSubject(instance.Name), logger.ColorizeSubject(instance.Namespace)))
-			if err := deleteBundleInstance(ctx, &engine.BundleInstance{
+			if err := deleteBundleInstance(ctx, &apiv1.BundleInstance{
 				Bundle:    bundleDelArgs.name,
 				Cluster:   cluster.Name,
 				Name:      instance.Name,
@@ -146,7 +146,7 @@ func runBundleDelCmd(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func deleteBundleInstance(ctx context.Context, instance *engine.BundleInstance, wait bool, dryrun bool) error {
+func deleteBundleInstance(ctx context.Context, instance *apiv1.BundleInstance, wait bool, dryrun bool) error {
 	log := loggerBundle(ctx, instance.Bundle, instance.Cluster, true)
 
 	sm, err := runtime.NewResourceManager(kubeconfigArgs)

internal/engine/bundle_builder.go

@@ -42,20 +42,6 @@ type BundleBuilder struct {
 	injector          *RuntimeInjector
 }
 
-type Bundle struct {
-	Name      string
-	Instances []*BundleInstance
-}
-
-type BundleInstance struct {
-	Bundle    string
-	Cluster   string
-	Name      string
-	Namespace string
-	Module    apiv1.ModuleReference
-	Values    cue.Value
-}
-
 // NewBundleBuilder creates a BundleBuilder for the given module and package.
 func NewBundleBuilder(ctx *cue.Context, files []string) *BundleBuilder {
 	if ctx == nil {
@@ -172,7 +158,7 @@ func (b *BundleBuilder) getInstanceUrl(v cue.Value) string {
 }
 
 // GetBundle returns a Bundle from the bundle CUE value.
-func (b *BundleBuilder) GetBundle(v cue.Value) (*Bundle, error) {
+func (b *BundleBuilder) GetBundle(v cue.Value) (*apiv1.Bundle, error) {
 	bundleNameValue := v.LookupPath(cue.ParsePath(apiv1.BundleName.String()))
 	bundleName, err := bundleNameValue.String()
 	if err != nil {
@@ -184,7 +170,7 @@ func (b *BundleBuilder) GetBundle(v cue.Value) (*Bundle, error) {
 		return nil, fmt.Errorf("lookup %s failed: %w", apiv1.BundleInstancesSelector.String(), instances.Err())
 	}
 
-	var list []*BundleInstance
+	var list []*apiv1.BundleInstance
 	iter, err := instances.Fields(cue.Concrete(true))
 	if err != nil {
 		return nil, err
@@ -208,7 +194,7 @@ func (b *BundleBuilder) GetBundle(v cue.Value) (*Bundle, error) {
 
 		values := expr.LookupPath(cue.ParsePath(apiv1.BundleValuesSelector.String()))
 
-		list = append(list, &BundleInstance{
+		list = append(list, &apiv1.BundleInstance{
 			Bundle:    bundleName,
 			Name:      name,
 			Namespace: namespace,
@@ -221,7 +207,7 @@ func (b *BundleBuilder) GetBundle(v cue.Value) (*Bundle, error) {
 		})
 	}
 
-	return &Bundle{
+	return &apiv1.Bundle{
 		Name:      bundleName,
 		Instances: list,
 	}, nil

internal/reconciler/reconciler.go

@@ -54,7 +54,7 @@ func NewReconciler(log logr.Logger, opts *CommonOptions, timeout time.Duration)
 	return reconciler
 }
 
-func (r *Reconciler) Init(ctx context.Context, builder *engine.ModuleBuilder, buildResult cue.Value, instance *engine.BundleInstance, rcg genericclioptions.RESTClientGetter) error {
+func (r *Reconciler) Init(ctx context.Context, builder *engine.ModuleBuilder, buildResult cue.Value, instance *apiv1.BundleInstance, rcg genericclioptions.RESTClientGetter) error {
 	finalValues, err := builder.GetDefaultValues()
 	if err != nil {
 		return fmt.Errorf("failed to extract values: %w", err)