From ff5de461864925f5a0c96ccc3d77f8dd6a0f72c3 Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Tue, 12 Nov 2024 09:37:02 +0100 Subject: [PATCH 01/12] Improved the style and presentation across the whole page Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 136 ++++++++++++++---------------- 1 file changed, 64 insertions(+), 72 deletions(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index 5efbc24e..a9d94e06 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -4,32 +4,32 @@ sidebar_position: 1 # Requirements -What is needed to run XCP-ng. +Understand what is needed to run XCP-ng. -An XCP-ng computer is dedicated entirely to the task of running XCP-ng and hosting VMs, and is not used for other applications. +An XCP-ng server is dedicated entirely to running XCP-ng and hosting VMs. It is not used for other applications. :::info -Installing third-party software directly in the control domain of XCP-ng is not supported. The exception is for software supplied in the current repositories. If you want to add an extra package inside XCP-ng please [ask here](https://github.com/xcp-ng/xcp/issues/56). +Installing third-party software directly in the XCP-ng control domain is not supported, except for software supplied in the official repositories. If you wish to add extra packages to XCP-ng, please [submit your request here](https://github.com/xcp-ng/xcp/issues/56). ::: -## 📋 XCP-ng system requirements +## 📋 XCP-ng System Requirements -Although XCP-ng is usually deployed on server-class hardware, XCP-ng is also compatible with many models of workstations and laptops. For more information, see the [Hardware Compatibility List (HCL)](../../installation/hardware). +XCP-ng is generally deployed on server-class hardware, but it also supports many workstation and laptop models. For more information, refer to the [Hardware Compatibility List (HCL)](../../installation/hardware). -The following section describes the recommended XCP-ng hardware specifications. +The following outlines the recommended XCP-ng hardware specifications. -XCP-ng must be a **64-bit x86** server-class machine devoted to hosting VMs. XCP-ng creates an optimized and hardened Linux partition with a Xen-enabled kernel. This kernel controls the interaction between the virtualized devices seen by VMs and the physical hardware. +XCP-ng must be a **64-bit x86** server-class machine dedicated to hosting VMs. It creates a hardened Linux partition using a Xen-enabled kernel, which manages interactions between VMs and the physical hardware. -XCP-ng can use, per host: +XCP-ng supports, per host: -* Up to 6 TB of RAM -* Up to 16 physical NICs -* Up to 512 logical processors -* Up to 512 virtual NICs -* Up to 800 VLANs +- Up to 6 TB of RAM +- Up to 16 physical NICs +- Up to 512 logical processors +- Up to 512 virtual NICs +- Up to 800 VLANs :::note -The maximum number of logical processors supported differs by CPU. For more information, see the [Hardware Compatibility List (HCL)](../../installation/hardware). +The maximum number of supported logical processors may vary by CPU. For more information, see the [Hardware Compatibility List (HCL)](../../installation/hardware). ::: @@ -37,113 +37,105 @@ The system requirements for XCP-ng are: ### CPUs -One or more 64-bit x86 CPUs, 1.5 GHz minimum, 2 GHz or faster multicore CPU recommended. +- One or more 64-bit x86 CPUs, minimum 1.5 GHz; 2 GHz or faster multicore CPUs are recommended. +- To run Windows VMs or recent Linux versions, an Intel VT or AMD-V 64-bit x86-based system with one or more CPUs is required. -To support VMs running Windows or more recent versions of Linux, you require an Intel VT or AMD-V 64-bit x86-based system with one or more CPUs. +> **Note**: For Windows VMs or newer Linux distributions, enable hardware virtualization in the BIOS. It may be disabled by default—consult your BIOS documentation for guidance. -> Note: To run Windows VMs or more recent versions of Linux, enable hardware support for virtualization on XCP-ng. Virtualization support is an option in the BIOS. It is possible that your BIOS might have virtualization support disabled. For more information, see your BIOS documentation. - -To support VMs running supported paravirtualized Linux, you require a standard 64-bit x86-based system with one or more CPUs. +- For VMs running supported paravirtualized Linux, a standard 64-bit x86-based system with one or more CPUs is required. ### Memory -2 GB minimum, 4 GB or more recommended. - -A fixed amount of RAM is allocated to the control domain (dom0). The optimal amount of RAM for the control domain depends on the workload. - -### Disk space +- Minimum 2 GB, recommended 4 GB or more. +- A fixed amount of RAM is allocated to the control domain (dom0). Optimal allocation depends on your workload. -* Locally attached storage (PATA, SATA, SCSI) with 46 GB of disk space minimum, 70 GB of disk space recommended. -* SAN via HBA (not through software) when installing with multipath boot from SAN. +### Disk Space +- Local storage (PATA, SATA, SCSI) with a minimum of 46 GB, recommended 70 GB. +- SAN access via HBA (not software) when installing with multipath boot from SAN. -For a detailed list of compatible storage solutions, see the [Hardware Compatibility List (HCL)](../../installation/hardware). +For more details, refer to the [Hardware Compatibility List (HCL)](../../installation/hardware). -#### Installation on USB drives +#### Installation on USB Drives :::danger -We **strongly discourage** the installation of XCP-ng on USB drives. The frequent writing actions required by XCP-ng can rapidly degrade a USB drive due to: -* XAPI: This is the XenServer API database, which undergoes constant changes. This results in significant write operations, which are detrimental to the longevity of USB drives. Note: The XAPI database maintains the state of all XCP-ng operations and is replicated across each host (from the slave). -* Logs: XCP-ng generates a substantial amount of debug logs. A possible solution is to utilize a remote syslog. +**Strongly discouraged** due to heavy write operations in XCP-ng: +- **XAPI Database**: Undergoes frequent changes, resulting in extensive write operations, potentially reducing USB drive lifespan. The XAPI database maintains the state of all XCP-ng operations and is replicated across all hosts. +- **Logging**: XCP-ng generates a high volume of logs. Consider using a remote syslog service as an alternative. ::: -#### Installation on SD cards +#### Installation on SD Cards :::danger -For similar reasons as USB drives, we highly recommend against installing XCP-ng on SD cards. Opting for even a basic SSD would be vastly more effective in managing system partitions. +Similarly, installing XCP-ng on SD cards is highly discouraged. A basic SSD offers a vastly more durable and effective alternative for managing system partitions. ::: ### Network -100 Mbit/s or faster NIC. One or more Gb, or 10 Gb NICs is recommended for faster P2V and export/import data transfers and VM live migration. +- Minimum 100 Mbit/s NIC. Recommended: one or more Gb or 10 Gb NICs for faster data transfers, including P2V, import/export, and VM live migrations. +- Use multiple NICs for redundancy. Network configuration depends on your storage type—refer to vendor documentation for guidance. -We recommend that you use multiple NICs for redundancy. The configuration of NICs differs depending on the storage type. For more information, see the vendor documentation. - -XCP-ng 8.2 requires an IPv4 network for management and storage traffic. Starting with XCP-ng 8.3, the management network can use IPv6. +XCP-ng 8.2 requires an IPv4 network for management and storage traffic. Starting from XCP-ng 8.3, the management network supports IPv6. :::info -Ensure that the time setting in the BIOS of your server is set to the current time in UTC. In some support cases, serial console access is required for debug purposes. When setting up XCP-ng configuration, we recommend that you configure serial console access. For hosts that do not have physical serial port or where suitable physical infrastructure is not available, investigate whether you can configure an embedded management device. For example, Dell DRAC or HP iLO. For more information about setting up serial console access, see [CTX228930 - How to Configure Serial Console Access on XenServer 7.0 and later](https://support.citrix.com/article/CTX228930). +Set the server's BIOS clock to the current UTC time. For debugging support cases, serial console access may be required. Consider configuring serial console access for XCP-ng. For systems without physical serial ports, explore embedded management devices like Dell DRAC or HP iLO. See [CTX228930 - How to Configure Serial Console Access on XenServer 7.0 and later](https://support.citrix.com/article/CTX228930). ::: -## 🖥️ Supported guest OS +## 🖥️ Supported Guest OSes -We only officially support operating systems which still receive support from their publisher. But there's a lot more that can run on XCP-ng. +XCP-ng officially supports operating systems still receiving updates from their publishers. Many other systems can also run on XCP-ng. -### Windows based +### Windows -* Windows Server 2016, 2019, 2022 -* Windows 10 -* Windows 11 (starting with XCP-ng 8.3). +- Windows Server 2016, 2019, 2022 +- Windows 10 +- Windows 11 (starting with XCP-ng 8.3) :::info -Very old versions of Windows will run, but without PV drivers, so with lower networking and disk performance (Windows XP, Windows Server 2003, etc.). - -Less old but EOL versions of Windows, such as Windows Server 2012, currently run well but we don't offer guarantees for the future. For example, the future PV drivers updates might drop the compatibility with such old releases. +Older Windows versions may work but lack PV drivers, resulting in lower networking and disk performance (e.g., Windows XP, Windows Server 2003). While unsupported versions like Windows Server 2012 still function, future PV driver updates may drop compatibility. ::: ### Linux -* RHEL, CentOS, Rocky, AlmaLinux, Oracle… -* Debian & Ubuntu -* Arch, Alpine, SUSE and many more… +- RHEL, CentOS, Rocky, AlmaLinux, Oracle +- Debian, Ubuntu +- Arch, Alpine, SUSE, and others ### BSD -* FreeBSD and related (pfSense, TrueNAS…) -* OpenBSD +- FreeBSD and related distributions (e.g., pfSense, TrueNAS) +- OpenBSD -## 🎱 Pool requirements +## 🎱 Pool Requirements -A resource pool is a homogeneous or heterogeneous aggregate of one or more servers, up to a maximum of 64. Before you create a pool or join a server to an existing pool, ensure that all servers in the pool meet the following requirements. -Hardware requirements +A resource pool is a collection of one or more servers (up to 64), which can be homogeneous or heterogeneous. Before creating or joining a pool, ensure the following: -All of the servers in a XCP-ng resource pool must have broadly compatible CPUs, that is: +### Hardware Requirements -* The CPU vendor (Intel, AMD) must be the same on all CPUs on all servers. -* To run HVM virtual machines, all CPUs must have virtualization enabled. +- All servers must have compatible CPUs (same vendor — Intel or AMD). To run HVM VMs, CPUs must support virtualization. -## 📌 Other requirements +### Additional Pool Requirements In addition to the hardware prerequisites identified previously, there are some other configuration prerequisites for a server joining a pool: -* It must have a consistent IP address (a static IP address on the server or a static DHCP lease). This requirement also applies to the servers providing shared NFS or iSCSI storage. -* Its system clock must be synchronized to the pool master (for example, through NTP). -* It cannot be a member of an existing resource pool. -* It cannot have any running or suspended VMs or any active operations in progress on its VMs, such as shutting down or exporting. Shut down all VMs on the server before adding it to a pool. -* It cannot have any shared storage already configured. -* It cannot have a bonded management interface. Reconfigure the management interface and move it on to a physical NIC before adding the server to the pool. After the server has joined the pool, you can reconfigure the management interface again. +- Static IP address (or static DHCP lease). This requirement also applies to the servers providing shared NFS or iSCSI storage. +- System clock synchronized to the pool master (e.g., via NTP). +- Must not be part of an existing pool. +- No running or suspended VMs, or active VM operations (shut down VMs before joining). +- No configured shared storage. +* It cannot have a bonded management interface. Reconfigure the management interface and move it to a physical NIC before adding the server to the pool. Once the server has joined the pool, you can reconfigure the management interface again. * It must be running the same version of XCP-ng, at the same update level, as servers already in the pool. -XCP-ng hosts in resource pools can contain different numbers of physical network interfaces and have local storage repositories of varying size. In practice, it is often difficult to obtain multiple servers with the exact same CPUs, and so minor variations are permitted. If you want your environment to have hosts with varying CPUs in the same resource pool, you can force join a pool together using the CLI. For information about forcing the joining operation, see Hosts and resource pools. +Resource pools can have hosts with varying physical network interfaces and local storage capacities. In practice, it is often difficult to obtain multiple servers with the exact same CPUs, and so minor variations are permitted. If you want your environment to have hosts with varying CPUs in the same resource pool, you can force join a pool together using the CLI. To know more on forced joining operation, see Hosts and Resource Pools. -> Note: Servers providing shared NFS or iSCSI storage for the pool must have a static IP address or be DNS addressable. +> **Note**: Servers providing shared NFS or iSCSI storage must have static or DNS-addressable IPs. -### Homogeneous pools +### Homogeneous Pools -A homogeneous resource pool is an aggregate of servers with identical CPUs. CPUs on a server joining a homogeneous resource pool must have the same vendor, model, and features as the CPUs on servers already in the pool. +A homogeneous resource pool is an aggregate of servers with identical CPUs. Servers in a homogeneous pool must have identical CPUs, including vendor, model, and features. -### Heterogeneous pools +### Heterogeneous Pools -Heterogeneous pool creation is made possible by using technologies in Intel (FlexMigration) and AMD (Extended Migration) CPUs that provide CPU masking or levelling. These features allow a CPU to be configured to appear as providing a different make, model, or feature set than it actually does. These capabilities enable you to create pools of hosts with different CPUs but still safely support live migrations. +Technologies such as Intel FlexMigration or AMD Extended Migration allow you to create heterogeneous pools. These technologies provide CPU masking or leveling, which means you can configure a CPU to appear to provide a different make, model, or feature set than it actually does. These capabilities allow you to create pools of hosts with different CPUs and still support secure, live migrations. -For information about creating heterogeneous pools, see Hosts and resource pools. +For detailed information, see the Hosts and Resource Pools. \ No newline at end of file From 0fe1c7ada137a275be7e2ef580b8c05af7089a74 Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Tue, 12 Nov 2024 10:01:41 +0100 Subject: [PATCH 02/12] Added VM limits (vCPU/Memory/Storage/Networking/etc.) to the Requirements page Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 34 +++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index a9d94e06..36b0ca57 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -106,6 +106,40 @@ Older Windows versions may work but lack PV drivers, resulting in lower networki - FreeBSD and related distributions (e.g., pfSense, TrueNAS) - OpenBSD +## Virtual Machine Requirements + +Below are the recommended configuration limits for virtual machines running on XCP-ng, designed to maintain optimal performance and stability. + +| Category | Requirement | +|--------------------------------------|-------------------------------------| +| **CPU** | | +| Virtual CPUs (vCPUs) per Linux VM | Up to 32 or 64 vCPUs (see note 1) | +| Virtual CPUs (vCPUs) per Windows VM | Up to 32 or 64 vCPUs (see note 1) | +| **Memory** | | +| Maximum RAM per VM | 1.5 TiB (see note 2) | +| **Storage** | | +| Virtual Disk Images per VM, including CD-ROM | 241 (see note 2) | +| Virtual CD-ROM drives per VM | 1 | +| Maximum Virtual Disk Size (NFS) | 2040 GiB | +| Maximum Virtual Disk Size (LVM) | 2040 GiB | +| Maximum Virtual Disk Size (XFS) | 16 TiB | +| Maximum Virtual Disk Size (GFS2) | 16 TiB | +| **Networking** | | +| Virtual Network Interface Controller (NICs) per VM | 7 (see note 4) | +| **GPU** | | +| Virtual GPUs per VM | 8 | +| Passed-through GPUs per VM | 1 | +| **Other** | | +| Passed-through USB devices | 6 | + +:::info Notes +1. Always check the documentation for your guest operating system to make sure you are staying within the supported limits. For example, Red Hat Enterprise Linux 8 and its derivatives only support up to 32 vCPUs. While the theoretical limit is 64, it's a good idea to limit yourself to 32 if you're concerned about the reliability of your VMs or want to avoid any potential impact on the stability of your system. +2. The amount of physical memory that can be used by your operating system depends on its capabilities. Allocating more memory than the operating system can handle can cause performance degradation within your guest VM. +3. The number of virtual disk images (VDIs) you can use is determined by the capabilities of the guest OS. Be sure to consult your guest operating system documentation to ensure that you stay within the limits supported by the guest operating system. +4. Some guest operating systems may have lower limits by default, while others may require the installation of XCP-ng Guest Tools to reach the maximum supported limits. +::: + + ## 🎱 Pool Requirements A resource pool is a collection of one or more servers (up to 64), which can be homogeneous or heterogeneous. Before creating or joining a pool, ensure the following: From 6609d0a6831458c3f27001795fa73e7b80fe2e7c Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Wed, 13 Nov 2024 08:20:28 +0100 Subject: [PATCH 03/12] Made the VM requirements parts more consistent with our style guidelines Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 55 ++++++++++++++----------------- 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index 36b0ca57..1635060c 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -108,37 +108,32 @@ Older Windows versions may work but lack PV drivers, resulting in lower networki ## Virtual Machine Requirements -Below are the recommended configuration limits for virtual machines running on XCP-ng, designed to maintain optimal performance and stability. - -| Category | Requirement | -|--------------------------------------|-------------------------------------| -| **CPU** | | -| Virtual CPUs (vCPUs) per Linux VM | Up to 32 or 64 vCPUs (see note 1) | -| Virtual CPUs (vCPUs) per Windows VM | Up to 32 or 64 vCPUs (see note 1) | -| **Memory** | | -| Maximum RAM per VM | 1.5 TiB (see note 2) | -| **Storage** | | -| Virtual Disk Images per VM, including CD-ROM | 241 (see note 2) | -| Virtual CD-ROM drives per VM | 1 | -| Maximum Virtual Disk Size (NFS) | 2040 GiB | -| Maximum Virtual Disk Size (LVM) | 2040 GiB | -| Maximum Virtual Disk Size (XFS) | 16 TiB | -| Maximum Virtual Disk Size (GFS2) | 16 TiB | -| **Networking** | | -| Virtual Network Interface Controller (NICs) per VM | 7 (see note 4) | -| **GPU** | | -| Virtual GPUs per VM | 8 | -| Passed-through GPUs per VM | 1 | -| **Other** | | -| Passed-through USB devices | 6 | - -:::info Notes -1. Always check the documentation for your guest operating system to make sure you are staying within the supported limits. For example, Red Hat Enterprise Linux 8 and its derivatives only support up to 32 vCPUs. While the theoretical limit is 64, it's a good idea to limit yourself to 32 if you're concerned about the reliability of your VMs or want to avoid any potential impact on the stability of your system. -2. The amount of physical memory that can be used by your operating system depends on its capabilities. Allocating more memory than the operating system can handle can cause performance degradation within your guest VM. -3. The number of virtual disk images (VDIs) you can use is determined by the capabilities of the guest OS. Be sure to consult your guest operating system documentation to ensure that you stay within the limits supported by the guest operating system. -4. Some guest operating systems may have lower limits by default, while others may require the installation of XCP-ng Guest Tools to reach the maximum supported limits. -::: +Here are the recommended setup limits for virtual machines on XCP-ng to keep things running smoothly and efficiently: + +**CPU** +- Virtual CPUs (vCPUs) for Linux VMs: You can use up to 32 or 64 vCPUs, but make sure to check what your guest OS supports. For example, Red Hat Enterprise Linux 8 and its similar distributions only handle up to 32 vCPUs. Even though 64 is possible, sticking to 32 is a safer bet for reliability and stability. +- Virtual CPUs (vCPUs) for Windows VMs: Same as for Linux—up to 32 or 64 vCPUs, depending on what’s compatible with your guest OS. + +**GPU** +- Virtual GPUs per VM: 8 +- Passed-through GPUs per VM: 1 + +**Memory** +- Maximum RAM per VM: 1.5 TiB. Just keep in mind that the actual memory your OS can use depends on its limits. If you go over what it can manage, you might see some performance drops. + +**Storage** +- Virtual Disk Images per VM, including CD-ROMs: Up to 241. This number is influenced by what your guest OS supports, so double-check your OS documentation to stay within its limits. +- Virtual CD-ROM drives per VM: 1 +- Maximum Virtual Disk Size for NFS: 2040 GiB +- Maximum Virtual Disk Size for LVM: 2040 GiB +- Maximum Virtual Disk Size for XFS: 16 TiB +- Maximum Virtual Disk Size for GFS2: 16 TiB + +**Networking** +- Virtual Network Interface Controllers (NICs) per VM: Up to 7. Some guest operating systems might have stricter limits, or you might need to install XCP-ng Guest Tools to hit the maximum limit. +**Other** +- Passed-through USB devices: Up to 6 ## 🎱 Pool Requirements From afad7b07b80c4dd539558dc10524bdac56decf9a Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Wed, 13 Nov 2024 09:31:49 +0100 Subject: [PATCH 04/12] Made number formatting more consistent with English standards Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index 1635060c..a0dc9a26 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -124,8 +124,8 @@ Here are the recommended setup limits for virtual machines on XCP-ng to keep thi **Storage** - Virtual Disk Images per VM, including CD-ROMs: Up to 241. This number is influenced by what your guest OS supports, so double-check your OS documentation to stay within its limits. - Virtual CD-ROM drives per VM: 1 -- Maximum Virtual Disk Size for NFS: 2040 GiB -- Maximum Virtual Disk Size for LVM: 2040 GiB +- Maximum Virtual Disk Size for NFS: 2,040 GiB +- Maximum Virtual Disk Size for LVM: 2,040 GiB - Maximum Virtual Disk Size for XFS: 16 TiB - Maximum Virtual Disk Size for GFS2: 16 TiB From c51e1005d40f334443782682e5227cac0df53d21 Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Fri, 15 Nov 2024 09:32:36 +0100 Subject: [PATCH 05/12] Explained VM limits for XCP-ng 8.2 vs. XCP-ng 8.3 Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index a0dc9a26..1b160f85 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -110,18 +110,26 @@ Older Windows versions may work but lack PV drivers, resulting in lower networki Here are the recommended setup limits for virtual machines on XCP-ng to keep things running smoothly and efficiently: -**CPU** -- Virtual CPUs (vCPUs) for Linux VMs: You can use up to 32 or 64 vCPUs, but make sure to check what your guest OS supports. For example, Red Hat Enterprise Linux 8 and its similar distributions only handle up to 32 vCPUs. Even though 64 is possible, sticking to 32 is a safer bet for reliability and stability. -- Virtual CPUs (vCPUs) for Windows VMs: Same as for Linux—up to 32 or 64 vCPUs, depending on what’s compatible with your guest OS. +### CPU -**GPU** +#### XCP-ng 8.2 + +- Virtual CPUs (vCPUs) for Linux VMs: You can use up to **32 vCPUs**, but make sure to check what your guest OS supports. +- Virtual CPUs (vCPUs) for Windows VMs: You can use up to **32 vCPUs**. + +#### XCP-ng 8.3 + +- Virtual CPUs (vCPUs) for Linux and Windows VMs: You can use up to **64 vCPUs**, but make sure to check what your guest OS supports. \ +For example, Red Hat Enterprise Linux 8 and its similar distributions only handle up to 32 vCPUs. Even though 64 is possible, sticking to 32 is a safer bet for reliability and stability. + +#### GPU - Virtual GPUs per VM: 8 - Passed-through GPUs per VM: 1 -**Memory** +#### Memory - Maximum RAM per VM: 1.5 TiB. Just keep in mind that the actual memory your OS can use depends on its limits. If you go over what it can manage, you might see some performance drops. -**Storage** +#### Storage - Virtual Disk Images per VM, including CD-ROMs: Up to 241. This number is influenced by what your guest OS supports, so double-check your OS documentation to stay within its limits. - Virtual CD-ROM drives per VM: 1 - Maximum Virtual Disk Size for NFS: 2,040 GiB @@ -129,10 +137,10 @@ Here are the recommended setup limits for virtual machines on XCP-ng to keep thi - Maximum Virtual Disk Size for XFS: 16 TiB - Maximum Virtual Disk Size for GFS2: 16 TiB -**Networking** +#### Networking - Virtual Network Interface Controllers (NICs) per VM: Up to 7. Some guest operating systems might have stricter limits, or you might need to install XCP-ng Guest Tools to hit the maximum limit. -**Other** +#### Other - Passed-through USB devices: Up to 6 ## 🎱 Pool Requirements From 823ece9eb8e33ab952858df0885f0aa501a63f29 Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Fri, 15 Nov 2024 10:32:40 +0100 Subject: [PATCH 06/12] Made system requirements a little more organized + made terms a little more explici Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index 1b160f85..489901ec 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -22,10 +22,19 @@ XCP-ng must be a **64-bit x86** server-class machine dedicated to hosting VMs. I XCP-ng supports, per host: -- Up to 6 TB of RAM +### RAM +- Up to 6 TB + +### Physical Network Interface Cards (NICs) - Up to 16 physical NICs + +### Logical processors - Up to 512 logical processors + +### Virtual Network Interface Cards (vNICs) - Up to 512 virtual NICs + +### Virtual Local Area Networks (VLANs) - Up to 800 VLANs :::note From 92cdadf70282472119b332cca52bafa5a93caa14 Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Mon, 18 Nov 2024 10:42:23 +0100 Subject: [PATCH 07/12] Addded long-term (LTS) support mention to XCP-ng 8.2 titles Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index 489901ec..cae38584 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -29,8 +29,13 @@ XCP-ng supports, per host: - Up to 16 physical NICs ### Logical processors + +#### XCP-ng 8.2 (LTS) - Up to 512 logical processors +#### XCP-ng 8.3 +- Up to 960 logical processors, depending on CPU support + ### Virtual Network Interface Cards (vNICs) - Up to 512 virtual NICs @@ -121,7 +126,7 @@ Here are the recommended setup limits for virtual machines on XCP-ng to keep thi ### CPU -#### XCP-ng 8.2 +#### XCP-ng 8.2 (LTS) - Virtual CPUs (vCPUs) for Linux VMs: You can use up to **32 vCPUs**, but make sure to check what your guest OS supports. - Virtual CPUs (vCPUs) for Windows VMs: You can use up to **32 vCPUs**. From 53e1ad10310e5480fc3f250576761dd281de259b Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Mon, 18 Nov 2024 13:26:04 +0100 Subject: [PATCH 08/12] Changed logical processor limit for XCP-ng 8.2 from 512 to 448, as 512 is not tested yet Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index cae38584..da6b33f9 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -31,7 +31,7 @@ XCP-ng supports, per host: ### Logical processors #### XCP-ng 8.2 (LTS) -- Up to 512 logical processors +- Up to 448 logical processors #### XCP-ng 8.3 - Up to 960 logical processors, depending on CPU support From 26d6a68fe6c1ee3d53678e14c3b5bcc9331f6763 Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Thu, 21 Nov 2024 10:49:39 +0100 Subject: [PATCH 09/12] Remove mention of XFS and GFS2, which isn't supported by XCP-ng Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index da6b33f9..9eb492dd 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -148,8 +148,6 @@ For example, Red Hat Enterprise Linux 8 and its similar distributions only handl - Virtual CD-ROM drives per VM: 1 - Maximum Virtual Disk Size for NFS: 2,040 GiB - Maximum Virtual Disk Size for LVM: 2,040 GiB -- Maximum Virtual Disk Size for XFS: 16 TiB -- Maximum Virtual Disk Size for GFS2: 16 TiB #### Networking - Virtual Network Interface Controllers (NICs) per VM: Up to 7. Some guest operating systems might have stricter limits, or you might need to install XCP-ng Guest Tools to hit the maximum limit. From 025acb35ba3f66d1a60423e692947de66ddbacaa Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Thu, 21 Nov 2024 10:52:52 +0100 Subject: [PATCH 10/12] Doc: Make LTS version according to our writing standards Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index 9eb492dd..3a042f2b 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -30,7 +30,7 @@ XCP-ng supports, per host: ### Logical processors -#### XCP-ng 8.2 (LTS) +#### XCP-ng 8.2 LTS - Up to 448 logical processors #### XCP-ng 8.3 @@ -126,7 +126,7 @@ Here are the recommended setup limits for virtual machines on XCP-ng to keep thi ### CPU -#### XCP-ng 8.2 (LTS) +#### XCP-ng 8.2 LTS - Virtual CPUs (vCPUs) for Linux VMs: You can use up to **32 vCPUs**, but make sure to check what your guest OS supports. - Virtual CPUs (vCPUs) for Windows VMs: You can use up to **32 vCPUs**. From d7854bbbe98cdbf937c47077b3899fd2529261bc Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Thu, 21 Nov 2024 10:54:01 +0100 Subject: [PATCH 11/12] Doc: Remove extraneous backslash Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index 3a042f2b..ed7d4be4 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -133,7 +133,7 @@ Here are the recommended setup limits for virtual machines on XCP-ng to keep thi #### XCP-ng 8.3 -- Virtual CPUs (vCPUs) for Linux and Windows VMs: You can use up to **64 vCPUs**, but make sure to check what your guest OS supports. \ +- Virtual CPUs (vCPUs) for Linux and Windows VMs: You can use up to **64 vCPUs**, but make sure to check what your guest OS supports. For example, Red Hat Enterprise Linux 8 and its similar distributions only handle up to 32 vCPUs. Even though 64 is possible, sticking to 32 is a safer bet for reliability and stability. #### GPU From a087408919a19e41e90ff616851af111759274de Mon Sep 17 00:00:00 2001 From: Thomas Moraine Date: Thu, 21 Nov 2024 10:57:03 +0100 Subject: [PATCH 12/12] Doc: Regroup max virtual disk size limits in one entry for all storage drivers Signed-off-by: Thomas Moraine --- docs/installation/requirements.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index ed7d4be4..8f9c33ed 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -146,8 +146,7 @@ For example, Red Hat Enterprise Linux 8 and its similar distributions only handl #### Storage - Virtual Disk Images per VM, including CD-ROMs: Up to 241. This number is influenced by what your guest OS supports, so double-check your OS documentation to stay within its limits. - Virtual CD-ROM drives per VM: 1 -- Maximum Virtual Disk Size for NFS: 2,040 GiB -- Maximum Virtual Disk Size for LVM: 2,040 GiB +- Maximum Virtual Disk Size: 2,040 GiB #### Networking - Virtual Network Interface Controllers (NICs) per VM: Up to 7. Some guest operating systems might have stricter limits, or you might need to install XCP-ng Guest Tools to hit the maximum limit.