Add crane root flags and ability to place files in home dir (#1848)

## Description This makes necessary changes to Zarf to allow for a `k3d` multi-arch package to exist (see https://github.com/Racer159/zarf-package-k3d) ## Related Issue Fixes #1777 ## Type of change - [X] Bug fix (non-breaking change which fixes an issue) - [X] New feature (non-breaking change which adds functionality) - [X] Other (security config, docs update, etc) ## Checklist before merging - [X] Test, docs, adr added or updated as needed - [X] [Contributor Guide Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow) followed --------- Co-authored-by: Jonathan Perry <YrrepNoj@gmail.com>
zarf-dev · Jun 26, 2023 · f52d66a · f52d66a
1 parent 14cccd2
commit f52d66a
Show file tree

Hide file tree

Showing 25 changed files with 167 additions and 190 deletions.
diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md
@@ -31,7 +31,7 @@ Collection of additional tools to make airgap easier
 * [zarf tools gen-pki](zarf_tools_gen-pki.md)	 - Generates a Certificate Authority and PKI chain of trust for the given host
 * [zarf tools get-creds](zarf_tools_get-creds.md)	 - Displays a Table of credentials for deployed components. Pass a component name to get a single credential
 * [zarf tools kubectl](zarf_tools_kubectl.md)	 - Kubectl command. See https://kubernetes.io/docs/reference/kubectl/overview/ for more information.
-* [zarf tools monitor](zarf_tools_monitor.md)	 - Launches a terminal UI to monitor the connected cluster using K9s
+* [zarf tools monitor](zarf_tools_monitor.md)	 - Launches a terminal UI to monitor the connected cluster using K9s.
 * [zarf tools registry](zarf_tools_registry.md)	 - Tools for working with container registries using go-containertools
 * [zarf tools sbom](zarf_tools_sbom.md)	 - Generates a Software Bill of Materials (SBOM) for the given package
 * [zarf tools wait-for](zarf_tools_wait-for.md)	 - Waits for a given Kubernetes resource to be ready
diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_kubectl.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_kubectl.md
@@ -13,18 +13,6 @@ zarf tools kubectl [flags]
   -h, --help   help for kubectl
 ```
 
-## Options inherited from parent commands
-
-```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
-```
-
 ## SEE ALSO
 
 * [zarf tools](zarf_tools.md)	 - Collection of additional tools to make airgap easier
diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_monitor.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_monitor.md
@@ -1,7 +1,7 @@
 # zarf tools monitor
 <!-- Auto-generated by docs/gen-cli-docs.sh -->
 
-Launches a terminal UI to monitor the connected cluster using K9s
+Launches a terminal UI to monitor the connected cluster using K9s.
 
 ```
 zarf tools monitor [flags]
@@ -13,18 +13,6 @@ zarf tools monitor [flags]
   -h, --help   help for monitor
 ```
 
-## Options inherited from parent commands
-
-```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
-```
-
 ## SEE ALSO
 
 * [zarf tools](zarf_tools.md)	 - Collection of additional tools to make airgap easier
diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry.md
@@ -6,19 +6,11 @@ Tools for working with container registries using go-containertools
 ## Options
 
 ```
-  -h, --help   help for registry
-```
-
-## Options inherited from parent commands
-
-```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+      --allow-nondistributable-artifacts   Allow pushing non-distributable (foreign) layers
+  -h, --help                               help for registry
+      --insecure                           Allow image references to be fetched without TLS
+      --platform string                    Specifies the platform in the form os/arch[/variant][:osversion] (e.g. linux/amd64). (default "all")
+  -v, --verbose                            Enable debug logs
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_catalog.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_catalog.md
@@ -29,13 +29,10 @@ zarf tools registry catalog REGISTRY [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+      --allow-nondistributable-artifacts   Allow pushing non-distributable (foreign) layers
+      --insecure                           Allow image references to be fetched without TLS
+      --platform string                    Specifies the platform in the form os/arch[/variant][:osversion] (e.g. linux/amd64). (default "all")
+  -v, --verbose                            Enable debug logs
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_copy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_copy.md
@@ -10,7 +10,7 @@ zarf tools registry copy SRC DST [flags]
 ## Options
 
 ```
-      --all-tags     (Optional) if true, copy all tags from SRC to DST
+  -a, --all-tags     (Optional) if true, copy all tags from SRC to DST
   -h, --help         help for copy
   -j, --jobs int     (Optional) The maximum number of concurrent copies, defaults to GOMAXPROCS
   -n, --no-clobber   (Optional) if true, avoid overwriting existing tags in DST
@@ -19,13 +19,10 @@ zarf tools registry copy SRC DST [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+      --allow-nondistributable-artifacts   Allow pushing non-distributable (foreign) layers
+      --insecure                           Allow image references to be fetched without TLS
+      --platform string                    Specifies the platform in the form os/arch[/variant][:osversion] (e.g. linux/amd64). (default "all")
+  -v, --verbose                            Enable debug logs
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_login.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_login.md
@@ -19,13 +19,10 @@ zarf tools registry login [OPTIONS] [SERVER] [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+      --allow-nondistributable-artifacts   Allow pushing non-distributable (foreign) layers
+      --insecure                           Allow image references to be fetched without TLS
+      --platform string                    Specifies the platform in the form os/arch[/variant][:osversion] (e.g. linux/amd64). (default "all")
+  -v, --verbose                            Enable debug logs
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_pull.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_pull.md
@@ -19,13 +19,10 @@ zarf tools registry pull IMAGE TARBALL [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+      --allow-nondistributable-artifacts   Allow pushing non-distributable (foreign) layers
+      --insecure                           Allow image references to be fetched without TLS
+      --platform string                    Specifies the platform in the form os/arch[/variant][:osversion] (e.g. linux/amd64). (default "all")
+  -v, --verbose                            Enable debug logs
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_push.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_registry_push.md
@@ -22,13 +22,10 @@ zarf tools registry push PATH IMAGE [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+      --allow-nondistributable-artifacts   Allow pushing non-distributable (foreign) layers
+      --insecure                           Allow image references to be fetched without TLS
+      --platform string                    Specifies the platform in the form os/arch[/variant][:osversion] (e.g. linux/amd64). (default "all")
+  -v, --verbose                            Enable debug logs
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom.md
@@ -28,18 +28,6 @@ zarf tools sbom [flags]
   -v, --verbose count            increase verbosity (-v = info, -vv = debug)
 ```
 
-## Options inherited from parent commands
-
-```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
-```
-
 ## SEE ALSO
 
 * [zarf tools](zarf_tools.md)	 - Collection of additional tools to make airgap easier

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_attest.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_attest.md
@@ -29,16 +29,9 @@ zarf tools sbom attest --output [FORMAT] <IMAGE> [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-  -c, --config string         application config file
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-  -q, --quiet                 suppress all logging output
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-  -v, --verbose count         increase verbosity (-v = info, -vv = debug)
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+  -c, --config string   application config file
+  -q, --quiet           suppress all logging output
+  -v, --verbose count   increase verbosity (-v = info, -vv = debug)
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_convert.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_convert.md
@@ -28,16 +28,9 @@ zarf tools sbom convert [SOURCE-SBOM] -o [FORMAT] [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-  -c, --config string         application config file
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-  -q, --quiet                 suppress all logging output
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-  -v, --verbose count         increase verbosity (-v = info, -vv = debug)
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+  -c, --config string   application config file
+  -q, --quiet           suppress all logging output
+  -v, --verbose count   increase verbosity (-v = info, -vv = debug)
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_login.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_login.md
@@ -19,16 +19,9 @@ zarf tools sbom login [OPTIONS] [SERVER] [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-  -c, --config string         application config file
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-  -q, --quiet                 suppress all logging output
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-  -v, --verbose count         increase verbosity (-v = info, -vv = debug)
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+  -c, --config string   application config file
+  -q, --quiet           suppress all logging output
+  -v, --verbose count   increase verbosity (-v = info, -vv = debug)
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_packages.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_packages.md
@@ -28,16 +28,9 @@ zarf tools sbom packages [SOURCE] [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-  -c, --config string         application config file
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-  -q, --quiet                 suppress all logging output
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-  -v, --verbose count         increase verbosity (-v = info, -vv = debug)
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+  -c, --config string   application config file
+  -q, --quiet           suppress all logging output
+  -v, --verbose count   increase verbosity (-v = info, -vv = debug)
 ```
 
 ## SEE ALSO

diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_version.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_sbom_version.md
@@ -17,16 +17,9 @@ zarf tools sbom version [flags]
 ## Options inherited from parent commands
 
 ```
-  -a, --architecture string   Architecture for OCI images and Zarf packages
-  -c, --config string         application config file
-      --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
-  -l, --log-level string      Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
-      --no-log-file           Disable log file creation
-      --no-progress           Disable fancy UI progress bars, spinners, logos, etc
-  -q, --quiet                 suppress all logging output
-      --tmpdir string         Specify the temporary directory to use for intermediate files
-  -v, --verbose count         increase verbosity (-v = info, -vv = debug)
-      --zarf-cache string     Specify the location of the Zarf cache directory (default "~/.zarf-cache")
+  -c, --config string   application config file
+  -q, --quiet           suppress all logging output
+  -v, --verbose count   increase verbosity (-v = info, -vv = debug)
 ```
 
 ## SEE ALSO