Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(XCP-ng) Fix broken links in the XCP-ng documentation #324

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/installation/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ To start the process, just tell the host to reboot. It is best to watch the prog

### Live migration

Live migration **should work** from any older XenServer/XCP-ng toward the latest release. However, there are some cases where it doesn't. For example, XenServer (and XCP-ng) 7.6 has a regression that makes live migration with storage motion crash guests that are based on the "Other installation media" template when the source host has a version lower than 7.6 ([reported here to Citrix](https://bugs.xenserver.org/browse/XSO-924)). But **this bug has been fixed in latest XCP-ng 7.6 updates**.
Live migration **should work** from any older XenServer/XCP-ng toward the latest release. However, there are some cases where it doesn't. For example, XenServer (and XCP-ng) 7.6 has a regression that makes live migration with storage motion crash guests that are based on the "Other installation media" template when the source host has a version lower than 7.6. But **this bug has been fixed in latest XCP-ng 7.6 updates**.

### Warm migration

Expand Down
2 changes: 1 addition & 1 deletion docs/management/manage-at-scale/xo-web-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Take a look at [the official doc](https://xen-orchestra.com/docs/) to take a tou
Xen Orchestra is fully Open Source, and it comes in 2 "flavors":

1. the turnkey/preinstalled virtual appliance, called **XOA** that you can [deploy in a minute](https://vates.tech/deploy/) tested and bundled with actual commercial support
2. manual install from GitHub ([documentation](https://xen-orchestra.com/docs/from_the_sources.html)), no QA nor stable version, community supported only
2. manual install from GitHub ([documentation](https://docs.xen-orchestra.com/installation#from-the-sources)), no QA nor stable version, community supported only

:::info
We advise to start using XOA by deploying it really easily in [few clicks on this page](https://vates.tech/deploy/). You can always decide later to build it yourself from GitHub.
Expand Down
2 changes: 1 addition & 1 deletion docs/management/manage-locally/api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# XCP-ng API

XCP-ng is entirely managed by its API, called "XAPI". XAPI project is hosted [inside the Linux Foundation](https://xenproject.org/developers/teams/xen-api/) and the documentation is available on [its dedicated website](https://xapi-project.github.io/xen-api/).
XCP-ng is entirely managed by its API, called "XAPI". XAPI project is hosted [on GitHub](https://github.com/xapi-project/xen-api) and the documentation is available on [its dedicated website](https://xapi-project.github.io/xen-api/).

XAPI is requested by multiple **clients**, like Xen Orchestra or `xe` CLI. See [our management](../../../management) section for more details.

Expand Down
2 changes: 1 addition & 1 deletion docs/project/development-process/what-xcp-ng-is-made-of.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ XCP-ng is a collection of components, that put together create a complete turnke
As usual in the Free Software world, we stand *on the shoulders of giants*:
* **CentOS**: many RPM packages come from the [CentOS](https://www.centos.org/) Linux distribution, which in turn is based on Red Hat's [RHEL](https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux), mostly based itself on the work of the [Fedora](https://getfedora.org/) project, all based on the work of all the developers who wrote the [FLOSS](https://en.wikipedia.org/wiki/Free/Libre_Open_Source_Software) software that is packaged in those Linux distributions. Examples: glibc, GNU coreutils, crontabs, iptables and many others. However, the list keeps shrinking while we rebuild, patch or update sensitive components directly in XCP-ng repositories.
* **EPEL**: a few packages come from [EPEL](https://fedoraproject.org/wiki/EPEL).
* **XenServer**: most packages that make XCP-ng what it is have been rebuilt from source RPMs released by the [XenServer](https://xenserver.org/) project, with or without modifications. This includes xen, a patched Linux kernel, the Xen API, and many others. This also includes redistributable drivers or tools from third party vendors.
* **XenServer**: most packages that make XCP-ng what it is have been rebuilt from source RPMs released by the [XenServer](https://www.xenserver.com/) project, with or without modifications. This includes xen, a patched Linux kernel, the Xen API, and many others. This also includes redistributable drivers or tools from third party vendors.
* **XCP-ng**: the remaining packages are additions (or replacements of closed-source components) to the original XenServer distribution.
6 changes: 3 additions & 3 deletions docs/releases/release-8-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Citrix announces:
* Support for **AMD EPYC 7xx2(P)** added

Other changes:
* Windows drivers delivered through Windows Update should now work well with non-English locales. Source: [XSO-951](https://bugs.xenserver.org/browse/XSO-951).
* Windows drivers delivered through Windows Update should now work well with non-English locales.
* `chrony` replaces `ntp` for time synchronisation
* **PV guests are not supported anymore**
* Templates for creating PV guests have been removed
Expand Down Expand Up @@ -187,7 +187,7 @@ If the ntp server can't be reached, the `chrony-wait` service may stall the boot
* up to 10 minutes if you installed with `xcp-ng-8.1.0.iso`, or with yum update before 2020-04-03;
* up to 2 minutes only if you installed with `xcp-ng-8.1.0-2.iso`, with yum update after 2020-04-03, or have updated your host after 2020-04-03.

Reported to Citrix: [XSO-981](https://bugs.xenserver.org/browse/XSO-981)
Reported to Citrix.

We must stress that it is important that all your hosts have accurate date and time and so be able to connect an ntp server.

Expand All @@ -202,7 +202,7 @@ See [this forum thread](https://xcp-ng.org/forum/topic/2822/xcp-ng-8-0-upgrade-t
### Backup partition restore from installer fails on UEFI hosts
Context: the installer creates a backup of the root partition when you upgrade. It also allows to restore that backup when a backup is found.

On UEFI hosts, the backup restore function of the installer fails with the following error message: `setEfiBootEntry() takes exactly 5 arguments (4 given)`. This is [a bug inherited from Citrix Hypervisor 8.1](https://bugs.xenserver.org/browse/XSO-984).
On UEFI hosts, the backup restore function of the installer fails with the following error message: `setEfiBootEntry() takes exactly 5 arguments (4 given)`. This is a bug inherited from Citrix Hypervisor 8.1.

Consequences: although the root filesystem is correctly restored, the system is unbootable.

Expand Down
6 changes: 2 additions & 4 deletions docs/releases/release-8-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Main changes announced by Citrix:

Other changes:
* Bug fixed for hosts configured with DHCP. `xcp-networkd` used not to send the hostname along with the DHCP request. Fix contributed by XCP-ng team.
* [Backup restore fixed for UEFI hosts](https://bugs.xenserver.org/browse/XSO-984). Bug reported by XCP-ng community.
* Backup restore fixed for UEFI hosts. Bug reported by XCP-ng community.

**The rest, below, is about changes specific to XCP-ng.**

Expand Down Expand Up @@ -189,7 +189,7 @@ When a host is upgraded to XCP-ng 8.2 using the installation ISO, two files are
* `/etc/modprobe.d/blacklist-bridge.conf`
* `/etc/modprobe.d/disable-ipv6.conf`

We reported the issue to Citrix: [https://bugs.xenserver.org/browse/XSO-991](https://bugs.xenserver.org/browse/XSO-991)
We reported the issue to Citrix.

There are no known consequences of having those files missing, except possible slightly increased memory usage.

Expand Down Expand Up @@ -230,8 +230,6 @@ Live migrating a VM from an old XenServer can sometimes end with an error, with

Would require a hotfix to the old XenServer, but since those versions are not supported anymore, Citrix won't develop one.

Reference: [XSO-938](https://bugs.xenserver.org/browse/XSO-938)

#### Dell servers do not get the best partitioning

Due to the presence of the diagnostic partition on Dell servers, the installer does not create all partitions, so for example there's no dedicated /var/log partition (side-effect: log rotation switches to aggressive mode, so old logs are deleted quickly, sometimes even the same day!).
Expand Down
3 changes: 1 addition & 2 deletions docs/storage/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,10 @@ Note: If you use ZFS, assign at least 16GB RAM to avoid swapping. ZFS (in standa

#### ZFS Knowledge & status

Do not hesitate to take a look at these links for more advanced explanations:
Feel free to look at these links for more advanced explanations:

* Wikipedia: [https://en.wikipedia.org/wiki/ZFS](https://en.wikipedia.org/wiki/ZFS)
* OpenZFS Basics: [https://www.youtube.com/watch?v=MsY-BafQgj4](https://www.youtube.com/watch?v=MsY-BafQgj4)
* Blog full of useful information: [http://www.zfsbuild.com](http://www.zfsbuild.com)

You can monitor your ZFS pool using:

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/common-problems.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ If you need to modify your XCP-ng root password, you may follow the steps below.

### Solution

The full prodecure can also be found on [this page](https://support.citrix.com/article/CTX214360).
The full prodecure can also be found on [this page](https://linuxconfig.org/how-to-reset-an-administrative-root-password-on-xenserver-7-linux).

* Reboot your XCP-ng into Grub boot menu.
* Select XCP-ng boot menu entry and press <kbd>e</kbd> key to edit boot options.
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/storage/iscsi-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This apply to setup using DRBD/Corosync/Pacemaker.

The problem is that in a storage-cluster environment every time the node changes or pacemaker start /stop /restart iSCSI resources the "iSCSI SN" for a lun are new generated and differs from that before.
Xen uses the "iSCSI SN" as an identifier, so you have to ensure that "iSCSI SN" is the same on all cluster nodes.
You can read more about it [here](https://smcleod.net/tech/2015/12/14/iscsi-scsiid-persistence.html).
You can read more about it [here](https://smcleod.net/2015/12/iscsi-scsi-id-/-serial-persistence/).

* error message xen orchestra

Expand Down
2 changes: 1 addition & 1 deletion docs/vms/vms.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ Versions 12.0-U1 and higher of TrueNAS include the package by default, to instal
```bash
# sed -i '' 's/enabled: no/enabled: yes/' /usr/local/etc/pkg/repos/FreeBSD.conf
```
If you are using FreeNAS v11.2 or higher, you also have to disable the local package repository [to avoid an issue in that particular release and that may affect later versions](https://www.justinsilver.com/random/fix-pkg-on-freenas-11-2/) before running `pkg install`:
If you are using FreeNAS v11.2 or higher, you also have to disable the local package repository to avoid an issue in that particular release and that may affect later versions before running `pkg install`:
```bash
# sed -i '' 's/enabled: yes/enabled: no/' /usr/local/etc/pkg/repos/local.conf
```
Expand Down