updated sync flag and related logs [breaking change] (#402)

* updated sync flag and related logs [breaking change]
* fixed typo in sync flag name
* and the last typo fix...

.github/workflows/tests.yaml

@@ -258,7 +258,7 @@ jobs:
           # download local helm repository
           curl -sfOL https://github.com/rancherfederal/rancher-cluster-templates/releases/download/rancher-cluster-templates-0.5.2/rancher-cluster-templates-0.5.2.tgz
           # verify via sync
-          hauler store sync --files testdata/hauler-manifest-pipeline.yaml
+          hauler store sync --filename testdata/hauler-manifest-pipeline.yaml
           # need more tests here
 
       - name: Verify - hauler store serve

cmd/hauler/cli/store.go

@@ -67,6 +67,7 @@ func addStoreSync(rso *flags.StoreRootOpts, ro *flags.CliRootOpts) *cobra.Comman
 	cmd := &cobra.Command{
 		Use:   "sync",
 		Short: "Sync content to the content store",
+		Args:  cobra.ExactArgs(0),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := cmd.Context()
 
@@ -123,7 +124,6 @@ func addStoreServe(rso *flags.StoreRootOpts, ro *flags.CliRootOpts) *cobra.Comma
 	return cmd
 }
 
-// RegistryCmd serves the registry
 func addStoreServeRegistry(rso *flags.StoreRootOpts, ro *flags.CliRootOpts) *cobra.Command {
 	o := &flags.ServeRegistryOpts{StoreRootOpts: rso}
 
@@ -147,7 +147,6 @@ func addStoreServeRegistry(rso *flags.StoreRootOpts, ro *flags.CliRootOpts) *cob
 	return cmd
 }
 
-// FileServerCmd serves the file server
 func addStoreServeFiles(rso *flags.StoreRootOpts, ro *flags.CliRootOpts) *cobra.Command {
 	o := &flags.ServeFilesOpts{StoreRootOpts: rso}
 

cmd/hauler/cli/store/add.go

@@ -42,13 +42,13 @@ func storeFile(ctx context.Context, s *store.Layout, fi v1.File) error {
 		return err
 	}
 
-	l.Infof("adding 'file' [%s] to the store as [%s]", fi.Path, ref.Name())
+	l.Infof("adding file [%s] to the store as [%s]", fi.Path, ref.Name())
 	_, err = s.AddOCI(ctx, f, ref.Name())
 	if err != nil {
 		return err
 	}
 
-	l.Infof("successfully added 'file' [%s]", ref.Name())
+	l.Infof("successfully added file [%s]", ref.Name())
 
 	return nil
 }
@@ -83,15 +83,15 @@ func storeImage(ctx context.Context, s *store.Layout, i v1.Image, platform strin
 		}
 	}
 
-	l.Infof("adding 'image' [%s] to the store", i.Name)
+	l.Infof("adding image [%s] to the store", i.Name)
 
 	r, err := name.ParseReference(i.Name)
 	if err != nil {
 		if ro.IgnoreErrors {
-			l.Warnf("unable to parse 'image' [%s]: %v... skipping...", i.Name, err)
+			l.Warnf("unable to parse image [%s]: %v... skipping...", i.Name, err)
 			return nil
 		} else {
-			l.Errorf("unable to parse 'image' [%s]: %v", i.Name, err)
+			l.Errorf("unable to parse image [%s]: %v", i.Name, err)
 			return err
 		}
 	}
@@ -99,15 +99,15 @@ func storeImage(ctx context.Context, s *store.Layout, i v1.Image, platform strin
 	err = cosign.SaveImage(ctx, s, r.Name(), platform, rso, ro)
 	if err != nil {
 		if ro.IgnoreErrors {
-			l.Warnf("unable to add 'image' [%s] to store: %v... skipping...", r.Name(), err)
+			l.Warnf("unable to add image [%s] to store: %v... skipping...", r.Name(), err)
 			return nil
 		} else {
-			l.Errorf("unable to add 'image' [%s] to store: %v", r.Name(), err)
+			l.Errorf("unable to add image [%s] to store: %v", r.Name(), err)
 			return err
 		}
 	}
 
-	l.Infof("successfully added 'image' [%s]", r.Name())
+	l.Infof("successfully added image [%s]", r.Name())
 	return nil
 }
 
@@ -124,7 +124,7 @@ func AddChartCmd(ctx context.Context, o *flags.AddChartOpts, s *store.Layout, ch
 func storeChart(ctx context.Context, s *store.Layout, cfg v1.Chart, opts *action.ChartPathOptions) error {
 	l := log.FromContext(ctx)
 
-	l.Infof("adding 'chart' [%s] to the store", cfg.Name)
+	l.Infof("adding chart [%s] to the store", cfg.Name)
 
 	// TODO: This shouldn't be necessary
 	opts.RepoURL = cfg.RepoURL
@@ -149,6 +149,6 @@ func storeChart(ctx context.Context, s *store.Layout, cfg v1.Chart, opts *action
 		return err
 	}
 
-	l.Infof("successfully added 'chart' [%s]", ref.Name())
+	l.Infof("successfully added chart [%s]", ref.Name())
 	return nil
 }

cmd/hauler/cli/store/sync.go

@@ -30,9 +30,9 @@ func SyncCmd(ctx context.Context, o *flags.SyncOpts, s *store.Layout, rso *flags
 	l := log.FromContext(ctx)
 
 	// if passed products, check for a remote manifest to retrieve and use.
-	for _, product := range o.Products {
-		l.Infof("processing content for product [%s]", product)
-		parts := strings.Split(product, "=")
+	for _, productName := range o.Products {
+		l.Infof("processing product manifest for [%s] to store [%s]", productName, o.StoreDir)
+		parts := strings.Split(productName, "=")
 		tag := strings.ReplaceAll(parts[1], "+", "-")
 
 		ProductRegistry := o.ProductRegistry // cli flag
@@ -42,7 +42,7 @@ func SyncCmd(ctx context.Context, o *flags.SyncOpts, s *store.Layout, rso *flags
 		}
 
 		manifestLoc := fmt.Sprintf("%s/hauler/%s-manifest.yaml:%s", ProductRegistry, parts[0], tag)
-		l.Infof("retrieving product manifest from [%s]", manifestLoc)
+		l.Infof("fetching product manifest from [%s]", manifestLoc)
 		img := v1.Image{
 			Name: manifestLoc,
 		}
@@ -64,12 +64,13 @@ func SyncCmd(ctx context.Context, o *flags.SyncOpts, s *store.Layout, rso *flags
 		if err != nil {
 			return err
 		}
+		l.Infof("processing completed successfully")
 	}
 
 	// if passed a local manifest, process it
-	for _, filename := range o.ContentFiles {
-		l.Infof("processing content [%s]", filename)
-		fi, err := os.Open(filename)
+	for _, fileName := range o.FileName {
+		l.Infof("processing manifest for [%s] to store [%s]", fileName, o.StoreDir)
+		fi, err := os.Open(fileName)
 		if err != nil {
 			return err
 		}
@@ -77,6 +78,7 @@ func SyncCmd(ctx context.Context, o *flags.SyncOpts, s *store.Layout, rso *flags
 		if err != nil {
 			return err
 		}
+		l.Infof("processing completed successfully")
 	}
 
 	return nil

internal/flags/sync.go

@@ -1,10 +1,13 @@
 package flags
 
-import "github.com/spf13/cobra"
+import (
+	"github.com/spf13/cobra"
+	"hauler.dev/go/hauler/pkg/consts"
+)
 
 type SyncOpts struct {
 	*StoreRootOpts
-	ContentFiles    []string
+	FileName        []string
 	Key             string
 	Products        []string
 	Platform        string
@@ -15,7 +18,7 @@ type SyncOpts struct {
 func (o *SyncOpts) AddFlags(cmd *cobra.Command) {
 	f := cmd.Flags()
 
-	f.StringSliceVarP(&o.ContentFiles, "files", "f", []string{}, "Location of content manifests (files)... i.e. --files ./rke2-files.yaml")
+	f.StringSliceVarP(&o.FileName, "filename", "f", []string{consts.DefaultHaulerManifestName}, "Specify the name of manifest(s) to sync")
 	f.StringVarP(&o.Key, "key", "k", "", "(Optional) Location of public key to use for signature verification")
 	f.StringSliceVar(&o.Products, "products", []string{}, "(Optional) Specify the product name to fetch collections from the product registry i.e. rancher=v2.8.5,rke2=v1.28.11+rke2r1")
 	f.StringVarP(&o.Platform, "platform", "p", "", "(Optional) Specify the platform of the image... i.e linux/amd64 (defaults to all)")

pkg/consts/consts.go

@@ -72,19 +72,20 @@ const (
 	ImageConfigFile   = "config.json"
 
 	// other constraints
-	CarbideRegistry          = "rgcrprod.azurecr.us"
-	DefaultNamespace         = "hauler"
-	DefaultTag               = "latest"
-	DefaultStoreName         = "store"
-	DefaultHaulerDirName     = ".hauler"
-	DefaultHaulerTempDirName = "hauler"
-	DefaultRegistryRootDir   = "registry"
-	DefaultRegistryPort      = 5000
-	DefaultFileserverRootDir = "fileserver"
-	DefaultFileserverPort    = 8080
-	DefaultFileserverTimeout = 60
-	DefaultHaulArchiveName   = "haul.tar.zst"
-	DefaultRetries           = 3
-	RetriesInterval          = 5
-	CustomTimeFormat         = "2006-01-02 15:04:05"
+	CarbideRegistry           = "rgcrprod.azurecr.us"
+	DefaultNamespace          = "hauler"
+	DefaultTag                = "latest"
+	DefaultStoreName          = "store"
+	DefaultHaulerDirName      = ".hauler"
+	DefaultHaulerTempDirName  = "hauler"
+	DefaultRegistryRootDir    = "registry"
+	DefaultRegistryPort       = 5000
+	DefaultFileserverRootDir  = "fileserver"
+	DefaultFileserverPort     = 8080
+	DefaultFileserverTimeout  = 60
+	DefaultHaulArchiveName    = "haul.tar.zst"
+	DefaultHaulerManifestName = "hauler-manifest.yaml"
+	DefaultRetries            = 3
+	RetriesInterval           = 5
+	CustomTimeFormat          = "2006-01-02 15:04:05"
 )