[pve-devel] [PATCH v2 pve-docs 5/6] sdn: IPAM

[Stefan Lendl <s.lendl@proxmox.com>]

Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
---
 pvesdn.adoc | 66 ++++++++++++++++++++++++++---------------------------
 1 file changed, 33 insertions(+), 33 deletions(-)

diff --git a/pvesdn.adoc b/pvesdn.adoc
index 73d3dee..450955d 100644
--- a/pvesdn.adoc
+++ b/pvesdn.adoc
@@ -425,56 +425,56 @@ Loopback:: Use a loopback or dummy interface as the source of the EVPN network
 
 
 [[pvesdn_config_ipam]]
-IPAMs
------
+IPAM
+-------------
+
+IP Address Management (IPAM) tools manage the IP addresses of clients on the
+network. SDN in {pve} uses IPAM for example to find free IP addresses for new
+guests.
 
-IPAM (IP Address Management) tools are used to manage/assign the IP addresses of
-guests on the network. It can be used to find free IP addresses when you create
-a VM/CT for example (not yet implemented).
+A single IPAM instance can be associated with one or more zones.
 
-An IPAM can be associated with one or more zones, to provide IP addresses
-for all subnets defined in those zones.
 
 [[pvesdn_ipam_plugin_pveipam]]
-{pve} IPAM Plugin
-~~~~~~~~~~~~~~~~~
+PVE IPAM Plugin
+~~~~~~~~~~~~~
 
-This is the default internal IPAM for your {pve} cluster, if you don't have
-external IPAM software.
+The default built-in IPAM for your {pve} cluster.
 
-[[pvesdn_ipam_plugin_phpipam]]
-phpIPAM Plugin
-~~~~~~~~~~~~~~
-https://phpipam.net/
 
-You need to create an application in phpIPAM and add an API token with admin
-privileges.
+[[pvesdn_ipam_plugin_netbox]]
+NetBox IPAM Plugin
+~~~~~~~~~~~~~
 
-The phpIPAM configuration properties are:
+link:https://github.com/netbox-community/netbox[NetBox] is an open-source IP
+Address Management (IPAM) and datacenter infrastructure management (DCIM) tool.
 
-url:: The REST-API endpoint: `http://phpipam.domain.com/api/<appname>/`
+To integrate NetBox with {pve} SDN, create an API token in NetBox as described
+here: https://docs.netbox.dev/en/stable/integrations/rest-api/#tokens
 
-token:: An API access token
+The NetBox configuration properties are:
 
-section:: An integer ID. Sections are a group of subnets in phpIPAM. Default
-  installations use `sectionid=1` for customers.
+URL:: The NetBox REST API endpoint: `http://yournetbox.domain.com/api`
 
-[[pvesdn_ipam_plugin_netbox]]
-NetBox IPAM Plugin
-~~~~~~~~~~~~~~~~~~
+Token:: An API access token
+
+
+[[pvesdn_ipam_plugin_phpipam]]
+phpIPAM Plugin
+~~~~~~~~~~~~~
+
+In link:https://phpipam.net/[phpIPAM] you need to create an "application" and add
+an API token with admin privileges to the application.
 
-NetBox is an IP address management (IPAM) and datacenter infrastructure
-management (DCIM) tool. See the source code repository for details:
-https://github.com/netbox-community/netbox
+The phpIPAM configuration properties are:
 
-You need to create an API token in NetBox to use it:
-https://docs.netbox.dev/en/stable/integrations/rest-api/#tokens
+URL:: The REST-API endpoint: `http://phpipam.domain.com/api/<appname>/`
 
-The NetBox configuration properties are:
+Token:: An API access token
 
-url:: The REST API endpoint: `http://yournetbox.domain.com/api`
+Section:: An integer ID. Sections are a group of subnets in phpIPAM. Default
+  installations use `sectionid=1` for customers.
 
-token:: An API access token
 
 [[pvesdn_config_dns]]
 DNS
-- 
2.42.0