[lxc-devel] [lxd/master] Documentation improvements (instance type and github docs)

stgraber on Github lxc-bot at linuxcontainers.org
Thu Oct 5 21:53:40 UTC 2017


A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 301 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20171005/06ba99c2/attachment.bin>
-------------- next part --------------
From 3915c2044c0fa2818fcd8d1f700e03df7dcf149f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgraber at ubuntu.com>
Date: Thu, 5 Oct 2017 16:04:59 -0400
Subject: [PATCH 1/3] github: Refresh the issue template
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

 - Point to the forum for support questions
 - Update for snap paths
 - Request container config

Signed-off-by: Stéphane Graber <stgraber at ubuntu.com>
---
 .github/ISSUE_TEMPLATE.md | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index dd96d36de..240ec4a1d 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,4 +1,6 @@
-The template below is mostly useful for bug reports and support questions.
+Github issues are used for bug reports. For support questions, please use [our forum](https://discuss.linuxcontainers.org).
+
+Please fill the template below as it will greatly help us track down your issue and reproduce it on our side.  
 Feel free to remove anything which doesn't apply to you and add more information where it makes sense.
 
 # Required information
@@ -13,7 +15,9 @@ Feel free to remove anything which doesn't apply to you and add more information
 
 # Issue description
 
-A brief description of what failed or what could be improved.
+A brief description of the problem. Should include what you were
+attempting to do, what you did, what happened and what you expected to
+see happen.
 
 # Steps to reproduce
 
@@ -23,8 +27,9 @@ A brief description of what failed or what could be improved.
 
 # Information to attach
 
- - [ ] any relevant kernel output (`dmesg`)
- - [ ] container log (`lxc info NAME --show-log`)
- - [ ] main daemon log (`cat /var/log/lxd/lxd.log`)
- - [ ] output of the client with --debug
- - [ ] output of the daemon with --debug
+ - [ ] Any relevant kernel output (`dmesg`)
+ - [ ] Container log (`lxc info NAME --show-log`)
+ - [ ] Container configuration (`lxc config show NAME --expanded`)
+ - [ ] Main daemon log (at /var/log/lxd/lxd.log or /var/snap/lxd/common/lxd/logs/lxd.log)
+ - [ ] Output of the client with --debug
+ - [ ] Output of the daemon with --debug (alternatively output of `lxc monitor` while reproducing the issue)

From 18db580756136b6aa8d7604c5ba70ca45d8f2992 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgraber at ubuntu.com>
Date: Thu, 5 Oct 2017 16:11:05 -0400
Subject: [PATCH 2/3] github: Add SUPPORT.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This points to various support resources.

Signed-off-by: Stéphane Graber <stgraber at ubuntu.com>
---
 .github/SUPPORT.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 .github/SUPPORT.md

diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
new file mode 100644
index 000000000..eb3988f7d
--- /dev/null
+++ b/.github/SUPPORT.md
@@ -0,0 +1,10 @@
+The following support resources are available to LXD users:
+
+ - Official documentation: https://lxd.readthedocs.org/en/latest
+ - Community forum: https://discuss.linuxcontainers.org
+ - Various howtos and blog posts: https://linuxcontainers.org/lxd/articles
+ - Users mailing-list: https://lists.linuxcontainers.org/listinfo/lxc-users
+ - IRC channel: #lxcontainers on irc.freenode.net
+
+
+Commercial support for LXD can be obtained through [Canonical Ltd](https://www.canonical.com)

From 4cdf58d6169fa452d269a589a6cb22eec98f8e85 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Graber?= <stgraber at ubuntu.com>
Date: Thu, 5 Oct 2017 16:18:15 -0400
Subject: [PATCH 3/3] doc: Document instance types
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/doc/containers.md b/doc/containers.md
index 591868919..5070b3d03 100644
--- a/doc/containers.md
+++ b/doc/containers.md
@@ -291,3 +291,28 @@ uid         | int       | 0                 | no        | UID of the device owne
 gid         | int       | 0                 | no        | GID of the device owner in the container
 mode        | int       | 0660              | no        | Mode of the device in the container
 
+## Instance types
+LXD supports simple instance types. Those are represented as a string
+which can be passed at container creation time.
+
+There are three allowed syntaxes:
+
+ - `<instance type>`
+ - `<cloud>:<instance type>`
+ - `c<CPU>-m<RAM in GB>`
+
+For example, those 3 are equivalent:
+
+ - t2.micro
+ - aws:t2.micro
+ - c1-m1
+
+On the command line, this is passed like this:
+
+```bash
+lxc launch ubuntu:16.04 my-container -t t2.micro
+```
+
+The list of supported clouds and instance types can be found here:
+
+  https://github.com/dustinkirkland/instance-type


More information about the lxc-devel mailing list