From c0d285f4b03b176f1e1b5e4ac8968f2c8aa4492d Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 2 Mar 2019 11:39:25 +0100 Subject: Merging upstream version 20190301. Signed-off-by: Daniel Baumann --- share/man/container-create-curl.1.txt | 129 --------------------------- share/man/container-create-debconf.1.txt | 10 ++- share/man/container-create-debootstrap.1.txt | 13 +-- share/man/container-create.1.txt | 7 +- share/man/container-key.1.txt | 86 ------------------ share/man/container-limit.1.txt | 109 ---------------------- share/man/container-list.1.txt | 1 - share/man/container-move.1.txt | 3 +- share/man/container-remove.1.txt | 3 +- share/man/container-restart.1.txt | 1 + share/man/container-start.1.txt | 1 + share/man/container-status.1.txt | 1 + share/man/container-stop.1.txt | 1 + share/man/container-version.1.txt | 2 - share/man/container.1.txt | 6 -- 15 files changed, 21 insertions(+), 352 deletions(-) delete mode 100644 share/man/container-create-curl.1.txt delete mode 100644 share/man/container-key.1.txt delete mode 100644 share/man/container-limit.1.txt (limited to 'share/man') diff --git a/share/man/container-create-curl.1.txt b/share/man/container-create-curl.1.txt deleted file mode 100644 index 40028c9..0000000 --- a/share/man/container-create-curl.1.txt +++ /dev/null @@ -1,129 +0,0 @@ -// Copyright (C) 2014-2019 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-CURL(1) -======================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: compute-tools -:man version: {revnumber} - - -NAME ----- -container-create-curl - Create a Debian based container by downloading a tarball over the network - - -SYNOPSIS --------- -*container create -s curl* ['OPTIONS'] - - -DESCRIPTION ------------ -The curl container creation script uses curl(1) to download a tarball over the -network to create a Debian based container. - -Depending on the tarball this script otherwise creates a pure Debian system with three modificiations: - - * hostname is set (container name) in /etc/hostname - * systemd machine-id is generated in /etc/machine-id - * 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 container architecture. - -"--clean*:: - Remove downloaded tarball after successfull container creation. - -*-p, --root-password='PASSWORD'*:: - Specify the root password, defaults to a random 16 character password. - -*--server='SERVER'*:: - Specify the image server to download from, defaults to https://get.open-infrastructure.net/system/container/debian. - -*--setup='SETUP'*:: - Specify the setup image name to download, defaults to the value specified through --system using the setup.tar.${COMPRESSION} suffix. - -*--system='SYSTEM'*:: - Specify the system image name to download, defaults to debian-stretch-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 --------- -*Create a Debian 9 (stretch) based container with same architecture as the host system:*:: - sudo container create -s curl -n stretch.example.net - -*Create a Debian 9 (stretch) based container with different architecture as the host system:*:: - sudo container create -s curl -n stretch-i386.example.net -- --system debian-stretch-current_i386.system.tar.xz - -FILES ------ -The following files are used: - -*/etc/open-infrastructure/container/config*:: - Container configuration files. - -*/usr/share/open-infrastructure/container/scripts*:: - Container creation scripts. - -*/usr/share/doc/compute-tools*:: - Container documentation. - -*/var/lib/machines*:: - Container directory. - -*/var/cache/open-infrastructure/container*:: - Container cache directory. - - -CONTAINER IMAGES ----------------- - -compute-tools will download tarballs from a server expecting that the images are tarballs with either gzip, lzip, xz, or no compression. See container-images.sh as an example on how to create your own container images. - - -SEE ALSO --------- -compute-tools(7), -container(1). - - -HOMEPAGE --------- -More information about compute-tools and the Open Infrastructure project can be found on the homepage at 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 at https://bugs.debian.org. - - -AUTHORS -------- -compute-tools were written by Daniel Baumann and others. diff --git a/share/man/container-create-debconf.1.txt b/share/man/container-create-debconf.1.txt index e6f2582..ecc30a6 100644 --- a/share/man/container-create-debconf.1.txt +++ b/share/man/container-create-debconf.1.txt @@ -31,8 +31,13 @@ container-create-debconf - Create an advanced Debian based container with debcon 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 @@ -49,7 +54,7 @@ The intenion of this script is to create the initial container to that extend th 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. (FIXME) +after that is out of scope. Same goes for this script. FUNCTIONS ~~~~~~~~~ @@ -67,9 +72,6 @@ This container creation script can be used under two different names: debian and Alternative, calling it under the debconf name is equal to the debian mode. -INTERACTIVE/NONINTERACTIVE -~~~~~~~~~~~~~~~~~~~~~~~~~~ -FIXME PRESEEDING ~~~~~~~~~~ diff --git a/share/man/container-create-debootstrap.1.txt b/share/man/container-create-debootstrap.1.txt index fc8651e..43950af 100644 --- a/share/man/container-create-debootstrap.1.txt +++ b/share/man/container-create-debootstrap.1.txt @@ -25,17 +25,20 @@ CONTAINER-CREATE-DEBOOTSTRAP(1) NAME ---- -container-create-debootstrap - Create a basic Debian based container with debootstrap +container-create-debootstrap - Create a basic Debian based container with debootstrap or mmdebstrap 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) to create a Debian based container. +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: @@ -66,11 +69,11 @@ The following script options are available: EXAMPLES -------- -*Create a Debian 9 (stretch) based container with same architecture as the host system:*:: +*Create a Debian 9 (stretch) based container with same architecture as the host system using debootstrap:*:: sudo container create -s debootstrap -n stretch.example.net -*Create a Debian 9 (stretch) based container with different architecture as the host system:*:: - sudo container create -s debootstrap -n stretch-i386.example.net -- -a i386 +*Create a Debian 9 (stretch) based container with different architecture as the host system using mmdebstrap:*:: + sudo container create -s mmdebstrap -n stretch-i386.example.net -- -a i386 SEE ALSO diff --git a/share/man/container-create.1.txt b/share/man/container-create.1.txt index d36a694..5ba4637 100644 --- a/share/man/container-create.1.txt +++ b/share/man/container-create.1.txt @@ -31,6 +31,7 @@ container-create - Create a container SYNOPSIS -------- *container create* ['OPTIONS'] +*cnt cr* ['OPTIONS'] DESCRIPTION @@ -71,9 +72,6 @@ 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). @@ -86,9 +84,6 @@ The following container scripts are available: 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 diff --git a/share/man/container-key.1.txt b/share/man/container-key.1.txt deleted file mode 100644 index 7e7f376..0000000 --- a/share/man/container-key.1.txt +++ /dev/null @@ -1,86 +0,0 @@ -// Copyright (C) 2014-2019 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-KEY(1) -================ -:doctype: manpage -:man manual: Open Infrastructure -:man source: compute-tools -:man version: {revnumber} - - -NAME ----- -container-key - Manage GnuPG keyring for container operations - - -SYNOPSIS --------- -*container key* ['OPTIONS'] - - -DESCRIPTION ------------ -The container key manages the GnuPG keyring for container operations. - - -OPTIONS -------- -The following container options are available: - -*-a, --add='KEY'*:: - Add a key to the keyring. - -*-l, --list'*:: - List keys in the keyring. - -*-r, --remove='KEY'*:: - Remove a key from the keyring. - - -EXAMPLES --------- -*Add a key to the keyring:*:: - gpg --keyserver hkps://hkps.pool.sks-keyservers.net --recv 0x1E9B3AED2D9FA8F6 - gpg --armor --export 0x1E9B3AED2D9FA8F6 | sudo container key --add - - -*Remove a key from the keyring:*:: - sudo container key --remove 0x1E9B3AED2D9FA8F6 - - -SEE ALSO --------- -compute-tools(7), -container(1). - - -HOMEPAGE --------- -More information about compute-tools and the Open Infrastructure project can be found on the homepage at 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 at https://bugs.debian.org. - - -AUTHORS -------- -compute-tools were written by Daniel Baumann and others. diff --git a/share/man/container-limit.1.txt b/share/man/container-limit.1.txt deleted file mode 100644 index 62f0288..0000000 --- a/share/man/container-limit.1.txt +++ /dev/null @@ -1,109 +0,0 @@ -// Copyright (C) 2014-2019 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-LIMIT(1) -================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: compute-tools -:man version: {revnumber} - - -NAME ----- -container-limit - Limit ressources of a container - - -SYNOPSIS --------- -*container limit* ['OPTIONS'] - - -DESCRIPTION ------------ -The container limit command limits ressources available to a container at runtime. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - -*--blockio-device-weight='DEVICE WEIGHT'*:: - Specify device specific blockio weight, see systemd.resource-control(5). - -*--blockio-read-bandwidth='DEVICE BYTES'*:: - Specify device specific blockio read bandwidth, see systemd.resource-control(5). - -*-b, --blockio-weight='WEIGHT'*:: - Specify general blockio weight, see systemd.resource-control(5). - -*--blockio-write-bandwidth='DEVICE BYTES'*:: - Specify device specific blockio write bandwidth, see systemd.resource-control(5). - -*-c, --cpu-quota='QUOTA'*:: - Specify CPU quota, see systemd.resource-control(5). - -*--cpu-shares='SHARES'*:: - Specify CPU shares, see systemd.resource-control(5). - -*-m, --memory-limit='BYTES'*:: - Specify memory limit, see systemd.resource-control(5). - -*-t, --tasks-max='NUMBER'*:: - Specify tasks max, see systemd.resource-control(5). - - -EXAMPLES --------- -*Set blockio weight for the example.net container:*:: - sudo container limit -n example.net --blockio-weight 100 - -*Set CPU quota for the example.net container:*:: - sudo container limit -n example.net --cpu-quota 10% - -*Set memory limit for the example.net container to 1GB:*:: - sudo container limit -n example.net --memory-limit 1G - -*Set tasks max for the example.net container to 100:*:: - sudo container limit -n example.net --tasks-max 100 - - -SEE ALSO --------- -compute-tools(7), -container(1). - - -HOMEPAGE --------- -More information about compute-tools and the Open Infrastructure project can be found on the homepage at 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 at https://bugs.debian.org. - - -AUTHORS -------- -compute-tools were written by Daniel Baumann and others. diff --git a/share/man/container-list.1.txt b/share/man/container-list.1.txt index 1916a6b..897ea9c 100644 --- a/share/man/container-list.1.txt +++ b/share/man/container-list.1.txt @@ -31,7 +31,6 @@ container-list - List container on the system SYNOPSIS -------- *container list* ['OPTIONS'] - *container ls* ['OPTIONS'] diff --git a/share/man/container-move.1.txt b/share/man/container-move.1.txt index 2320dfb..5543ab2 100644 --- a/share/man/container-move.1.txt +++ b/share/man/container-move.1.txt @@ -31,8 +31,7 @@ container-move - Rename a container SYNOPSIS -------- *container move* ['OPTIONS'] - -*container mv* ['OPTIONS'] +*cnt mv* ['OPTIONS'] DESCRIPTION diff --git a/share/man/container-remove.1.txt b/share/man/container-remove.1.txt index b3fb1f7..cdcda76 100644 --- a/share/man/container-remove.1.txt +++ b/share/man/container-remove.1.txt @@ -31,8 +31,7 @@ container-remove - Remove a container SYNOPSIS -------- *container remove* ['OPTIONS'] - -*container rm* ['OPTIONS'] +*cnt rm* ['OPTIONS'] DESCRIPTION diff --git a/share/man/container-restart.1.txt b/share/man/container-restart.1.txt index f3780b6..d452f32 100644 --- a/share/man/container-restart.1.txt +++ b/share/man/container-restart.1.txt @@ -31,6 +31,7 @@ container-restart - Restart a container SYNOPSIS -------- *container restart* ['OPTIONS'] +*cnt rs* ['OPTIONS'] DESCRIPTION diff --git a/share/man/container-start.1.txt b/share/man/container-start.1.txt index 544d155..90750c0 100644 --- a/share/man/container-start.1.txt +++ b/share/man/container-start.1.txt @@ -31,6 +31,7 @@ container-start - Start a container SYNOPSIS -------- *container start* ['OPTIONS'] +*cnt s* ['OPTIONS'] DESCRIPTION diff --git a/share/man/container-status.1.txt b/share/man/container-status.1.txt index d4d06a9..86820df 100644 --- a/share/man/container-status.1.txt +++ b/share/man/container-status.1.txt @@ -31,6 +31,7 @@ container-status - Show container status SYNOPSIS -------- *container status* ['OPTIONS'] +*cnt st* ['OPTIONS'] DESCRIPTION diff --git a/share/man/container-stop.1.txt b/share/man/container-stop.1.txt index 62cfcd3..ec9e48d 100644 --- a/share/man/container-stop.1.txt +++ b/share/man/container-stop.1.txt @@ -31,6 +31,7 @@ container-stop - Stop a container SYNOPSIS -------- *container stop* ['OPTIONS'] +*cnt t* ['OPTIONS'] DESCRIPTION diff --git a/share/man/container-version.1.txt b/share/man/container-version.1.txt index d774401..060f393 100644 --- a/share/man/container-version.1.txt +++ b/share/man/container-version.1.txt @@ -32,8 +32,6 @@ SYNOPSIS -------- *container version* ['OPTIONS'] -*container ver* ['OPTIONS'] - DESCRIPTION ----------- diff --git a/share/man/container.1.txt b/share/man/container.1.txt index aba9141..224d6cc 100644 --- a/share/man/container.1.txt +++ b/share/man/container.1.txt @@ -75,12 +75,6 @@ The following container commands are available: *enter*:: Enter a container namespace, see container-enter(1). -*key*:: - Manage GnuPG keyring for container operations, see container-key(1). - -*limit*:: - Limit ressources of a container, see container-limit(1). - *list*:: List container on the system, see container-list(1). -- cgit v1.2.3