extend package inspection a bit more, some more registry tweaks (still not a very safe option)

Author: tinyzimmer

pkg/build/builder.go

@@ -190,9 +190,11 @@ func (b *builder) bundleImages(opts *types.BuildOptions, parser types.ManifestPa
 		log.Info("Building private image registry to bundle with the package")
 		artifacts, err := images.NewImageDownloader().BuildRegistry(&types.BuildRegistryOptions{
 			Name:       opts.Name,
+			AppVersion: opts.BuildVersion,
 			Arch:       opts.Arch,
 			Images:     imageNames,
 			PullPolicy: opts.PullPolicy,
+			// TODO: Make more configurable
 		})
 		if err != nil {
 			return err

pkg/cmd/inspect.go

@@ -21,41 +21,58 @@ import (
 
 var inspectDetails bool
 var inspectManifest string
+var inspectConfig string
 
 func init() {
 	inspectCmd.Flags().BoolVarP(&inspectDetails, "details", "D", false, "Show additional details on package content")
 	inspectCmd.Flags().StringVarP(&inspectManifest, "manifest", "m", "", "Dump the contents of the specified manifest")
+	inspectCmd.Flags().StringVarP(&inspectConfig, "config", "c", "", "Dump the contents of the specified config file")
 
 	inspectCmd.RegisterFlagCompletionFunc("manifest", completeManifests)
+	inspectCmd.RegisterFlagCompletionFunc("config", completeConfigs)
 
 	rootCmd.AddCommand(inspectCmd)
 }
 
 func completeManifests(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 	log.Verbose = false
+	pkg, err := getInspectPackage(args[0])
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+	defer pkg.Close()
+	manifest := pkg.GetMeta().GetManifest()
+	return manifest.K8sManifests, cobra.ShellCompDirectiveDefault
+}
+
+func completeConfigs(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	log.Verbose = false
+	pkg, err := getInspectPackage(args[0])
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+	defer pkg.Close()
+	manifest := pkg.GetMeta().GetManifest()
+	return manifest.Etc, cobra.ShellCompDirectiveDefault
+}
 
+func getInspectPackage(path string) (types.Package, error) {
 	var pkgReader io.ReadCloser
 	var err error
 
-	pkgReader, err = os.Open(args[0])
+	pkgReader, err = os.Open(path)
 	if err != nil {
-		return nil, cobra.ShellCompDirectiveError
+		return nil, err
 	}
 
-	if strings.HasSuffix(args[0], ".zst") {
+	if strings.HasSuffix(path, ".zst") {
 		pkgReader, err = v1.Decompress(pkgReader)
 		if err != nil {
-			return nil, cobra.ShellCompDirectiveError
+			return nil, err
 		}
 	}
 
-	pkg, err := v1.Load(pkgReader)
-	if err != nil {
-		return nil, cobra.ShellCompDirectiveError
-	}
-	defer pkg.Close()
-	manifest := pkg.GetMeta().GetManifest()
-	return manifest.K8sManifests, cobra.ShellCompDirectiveDefault
+	return v1.Load(pkgReader)
 }
 
 var inspectCmd = &cobra.Command{
@@ -66,22 +83,7 @@ var inspectCmd = &cobra.Command{
 		return []string{"tar"}, cobra.ShellCompDirectiveFilterFileExt
 	},
 	RunE: func(cmd *cobra.Command, args []string) error {
-		var pkgReader io.ReadCloser
-		var err error
-
-		pkgReader, err = os.Open(args[0])
-		if err != nil {
-			return err
-		}
-
-		if strings.HasSuffix(args[0], ".zst") {
-			pkgReader, err = v1.Decompress(pkgReader)
-			if err != nil {
-				return err
-			}
-		}
-
-		pkg, err := v1.Load(pkgReader)
+		pkg, err := getInspectPackage(args[0])
 		if err != nil {
 			return err
 		}
@@ -106,6 +108,23 @@ var inspectCmd = &cobra.Command{
 			return nil
 		}
 
+		if inspectConfig != "" {
+			artifact := &types.Artifact{
+				Type: types.ArtifactEtc,
+				Name: inspectConfig,
+			}
+			if err := pkg.Get(artifact); err != nil {
+				return err
+			}
+			defer artifact.Body.Close()
+			body, err := ioutil.ReadAll(artifact.Body)
+			if err != nil {
+				return err
+			}
+			fmt.Println(string(body))
+			return nil
+		}
+
 		fmt.Println()
 		fmt.Println("NAME:   ", meta.Name)
 		fmt.Println("VERSION:", meta.Version)

pkg/cmd/uninstall.go

@@ -7,15 +7,7 @@ import (
 	"github.com/tinyzimmer/k3p/pkg/log"
 )
 
-var (
-	uninstallName string
-)
-
 func init() {
-	uninstallCmd.Flags().StringVarP(&uninstallName, "name", "n", "", "The name of the package to uninstall (required for docker)")
-	uninstallCmd.MarkFlagRequired("name")
-	uninstallCmd.RegisterFlagCompletionFunc("name", completeClusters)
-
 	rootCmd.AddCommand(uninstallCmd)
 }
 
@@ -29,9 +21,12 @@ func completeClusters(cmd *cobra.Command, args []string, toComplete string) ([]s
 }
 
 var uninstallCmd = &cobra.Command{
-	Use:   "uninstall",
-	Short: "Uninstall a k3p package (currently only for docker)",
+	Use:               "uninstall",
+	Short:             "Uninstall a k3p package (currently only for docker)",
+	Args:              cobra.ExactArgs(1),
+	ValidArgsFunction: completeClusters,
 	RunE: func(cmd *cobra.Command, args []string) error {
+		uninstallName := args[0]
 		nodes, err := node.LoadDockerCluster(uninstallName)
 		if err != nil {
 			return err

pkg/images/build_registry.go

@@ -21,17 +21,36 @@ const kubenabImage = "docker.bintray.io/kubenab:0.3.4"
 
 var requiredRegistryImages = []string{"registry:2", "busybox", kubenabImage}
 
+func setOptDefaults(opts *types.BuildRegistryOptions) *types.BuildRegistryOptions {
+	if opts.RegistrySecret == "" {
+		opts.RegistrySecret = util.GenerateToken(16)
+	}
+
+	if opts.AppVersion == "" {
+		opts.AppVersion = types.VersionLatest
+	}
+
+	if opts.RegistryNodePort == "" {
+		opts.RegistryNodePort = "30100"
+	}
+
+	if opts.PullPolicy == "" {
+		opts.PullPolicy = types.PullPolicyAlways
+	}
+
+	return opts
+}
+
 func (d *dockerImageDownloader) BuildRegistry(opts *types.BuildRegistryOptions) ([]*types.Artifact, error) {
+	opts = setOptDefaults(opts)
+
 	cli, err := getDockerClient()
 	if err != nil {
 		return nil, err
 	}
 	defer cli.Close()
 
-	// Generate a secret if one is not provided
-	if opts.RegistrySecret == "" {
-		opts.RegistrySecret = util.GenerateToken(16)
-	}
+	regDataImgName := fmt.Sprintf("%s-private-registry-data:%s", opts.Name, opts.AppVersion)
 
 	// Generate certificates for the registry
 	// TODO: Allow user to supply certificates
@@ -78,23 +97,26 @@ func (d *dockerImageDownloader) BuildRegistry(opts *types.BuildRegistryOptions)
 		"TLSCACertificate":     string(caCertPem),
 		"RegistryAuthHtpasswd": string(htpasswd),
 		"KubenabImage":         kubenabImage,
+		"RegistryDataImage":    regDataImgName,
+		"RegistryNodePort":     opts.RegistryNodePort,
 	})
 	if err != nil {
 		return nil, err
 	}
 	body := buf.Bytes()
 	deploymentManifest := &types.Artifact{
 		Type: types.ArtifactManifest,
-		Name: "private-registry-deployment.yaml",
+		Name: fmt.Sprintf("%s-private-registry-deployment.yaml", opts.Name),
 		Body: ioutil.NopCloser(bytes.NewReader(body)),
 		Size: int64(len(body)),
 	}
 
 	// Generate a registries.yaml
 	var yamlBuf bytes.Buffer
 	err = registriesYamlTmpl.Execute(&yamlBuf, map[string]string{
-		"Username": "registry",
-		"Password": opts.RegistrySecret,
+		"Username":         "registry",
+		"Password":         opts.RegistrySecret,
+		"RegistryNodePort": opts.RegistryNodePort,
 	})
 	if err != nil {
 		return nil, err
@@ -206,13 +228,13 @@ func (d *dockerImageDownloader) BuildRegistry(opts *types.BuildRegistryOptions)
 	}
 
 	// Commit the registry volume container to an image
-	_, err = cli.ContainerCommit(context.TODO(), volContainerID, dockertypes.ContainerCommitOptions{Reference: "private-registry-data:latest"})
+	_, err = cli.ContainerCommit(context.TODO(), volContainerID, dockertypes.ContainerCommitOptions{Reference: regDataImgName})
 	if err != nil {
 		return nil, err
 	}
 
 	// Save all images for the registry
-	rdr, err := cli.ImageSave(context.TODO(), append(requiredRegistryImages, "private-registry-data:latest"))
+	rdr, err := cli.ImageSave(context.TODO(), append(requiredRegistryImages, regDataImgName))
 	if err != nil {
 		return nil, err
 	}
@@ -223,5 +245,5 @@ func (d *dockerImageDownloader) BuildRegistry(opts *types.BuildRegistryOptions)
 		return nil, err
 	}
 
-	return []*types.Artifact{caCertificate, registriesYamlArtifact, deploymentManifest, registryArtifact}, err
+	return []*types.Artifact{caCertificate, registriesYamlArtifact, deploymentManifest, registryArtifact}, nil
 }

pkg/images/registry_templates.go

@@ -10,10 +10,10 @@ var registriesYamlTmpl = template.Must(template.New("").Funcs(sprig.TxtFuncMap()
 mirrors:
   registry.private:
     endpoint:
-      - https://localhost:30100
+      - https://localhost:{{ .RegistryNodePort }}
 
 configs:
-  "localhost:30100":
+  "localhost:{{ .RegistryNodePort }}":
     auth:
       username: {{ .Username }}
       password: {{ .Password }}
@@ -88,7 +88,7 @@ spec:
               secretName: registry-htpasswd
       initContainers:
         - name: data-extractor
-          image: private-registry-data:latest
+          image: {{ .RegistryDataImage }}
           imagePullPolicy: Never
           command: ['tar', '-xvz', '--file=/var/registry-data.tgz', '--directory=/var/lib/registry']
           volumeMounts:
@@ -178,7 +178,7 @@ spec:
     - port: 5000
       protocol: TCP
       targetPort: 5000
-      nodePort: 30100
+      nodePort: {{ .RegistryNodePort }}
 ---
 apiVersion: v1
 kind: Service

pkg/images/util.go

@@ -260,7 +260,7 @@ func waitForLocalRegistry(port string, timeout time.Duration) error {
 				continue
 			}
 			if res.StatusCode != http.StatusOK {
-				log.Debug("Non-200 status code from registry catalog, will retry:", err)
+				log.Debug("Non-200 status code from registry catalog, will retry:", res.StatusCode)
 				continue
 			}
 			log.Debug("Local registry is ready")

pkg/types/registry_options.go

@@ -5,6 +5,9 @@ package types
 type BuildRegistryOptions struct {
 	// A name to use when generating identifiers for various resources
 	Name string
+	// The version of the application this registry is being built for.
+	// Defaults to latest.
+	AppVersion string
 	// A list of images to bundle in the registry
 	Images []string
 	// Architecture to build the registry for
@@ -14,4 +17,7 @@ type BuildRegistryOptions struct {
 	// The password to use for authentication to the registry, if this is blank one will
 	// be generated.
 	RegistrySecret string
+	// The node port that the private registry will listen on when installed. Defaults to
+	// 30100.
+	RegistryNodePort string
 }

pkg/util/util.go

@@ -32,8 +32,11 @@ var TempDir = os.TempDir()
 // the system default, or user-configured path.
 func GetTempDir() (string, error) { return ioutil.TempDir(TempDir, "") }
 
-// GetRandomName returns a random name using the docker name generator
-func GetRandomName() string { return namesgenerator.GetRandomName(0) }
+// GetRandomName returns a random name using the docker name generator. Underscores are converted
+// to hyphens for parity with most other strings.
+func GetRandomName() string {
+	return strings.Replace(namesgenerator.GetRandomName(0), "_", "-", -1)
+}
 
 // CalculateSHA256Sum calculates the sha256sum of the contents of the given reader.
 func CalculateSHA256Sum(rdr io.Reader) (string, error) {