[pve-devel] [PATCH docs 02/10] Rewrite Package Repositories
Aaron Lauterer
a.lauterer at proxmox.com
Mon Jun 17 15:05:42 CEST 2019
Polished Phrasing, aligned CLI command styling and line width
Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
---
pve-package-repos.adoc | 118 +++++++++++++++++++++--------------------
1 file changed, 60 insertions(+), 58 deletions(-)
diff --git a/pve-package-repos.adoc b/pve-package-repos.adoc
index 06d1b2f..acd5294 100644
--- a/pve-package-repos.adoc
+++ b/pve-package-repos.adoc
@@ -12,11 +12,11 @@ management tool. The list of repositories is defined in
`/etc/apt/sources.d/`. Updates can be installed directly using
`apt-get`, or via the GUI.
-Apt `sources.list` files list one package repository per line, with
-the most preferred source listed first. Empty lines are ignored, and a
+The `.list` files configure one package repository per line, with
+the most preferred source first. Empty lines are ignored, and a
`#` character anywhere on a line marks the remainder of that line as a
-comment. The information available from the configured sources is
-acquired by `apt-get update`.
+comment. The available packages from a repository is acquired by
+running `apt-get update`.
.File `/etc/apt/sources.list`
----
@@ -27,7 +27,7 @@ deb http://ftp.debian.org/debian buster-updates main contrib
deb http://security.debian.org buster/updates main contrib
----
-In addition, {pve} provides three different package repositories.
+{pve} provides three different additional package repositories.
{pve} Enterprise Repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -42,28 +42,28 @@ enabled by default:
deb https://enterprise.proxmox.com/debian/pve buster pve-enterprise
----
-As soon as updates are available, the `root at pam` user is notified via
-email about the available new packages. On the GUI, the change-log of
-each package can be viewed (if available), showing all details of the
-update. So you will never miss important security fixes.
+To not miss important updates the `root at pam` user is notified via
+email about newly available packages. In the GUI, the change-log of
+each package can be viewed (if available). It shows all details of the
+update.
-Please note that you need a valid subscription key to access this
-repository. We offer different support levels, and you can find further
-details at https://www.proxmox.com/en/proxmox-ve/pricing.
+Please note that a valid subscription key is needed to access this
+repository. We offer different support levels. Further details can be
+found at https://www.proxmox.com/en/proxmox-ve/pricing.
-NOTE: You can disable this repository by commenting out the above line
-using a `#` (at the start of the line). This prevents error messages
-if you do not have a subscription key. Please configure the
-`pve-no-subscription` repository in that case.
+NOTE: If you do not have a subscription this repository can be
+disabled. Add a `#` at the beginning of the line. This will prevent
+error messages when updating the system. Please configure the
+`pve-no-subscription` repository in this case.
{pve} No-Subscription Repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-As the name suggests, you do not need a subscription key to access
-this repository. It can be used for testing and non-production
-use. Its not recommended to run on production servers, as these
-packages are not always heavily tested and validated.
+No subscription key is needed to access this repository. It can be
+used for testing and non-production environments. Using the
+no-subscription repository in a production environment is not
+recommended as the packages are not heavily tested and validated.
We recommend to configure this repository in `/etc/apt/sources.list`.
@@ -84,26 +84,24 @@ deb http://security.debian.org buster/updates main contrib
{pve} Test Repository
~~~~~~~~~~~~~~~~~~~~~~
-Finally, there is a repository called `pvetest`. This one contains the
-latest packages and is heavily used by developers to test new
-features. As usual, you can configure this using
-`/etc/apt/sources.list` by adding the following line:
+The test repository (`pvetest`) is primarily used by developers to
+test new features. It contains the latest packages. As usual, it can
+be configured by adding the following line to `/etc/apt/sources.list`:
.sources.list entry for `pvetest`
----
deb http://download.proxmox.com/debian/pve buster pvetest
----
-WARNING: the `pvetest` repository should (as the name implies) only be used
-for testing new features or bug fixes.
+WARNING: the `pvetest` repository should (as the name implies) only be
+used for testing new features or bug fixes.
[[sysadmin_package_repositories_ceph]]
{pve} Ceph Repository
~~~~~~~~~~~~~~~~~~~~~
-This is {pve}'s main Ceph repository and holds the Ceph packages for
-production use. You can also use this repository to update only the Ceph
-client.
+This is the main Ceph repository for {pve}. It holds the Ceph packages
+for production use and can be used to update only the Ceph client.
.File `/etc/apt/sources.list.d/ceph.list`
----
@@ -114,8 +112,8 @@ deb http://download.proxmox.com/debian/ceph-nautilus buster main
{pve} Ceph Testing Repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This Ceph repository contains the Ceph packages before they are moved into the
-main repository and is used to test new Ceph release on {pve}.
+This Ceph repository contains the Ceph packages before they are moved
+to the main repository. It is used to test new Ceph releases on {pve}.
.File `/etc/apt/sources.list.d/ceph.list`
----
@@ -125,9 +123,10 @@ deb http://download.proxmox.com/debian/ceph-nautilus buster test
{pve} Ceph Luminous Repository For Upgrade
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This is a build of tje Ceph Luminous release for {pve} 6.0, this can be used to
-upgrade a {pve} cluster with Ceph Luminous deployed first to our 6.0 release,
-based on Debian Buster, and only afterwards upgrade the Ceph on it's own.
+This repository is part of the upgrade path from {pve} 5.x to {pve}
+6.0 if Ceph is deployed. It provides packages of the older Ceph
+Luminous release for {pve} 6.0. After the upgrade to {pve} 6.0 is
+done, Ceph can be upgraded to the Nautilus release.
.File `/etc/apt/sources.list.d/ceph.list`
----
@@ -137,24 +136,27 @@ deb http://download.proxmox.com/debian/ceph-luminous buster main
SecureApt
~~~~~~~~~
-We use GnuPG to sign the `Release` files inside those repositories,
-and APT uses that signatures to verify that all packages are from a
-trusted source.
+GnuPG is used to sign the `Release` files in the repositories. APT is
+using these signatures to verify that all packages are from a trusted
+source.
-The key used for verification is already installed if you install from
-our installation CD. If you install by other means, you can manually
-download the key with:
+The key used to verify the signatures is already installed if {pve}
+has been installed from an official ISO image. If {pve} is installed
+in another way (e.g. on top of Debian) the keys need to be downloaded
+separately:
+----
# wget http://download.proxmox.com/debian/proxmox-ve-release-6.x.gpg -O /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
+----
-Please verify the checksum afterwards:
+Please verify the checksum afterwards with:
----
# sha512sum /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
acca6f416917e8e11490a08a1e2842d500b3a5d9f322c6319db0927b2901c3eae23cfb5cd5df6facf2b57399d3cfa52ad7769ebdd75d9b204549ca147da52626 /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
----
-or
+or:
----
# md5sum /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
@@ -170,10 +172,10 @@ ifdef::wiki[]
{pve} 5.x Repositories
~~~~~~~~~~~~~~~~~~~~~~
-{pve} 5.x is based on Debian 9.x (``stretch''). Please note that this release
-is out of date, and you should update your installation.
-Nevertheless, we still provide access to those repositories at our download
-servers.
+{pve} 5.x is based on Debian 9.x (``stretch'').
+Please note that this release is out of date. Existing installations
+should be updated. Nevertheless access to these repositories is still
+provided.
[width="100%",cols="<d,3m",options="header"]
|===========================================================
@@ -190,10 +192,10 @@ deb http://download.proxmox.com/debian stretch pvetest
{pve} 4.x Repositories
~~~~~~~~~~~~~~~~~~~~~~
-{pve} 4.x is based on Debian 8.x (``jessie''). Please note that this
-release is out of date, and you should update your
-installation. Nevertheless, we still provide access to those
-repositories at our download servers.
+{pve} 4.x is based on Debian 8.x (``jessie'').
+Please note that this release is out of date. Existing installations
+should be updated. Nevertheless access to these repositories is still
+provided.
[width="100%",cols="<d,3m",options="header"]
|===========================================================
@@ -210,10 +212,10 @@ deb http://download.proxmox.com/debian jessie pvetest
{pve} 3.x Repositories
~~~~~~~~~~~~~~~~~~~~~~
-{pve} 3.x is based on Debian 7.x (``wheezy''). Please note that this
-release is out of date, and you should update your
-installation. Nevertheless, we still provide access to those
-repositories at our download servers.
+{pve} 3.x is based on Debian 7.x (``wheezy'').
+Please note that this release is out of date. Existing installations
+should be updated. Nevertheless access to these repositories is still
+provided.
[width="100%",cols="<d,3m",options="header"]
|===========================================================
@@ -230,9 +232,9 @@ deb http://download.proxmox.com/debian wheezy pvetest
Outdated: `stable` Repository `pve`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This repository is a leftover to easy the update to 3.1. It will not
-get any updates after the release of 3.1. Therefore you need to remove
-this repository after you upgraded to 3.1.
+This repository is a leftover to ease the update to 3.1. It will not
+get any updates after the release of 3.1. Therefore the repository
+needs to be removed after the upgrade to 3.1.
.File `/etc/apt/sources.list`
----
@@ -250,7 +252,7 @@ Outdated: {pve} 2.x Repositories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
{pve} 2.x is based on Debian 6.0 (``squeeze'') and outdated. Please
-upgrade to latest version as soon as possible. In order to use the
+upgrade to the latest version as soon as possible. In order to use the
stable `pve` 2.x repository, check your sources.list:
.File `/etc/apt/sources.list`
--
2.20.1
More information about the pve-devel
mailing list