From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 6E2C39A861 for ; Fri, 17 Nov 2023 14:55:38 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 56BEB33DE4 for ; Fri, 17 Nov 2023 14:55:38 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Fri, 17 Nov 2023 14:55:37 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 5A18B43E49 for ; Fri, 17 Nov 2023 14:55:37 +0100 (CET) From: Stefan Lendl To: pve-devel@lists.proxmox.com Date: Fri, 17 Nov 2023 14:55:30 +0100 Message-ID: <20231117135531.3198353-6-s.lendl@proxmox.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231117135531.3198353-1-s.lendl@proxmox.com> References: <20231117135531.3198353-1-s.lendl@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.065 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH v2 pve-docs 5/6] sdn: IPAM X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Nov 2023 13:55:38 -0000 Signed-off-by: Stefan Lendl --- 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//` +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//` -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