diff options
Diffstat (limited to '')
-rw-r--r-- | share/man/container-create-curl.1.txt | 116 | ||||
-rw-r--r-- | share/man/container-create.1.txt | 6 | ||||
-rw-r--r-- | share/man/container-tools.7.txt | 11 | ||||
-rw-r--r-- | share/man/container-version.1.txt | 2 |
4 files changed, 132 insertions, 3 deletions
diff --git a/share/man/container-create-curl.1.txt b/share/man/container-create-curl.1.txt new file mode 100644 index 0000000..f310eaf --- /dev/null +++ b/share/man/container-create-curl.1.txt @@ -0,0 +1,116 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann <daniel.baumann@open-infrastructure.net> +// +// 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 <http://www.gnu.org/licenses/>. + +CONTAINER-CREATE-CURL(1) +======================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-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. + +*--image='IMAGE'*:: + Specify the image name to download, defaults to debian-stretch-${ARCHITECTURE}.tar.xz (where ${ARCHITECTURE} is the host systems architecture). + +*--server='SERVER'*:: + Specify the image server to download from, defaults to https://files.open-infrastructure.net/images/container-tools/current. + +*-p, --root-password='PASSWORD'*:: + Specify the root password, defaults to a random 16 character password. + + +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 -- --image debian-stretch-i386.tar.xz + +FILES +----- +The following files are used: + +*/etc/container-tools/config*:: + Container configuration files. + +*/usr/share/container-tools/scripts*:: + Container creation scripts. + +*/usr/share/doc/container-tools*:: + Container documentation. + +*/var/lib/machines*:: + Container directory. + +*/var/cache/container-tools*:: + Container cache directory. + + +CONTAINER IMAGES +---------------- + +container-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 +-------- +container-tools(7), +container(1). + + +HOMEPAGE +-------- +More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. + + +BUGS +---- +Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. + + +AUTHORS +------- +container-tools was written by Daniel Baumann <daniel.baumann@open-infrastructure.net>. diff --git a/share/man/container-create.1.txt b/share/man/container-create.1.txt index 4fe592f..6918585 100644 --- a/share/man/container-create.1.txt +++ b/share/man/container-create.1.txt @@ -64,6 +64,9 @@ 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). @@ -76,6 +79,9 @@ 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-tools.7.txt b/share/man/container-tools.7.txt index 2e71b05..23f8403 100644 --- a/share/man/container-tools.7.txt +++ b/share/man/container-tools.7.txt @@ -63,14 +63,19 @@ DEBIAN 9 (STRETCH) AND NEWER DEVELOPMENT ----------- -Bug reports, feature requests, and patches are welcome via Debian Bug Tracking System: +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List: - * https://bugs.debian.org + * https://lists.open-infrastructure.net/listinfo/software -Please base them against the 'next' Git branch using common sense: +Please base patches against the 'next' Git branch using common sense: * https://www.kernel.org/doc/Documentation/SubmittingPatches +Debian specific bugs can also be reported in the Debian Bug Tracking System: + + * https://bugs.debian.org + KNOWN LIMITATIONS ----------------- diff --git a/share/man/container-version.1.txt b/share/man/container-version.1.txt index 5e50ad4..9b0ae5e 100644 --- a/share/man/container-version.1.txt +++ b/share/man/container-version.1.txt @@ -31,6 +31,8 @@ SYNOPSIS -------- *container version* ['OPTIONS'] +*container ver* ['OPTIONS'] + DESCRIPTION ----------- |