-
-
Notifications
You must be signed in to change notification settings - Fork 512
builder doc improvements #1520
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.
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
Open
ydirson
wants to merge
3
commits into
QubesOS:main
Choose a base branch
from
ydirson:qb-doc-improvements
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
builder doc improvements #1520
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -14,13 +14,20 @@ In the second generation of Qubes OS builder, container or disposable qube isola | |||||
| Setup | ||||||
| ----- | ||||||
|
|
||||||
| This is a simple setup using a docker executor. This is a good default choice; if you don’t know which executor to use, use docker. | ||||||
| This is a simple setup using a docker or podman executor. This is a good default choice; if you don’t know which executor to use, use docker. Note the podman exector `is known <https://github.com/QubesOS/qubes-issues/issues/10280>` not to be currently able to build DEB packages. | ||||||
|
|
||||||
| 1. First, decide what qube you are going to use when working with Qubes Builder v2. It can be an AppVM or a Standalone qube, with some steps different between the two. | ||||||
|
|
||||||
| 2. Installing dependencies | ||||||
| 2. Clone the qubes-builder v2 repository into a location of your choice: | ||||||
|
|
||||||
| If you want to use an app qube for developing, install dependencies in the template. If you are using a standalone, install them in the qube itself. Dependencies are specified in ``dependencies-*. txt`` files in the main builder directory, and you can install them easily in the following ways: | ||||||
| .. code:: console | ||||||
|
|
||||||
| $ git clone https://github.com/QubesOS/qubes-builderv2 | ||||||
| $ cd qubes-builderv2/ | ||||||
|
|
||||||
| 3. Installing dependencies | ||||||
|
|
||||||
| If you want to use an app qube for developing, install dependencies in the template. If you are using a standalone, install them in the qube itself. Dependencies are specified in ``dependencies-*. txt`` files in the main builder directory (you will also find dependency lists for ``podman`` and ``qubes`` executors if you choose to use thsose), and you can install them easily in the following ways: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| - for Fedora, use: | ||||||
|
|
||||||
|
|
@@ -38,14 +45,7 @@ This is a simple setup using a docker executor. This is a good default choice; i | |||||
|
|
||||||
| If you have installed dependencies in the template, close it, and (re)start the development qube. | ||||||
|
|
||||||
| 3. Clone the qubes-builder v2 repository into a location of your choice: | ||||||
|
|
||||||
| .. code:: console | ||||||
|
|
||||||
| $ git clone https://github.com/QubesOS/qubes-builderv2 | ||||||
| $ cd qubes-builderv2/ | ||||||
|
|
||||||
| 4. If you haven’t previously used docker in the current qube, you need to set up some permissions. In particular, the user has to be added to the ``docker`` group: | ||||||
| 4. If you haven’t previously used docker in the current qube, you need to set up some permissions (nothing needs to be done here if you're using `podman`). In particular, the user has to be added to the ``docker`` group: | ||||||
|
|
||||||
| .. code:: console | ||||||
|
|
||||||
|
|
@@ -55,16 +55,24 @@ This is a simple setup using a docker executor. This is a good default choice; i | |||||
|
|
||||||
| 5. Finally, you need to generate a docker image: | ||||||
|
|
||||||
| Depending on your choice of a container runtime, run one of: | ||||||
|
|
||||||
| .. code:: console | ||||||
|
|
||||||
| $ tools/generate-container-image.sh docker | ||||||
|
|
||||||
| In an app qube, as ``/var/lib/docker`` is not persistent by default, you also need to use :doc:`bind-dirs </user/advanced-topics/bind-dirs>` to avoid repeating this step after reboot, adding the following to the ``/rw/config/qubes-bind-dirs.d/docker.conf`` file in this qube: | ||||||
| .. code:: console | ||||||
|
|
||||||
| $ tools/generate-container-image.sh podman | ||||||
|
|
||||||
| If you are using ``docker`` and an app qube, as ``/var/lib/docker`` is not persistent by default, you also need to use :doc:`bind-dirs </user/advanced-topics/bind-dirs>` to avoid repeating this step after reboot, adding the following to the ``/rw/config/qubes-bind-dirs.d/docker.conf`` file in this qube: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| .. code:: bash | ||||||
|
|
||||||
| binds+=( '/var/lib/docker' ) | ||||||
|
|
||||||
| If you are using ``podman`` this is not necessary, as the container images are stored in ``~/.local/share/containers/``. | ||||||
|
|
||||||
| Configuration | ||||||
| ------------- | ||||||
|
|
||||||
|
|
@@ -98,6 +106,13 @@ To use Qubes OS Builder v2, you need to have a ``builder.yml`` configuration fil | |||||
| options: | ||||||
| image: "qubes-builder-fedora:latest" | ||||||
|
|
||||||
| If you want use the ``podman`` executor, you have to enable socket activation, with: | ||||||
|
|
||||||
|
|
||||||
| .. code:: console | ||||||
|
|
||||||
| # systemctl --user enable --now podman.socket | ||||||
|
|
||||||
| Using Builder v2 | ||||||
| ---------------- | ||||||
|
|
||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you need a
__after the link so it's considered a link