From: Alexandre Derumier <aderumier@odiso.com>
To: pve-devel@pve.proxmox.com
Subject: [pve-devel] [PATCH pve-docs 2/2] sdn : add subnet/ipam documentation
Date: Sun, 19 Jul 2020 13:09:15 +0200 [thread overview]
Message-ID: <20200719110915.9155-3-aderumier@odiso.com> (raw)
In-Reply-To: <20200719110915.9155-1-aderumier@odiso.com>
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
prev parent reply other threads:[~2020-07-19 11:09 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-19 11:09 [pve-devel] [PATCH pve-docs 0/2] simple zone + " Alexandre Derumier
2020-07-19 11:09 ` [pve-devel] [PATCH pve-docs 1/2] sdn: add simple zone plugin documentation Alexandre Derumier
2020-07-19 11:09 ` Alexandre Derumier [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200719110915.9155-3-aderumier@odiso.com \
--to=aderumier@odiso.com \
--cc=pve-devel@pve.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox