[lxc-devel] [lxd/master] doc: Document hostname requirements

[stgraber on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 370 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20180704/db8b9f5d/attachment.bin>
-------------- next part --------------
From 16a174bab0743287a283f920d49aadecdd4389cf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgraber at ubuntu.com>
Date: Wed, 4 Jul 2018 13:42:07 -0400
Subject: [PATCH] doc: Document hostname requirements
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Closes #4734

Signed-off-by: Stéphane Graber <stgraber at ubuntu.com>
---
 doc/containers.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/containers.md b/doc/containers.md
index 7517c8d0a..b1866d913 100644
--- a/doc/containers.md
+++ b/doc/containers.md
@@ -7,6 +7,17 @@ The following are direct container properties and can't be part of a profile:
 
 Name is the container name and can only be changed by renaming the container.
 
+Valid container names must:
+
+ - Be between 1 and 63 characters long
+ - Be made up exclusively of letters, numbers and dashes from the ASCII table
+ - Not start with a digit or a dash
+ - Not end with a dash
+
+This requirement is so that the container name may properly be used in
+DNS records, on the filesystem, in various security profiles as well as
+the hostname of the container itself.
+
 ## Key/value configuration
 The key/value configuration is namespaced with the following namespaces
 currently supported: