From 771ee09fa6b7cdc69f856c51bd7c52dc1ffad89a Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 5 Jun 2022 10:15:14 +0200 Subject: Adding container-config manpage stub (FIXME). Signed-off-by: Daniel Baumann --- share/man/container-config.5.rst | 116 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 share/man/container-config.5.rst diff --git a/share/man/container-config.5.rst b/share/man/container-config.5.rst new file mode 100644 index 0000000..504d848 --- /dev/null +++ b/share/man/container-config.5.rst @@ -0,0 +1,116 @@ +.. Open Infrastructure: compute-tools + +.. Copyright (C) 2014-2022 Daniel Baumann +.. +.. 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 . + +================ +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 +. + +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 + and others. -- cgit v1.2.3