summaryrefslogtreecommitdiffstats
path: root/share/man/container-create.1
blob: 70dabf2b8712ac9f6e247188a59bb03c72a24fbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
'\" t
.\"     Title: container-create
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 20190304
.\"    Manual: Open Infrastructure
.\"    Source: compute-tools
.\"  Language: English
.\"
.TH "CONTAINER\-CREATE" "1" "20190304" "compute\-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 \- Create a container
.SH "SYNOPSIS"
.sp
\fBcontainer create\fR [\fIOPTIONS\fR] \fBcnt cr\fR [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.sp
The container\-create command creates a container based on a script\&.
.SH "OPTIONS"
.sp
The following container\-create options are available:
.PP
\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR
.RS 4
Specify container name\&.
.RE
.PP
\fB\-c, \-\-capability=\fR\fB\fICAPABILITY\fR\fR
.RS 4
Specify capabilities to grant, see capabilities(7)\&.
.RE
.PP
\fB\-d, \-\-drop\-capability=\fR\fB\fIDROP_CAPABILITY\fR\fR
.RS 4
Specify capabilities to drop, see capabilities(7)\&.
.RE
.PP
\fB\-s, \-\-script=\fR\fB\fISCRIPT\fR\fR
.RS 4
Specify container creation script, defaults to debootstrap\&.
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Explain what is being done\&.
.RE
.PP
\fB\-b, \-\-bind=\fR\fB\fIDIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]\fR\fR
.RS 4
Specify container read\-write bind mounts, see systemd\-nspawn(1) \-\-bind option\&.
.RE
.PP
\fB\-\-bind\-ro=\fR\fB\fIDIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]\fR\fR
.RS 4
Specify container read\-only bind mounts, see systemd\-nspawn(1) \-\-bind\-ro option\&.
.RE
.PP
\fB\-\-cnt\-overlay=\fR\fB\fIDIRECTORY_LOWER:DIRECTORY_UPPER:DIRECTORY_WORK:DIRECTORY_MERGED[;DIRECTORY_UPPER:DIRECTORY_LOWER:DIRECTORY_WORK:DIRECTORY_MERGED]\fR\fR
.RS 4
Specify container overlay mounts, see Documentation/filesystems/overlayfs\&.txt\&.
.RE
.SH "SCRIPTS"
.sp
The following container scripts are available:
.PP
\fBcurl\fR
.RS 4
Basic script to create Debian based container, see container\-create\-curl(1)\&.
.RE
.PP
\fBdebootstrap\fR
.RS 4
Basic script to create Debian based container, see container\-create\-debootstrap(1)\&.
.RE
.PP
\fBdebconf\fR
.RS 4
Advanced script to automatically create Debian based container, see container\-create\-debconf(1)\&.
.RE
.PP
\fBdefault\fR
.RS 4
Symlink (if existing) to a container script which is used if no script was specified\&. On Debian based system this can be managed through update\-alternatives(1), i\&.e\&.
\fIsudo update\-alternatives \-\-config container_script\fR\&.
.RE
.SH "EXAMPLES"
.PP
\fBCreate example\&.net container using curl script:\fR
.RS 4
sudo container create \-n example\&.net \-s curl
.RE
.PP
\fBCreate example\&.net container using debootstrap script:\fR
.RS 4
sudo container create \-n example\&.net \-s debootstrap
.RE
.PP
\fBCreate example\&.net container using debconf script:\fR
.RS 4
sudo container create \-n example\&.net \-s debconf
.RE
.PP
\fBCreate example\&.net container with the default create script and start it:\fR
.RS 4
sudo container create,start \-n example\&.net
.RE
.SH "SEE ALSO"
.sp
compute\-tools(7), container(1)\&.
.SH "HOMEPAGE"
.sp
More information about compute\-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
compute\-tools were written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net> and others\&.