[lxc-devel] [pylxd/master] Update containers.rst

[Synforge on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 506 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20170507/701a82a8/attachment.bin>
-------------- next part --------------
From 39645926a0f97d3347abebd306bb0b3a1745b414 Mon Sep 17 00:00:00 2001
From: Paul Oyston <paul at synforge.com>
Date: Sun, 7 May 2017 15:47:22 +0100
Subject: [PATCH] Update containers.rst

When creating a container the documentation stated that config source type should be image and an image key should be present to define the image. However this should be {'type': 'image', 'alias': '...'}.
---
 doc/source/containers.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/source/containers.rst b/doc/source/containers.rst
index 014288f..0537707 100644
--- a/doc/source/containers.rst
+++ b/doc/source/containers.rst
@@ -107,7 +107,7 @@ container.
 
 .. code-block:: python
 
-    >>> config = {'name': 'my-container', 'source': {'type': 'image', 'image': 'ubuntu/trusty'}}
+    >>> config = {'name': 'my-container', 'source': {'type': 'image', 'alias': 'ubuntu/trusty'}}
     >>> container = client.containers.create(config, wait=True)
     >>> container.start()
     >>> container.freeze()