Skip to content

Commit

Permalink
docs: resolve comments, change zotregistry.io to .dev
Browse files Browse the repository at this point in the history
Signed-off-by: mbshields <[email protected]>
  • Loading branch information
mbshields committed Jan 12, 2024
1 parent 6f64e02 commit 654b948
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/reference/stacker_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ This document lists the command line interface (CLI) commands for stacker versio
<table>
<tr><td><a href="#stacker">stacker</a></td><td>Stacker builds OCI images</td></tr>
<tr><td><a href="#stacker-build">stacker build</a></td><td>Builds a new OCI image from a stacker yaml file</td></tr>
<tr><td><a href="#stacker-recursive-build">stacker recursive-build</a></td><td>Finds stacker yaml files under a directory and builds all OCI layers they define</td></tr>
<tr><td><a href="#stacker-recursive-build">stacker recursive-build</a></td><td>Finds stacker yaml files under a directory and builds all OCI images they define</td></tr>
<tr><td><a href="#stacker-convert">stacker convert</a></td><td>Converts a Dockerfile into a stacker yaml file</td></tr>
<tr><td><a href="#stacker-publish">stacker publish</a></td><td>Publishes OCI images previously built from one or more stacker yaml files</td></tr>
<tr><td><a href="#stacker-chroot-exec">stacker chroot</a></td><td>Runs a command in a chroot (same as <code>stacker exec</code>)</td></tr>
<tr><td><a href="#stacker-clean">stacker clean</a></td><td>Cleans up after a stacker build</td></tr>
<tr><td><a href="#stacker-inspect">stacker inspect</a></td><td>Prints the json representation of an OCI image</td></tr>
<tr><td><a href="#stacker-grab">stacker grab</a></td><td>Grabs a file from the layer's filesystem</td></tr>
<tr><td><a href="#stacker-grab">stacker grab</a></td><td>Grabs a file from the image's filesystem</td></tr>
<tr><td><a href="#stacker-unpriv-setup">stacker unpriv-setup</a></td><td>Does the necessary unprivileged setup for stacker build to work without root</td></tr>
<tr><td><a href="#stacker-gc">stacker gc</a></td><td>Garbage collection of unused OCI imports/outputs snapshots</td></tr>
<tr><td><a href="#stacker-check">stacker check</a></td><td>Checks that all runtime required items (like kernel features) are present</td></tr>
Expand Down Expand Up @@ -146,7 +146,7 @@ This document lists the command line interface (CLI) commands for stacker versio
--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
--image value image to be published; can be specified multiple times

<a name="stacker-chroot-exec"></a>

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/stacker_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Will import foo.tar.gz and make it available in `/stacker`. Note that stacker wi

stacker://$name/path/to/file

Will grab /path/to/file from the previously built layer `$name`.
Will grab /path/to/file from the previously built image `$name`.

#### `import hash`

Expand Down
10 changes: 5 additions & 5 deletions docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@

:pencil2: The conversion is a best-effort process and may not be successful in all cases.

### Publish specific layers
### Publish specific images

- By default, the [`stacker publish`](reference/stacker_cli.md#stacker-publish) command pushes all layers in a stacker.yaml file instead of only the required layers. Using a new command option, `layer <value>`, you can explicitly specify which layers are to be published. This command option can be specified multiple times, selecting each layer to be included.
- By default, the [`stacker publish`](reference/stacker_cli.md#stacker-publish) command pushes all images in a stacker.yaml file instead of only the required images. Using a new command option, `--image <value>`, you can explicitly specify which images are to be published. This command option can be specified multiple times, selecting each image to be included.

### Specify a single working directory

- A new [`stacker`](reference/stacker_cli.md#stacker) command option, `--work-dir`, sets the working directory for stacker's cache, OCI output, and rootfs output. The existing command options `--stacker-dir`, `--oci-dir`, and `--roots-dir` can then be omitted or used to override the `--work-dir` setting.

### Import contents when no shell exists in the base image

- Import directives can include destination paths. This feature is useful when images are built from a scratch layer before any shell has been invoked. Prior to this, a `run:` section was required to invoke a shell and to explicitly copy files to be imported into the image. For example, you can now write a directive such as the following, with no `run:` section:
- Import directives can include destination paths. This feature is useful to simplify `run` section scripts, and for when images are built without a base image. With no base image, there is no shell to run the script in a `run` section. Prior to this change, a `run:` section was required to invoke a shell and to explicitly copy files to be imported into the image. For example, you can now write a directive such as the following, with no `run:` section:

test:
from:
Expand Down Expand Up @@ -47,11 +47,11 @@

### Support for `scratch`

- Prior to v0.40.1, `stacker` did not support empty root filesystems to be used a base container image. The support has now been [added](reference/stacker_file.md#from) which can be used to host statically built binaries.
- Prior to v0.40.1, `stacker` did not support empty root filesystems to be used as a base container image. The support has now been [added](reference/stacker_file.md#from) which can be used to host statically built binaries.

### Support for `import`ing content into container image

- Prior to v0.40.1, copying content into an image permanently involved bind mounting a shell such as busybox and invoking appropriate commands using the `run` directive. Now `import` directive [allows](reference/stacker_file.md#import-dest) for the `dest` option to achieve the same.
- Prior to v0.40.1, copying content into a scratch image permanently involved bind mounting a shell such as busybox and invoking appropriate commands using the `run` directive. Now the `import` directive [allows](reference/stacker_file.md#import-dest) for the `dest` option to achieve the same.

### Publish with substitutions specified in a file

Expand Down
2 changes: 1 addition & 1 deletion material/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h1>Stacker Build</h1>
<a href="{{ 'user_guide/build_environment' | url }}" title="User Guide" class="md-button">
User Guide
</a>
<h3>Pair stacker with <a href="https://zotregistry.io">zot</a>, an OCI-native Image Registry</h3>
<h3>Pair stacker with <a href="https://zotregistry.dev">zot</a>, an OCI-native Image Registry</h3>
</div>
</div>
</div>
Expand Down

0 comments on commit 654b948

Please sign in to comment.