summaryrefslogtreecommitdiffstats
path: root/share/man/container-create-debconf.1.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@open-infrastructure.net>2021-07-24 23:34:57 +0000
committerDaniel Baumann <daniel.baumann@open-infrastructure.net>2021-07-25 05:27:45 +0000
commit349fa0be0f4a851d75262628a081beb442089b2b (patch)
tree5fbfb14b4ab4d9b42c35f64871a9dce9aeaa066c /share/man/container-create-debconf.1.rst
parentUpdating build relevant stuff to move from asciidoc to rst for manpage genera... (diff)
downloadcompute-tools-349fa0be0f4a851d75262628a081beb442089b2b.tar.xz
compute-tools-349fa0be0f4a851d75262628a081beb442089b2b.zip
Migrationg manpages from asciidoc to rst.
Signed-off-by: Daniel Baumann <daniel.baumann@open-infrastructure.net>
Diffstat (limited to '')
-rw-r--r--share/man/container-create-debconf.1.rst173
1 files changed, 173 insertions, 0 deletions
diff --git a/share/man/container-create-debconf.1.rst b/share/man/container-create-debconf.1.rst
new file mode 100644
index 0000000..b135b46
--- /dev/null
+++ b/share/man/container-create-debconf.1.rst
@@ -0,0 +1,173 @@
+.. Open Infrastructure: compute-tools
+
+.. Copyright (C) 2014-2021 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-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 managment 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 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
+<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.