From 0b27b3d448fdb69be9173f9f2097b345584688fe Mon Sep 17 00:00:00 2001 From: mbshields Date: Tue, 6 Jun 2023 08:18:49 -0700 Subject: [PATCH 1/3] docs: update CLI reference with 1.0.0 changes Signed-off-by: mbshields --- docs/reference/stacker_cli.md | 64 +++++++++++++++++++++++------------ 1 file changed, 43 insertions(+), 21 deletions(-) diff --git a/docs/reference/stacker_cli.md b/docs/reference/stacker_cli.md index f186550..f0725d7 100644 --- a/docs/reference/stacker_cli.md +++ b/docs/reference/stacker_cli.md @@ -1,18 +1,21 @@ # Stacker Command-Line Interface Reference +This document lists the command line interface (CLI) commands for stacker version 1.0.0. + - - - - - - - - + + + + + + + + + - - + +
stackerStacker builds OCI images
stacker buildBuild a new OCI image from a stacker yaml file
stacker recursive-buildFind stacker yaml files under a directory and builds all OCI layers they define
stacker publishPublish OCI images previously built from one or more stacker yaml files
stacker chrootRun a command in a chroot (same as stacker exec)
stacker cleanClean up after a stacker build
stacker inspectPrint the json representation of an OCI image
stacker grabGrab a file from the layer's filesystem
stacker unpriv-setupDo the necessary unprivileged setup for stacker build to work without root
stacker buildBuilds a new OCI image from a stacker yaml file
stacker recursive-buildFinds stacker yaml files under a directory and builds all OCI layers they define
stacker convertConverts a Dockerfile into a stacker yaml file
stacker publishPublishes OCI images previously built from one or more stacker yaml files
stacker chrootRuns a command in a chroot (same as stacker exec)
stacker cleanCleans up after a stacker build
stacker inspectPrints the json representation of an OCI image
stacker grabGrabs a file from the layer's filesystem
stacker unpriv-setupDoes the necessary unprivileged setup for stacker build to work without root
stacker gcGarbage collection of unused OCI imports/outputs snapshots
stacker checkCheck that all runtime required items (like kernel features) are present
stacker helpShow a list of commands or help for one command
stacker checkChecks that all runtime required items (like kernel features) are present
stacker helpShows a list of commands or help for one command
@@ -26,11 +29,12 @@ stacker [global options] command [command options] [arguments...] VERSION: - stacker v0.40.1-e54a685 liblxc a330126b45c7c3b6fcf0f9ba6c1eda7bdb4e508a + stacker v1.0.0-rc4-8e267fc liblxc 727adc05220e9b8b594c5bc2124bef5b2e0abe7a COMMANDS: build builds a new OCI image from a stacker yaml file recursive-build finds stacker yaml files under a directory and builds all OCI layers they define + convert converts a Dockerfile into a stacker yaml file (experimental, best-effort) publish publishes OCI images previously built from one or more stacker yaml files chroot, exec run a command in a chroot clean cleans up after a `stacker build` @@ -42,10 +46,11 @@ help, h Shows a list of commands or help for one command GLOBAL OPTIONS: + --work-dir value set the working directory for stacker's cache, OCI output and rootfs output --stacker-dir value set the directory for stacker's cache (default: ".stacker") --oci-dir value set the directory for OCI output (default: "oci") --roots-dir value set the directory for the rootfs output (default: "roots") - --config value stacker config file with defaults (default: "/users/mishield/.config/stacker/conf.yaml") + --config value stacker config file with defaults (default: "/home/mishield/.config/stacker/conf.yaml") --debug enable stacker debug mode -q, --quiet silence all logs --log-file value log to a file instead of stderr @@ -82,11 +87,11 @@ ## stacker recursive-build - NAME: - stacker recursive-build - finds stacker yaml files under a directory and builds all OCI layers they define +AME: + stacker recursive-build - finds stacker yaml files under a directory and builds all OCI layers they define - USAGE: - stacker recursive-build [command options] [arguments...] +USAGE: + stacker recursive-build [command options] [arguments...] OPTIONS: --no-cache don't use the previous build cache @@ -102,19 +107,35 @@ --stacker-file-pattern value, -p value regex pattern to use when searching for stackerfile paths (default: "\\/stacker.yaml$") --search-dir value, -d value directory under which to search for stackerfiles to build (default: ".") - + -## stacker publish +## stacker convert NAME: - stacker publish - publishes OCI images previously built from one or more stacker yaml files + stacker convert - converts a Dockerfile into a stacker yaml file (experimental, best-effort) USAGE: - stacker publish [command options] [arguments...] + stacker convert [command options] [arguments...] + + OPTIONS: + --docker-file value, -i value the input Dockerfile (default: "Dockerfile") + --output-file value, -o value the output stacker file (default: "stacker.yaml") + --substitute-file value, -s value the output file containing detected substitutions (default: "stacker-subs.yaml") + + + +## stacker publish + +NAME: + stacker publish - publishes OCI images previously built from one or more stacker yaml files + +USAGE: + stacker publish [command options] [arguments...] OPTIONS: --stacker-file value, -f value the input stackerfile (default: "stacker.yaml") --stacker-file-pattern value, -p value regex pattern to use when searching for stackerfile paths (default: "\\/stacker.yaml$") + --substitute-file value file containing variable substitution in stackerfiles, 'FOO: bar' yaml format --search-dir value, -d value directory under which to search for stackerfiles to publish --url value url where to publish the OCI images --username value username for the registry where the OCI images are published @@ -125,6 +146,7 @@ --show-only show the images to be published without actually publishing them --force force publishing the images present in the OCI layout even if they should be rebuilt --layer-type value set the output layer type (supported values: tar, squashfs); can be supplied multiple times (default: "tar") + --layer value layer to be published; can be specified multiple times @@ -157,7 +179,7 @@ stacker clean [command options] [arguments...] OPTIONS: - --all no-op; this used to do soemthing, and is left in for compatibility + --all no-op; this used to do something, and is left in for compatibility From 896701c1fcfc8d5cc2d0b881de899c827b009ecb Mon Sep 17 00:00:00 2001 From: mbshields Date: Tue, 6 Jun 2023 08:23:45 -0700 Subject: [PATCH 2/3] docs: update CLI reference with 1.0.0 changes Signed-off-by: mbshields --- docs/reference/stacker_cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/stacker_cli.md b/docs/reference/stacker_cli.md index f0725d7..5e9a1e8 100644 --- a/docs/reference/stacker_cli.md +++ b/docs/reference/stacker_cli.md @@ -50,7 +50,7 @@ This document lists the command line interface (CLI) commands for stacker versio --stacker-dir value set the directory for stacker's cache (default: ".stacker") --oci-dir value set the directory for OCI output (default: "oci") --roots-dir value set the directory for the rootfs output (default: "roots") - --config value stacker config file with defaults (default: "/home/mishield/.config/stacker/conf.yaml") + --config value stacker config file with defaults (default: "/home//.config/stacker/conf.yaml") --debug enable stacker debug mode -q, --quiet silence all logs --log-file value log to a file instead of stderr From 44d3c42b7d0de94b695f009fcb0c65068e289909 Mon Sep 17 00:00:00 2001 From: mbshields Date: Tue, 13 Jun 2023 16:49:35 -0700 Subject: [PATCH 3/3] docs: update CLI reference with 1.0.0 changes (fix formatting) Signed-off-by: mbshields --- docs/reference/stacker_cli.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/reference/stacker_cli.md b/docs/reference/stacker_cli.md index 5e9a1e8..a153fe4 100644 --- a/docs/reference/stacker_cli.md +++ b/docs/reference/stacker_cli.md @@ -87,11 +87,11 @@ This document lists the command line interface (CLI) commands for stacker versio ## stacker recursive-build -AME: - stacker recursive-build - finds stacker yaml files under a directory and builds all OCI layers they define + NAME: + stacker recursive-build - finds stacker yaml files under a directory and builds all OCI layers they define -USAGE: - stacker recursive-build [command options] [arguments...] + USAGE: + stacker recursive-build [command options] [arguments...] OPTIONS: --no-cache don't use the previous build cache @@ -126,11 +126,11 @@ USAGE: ## stacker publish -NAME: - stacker publish - publishes OCI images previously built from one or more stacker yaml files + NAME: + stacker publish - publishes OCI images previously built from one or more stacker yaml files -USAGE: - stacker publish [command options] [arguments...] + USAGE: + stacker publish [command options] [arguments...] OPTIONS: --stacker-file value, -f value the input stackerfile (default: "stacker.yaml")