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.

Sign up for GitHub

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

Adding proxy configuration in the updates documentation #327

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+26 −1
Open

Adding proxy configuration in the updates documentation #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50c243a
Adding proxy configuration in the updates documentation
bleader Feb 27, 2025
2f7cac2
Fix typo in kernel module policy
bleader Feb 27, 2025
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
25 changes: 25 additions & 0 deletions docs/management/updates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,31 @@ If your version is lower than `8.2`, it will not receive updates anymore. To kee

Your dom0 system must either have access to the internet, or to a local mirror. In the second case, make sure to update the `baseurl` values in `/etc/yum.repos.d/xcp-ng.repo` to make them point at the local mirror, and keep the mirror regularly synced.

#### Proxy configuration

If your hosts need to use a proxy to be able to access the repositories, there are multiple ways to configure it depending on your use case:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If your hosts need to use a proxy to be able to access the repositories, there are multiple ways to configure it depending on your use case:
If your hosts need a proxy to access the repositories, there are a few ways to set it up depending on what you need:


For all yum repositories:
- Set `proxy=<proxy_url>` in `[main]` section of `/etc/yum.conf`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Set `proxy=<proxy_url>` in `[main]` section of `/etc/yum.conf`
- Set `proxy=<proxy_url>` in the `[main]` section of `/etc/yum.conf`


For specific repositories:
- Set `proxy=<proxy_url>` in the repository section of your choice in files present in `/etc/yum.repos.d`

Set a system-wide proxy that will be used for everything, not only yum:
- Add you can export lines for `http_proxy` and `https_proxy` variables in `/etc/environment`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Add you can export lines for `http_proxy` and `https_proxy` variables in `/etc/environment`
- Export the `http_proxy` and `https_proxy` variables in `/etc/environment`:

or

Suggested change
- Add you can export lines for `http_proxy` and `https_proxy` variables in `/etc/environment`
Add these export lines for `http_proxy` and `https_proxy` variables in `/etc/environment`

```bash
export http_proxy=<proxy_url>
export https_proxy=<proxy_url>
```

:::warning
There are caveats for each methods:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
There are caveats for each methods:
Each method has its own quirks:

or

Suggested change
There are caveats for each methods:
Each method has its caveat:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other caveats: none of this sticks after an upgrade to a newer version, AFAIK.

- Updating the `yum` package may overwrite `/etc/yum.conf`
- Updating the `xcp-ng-release` package may overwrite files in `/etc/yum.repos.d/`
- Updating the `setup` package may overwrite `/etc/environment`
Comment on lines +52 to +54
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you checked the way they are package, so that we can say for sure whether they will be overwritten or not? The counterpart when they're not overwritten is you don't get the latest changes and have to look for .rpmnew files (whereas overwritten changes are saved to a .rpmsave file).

- Environmentn variables won't be taken into account when updating through Xen Orchestra
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Environmentn variables won't be taken into account when updating through Xen Orchestra
- Environment variables won't be used when updating through Xen Orchestra

or

Suggested change
- Environmentn variables won't be taken into account when updating through Xen Orchestra
- Environment variables won't be taken into account when updating through Xen Orchestra

:::

### Be cautious with third party repositories and packages

If you have enabled third party repositories (CentOS, EPEL...) in the past, make sure to **disable** them before updating. Otherwise, core packages from your dom0 system can be overwritten with versions of packages that have not been tested in the context of XCP-ng, or lack specific patches.
Expand Down
2 changes: 1 addition & 1 deletion docs/project/development-process/kernel-module-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 9

# Kernel module policy

Our policity about kernel modules.
Our policy about kernel modules.

In XCP-ng, there is only one version of the kernel that is supported at a given time. There's also an [alternate kernel](../../../installation/hardware#-alternate-kernel) available for troubleshooting. The policy differs whether the kernel modules are for XCP-ng's supported kernel or for an alternate kernel.

Expand Down