From b5b74b561d10b8c627bcf49b0234d1fb22b9c09f Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 25 Jul 2021 09:54:36 +0200 Subject: Making previous container curl create script a container get script. Signed-off-by: Daniel Baumann --- share/man/container-build.1.rst | 3 - share/man/container-create-curl.1.rst | 148 ---------------------------------- share/man/container-get-curl.1.rst | 148 ++++++++++++++++++++++++++++++++++ 3 files changed, 148 insertions(+), 151 deletions(-) delete mode 100644 share/man/container-create-curl.1.rst create mode 100644 share/man/container-get-curl.1.rst (limited to 'share/man') diff --git a/share/man/container-build.1.rst b/share/man/container-build.1.rst index 55f2a9b..d4d7fc5 100644 --- a/share/man/container-build.1.rst +++ b/share/man/container-build.1.rst @@ -44,9 +44,6 @@ 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). diff --git a/share/man/container-create-curl.1.rst b/share/man/container-create-curl.1.rst deleted file mode 100644 index ccf5f3c..0000000 --- a/share/man/container-create-curl.1.rst +++ /dev/null @@ -1,148 +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-curl -===================== - -------------------------------------------------------------------------- -Create a Debian based container by downloading a tarball over the network -------------------------------------------------------------------------- - -:manual section: 1 -:manual group: Open Infrastructure - -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) - -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. - -Options -======= - -The following script options are available: - --n, --name='NAME': - Specify container name. - --a, --architecture='ARCHITECTURE': - Specify container architecture. - ---clean: - Remove downloaded tarball after successful 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 (where - ${COMPRESSION} is either lz, xz, or gz depending on compressor availability on - the host system). - ---system='SYSTEM': - Specify the system image name to download, defaults to - debian-bullseye-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 11 (bullseye) based container with same architecture as the host -system: - - sudo container create -s curl -n bullseye.example.net - -Create a Debian 11 (bullseye) based container with different architecture as the -host system: - - sudo container create -s curl -n bullseye-i386.example.net -- --system debian-bullseye-current_i386.system.tar.xz - -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. - -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-get-curl.1.rst b/share/man/container-get-curl.1.rst new file mode 100644 index 0000000..ba44ba0 --- /dev/null +++ b/share/man/container-get-curl.1.rst @@ -0,0 +1,148 @@ +.. 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-get-curl +================== + +--------------------------------------------------------------------------- +Download a Debian based container by downloading a tarball over the network +--------------------------------------------------------------------------- + +:manual section: 1 +:manual group: Open Infrastructure + +Synopsis +======== + +| **container get -s curl** ['OPTIONS'] + +Description +=========== + +The curl container download 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) + +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. + +Options +======= + +The following script options are available: + +-n, --name='NAME': + Specify container name. + +-a, --architecture='ARCHITECTURE': + Specify container architecture. + +--clean: + Remove container tarball after successful download. + +-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 (where + ${COMPRESSION} is either lz, xz, or gz depending on compressor availability on + the host system). + +--system='SYSTEM': + Specify the system image name to download, defaults to + debian-bullseye-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 +system: + + sudo container get -s curl -n bullseye.example.net + +Download a Debian 11 (bullseye) 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 + +Files +===== + +The following files are used: + +/etc/compute-tools/config: + Container configuration files. + +/usr/share/compute-tools/get-scripts: + Container download scripts. + +/usr/share/doc/compute-tools: + Container documentation. + +/var/lib/machines: + Container directory. + +/var/cache/container: + Container cache 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. -- cgit v1.2.3