summaryrefslogtreecommitdiffstats
path: root/share/man/container-build-debconf.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--share/man/container-build-debconf.1202
1 files changed, 202 insertions, 0 deletions
diff --git a/share/man/container-build-debconf.1 b/share/man/container-build-debconf.1
new file mode 100644
index 0000000..86c5058
--- /dev/null
+++ b/share/man/container-build-debconf.1
@@ -0,0 +1,202 @@
+.\" 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/>.
+.\"
+.
+.TH CONTAINER-BUILD-DEBCONF 1 compute-tools "Open Infrastructure"
+.SH NAME
+container-build-debconf \- Build an advanced Debian based container with debconf
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.nf
+\fBcontainer build \-s debconf\fP [\(aqOPTIONS\(aq]
+\fBcnt b \-s debconf\fP [\(aqOPTIONS\(aq]
+.fi
+.sp
+.nf
+\fBcontainer build \-s debian\fP [\(aqOPTIONS\(aq]
+\fBcnt b \-s debian\fP [\(aqOPTIONS\(aq]
+.fi
+.sp
+.nf
+\fBcontainer build \-s progress\-linux\fP [\(aqOPTIONS\(aq]
+\fBcnt b \-s progress\-linux\fP [\(aqOPTIONS\(aq]
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+The debconf container build script uses debconf(1) to automatically build a
+Debian based container.
+.SS Scope
+.sp
+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.
+.sp
+But: this is \fInot\fP 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.
+.sp
+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.
+.SS Functions
+.sp
+This script performs the following configuration on top of a Debian based
+system:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+network
+.IP \(bu 2
+root password
+.IP \(bu 2
+apt repositories
+.IP \(bu 2
+\&...
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS Modes
+.sp
+This container build script can be used under two different names: debian and
+progress\-linux.
+.sp
+Alternative, calling it under the debconf name is equal to the debian mode.
+.SS Preseeding
+.sp
+Hierarchy of Preseed Files:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+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).
+.IP \(bu 2
+The general rule of \(aqthe later preseed file overwrites the earlier\(aq 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.
+.IP \(bu 2
+That means that debconf values after the include statement in the main
+preseed file can overwrite any values specified in the included preseed
+files.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH OPTIONS
+.sp
+The following script options are available:
+.INDENT 0.0
+.TP
+.B \-n, \-\-name=\(aqNAME\(aq:
+Specify container name.
+.TP
+.B \-p, \-\-preseed\-file=\(aqFILE\(aq:
+Specify the preseed file.
+.UNINDENT
+.SH EXAMPLES
+.sp
+Build a Debian based container:
+.INDENT 0.0
+.INDENT 3.5
+sudo container build \-s debian \-n debian.example.net
+.UNINDENT
+.UNINDENT
+.sp
+Build a Progress Linux container:
+.INDENT 0.0
+.INDENT 3.5
+sudo container build \-s progress\-linux \-n progress.example.net
+.UNINDENT
+.UNINDENT
+.SH FILES
+.sp
+The following files are used:
+.INDENT 0.0
+.TP
+.B /etc/compute\-tools/config:
+Container configuration files.
+.TP
+.B /usr/share/compute\-tools/build\-scripts:
+Container build scripts.
+.TP
+.B /usr/share/doc/compute\-tools:
+Container documentation.
+.TP
+.B /var/lib/machines:
+Container directory.
+.TP
+.B /var/cache/container:
+Container cache directory.
+.TP
+.B /tmp/compute\-tools:
+Container temporary directory.
+.UNINDENT
+.SH SEE ALSO
+.nf
+compute\-tools(7),
+container(1).
+.fi
+.sp
+.SH HOMEPAGE
+.sp
+More information about compute\-tools and the Open Infrastructure project can be
+found on the homepage (\fI\%https://open\-infrastructure.net\fP).
+.SH CONTACT
+.sp
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<\fI\%software@lists.open\-infrastructure.net\fP>.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(\fI\%https://bugs.debian.org\fP).
+.SH AUTHORS
+.sp
+compute\-tools were written by Daniel Baumann
+<\fI\%daniel.baumann@open\-infrastructure.net\fP> and others.
+.