diff options
Diffstat (limited to 'share/man')
30 files changed, 276 insertions, 39 deletions
diff --git a/share/man/Makefile b/share/man/Makefile index a8af58d..a878dbd 100644 --- a/share/man/Makefile +++ b/share/man/Makefile @@ -1,6 +1,6 @@ # Open Infrastructure: compute-tools -# Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +# Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> # # SPDX-License-Identifier: GPL-3.0+ # diff --git a/share/man/compute-tools.7.rst b/share/man/compute-tools.7.rst index 3252f05..33e6aea 100644 --- a/share/man/compute-tools.7.rst +++ b/share/man/compute-tools.7.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. @@ -119,6 +119,12 @@ See container(1) for a list of all container commands. Links ===== +| * Linux Weekly News: Kernel / Containers +| (https://lwn.net/Kernel/Index/#Containers) + +| * Linux Weekly News: Security / Containers +| (https://lwn.net/Security/Index/#Containers) + | * 2016-02-24: Systemd vs. Docker | (https://lwn.net/Articles/676831/) diff --git a/share/man/container-auto.1.rst b/share/man/container-auto.1.rst index 530d64c..68836eb 100644 --- a/share/man/container-auto.1.rst +++ b/share/man/container-auto.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-build-debconf.1.rst b/share/man/container-build-debconf.1.rst index 1649071..6543140 100644 --- a/share/man/container-build-debconf.1.rst +++ b/share/man/container-build-debconf.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-build-debootstrap.1.rst b/share/man/container-build-debootstrap.1.rst index 853b4dc..10538c5 100644 --- a/share/man/container-build-debootstrap.1.rst +++ b/share/man/container-build-debootstrap.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. @@ -61,7 +61,7 @@ The following script options are available: Specify the Debian architecture, defaults to the host systems architecture. -d, --distribution='DISTRIBUTION': - Specify the Debian distribution, defaults to 'bullseye'. + Specify the Debian distribution, defaults to 'bookworm'. -m, --mirror='MIRROR': Specify the Debian mirror, defaults to 'https://deb.debian.org/debian'. @@ -72,15 +72,15 @@ The following script options are available: Examples ======== -Build a Debian 11 (bullseye) based container with same architecture as the host +Build a Debian 12 (bookworm) based container with same architecture as the host system using debootstrap: - sudo container build -s debootstrap -n bullseye.example.net + sudo container build -s debootstrap -n bookworm.example.net -Build a Debian 11 (bullseye) based container with different architecture as the +Build a Debian 12 (bookworm) based container with different architecture as the host system using mmdebstrap: - sudo container build -s mmdebstrap -n bullseye-i386.example.net -- -a i386 + sudo container build -s mmdebstrap -n bookworm-i386.example.net -- -a i386 See also ======== diff --git a/share/man/container-build.1.rst b/share/man/container-build.1.rst index 38a4aed..faa0e16 100644 --- a/share/man/container-build.1.rst +++ b/share/man/container-build.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-config.5.rst b/share/man/container-config.5.rst new file mode 100644 index 0000000..504d848 --- /dev/null +++ b/share/man/container-config.5.rst @@ -0,0 +1,116 @@ +.. Open Infrastructure: compute-tools + +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. +.. SPDX-License-Identifier: GPL-3.0+ +.. +.. This program is free software: you can redistribute it and/or modify +.. it under the terms of the GNU General Public License as published by +.. the Free Software Foundation, either version 3 of the License, or +.. (at your option) any later version. +.. +.. This program is distributed in the hope that it will be useful, +.. but WITHOUT ANY WARRANTY; without even the implied warranty of +.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. GNU General Public License for more details. +.. +.. You should have received a copy of the GNU General Public License +.. along with this program. If not, see <https://www.gnu.org/licenses/>. + +================ +container-config +================ + +---------------------------- +Container configuration file +---------------------------- + +:manual section: 5 +:manual group: Open Infrastructure + +Name +==== + +| **$container**.conf + +Description +=========== + +Containers managed by compute-tools have a container configuration file in +/etc/compute-tools/config/\*.conf. + +This manpage descripts all available configuration file options. + +Options +======= + +The following **container** options are available: + +Section 'start' +--------------- + +cnt.auto: + This setting controls wheter the container will be started automatically on boot. + Allowed values are: true (always started), false (never started), + force-true (always started, even after e.g. powerloss), + last-on (previous state, fallback to on), last-off (previous state, fallback to off) + +cnt.container-server: + When using central storage to keep all container shared on e.g. a NFS volume, + this allows binding containers to individual container servers, so that it is + started (and show) only once. See container-list(1) command for further details. + +cnt.network-bridge: + This setting pairs the container network interface to a bridge on the host, + e.g. "veth-123:bridge-456" + +cnt.overlay: +cnt.overlay-options: + This settings configure automatic overlay filesystem usage. + +cnt.start: + Same as cnt.auto, except that it applies to every start, rather than at + startup of the host system. + +bind: +bind-ro: + This settings configure automatic bind mounts from the host into the container. + +boot: +capability: +directory: +drop-capability: +link-journal: +machine: +network-veth-extra: +private-users: +register: + FIXME. + +See also +======== + +| compute-tools(7), +| container(1). + +Homepage +======== + +More information about compute-tools and the Open Infrastructure project can be +found on the homepage (https://open-infrastructure.net). + +Contact +======= + +Bug reports, feature requests, help, patches, support and everything else are +welcome on the Open Infrastructure Software Mailing List +<software@lists.open-infrastructure.net>. + +Debian specific bugs can also be reported in the Debian Bug Tracking System +(https://bugs.debian.org). + +Authors +======= + +compute-tools were written by Daniel Baumann +<daniel.baumann@open-infrastructure.net> and others. diff --git a/share/man/container-console.1.rst b/share/man/container-console.1.rst index b07ba95..a3afd51 100644 --- a/share/man/container-console.1.rst +++ b/share/man/container-console.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-enter.1.rst b/share/man/container-enter.1.rst index 4948e3a..65961f5 100644 --- a/share/man/container-enter.1.rst +++ b/share/man/container-enter.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-get-curl.1.rst b/share/man/container-get-curl.1.rst index ba44ba0..01ae592 100644 --- a/share/man/container-get-curl.1.rst +++ b/share/man/container-get-curl.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. @@ -82,22 +82,22 @@ The following script options are available: --system='SYSTEM': Specify the system image name to download, defaults to - debian-bullseye-current_${ARCHITECTURE}.system.tar.${COMPRESSION} (where + debian-bookworm-current_${ARCHITECTURE}.system.tar.${COMPRESSION} (where ${ARCHITECTURE} is the host systems architecture and ${COMPRESSION} either lz, xz, or gz depending on compressor availability on the host system). Examples ======== -Download a Debian 11 (bullseye) based container with same architecture as the host +Download a Debian 12 (bookworm) based container with same architecture as the host system: - sudo container get -s curl -n bullseye.example.net + sudo container get -s curl -n bookworm.example.net -Download a Debian 11 (bullseye) based container with different architecture as the +Download a Debian 12 (bookworm) based container with different architecture as the host system: - sudo container get -s curl -n bullseye-i386.example.net -- --system debian-bullseye-current_i386.system.tar.xz + sudo container get -s curl -n bookworm-i386.example.net -- --system debian-bookworm-current_i386.system.tar.xz Files ===== diff --git a/share/man/container-get.1.rst b/share/man/container-get.1.rst index edcb1de..8ec61de 100644 --- a/share/man/container-get.1.rst +++ b/share/man/container-get.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-info.1.rst b/share/man/container-info.1.rst index c3c8e7d..99ccb55 100644 --- a/share/man/container-info.1.rst +++ b/share/man/container-info.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. @@ -44,6 +44,9 @@ Options The following **container info** options are available, defaults to '--status --os --ip': +-n, --name='NAME': + Specify container name. Specifying 'ALL' will start all stopped container. + --status: Show container status (started|stopped|other). diff --git a/share/man/container-key.1.rst b/share/man/container-key.1.rst index d21956a..ff2b93f 100644 --- a/share/man/container-key.1.rst +++ b/share/man/container-key.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-limit.1.rst b/share/man/container-limit.1.rst index 67fad3d..715314e 100644 --- a/share/man/container-limit.1.rst +++ b/share/man/container-limit.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-list.1.rst b/share/man/container-list.1.rst index 6cd516f..81a394b 100644 --- a/share/man/container-list.1.rst +++ b/share/man/container-list.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-log.1.rst b/share/man/container-log.1.rst index 7984aa0..5e72184 100644 --- a/share/man/container-log.1.rst +++ b/share/man/container-log.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-move.1.rst b/share/man/container-move.1.rst index 550f1db..ecbea6b 100644 --- a/share/man/container-move.1.rst +++ b/share/man/container-move.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-rebuild.1.rst b/share/man/container-rebuild.1.rst new file mode 100644 index 0000000..345ec01 --- /dev/null +++ b/share/man/container-rebuild.1.rst @@ -0,0 +1,93 @@ +.. Open Infrastructure: compute-tools + +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. +.. SPDX-License-Identifier: GPL-3.0+ +.. +.. This program is free software: you can redistribute it and/or modify +.. it under the terms of the GNU General Public License as published by +.. the Free Software Foundation, either version 3 of the License, or +.. (at your option) any later version. +.. +.. This program is distributed in the hope that it will be useful, +.. but WITHOUT ANY WARRANTY; without even the implied warranty of +.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. GNU General Public License for more details. +.. +.. You should have received a copy of the GNU General Public License +.. along with this program. If not, see <https://www.gnu.org/licenses/>. + +================= +container-rebuild +================= + +------------------- +Restart a container +------------------- + +:manual section: 1 +:manual group: Open Infrastructure + +Synopsis +======== + +| **container rebuild** ['OPTIONS'] +| **cnt rb** ['OPTIONS'] + +Description +=========== + +The **container rebuild** command rebuilds a container by stopping, building, starting an existing container. + +Options +======= + +The following **container rebuild** options are available: + +-n, --name='NAME': + Specify container name. Specifying 'ALL' will rebuild all started container. + +-f, --force: + Do not fail if container is running. + +-v, --verbose: + Explain what is being done. + +Examples +======== + +Rebuild example.net container: + + sudo container rebuild -n example.net + +Restart all container: + + sudo container rebuild -n ALL + +See also +======== + +| compute-tools(7), +| container(1). + +Homepage +======== + +More information about compute-tools and the Open Infrastructure project can be +found on the homepage (https://open-infrastructure.net). + +Contact +======= + +Bug reports, feature requests, help, patches, support and everything else are +welcome on the Open Infrastructure Software Mailing List +<software@lists.open-infrastructure.net>. + +Debian specific bugs can also be reported in the Debian Bug Tracking System +(https://bugs.debian.org). + +Authors +======= + +compute-tools were written by Daniel Baumann +<daniel.baumann@open-infrastructure.net> and others. diff --git a/share/man/container-remove.1.rst b/share/man/container-remove.1.rst index d62f527..00f1ad1 100644 --- a/share/man/container-remove.1.rst +++ b/share/man/container-remove.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-restart.1.rst b/share/man/container-restart.1.rst index fb98a78..c52353d 100644 --- a/share/man/container-restart.1.rst +++ b/share/man/container-restart.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. @@ -47,6 +47,12 @@ The following **container restart** options are available: -n, --name='NAME': Specify container name. Specifying 'ALL' will restart all started container. +-f, --force: + Do not prompt before every restarting. + +-i, --interactive: + Prompt before every restarting (default). + -v, --verbose: Explain what is being done. diff --git a/share/man/container-run.1.rst b/share/man/container-run.1.rst index 9759811..0fb923d 100644 --- a/share/man/container-run.1.rst +++ b/share/man/container-run.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-shell.1.rst b/share/man/container-shell.1.rst index a41bd2a..b12958f 100644 --- a/share/man/container-shell.1.rst +++ b/share/man/container-shell.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-start.1.rst b/share/man/container-start.1.rst index b444c6e..65d4af7 100644 --- a/share/man/container-start.1.rst +++ b/share/man/container-start.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-status.1.rst b/share/man/container-status.1.rst index 79675be..ad51ba7 100644 --- a/share/man/container-status.1.rst +++ b/share/man/container-status.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-stop.1.rst b/share/man/container-stop.1.rst index 29bfa3d..bf668be 100644 --- a/share/man/container-stop.1.rst +++ b/share/man/container-stop.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. @@ -49,6 +49,12 @@ The following **container stop** options are available: Specify container name. Specifying 'ALL' will stop all started container. -f, --force: + Do not prompt before every stopping. + +-i, --interactive: + Prompt before every stopping (default). + +-k, --kill: Instead of running the proper shutdown sequence, terminate all processes of the container imediatly. -v, --verbose: @@ -61,9 +67,13 @@ Shutdown example.net container: sudo container stop -n example.net +Shutdown example.net container without prompting: + + sudo container stop -n example.net -f + Immediately stop example.net container: - sudo container stop -n example.net -f + sudo container stop -n example.net -k Stop all container: diff --git a/share/man/container-top.1.rst b/share/man/container-top.1.rst index 8d1493c..85b3627 100644 --- a/share/man/container-top.1.rst +++ b/share/man/container-top.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-update.1.rst b/share/man/container-update.1.rst index 58dcb73..ec64f6b 100644 --- a/share/man/container-update.1.rst +++ b/share/man/container-update.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container-version.1.rst b/share/man/container-version.1.rst index 3a57999..3f0266d 100644 --- a/share/man/container-version.1.rst +++ b/share/man/container-version.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. diff --git a/share/man/container.1.rst b/share/man/container.1.rst index 3fff87b..c08cbd9 100644 --- a/share/man/container.1.rst +++ b/share/man/container.1.rst @@ -1,6 +1,6 @@ .. Open Infrastructure: compute-tools -.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .. .. SPDX-License-Identifier: GPL-3.0+ .. @@ -59,6 +59,9 @@ build: start: Start a container, see container-start(1). +rebuild: + Rebuild a container, see container-rebuild(1). + restart: Restart a container, see container-restart(1). diff --git a/share/man/man.in b/share/man/man.in index 9e8de0e..45a5f40 100644 --- a/share/man/man.in +++ b/share/man/man.in @@ -1,6 +1,6 @@ .\" Open Infrastructure: compute-tools .\" -.\" Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.\" Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> .\" .\" SPDX-License-Identifier: GPL-3.0+ .\" |