[pve-devel] [PATCH pve-docs 0/2] simple zone + subnet/ipam documentation

[pve-devel] [PATCH pve-docs 0/2] simple zone + subnet/ipam documentation

[Alexandre Derumier]

Following last pve-network patches

Alexandre Derumier (2):
  sdn: add simple zone plugin documentation
  sdn : add subnet/ipam documentation

 pvesdn.adoc | 79 +++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 71 insertions(+), 8 deletions(-)

-- 
2.20.1

[pve-devel] [PATCH pve-docs 1/2] sdn: add simple zone plugin documentation

[Alexandre Derumier]

Signed-off-by: Alexandre Derumier <aderumier@odiso.com>
---
 pvesdn.adoc | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/pvesdn.adoc b/pvesdn.adoc
index c1597b8..ed8652d 100644
--- a/pvesdn.adoc
+++ b/pvesdn.adoc
@@ -142,12 +142,22 @@ Common options
 nodes:: Deploy and allow to use a VNets configured for this Zone only on these
 nodes.
 
+[[pvesdn_zone_plugin_simple]]
+Simple Zones
+~~~~~~~~~~~~
+
+This is the simplest plugin, it will create an isolated vnet bridge.
+This bridge is not linked to physical interfaces, VM traffic is only
+local to the node(s).
+It can be used for NAT or routed setup.
+
+
 [[pvesdn_zone_plugin_vlan]]
 VLAN Zones
 ~~~~~~~~~~
 
-This is the simplest plugin, it will reuse an existing local Linux or OVS
-bridge, and manage VLANs on it.
+This plugin will reuse an existing local Linux or OVS bridge, 
+and manage VLANs on it.
 The benefit of using SDN module, is that you can create different zones with
 specific VNets VLAN tag, and restrict Virtual Machines to separated zones.
 
-- 
2.20.1

[pve-devel] [PATCH pve-docs 2/2] sdn : add subnet/ipam documentation

[Alexandre Derumier]

Signed-off-by: Alexandre Derumier <aderumier@odiso.com>
---
 pvesdn.adoc | 65 ++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 59 insertions(+), 6 deletions(-)

diff --git a/pvesdn.adoc b/pvesdn.adoc
index ed8652d..5aeb0c0 100644
--- a/pvesdn.adoc
+++ b/pvesdn.adoc
@@ -64,6 +64,9 @@ On the web-interface  SDN feature have 4 main sections for the configuration
 
 * Controller: For complex setups to control Layer 3 routing
 
+* Subnets: Used to defined ip networks on Vnets.
+
+* Ipams: Allow to use external tools for ip managements (vm/ct ips)
 
 [[pvesdn_config_main_sdn]]
 SDN
@@ -117,12 +120,7 @@ VNet properties are:
 * VLAN Aware: Allow to add an extra VLAN tag in the virtual machine or
   container vNIC configurations or allow the guest OS to manage the VLAN's tag.
 
-* IPv4: an anycast IPv4 address, it will be configured on the underlying bridge
-  on each node part of the Zone. It's only useful for `bgp-evpn` routing.
-
-* IPv6: an anycast IPv6 address, it will be configured on the underlying bridge
-  on each node part of the Zone. It's only useful for `bgp-evpn` routing.
-
+* Subnets: A list of associated subnets for this Vnet
 
 [[pvesdn_config_controllers]]
 Controllers
@@ -269,6 +267,61 @@ gateway, but, for example, sent traffic to external BGP routers, which handle
 (reverse) routing then dynamically you can use. For example
 `192.168.0.253,192.168.0.254'
 
+[[pvesdn_config_subnet]]
+Subnets
+~~~~~~~
+
+A Subnet allow to define an ip network (ipv4 or ipv6).
+
+
+Subnet properties are:
+
+* ID: a cidr network address. Ex: 10.0.0.0/8
+
+* Gateway: ip address for the default gateway of the network. 
+           On layer3 vnets (simple/evpn plugins), it'll be deployed on the vnet.
+           
+* Snat: Enable Snat for layer3 vnets (simple/evpn plugins) for this subnet.
+
+* Ipam: Optional, if you want to use an ipam tool for this subnet.
+
+[[pvesdn_config_ipam]]
+Ipams
+~~~~~
+IPAM (IP address management) tools, are used to manage/assign ips on your devices on the network.
+It can be used to find free ip address when you create a vm/ct for example (not yet implemented).
+
+
+[[pvesdn_ipam_plugins]]
+Ipam Plugins
+-------------
+
+[[pvesdn_ipam_plugin_phpipam]]
+PHPIpam plugin
+~~~~~~~~~~~~~~
+https://phpipam.net/
+
+You need to create an application in phpipam, and add an api token with admin permission
+
+PHPipam properties are:
+
+* Url: The rest api url : http://phpipam.domain.com/api/<appname>/
+* Token: your api token
+* Section: An integer id. Sections are group of subnets in phpipam. 
+           Default install have sectionid=1 for customers
+
+Netbox Ipam plugin
+~~~~~~~~~~~~~~~~~~
+https://github.com/netbox-community/netbox
+
+you need to create an api token in netbox
+https://netbox.readthedocs.io/en/stable/api/authentication
+
+PHPipam properties are:
+
+* Url: The rest api url: http://yournetbox.domain.com/api
+* Token: your api token
+
 
 [[pvesdn_local_deployment_monitoring]]
 Local Deployment Monitoring
-- 
2.20.1