From 7e226f60b7a2bd7e854d14b2bfd9729e20b02119 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 25 Jul 2021 10:54:34 +0200 Subject: Renaming container create command to container build. Signed-off-by: Daniel Baumann --- share/man/compute-tools.7.rst | 4 +- share/man/container-build-debconf.1.rst | 173 +++++++++++++++++++++++++++ share/man/container-build-debootstrap.1.rst | 111 +++++++++++++++++ share/man/container-build.1.rst | 146 ++++++++++++++++++++++ share/man/container-create-debconf.1.rst | 173 --------------------------- share/man/container-create-debootstrap.1.rst | 111 ----------------- share/man/container-create.1.rst | 146 ---------------------- share/man/container.1.rst | 4 +- 8 files changed, 434 insertions(+), 434 deletions(-) create mode 100644 share/man/container-build-debconf.1.rst create mode 100644 share/man/container-build-debootstrap.1.rst create mode 100644 share/man/container-build.1.rst delete mode 100644 share/man/container-create-debconf.1.rst delete mode 100644 share/man/container-create-debootstrap.1.rst delete mode 100644 share/man/container-create.1.rst (limited to 'share/man') diff --git a/share/man/compute-tools.7.rst b/share/man/compute-tools.7.rst index b6405b2..3252f05 100644 --- a/share/man/compute-tools.7.rst +++ b/share/man/compute-tools.7.rst @@ -96,8 +96,8 @@ Linux' overlay filesystem Usage ===== -Create a new container: - sudo container create -n NAME +Build a new container: + sudo container build -n NAME Start a container: sudo container start -n NAME diff --git a/share/man/container-build-debconf.1.rst b/share/man/container-build-debconf.1.rst new file mode 100644 index 0000000..1649071 --- /dev/null +++ b/share/man/container-build-debconf.1.rst @@ -0,0 +1,173 @@ +.. Open Infrastructure: compute-tools + +.. Copyright (C) 2014-2021 Daniel Baumann +.. +.. 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 . + +======================= +container-build-debconf +======================= + +----------------------------------------------------- +Build an advanced Debian based container with debconf +----------------------------------------------------- + +:manual section: 1 +:manual group: Open Infrastructure + +Synopsis +======== + +| **container build -s debconf** ['OPTIONS'] +| **cnt b -s debconf** ['OPTIONS'] + +| **container build -s debian** ['OPTIONS'] +| **cnt b -s debian** ['OPTIONS'] + +| **container build -s progress-linux** ['OPTIONS'] +| **cnt b -s progress-linux** ['OPTIONS'] + +Description +=========== + +The debconf container build script uses debconf(1) to automatically build a +Debian based container. + +Scope +----- + +Note that this container build script can do a few things more than just +automatically debootstrap based on a preseed file. It also allows you to set a +root password, configure the network, install certain packages and execute +hooks. + +But: this is *not* a replacement for a configuration management system (like +ansible, puppet, etc.). The intenion of this script is to build the initial +container to that extend that a configuration management system can take over. + +As an analogy, think of debian-installer: d-i sets up your system to make it +ready to boot and connect to the network. Everything after that is out of scope. +Same goes for this script. + +Functions +--------- + +This script performs the following configuration on top of a Debian based +system: + + * network + * root password + * apt repositories + * \.\.\. + +Modes +----- + +This container build script can be used under two different names: debian and +progress-linux. + +Alternative, calling it under the debconf name is equal to the debian mode. + +Preseeding +---------- + +Hierarchy of Preseed Files: + + * The debconf script can be fully preseeded. Such preseed files can include + one or more preseed files themselfs (currently, only one layer of includes + is supported, no nested or recursive includes). + + * The general rule of 'the later preseed file overwrites the earlier' applies. + The debconf script reads the main preseed file (specified either on command + line or by debconf selection/input dialog) after any included preseed files + in there. + + * That means that debconf values after the include statement in the main + preseed file can overwrite any values specified in the included preseed + files. + +Options +======= + +The following script options are available: + +-n, --name='NAME': + Specify container name. + +-p, --preseed-file='FILE': + Specify the preseed file. + +Examples +======== + +Build a Debian based container: + + sudo container build -s debian -n debian.example.net + +Build a Progress Linux container: + + sudo container build -s progress-linux -n progress.example.net + +Files +===== + +The following files are used: + +/etc/compute-tools/config: + Container configuration files. + +/usr/share/compute-tools/build-scripts: + Container build scripts. + +/usr/share/doc/compute-tools: + Container documentation. + +/var/lib/machines: + Container directory. + +/var/cache/container: + Container cache directory. + +/tmp/compute-tools: + Container temporary directory. + +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 +. + +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 + and others. diff --git a/share/man/container-build-debootstrap.1.rst b/share/man/container-build-debootstrap.1.rst new file mode 100644 index 0000000..853b4dc --- /dev/null +++ b/share/man/container-build-debootstrap.1.rst @@ -0,0 +1,111 @@ +.. Open Infrastructure: compute-tools + +.. Copyright (C) 2014-2021 Daniel Baumann +.. +.. 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 . + +=========================== +container-build-debootstrap +=========================== + +------------------------------------------------------------------- +Build a basic Debian based container with debootstrap or mmdebstrap +------------------------------------------------------------------- + +:manual section: 1 +:manual group: Open Infrastructure + +Synopsis +======== + +| **container build -s debootstrap** ['OPTIONS'] +| **cnt b -s debootstrap** ['OPTIONS'] + +| **container build -s mmdebstrap** ['OPTIONS'] +| **cnt b -s mmdebstrap** ['OPTIONS'] + +Description +=========== + +The debootstrap container build script uses debootstrap(8) or mmdebstrap(1) +to build a Debian based container. + +This script builds a pure Debian system with three modificiations: + + * apt cache of packages downloaded during debootstrap is cleaned + * hostname is set (container name) in /etc/hostname + * root password is set (user specified or 16 random characters) + +Options +======= + +The following script options are available: + +-n, --name='NAME': + Specify container name. + +-a, --architecture='ARCHITECTURE': + Specify the Debian architecture, defaults to the host systems architecture. + +-d, --distribution='DISTRIBUTION': + Specify the Debian distribution, defaults to 'bullseye'. + +-m, --mirror='MIRROR': + Specify the Debian mirror, defaults to 'https://deb.debian.org/debian'. + +-p, --root-password='PASSWORD': + Specify the root password, defaults to a random 16 character password. + +Examples +======== + +Build a Debian 11 (bullseye) based container with same architecture as the host +system using debootstrap: + + sudo container build -s debootstrap -n bullseye.example.net + +Build a Debian 11 (bullseye) based container with different architecture as the +host system using mmdebstrap: + + sudo container build -s mmdebstrap -n bullseye-i386.example.net -- -a i386 + +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 +. + +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 + and others. diff --git a/share/man/container-build.1.rst b/share/man/container-build.1.rst new file mode 100644 index 0000000..55f2a9b --- /dev/null +++ b/share/man/container-build.1.rst @@ -0,0 +1,146 @@ +.. Open Infrastructure: compute-tools + +.. Copyright (C) 2014-2021 Daniel Baumann +.. +.. 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 . + +=============== +container-build +=============== + +----------------- +Build a container +----------------- + +:manual section: 1 +:manual group: Open Infrastructure + +Synopsis +======== + +| **container build** ['OPTIONS'] +| **cnt b** ['OPTIONS'] + +Description +=========== + +The **container build** command builds a container based on a script. + +Scripts +------- + +The following build scripts are available: + +curl: + Basic script to build Debian based container, see container-create-curl(1). + +debootstrap: + Basic script to build Debian based container, see + container-build-debootstrap(1). + +debconf: + Advanced script to automatically build Debian based container, see + container-build-debconf(1). + +default: + Symlink (if existing) to a build script which is used if no script was + specified. On Debian based system this can be managed through + update-alternatives(1), i.e. 'sudo update-alternatives --config + container_build-script'. + +Options +======= + +The following **container build** options are available: + +-n, --name='NAME': + Specify container name. + +-c, --capability='CAPABILITY': + Specify capabilities to grant, see capabilities(7). + +-d, --drop-capability='DROP_CAPABILITY': + Specify capabilities to drop, see capabilities(7). + +-s, --script='SCRIPT': + Specify container build script, defaults to 'debootstrap'. + +-v, --verbose: + Explain what is being done. + +-b, --bind='DIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]': + Specify container read-write bind mounts, see systemd-nspawn(1) --bind option. + +--bind-ro='DIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]': + Specify container read-only bind mounts, see systemd-nspawn(1) --bind-ro + option. + +--cnt-overlay='DIRECTORY_LOWER:DIRECTORY_UPPER:DIRECTORY_WORK:DIRECTORY_MERGED[;DIRECTORY_UPPER:DIRECTORY_LOWER:DIRECTORY_WORK:DIRECTORY_MERGED]': + Specify container overlay mounts, see Documentation/filesystems/overlayfs.txt. + +--cnt.overlay-options='OPTION1,OPTION2[;OPTION3,OPTION4]': + Specify container overlay mount options, see + Documentation/filesystems/overlayfs.txt. + +--cnt.start='OPTION1[,OPTION2,...]': + Specify container start options, see container-start(1). + +Examples +======== + +Build example.net container using curl script: + + sudo container build -n example.net -s curl + +Build example.net container using debootstrap script: + + sudo container build -n example.net -s debootstrap + +Build example.net container using debconf script: + + sudo container build -n example.net -s debconf + +Build example.net container with the default build script and start it: + + sudo container build,start -n example.net + +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 +. + +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 + and others. diff --git a/share/man/container-create-debconf.1.rst b/share/man/container-create-debconf.1.rst deleted file mode 100644 index 69cab10..0000000 --- a/share/man/container-create-debconf.1.rst +++ /dev/null @@ -1,173 +0,0 @@ -.. Open Infrastructure: compute-tools - -.. Copyright (C) 2014-2021 Daniel Baumann -.. -.. 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 . - -======================== -container-create-debconf -======================== - ------------------------------------------------------- -Create an advanced Debian based container with debconf ------------------------------------------------------- - -:manual section: 1 -:manual group: Open Infrastructure - -Synopsis -======== - -| **container create -s debconf** ['OPTIONS'] -| **cnt cr -s debconf** ['OPTIONS'] - -| **container create -s debian** ['OPTIONS'] -| **cnt cr -s debian** ['OPTIONS'] - -| **container create -s progress-linux** ['OPTIONS'] -| **cnt cr -s progress-linux** ['OPTIONS'] - -Description -=========== - -The debconf container creation script uses debconf(1) to automatically create a -Debian based container. - -Scope ------ - -Note that this container creation script can do a few things more than just -automatically debootstrap based on a preseed file. It also allows you to set a -root password, configure the network, install certain packages and execute -hooks. - -But: this is *not* a replacement for a configuration management system (like -ansible, puppet, etc.). The intenion of this script is to create the initial -container to that extend that a configuration management system can take over. - -As an analogy, think of debian-installer: d-i sets up your system to make it -ready to boot and connect to the network. Everything after that is out of scope. -Same goes for this script. - -Functions ---------- - -This script performs the following configuration on top of a Debian based -system: - - * network - * root password - * apt repositories - * \.\.\. - -Modes ------ - -This container creation script can be used under two different names: debian and -progress-linux. - -Alternative, calling it under the debconf name is equal to the debian mode. - -Preseeding ----------- - -Hierarchy of Preseed Files: - - * The debconf script can be fully preseeded. Such preseed files can include - one or more preseed files themselfs (currently, only one layer of includes - is supported, no nested or recursive includes). - - * The general rule of 'the later preseed file overwrites the earlier' applies. - The debconf script reads the main preseed file (specified either on command - line or by debconf selection/input dialog) after any included preseed files - in there. - - * That means that debconf values after the include statement in the main - preseed file can overwrite any values specified in the included preseed - files. - -Options -======= - -The following script options are available: - --n, --name='NAME': - Specify container name. - --p, --preseed-file='FILE': - Specify the preseed file. - -Examples -======== - -Create a Debian based container: - - sudo container create -s debian -n debian.example.net - -Create a Progress Linux container: - - sudo container create -s progress-linux -n progress.example.net - -Files -===== - -The following files are used: - -/etc/compute-tools/config: - Container configuration files. - -/usr/share/compute-tools/scripts: - Container creation scripts. - -/usr/share/doc/compute-tools: - Container documentation. - -/var/lib/machines: - Container directory. - -/var/cache/container: - Container cache directory. - -/tmp/compute-tools: - Container temporary directory. - -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 -. - -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 - and others. diff --git a/share/man/container-create-debootstrap.1.rst b/share/man/container-create-debootstrap.1.rst deleted file mode 100644 index 8165cea..0000000 --- a/share/man/container-create-debootstrap.1.rst +++ /dev/null @@ -1,111 +0,0 @@ -.. Open Infrastructure: compute-tools - -.. Copyright (C) 2014-2021 Daniel Baumann -.. -.. 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 . - -============================ -container-create-debootstrap -============================ - --------------------------------------------------------------------- -Create a basic Debian based container with debootstrap or mmdebstrap --------------------------------------------------------------------- - -:manual section: 1 -:manual group: Open Infrastructure - -Synopsis -======== - -| **container create -s debootstrap** ['OPTIONS'] -| **cnt cr -s debootstrap** ['OPTIONS'] - -| **container create -s mmdebstrap** ['OPTIONS'] -| **cnt cr -s mmdebstrap** ['OPTIONS'] - -Description -=========== - -The debootstrap container creation script uses debootstrap(8) or mmdebstrap(1) -to create a Debian based container. - -This script creates a pure Debian system with three modificiations: - - * apt cache of packages downloaded during debootstrap is cleaned - * hostname is set (container name) in /etc/hostname - * root password is set (user specified or 16 random characters) - -Options -======= - -The following script options are available: - --n, --name='NAME': - Specify container name. - --a, --architecture='ARCHITECTURE': - Specify the Debian architecture, defaults to the host systems architecture. - --d, --distribution='DISTRIBUTION': - Specify the Debian distribution, defaults to 'bullseye'. - --m, --mirror='MIRROR': - Specify the Debian mirror, defaults to 'https://deb.debian.org/debian'. - --p, --root-password='PASSWORD': - Specify the root password, defaults to a random 16 character password. - -Examples -======== - -Create a Debian 11 (bullseye) based container with same architecture as the host -system using debootstrap: - - sudo container create -s debootstrap -n bullseye.example.net - -Create a Debian 11 (bullseye) based container with different architecture as the -host system using mmdebstrap: - - sudo container create -s mmdebstrap -n bullseye-i386.example.net -- -a i386 - -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 -. - -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 - and others. diff --git a/share/man/container-create.1.rst b/share/man/container-create.1.rst deleted file mode 100644 index cb10f97..0000000 --- a/share/man/container-create.1.rst +++ /dev/null @@ -1,146 +0,0 @@ -.. Open Infrastructure: compute-tools - -.. Copyright (C) 2014-2021 Daniel Baumann -.. -.. 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 . - -================ -container-create -================ - ------------------- -Create a container ------------------- - -:manual section: 1 -:manual group: Open Infrastructure - -Synopsis -======== - -| **container create** ['OPTIONS'] -| **cnt cr** ['OPTIONS'] - -Description -=========== - -The **container create** command creates a container based on a script. - -Scripts -------- - -The following container scripts are available: - -curl: - Basic script to create Debian based container, see container-create-curl(1). - -debootstrap: - Basic script to create Debian based container, see - container-create-debootstrap(1). - -debconf: - Advanced script to automatically create Debian based container, see - container-create-debconf(1). - -default: - Symlink (if existing) to a container script which is used if no script was - specified. On Debian based system this can be managed through - update-alternatives(1), i.e. 'sudo update-alternatives --config - container_script'. - -Options -======= - -The following **container create** options are available: - --n, --name='NAME': - Specify container name. - --c, --capability='CAPABILITY': - Specify capabilities to grant, see capabilities(7). - --d, --drop-capability='DROP_CAPABILITY': - Specify capabilities to drop, see capabilities(7). - --s, --script='SCRIPT': - Specify container creation script, defaults to 'debootstrap'. - --v, --verbose: - Explain what is being done. - --b, --bind='DIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]': - Specify container read-write bind mounts, see systemd-nspawn(1) --bind option. - ---bind-ro='DIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]': - Specify container read-only bind mounts, see systemd-nspawn(1) --bind-ro - option. - ---cnt-overlay='DIRECTORY_LOWER:DIRECTORY_UPPER:DIRECTORY_WORK:DIRECTORY_MERGED[;DIRECTORY_UPPER:DIRECTORY_LOWER:DIRECTORY_WORK:DIRECTORY_MERGED]': - Specify container overlay mounts, see Documentation/filesystems/overlayfs.txt. - ---cnt.overlay-options='OPTION1,OPTION2[;OPTION3,OPTION4]': - Specify container overlay mount options, see - Documentation/filesystems/overlayfs.txt. - ---cnt.start='OPTION1[,OPTION2,...]': - Specify container start options, see container-start(1). - -Examples -======== - -Create example.net container using curl script: - - sudo container create -n example.net -s curl - -Create example.net container using debootstrap script: - - sudo container create -n example.net -s debootstrap - -Create example.net container using debconf script: - - sudo container create -n example.net -s debconf - -Create example.net container with the default create script and start it: - - sudo container create,start -n example.net - -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 -. - -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 - and others. diff --git a/share/man/container.1.rst b/share/man/container.1.rst index 61661ab..cce283b 100644 --- a/share/man/container.1.rst +++ b/share/man/container.1.rst @@ -53,8 +53,8 @@ Commands The following **container** commands are available: -create: - Create a new container, see container-create(1). +build: + Build a new container, see container-build(1). start: Start a container, see container-start(1). -- cgit v1.2.3