Skip to content

docs: initial test commit for docs editing #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2022
Merged

docs: initial test commit for docs editing #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions docs/get_started/get_stacker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ stacker check
```
## Kernel dependencies

Stacker requires overlayfs backend, and that works with any kernel >= 4.14.
However, for unprivileged use, the overlayfs backend requires a reasonably new
Stacker requires overlayfs backend. That works with any kernel >= 4.14.
However, for unprivileged usage, the overlayfs backend requires a new
kernel change available on all kernels >= 5.8.

!!! info
Expand All @@ -27,17 +27,15 @@ kernel change available on all kernels >= 5.8.
Some distributions may have ported these patches into older versions of their
kernels. For example, Ubuntu 20.04 and 22.04 kernels already have these patches.

Stacker has checks to ensure that it can run with all these environments
requirements, and will fail fast if it can't do something it should be able to
do.
Stacker includes checks to ensure that it can run with all these requirements, and will fail if it can't perform a function it should be able perform.

```bash title="Stacker Check"
stacker check && echo "stacker is ready to use!"
```

## Overlay filesystem

An underlying overlayfs cannot back stacker since the stacker needs to create
An underlying overlayfs cannot back stacker becuase the stacker needs to create
whiteout files, and the kernel (rightfully) forbids manual creation of whiteout
files on overlay filesystems. No additional userspace dependencies are required
to use the overlayfs backend.
Expand All @@ -49,11 +47,11 @@ to use the overlayfs backend.

## Unprivileged setup

Running stacker as an unprivileged user requires stacker to run inside a `user`
namespace owned by the user that executed the command, and stacker will try to
map `65k` user and group ids to meet the POSIX standard. So, to run stacker,
the user's `/etc/sub{u,g}id` should be configured with enough uids to map things
correctly. This configuration can be done automatically via
Running stacker as an unprivileged user requires stacker to run as part of a `user`
namespace owned by the user that executed the command. Stacker will
map `65k` user and group IDs to meet the POSIX standard. So, to run stacker,
the user's `/etc/sub{u,g}id` should be configured with enough UIDs to map components
correctly. This configuration can be run automatically via
`stacker unpriv-setup`.

```bash title="Stacker unprivileged setup"
Expand All @@ -65,7 +63,7 @@ cat /etc/subuid
## Squashfs support

In order to generate squashfs images, stacker invokes the `mksquashfs` binary.
This binary needs to be installed and present in `$PATH`.
This binary needs to be installed and available in `$PATH`.

```bash title="Install mksquashfs on ubuntu"
sudo apt-get install -y squashfs-tools
Expand Down