[pve-devel] [PATCH v2 pve-network 13/13] add documentation.txt

[Alexandre Derumier]

Signed-off-by: Alexandre Derumier <aderumier at odiso.com>
---
 test/documentation.txt | 82 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 test/documentation.txt

diff --git a/test/documentation.txt b/test/documentation.txt
new file mode 100644
index 0000000..567b798
--- /dev/null
+++ b/test/documentation.txt
@@ -0,0 +1,82 @@
+Here a sample of command with pvesh to manage the sdn.
+
+
+#create a vlan transportzone
+pvesh create /cluster/sdn/ --sdn vlanzone --type vlan --uplink-id 1
+
+
+#create a layer2 vxlan multicast transportzone
+pvesh create /cluster/sdn/ --sdn vxlanmulticastzone --type vxlan --uplink-id 1 --multicast-address 239.192.114.23
+
+#create a layer2 vxlan unicast transportzone
+pvesh create /cluster/sdn/ --sdn vxlanunicastzone --type vxlan --uplink-id 1 --unicast-address 192.168.0.1,192.168.0.2,192.168.0.3
+
+#create a frr router
+pvesh create /cluster/sdn/ --sdn frrrouter1 --type frr --uplink-id 1 --peers 192.168.0.1,192.168.0.2,192.168.0.3 --asn 1234
+
+#create a layer2 vxlan bgpevpn transportzone
+pvesh create /cluster/sdn/ --sdn layer2evpnzone --type vxlan --uplink-id 1 --router frrrouter1
+
+#create a layer3 routable vxlan bgpevpn transportzone
+pvesh create /cluster/sdn/ --sdn layer3evpnzone --type vxlan --uplink-id 1 --router frrrouter1 --vrf vrf1 --vrf-vxlan 4000
+
+
+#create a vnet in the transportzone
+pvesh create /cluster/sdn/ --sdn vnet10 --type vnet --transportzone vlanzone --tag 10
+
+#create a vnet in the transportzone with ip for evpn routing
+pvesh create /cluster/sdn/ --sdn vnet11 --type vnet --transportzone layer3evpnzone --tag 11 --ipv4 10.0.0.1/24 --mac c8:1f:66:f8:62:8d
+pvesh create /cluster/sdn/ --sdn vnet12 --type vnet --transportzone layer3evpnzone --tag 12 --ipv4 10.0.1.1/24 --mac c8:1f:66:f8:62:8e
+
+
+#apply changes from /etc/pve/sdn.cfg.new to /etc/pve/sdn.cfg
+pvesh set /cluster/sdn
+
+
+#generate local /etc/network/interfaces.d/sdn  and reload  (need to be called on each node)
+ pvesh set /nodes/<node>/network
+
+
+display transporzone status on all cluster nodes
+#pvesh get /cluster/resources    
+┌────────────────────────────────────┬─────────┬───────┬───────────┬─────────┬───────┬────────┬─────────────┬────────────┬────────────┬───────────────┬──────┬───────────┬──────────────┬────────────────┐
+│ id                                 │ type    │   cpu │ disk      │ hastate │ level │ maxcpu │     maxdisk │     maxmem │ mem        │ node          │ pool │ status    │ storage      │         uptime │
+│ sdn/node1/transportzone10          │ sdn     │       │           │         │       │        │             │            │            │ kvmformation1 │      │ error     │              │                │
+├────────────────────────────────────┼─────────┼───────┼───────────┼─────────┼───────┼────────┼─────────────┼────────────┼────────────┼───────────────┼──────┼───────────┼──────────────┼────────────────┤
+│ sdn/node1/zone1                    │ sdn     │       │           │         │       │        │             │            │            │ node1         │      │ available │              │                │
+├────────────────────────────────────┼─────────┼───────┼───────────┼─────────┼───────┼────────┼─────────────┼────────────┼────────────┼───────────────┼──────┼───────────┼──────────────┼────────────────┤
+│ sdn/node1/zone4                    │ sdn     │       │           │         │       │        │             │            │            │ node1         │      │ available │              │                │
+├────────────────────────────────────┼─────────┼───────┼───────────┼─────────┼───────┼────────┼─────────────┼────────────┼────────────┼───────────────┼──────┼───────────┼──────────────┼────────────────┤
+
+
+
+
+#list all transport zones of a node
+
+pvesh get /nodes/<node>/sdn/
+    ┌─────────────────┬───────────┐
+    │ sdn             │ status    │
+    ├─────────────────┼───────────┤
+    │ transportzone10 │ error     │
+    ├─────────────────┼───────────┤
+    │ zone1           │ available │
+    ├─────────────────┼───────────┤
+    │ zone4           │ available │
+    └─────────────────┴───────────┘
+
+
+#list all vnet status from a node transportzone
+
+pveset get /nodes/<node>/sdn/<transportzone>/content
+    
+    ┌─────────┬────────┐
+    │ vnet    │ status │
+    ├─────────┼────────┤
+    │ vnet100 │ error  │
+    ├─────────┼────────┤
+    │ vnet101 │ error  │
+    └─────────┴────────┘
+
+
+
+
-- 
2.20.1