Adding OS version to Crane for better Windows support. (#1173)

* Adding OS version to Crane for better Windows support. Windows images present some unique challenges and one of those challenges is being able to pull a specific OS version. This especially comes into play when working with a manifest like the k8s.gcr.io/pause:3.6 which doesn't offer tags specific to Windows OS version. Here is an example use case: crane pull --platform windows/amd64 --osversion 10.0.17763.2114 k8s.gcr.io/pause:3.6 windows-1809.tar Without the version specified Windows Server 2022 would have been pulled. Signed-off-by: Jamie Phillips <cphill11@gmail.com> * Updating the help docs. Generating the docs after adding the CLI flag. Signed-off-by: Jamie Phillips <cphill11@gmail.com>
google · Nov 10, 2021 · 6cb23fb · 6cb23fb
1 parent f337ecf
commit 6cb23fb
Show file tree

Hide file tree

Showing 24 changed files with 29 additions and 1 deletion.
diff --git a/cmd/crane/cmd/root.go b/cmd/crane/cmd/root.go
@@ -38,6 +38,7 @@ func New(use, short string, options []crane.Option) *cobra.Command {
 	verbose := false
 	insecure := false
 	platform := &platformValue{}
+	var osVersion string
 
 	root := &cobra.Command{
 		Use:               use,
@@ -62,6 +63,10 @@ func New(use, short string, options []crane.Option) *cobra.Command {
 				options = append(options, crane.WithUserAgent(fmt.Sprintf("%s/%s", binary, Version)))
 			}
 
+			if osVersion != "" {
+				platform.platform.OSVersion = osVersion
+			}
+
 			options = append(options, crane.WithPlatform(platform.platform))
 
 			transport := http.DefaultTransport.(*http.Transport).Clone()
@@ -111,6 +116,7 @@ func New(use, short string, options []crane.Option) *cobra.Command {
 	root.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Enable debug logs")
 	root.PersistentFlags().BoolVar(&insecure, "insecure", false, "Allow image references to be fetched without TLS")
 	root.PersistentFlags().Var(platform, "platform", "Specifies the platform in the form os/arch[/variant] (e.g. linux/amd64).")
+	root.PersistentFlags().StringVar(&osVersion, "osversion", "", "Specifies the OS version.")
 
 	return root
 }

diff --git a/cmd/crane/doc/crane.md b/cmd/crane/doc/crane.md
diff --git a/cmd/crane/doc/crane_append.md b/cmd/crane/doc/crane_append.md
diff --git a/cmd/crane/doc/crane_auth.md b/cmd/crane/doc/crane_auth.md
diff --git a/cmd/crane/doc/crane_auth_get.md b/cmd/crane/doc/crane_auth_get.md
diff --git a/cmd/crane/doc/crane_auth_login.md b/cmd/crane/doc/crane_auth_login.md
diff --git a/cmd/crane/doc/crane_blob.md b/cmd/crane/doc/crane_blob.md
diff --git a/cmd/crane/doc/crane_catalog.md b/cmd/crane/doc/crane_catalog.md
diff --git a/cmd/crane/doc/crane_config.md b/cmd/crane/doc/crane_config.md
diff --git a/cmd/crane/doc/crane_copy.md b/cmd/crane/doc/crane_copy.md
diff --git a/cmd/crane/doc/crane_delete.md b/cmd/crane/doc/crane_delete.md
diff --git a/cmd/crane/doc/crane_digest.md b/cmd/crane/doc/crane_digest.md
diff --git a/cmd/crane/doc/crane_export.md b/cmd/crane/doc/crane_export.md
diff --git a/cmd/crane/doc/crane_flatten.md b/cmd/crane/doc/crane_flatten.md
diff --git a/cmd/crane/doc/crane_ls.md b/cmd/crane/doc/crane_ls.md
diff --git a/cmd/crane/doc/crane_manifest.md b/cmd/crane/doc/crane_manifest.md
diff --git a/cmd/crane/doc/crane_mutate.md b/cmd/crane/doc/crane_mutate.md
diff --git a/cmd/crane/doc/crane_pull.md b/cmd/crane/doc/crane_pull.md
diff --git a/cmd/crane/doc/crane_push.md b/cmd/crane/doc/crane_push.md
diff --git a/cmd/crane/doc/crane_rebase.md b/cmd/crane/doc/crane_rebase.md
diff --git a/cmd/crane/doc/crane_tag.md b/cmd/crane/doc/crane_tag.md
diff --git a/cmd/crane/doc/crane_validate.md b/cmd/crane/doc/crane_validate.md
diff --git a/cmd/crane/doc/crane_version.md b/cmd/crane/doc/crane_version.md
diff --git a/pkg/v1/remote/index.go b/pkg/v1/remote/index.go
@@ -214,7 +214,7 @@ func (r *remoteIndex) childByPlatform(platform v1.Platform) (*Descriptor, error)
 			return r.childDescriptor(childDesc, platform)
 		}
 	}
-	return nil, fmt.Errorf("no child with platform %s/%s in index %s", platform.OS, platform.Architecture, r.Ref)
+	return nil, fmt.Errorf("no child with platform %+v in index %s", platform, r.Ref)
 }
 
 func (r *remoteIndex) childByHash(h v1.Hash) (*Descriptor, error) {