summaryrefslogtreecommitdiffstats
path: root/cmd/crane/doc/crane_index_filter.md
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/crane/doc/crane_index_filter.md')
-rw-r--r--cmd/crane/doc/crane_index_filter.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/cmd/crane/doc/crane_index_filter.md b/cmd/crane/doc/crane_index_filter.md
new file mode 100644
index 0000000..bda1f8d
--- /dev/null
+++ b/cmd/crane/doc/crane_index_filter.md
@@ -0,0 +1,41 @@
+## crane index filter
+
+Modifies a remote index by filtering based on platform.
+
+```
+crane index filter [flags]
+```
+
+### Examples
+
+```
+ # Filter out weird platforms from ubuntu, copy result to example.com/ubuntu
+ crane index filter ubuntu --platform linux/amd64 --platform linux/arm64 -t example.com/ubuntu
+
+ # Filter out any non-linux platforms, push to example.com/hello-world
+ crane index filter hello-world --platform linux -t example.com/hello-world
+
+ # Same as above, but in-place
+ crane index filter example.com/hello-world:some-tag --platform linux
+```
+
+### Options
+
+```
+ -h, --help help for filter
+ --platform platform(s) Specifies the platform(s) to keep from base in the form os/arch[/variant][:osversion][,<platform>] (e.g. linux/amd64).
+ -t, --tag string Tag to apply to resulting image
+```
+
+### Options inherited from parent commands
+
+```
+ --allow-nondistributable-artifacts Allow pushing non-distributable (foreign) layers
+ --insecure Allow image references to be fetched without TLS
+ -v, --verbose Enable debug logs
+```
+
+### SEE ALSO
+
+* [crane index](crane_index.md) - Modify an image index.
+