[lxc-devel] [lxd/master] Networks: Adds example usage of --type flag

[tomponline on Github]

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/20200722/6217be84/attachment.bin>
-------------- next part --------------
From d25670d5d05fbccb821f79bdfbe84b5958d8e680 Mon Sep 17 00:00:00 2001
From: Thomas Parrott <thomas.parrott at canonical.com>
Date: Wed, 22 Jul 2020 11:29:08 +0100
Subject: [PATCH] doc/networks: Adds example usage of --type flag

Signed-off-by: Thomas Parrott <thomas.parrott at canonical.com>
---
 doc/networks.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/doc/networks.md b/doc/networks.md
index 46ab740a16..00cd21063d 100644
--- a/doc/networks.md
+++ b/doc/networks.md
@@ -2,10 +2,18 @@
 
 LXD supports the following network types:
 
- - [bridge](#network-bridge): Creates an L2 bridge for connecting instances to (can provide local DHCP and DNS).
+ - [bridge](#network-bridge): Creates an L2 bridge for connecting instances to (can provide local DHCP and DNS). This is the default.
  - [macvlan](#network-macvlan): Provides preset configuration to use when connecting instances to a parent macvlan interface.
  - [sriov](#network-sriov): Provides preset configuration to use when connecting instances to a parent SR-IOV interface.
 
+The desired type can be specified using the `--type` argument, e.g.
+
+```bash
+lxc network create <name> --type=bridge [options...]
+```
+
+If no `--type` argument is specified, the default type of `bridge` is used.
+
 The configuration keys are namespaced with the following namespaces currently supported for all network types:
 
  - `maas` (MAAS network identification)