xcp-ng/xcp-ng-org

XCP-ng org website

XCP-ng website & documentation

Website

Our website is a simple and static HTML page.

Documentation

Our documentation is built using Docusaurus 3, a modern static website and documentation generator. It's available at https://docs.xcp-ng.org

Installation

$ npm i

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Autogeneration

This documentation is automatically rebuilt after each push event on master branch.

xcp-ng-org's Issues

Avoid one extra reboot after a fresh install

Right now, when an install is just finished, you need to reboot. And after that, one the host is added in XO(A), you need to update, and finally reboot again. Which is fine in most case, but sometimes your hardware is taking almost 10 minutes to reboot, it could be a unreasonable loss of time.

Is there a way to avoid this? Could we install updates directly in the install chroot? Or to have automation? Or maybe to enable "install updates" in the installer like in Ubuntu for example?

Thanks in advance for your suggestion :)

additional packages

https://xcp-ng.org/docs/additionalpackages.html

Document is very confusing.

No where in the document does it say that the repository in question, also no name of repo, is enabled by default. It does say, however, that 'update-process' assumes that only XCP repos are enabled, but that doesn't really tell me that I can install zfs from the default repos, it just says what the computer assumes, good for him.

The line "Prefer additional packages from XCP-ng's own repositories" should really include word 'default' and in the subsection word 'enabled' by default.

What I had done: I read this article https://xcp-ng.org/blog/2018/08/03/xcp-ng-with-zfs/ and tried to find which repo do I have to enable in order to install zfs on version 8 since the package moved from the old repo and the old repo doesn't exist anymore. The documentation says there's a list of installable packages from xcp-s own repos, but it doesn't say that xcps own repos are enabled by default and that no additional repositories need to be enabled in order to install the listed packages in the given list of packages.

It is all very confusing, I just installed zfs but before that I'd been trying in accordance to the old article for an hour.

Missing section: "Hosts and resource pools" ?

In requirements.md there's this sentence:
"For information about creating heterogeneous pools, see Hosts and resource pools." but currently there is no such section

Installer Software Raid fails when existing mdraid volumes exist

Trying to check out xcp-ng today from an old system with existing mdraid volumes, using the software raid setup for system disk selection simply does not work and errors out. I had several setup on different disks I was tossing in my frankenstein lab box, and annoyingly needed to remove all other ancillary disks physically, and booting into another os to secure-erase the existing nvme disks to before the software raid function actually worked.

Even more annoying, it didn't really error or anything, it simply never made a new raid volume, only listing the old raid volume it already discovered. Really ought to fix this lest this be a barrier to entry for being simply dumb from the start of the experience.

Nav's links don't work anymore

These links no longer work.

Documentation incorrectly stating xe-guest-utilities not being packages in Ubuntu anymore

At https://github.com/xcp-ng/xcp-ng-org/blob/master/docs/guests.md#ubuntu it is written that the xe-guest-utilities have not been packaged since Ubuntu 20.04. This is not true anymore. They are available in Ubuntu 22.04 and newer versions. I have checked that on my own VMs. A good overview is also provided at repology.org.
I am unsure how it has been for Ubuntu 20.10 to 21.10 - as these are not supported anymore, I would say, that it would not matter if they haven't been available in these releases.

Website is not accessible

The Website does not seem to be accessible.

Installer Missing Intel i225-V Drivers | 8.2.1

Looks like the version 8.2.1 iso does not contain drivers for the Intel i225-V ethernet adapter. Attempting to install on a Minisforum UM560XT but it's failing due to no network interfaces being detected. The install fails when hitting OK on step 3 of the install process here.

Please let me know if you need any additional information.

My apologies for including pictures of my screen but I currently have no way of easily getting direct output copied.

Docs page missing info for XO lite

The XO Lite page https://docs.xcp-ng.org/management/manage-locally/xo-lite/
infers that XO lite is already built in and dos not have any setup.
This is misleading and having to huntdown instrucitons from forums. Please add the steps to install XO Lite on the xcp-ng server.

Broken Discord-Invitation Link

The Discord-Links wrongly contain a ">" at the end which breaks the ability to be forwarded to the Discord-Invitation. Because ">" is not part of the markup at this point in the code, this character should be removed.

Introduced with Pull-Request:
#214 Fix advertised chat options

Exposed .git on webpage

Hi,

Not sure how much of an issue this can be but there is an exposed .git folder on the website. Despite being access denied (403) I was able to still see /HEAD as well as /refs/heads/master

once again, not sure if this is an issue or not. Thought I would still bring it up

Don't use admin secret on ceph SR

The ceph section in https://github.com/xcp-ng/xcp-ng-org/blob/master/docs/storage.md a admin user is used for accessing ceph.

It should be noted that this is NOT best practice for accessing cephfs and that in production a new keyring should be used with only the necessary privs

Migration from Xen project to XCP-ng

Hi. Missing from https://github.com/xcp-ng/xcp-ng-org/edit/master/docs/migratetoxcpng.md (https://xcp-ng.org/docs/migratetoxcpng.html) is any information on how one might either migrate from Xen project (i.e. non-Citrix Xen) to XCP-ng, or add XCP-ng to an existing Xen project host, if that's even feasible. I'm assuming that I'd have to just do a clean install, but what about my existing VM disks (LVs), e.g.? I guess I can just dd them off to my NAS, but will I be able to recover them on XCP-ng? Etc.

Some of my confusion might stem from the Xen-that-isn't-Citrix terminology problem.

In my case, Xen is running on Ubuntu, so my guess is that I'm in for a complete rebuild; but happy to be proven wrong.

Minimum required size for USB key for installation ISO

Trying to follow the installation guide to create an installation media using a USB key, but don't know what size I need.
It would be nice if the install docs mentioned the minimum required size.
The ISO itself is well under 1GB, but I suspect the installer will be much larger.

CLI Reference Docs help command - XCP-ng 8.2

Description

When following the guide on the xe CLI, the first command example xe help command fails.

Details

When following the guide here:

https://xcp-ng.org/docs/cli_reference.html

The first command presented xe help command fails.

[20:29 oasis ~]# xe help command
Unknown command 'command'
[20:29 oasis ~]# xe help
Usage: xe <command> [-s server] [-pw passwd] [-p port] [-u user] [-pwf password-file]
  [command specific arguments]

To get help on a specific command: xe help <command>
To get a full listing of commands: xe help --all

Common command list
-------------------
    cd-list, diagnostic-vm-status, network-list, snapshot-clone
    snapshot-copy, snapshot-disk-list, snapshot-export-to-template
    snapshot-reset-powerstate, snapshot-revert, snapshot-uninstall, sr-list
    template-export, template-uninstall, vm-cd-add, vm-cd-eject
    vm-cd-insert, vm-cd-list, vm-cd-remove, vm-checkpoint, vm-clone
    vm-compute-maximum-memory, vm-copy, vm-disk-add, vm-disk-list
    vm-disk-remove, vm-export, vm-import, vm-install, vm-list, vm-migrate
    vm-pause, vm-reboot, vm-reset-powerstate, vm-resume, vm-shutdown
    vm-snapshot, vm-snapshot-with-quiesce, vm-start, vm-suspend
    vm-uninstall, vm-unpause, vm-vif-list
[20:29 oasis ~]# xe help command

Other Notes

Maybe I'm over-analyzing the docs and command is supposed to be a generic stand-in. If so, it might be more helpful to lead with the xe help command and then add <> around the boilerplate examples that don't actually work. Happy to submit a PR to propose better clarity if this is just a mis-reading of the docs and not an actual missing command.

Proposal: Move the xcp-ng IRC channel to oftc.net

This message is because the xcp-ng project is listed as having IRC channels on freenode.net (see https://xenproject.org/help/irc/ )

There's been a situation developing on freenode for some time that came to a head last week. Since that time, the new operators of freenode have begun seizing control of any channel whose topic mentions moving to a new server. Furthermore, they have been using the number of people logged into freenode as evidence that the community supports their actions.

In response to this, the main hypervisor project has decided to move to oftc.net effective immediately, and a number of us have deleted our freenode accounts ( https://lists.xenproject.org/archives/html/xen-devel/2021-05/msg01057.html ).

If you're still using the IRC channel listed in that page, please consider following suit. If you're not using the IRC channel, let me know so I can delete references to it.

Forum icon uses Stack Overflow icon but the link doesn't lead to Stack Overflow

There is this link on the homepage:

The target of the link is https://xcp-ng.org/forum/

I expected to end up on Stack Overflow instead of a dedicated forum.

Could another icon could be used?

Docs Troubleshooting - Set XCP-ng Resolution

On some monitors an "Input Signal Out Of Range" error occurs a bit after the grub menu due to resolution issues. The fix is simply requiring vga kernel parameters be changed for both xen and dom0.

For xcp-ng version 8.2 and below, only following the steps in Citrix Article CTX226191 are required.

For xcp-ng v8.3b, modprobe.blacklist=i915 parameter needs to be added to dom0 along with the above fixes as the module is no longer blacklisted by default.

• Edit: @stormi pointed out module is blacklisted in modprobe.d by default. On Beta2 my systems do not appear to be loading the module anymore.

I'm planning to make a PR to the troubleshooting documentation in order to fully document and explain the above process along with how to do it temporarily at boot (mainly needed for installations) but I'm not sure when I'll get to it at this time so figured I'd get the information posted here if anyone wants to write it up.