summaryrefslogtreecommitdiffstats
path: root/share/man/container-create-debconf.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container-create-debconf.1')
-rw-r--r--share/man/container-create-debconf.1179
1 files changed, 179 insertions, 0 deletions
diff --git a/share/man/container-create-debconf.1 b/share/man/container-create-debconf.1
new file mode 100644
index 0000000..1e2db07
--- /dev/null
+++ b/share/man/container-create-debconf.1
@@ -0,0 +1,179 @@
+'\" t
+.\" Title: container-create-debootstrap
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 20161112
+.\" Manual: Open Infrastructure
+.\" Source: container-tools
+.\" Language: English
+.\"
+.TH "CONTAINER\-CREATE\-D" "1" "20161112" "container\-tools" "Open Infrastructure"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+container-create-debconf \- Create an advanced Debian based container with debconf
+.SH "SYNOPSIS"
+.sp
+\fBcontainer create \-s debconf\fR [\fIOPTIONS\fR] \fBcontainer create \-s debian\fR [\fIOPTIONS\fR] \fBcontainer create \-s progress\-linux\fR [\fIOPTIONS\fR]
+.SH "DESCRIPTION"
+.sp
+The debconf container creation script uses debconf(1) to automatically create a Debian based container\&.
+.SS "SCOPE"
+.sp
+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\&.
+.sp
+But: this is \fBnot\fR 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\&.
+.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\&. (FIXME)
+.SS "FUNCTIONS"
+.sp
+This script performs the following configuration on top of a Debian based system:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+network
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+root password
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+apt repositories
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\&...
+.RE
+.SS "MODES"
+.sp
+This container creation 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 "INTERACTIVE/NONINTERACTIVE"
+.sp
+FIXME
+.SS "PRESEEDING"
+.sp
+Hierarchy of Preseed Files
+.sp
+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)\&.
+.sp
+The general rule of \fIthe later preseed file overwrites the earlier\fR 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\&.
+.sp
+That means that debconf values after the include statement in the main preseed file can overwrite any values specified in the included preseed files\&.
+.SH "OPTIONS"
+.sp
+The following script options are available:
+.PP
+\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR
+.RS 4
+Specify container name\&.
+.RE
+.PP
+\fB\-p, \-\-preseed\-file=\fR\fB\fIFILE\fR\fR
+.RS 4
+Specify the preseed file\&.
+.RE
+.SH "EXAMPLES"
+.PP
+\fBCreate a Debian based container:\fR
+.RS 4
+sudo container create \-s debian \-n stretch\&.example\&.net
+.RE
+.PP
+\fBCreate a Progress Linux container:\fR
+.RS 4
+sudo container create \-s progress\-linux \-n cairon\-backports\&.example\&.net
+.RE
+.SH "FILES"
+.sp
+The following files are used:
+.PP
+\fB/etc/container\-tools/config\fR
+.RS 4
+Container configuration files\&.
+.RE
+.PP
+\fB/usr/share/container\-tools/scripts\fR
+.RS 4
+Container creation scripts\&.
+.RE
+.PP
+\fB/usr/share/doc/container\-tools\fR
+.RS 4
+Container documentation\&.
+.RE
+.PP
+\fB/var/lib/machines\fR
+.RS 4
+Container directory\&.
+.RE
+.PP
+\fB/var/cache/container\-tools\fR
+.RS 4
+Container cache directory\&.
+.RE
+.PP
+\fB/tmp/container\-tools\fR
+.RS 4
+Container temporary directory\&.
+.RE
+.SH "SEE ALSO"
+.sp
+container\-tools(7), container(1)\&.
+.SH "HOMEPAGE"
+.sp
+More information about container\-tools and the Open Infrastructure project can be found on the homepage at https://open\-infrastructure\&.net\&.
+.SH "CONTACT"
+.sp
+Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List software@lists\&.open\-infrastructure\&.net\&.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs\&.debian\&.org\&.
+.SH "AUTHORS"
+.sp
+container\-tools was written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net>\&.