summaryrefslogtreecommitdiffstats
path: root/share/man/container-config.5.rst
blob: 504d848028ed23a96fef56cfe4f8e39f3067b5f7 (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
.. Open Infrastructure: compute-tools

.. Copyright (C) 2014-2022 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-config
================

----------------------------
Container configuration file
----------------------------

:manual section: 5
:manual group: Open Infrastructure

Name
====

| **$container**.conf

Description
===========

Containers managed by compute-tools have a container configuration file in
/etc/compute-tools/config/\*.conf.

This manpage descripts all available configuration file options.

Options
=======

The following **container** options are available:

Section 'start'
---------------

cnt.auto:
  This setting controls wheter the container will be started automatically on boot.
  Allowed values are: true (always started), false (never started),
  force-true (always started, even after e.g. powerloss),
  last-on (previous state, fallback to on), last-off (previous state, fallback to off)

cnt.container-server:
  When using central storage to keep all container shared on e.g. a NFS volume,
  this allows binding containers to individual container servers, so that it is
  started (and show) only once. See container-list(1) command for further details.

cnt.network-bridge:
  This setting pairs the container network interface to a bridge on the host,
  e.g. "veth-123:bridge-456"

cnt.overlay:
cnt.overlay-options:
  This settings configure automatic overlay filesystem usage.

cnt.start:
  Same as cnt.auto, except that it applies to every start, rather than at
  startup of the host system.

bind:
bind-ro:
  This settings configure automatic bind mounts from the host into the container.

boot:
capability:
directory:
drop-capability:
link-journal:
machine:
network-veth-extra:
private-users:
register:
  FIXME.

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
<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.