[pve-devel] [PATCH v4 docs 3/7] Overhaul Install from USB flash drive
improve phrasing, align style of CLI commands, OSX is now macOS, Rufus
with dd mode is preferred to etcher
Signed-off-by: Aaron Lauterer
---
v2 -> v3:
rebased on current master
pve-usbstick.adoc | 109 +++---
1 file changed, 54 insertions(+), 55 deletions(-)
diff --git a/pve-usbstick.adoc b/pve-usbstick.adoc
index 5eb9132..3d4860f 100644
--- a/pve-usbstick.adoc
+++ b/pve-usbstick.adoc
@@ -1,121 +1,120 @@
-Install from USB Stick
---
+Install from a USB flash drive
+--
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
-The {pve} installation media is a hybrid ISO image, working in two ways:
+The {pve} installation media is a hybrid ISO image. It works in two ways:
-* An ISO image file ready to burn on CD
+* An ISO image file ready to burn to a CD or DVD.
-* A raw sector (IMG) image file ready to directly copy to flash media
- (USB Stick)
+* A raw sector (IMG) image file ready to copy to a USB flash drive (USB stick).
-Using USB sticks is faster and more environmental friendly and
-therefore the recommended way to install {pve}.
+Using a USB flash drive to install {pve} is the recommended way because it is
+the faster option.
+Prepare a USB flash drive as installation medium
+
-Prepare a USB flash drive as install medium
-~~~
-
-In order to boot the installation media, copy the ISO image to a USB
-media.
-
-First download the ISO image from
+Download the installer ISO image from:
https://www.proxmox.com/en/downloads/category/iso-images-pve
-You need at least a 1 GB USB media.
+The flash drive needs to have at least 1GB of storage available.
-NOTE: Using UNetbootin or Rufus does not work.
+NOTE: Do not use UNetbootin. It does not work with the {pve} installation
image.
-IMPORTANT: Make sure that the USB media is not mounted and does not
+IMPORTANT: Make sure that the USB flash drive is not mounted and does not
contain any important data.
Instructions for GNU/Linux
~~
-You can simply use `dd` on UNIX like systems. First download the ISO
-image, then plug in the USB stick. You need to find out what device
-name gets assigned to the USB stick (see below). Then run:
+On Unix-like operating system use the `dd` command to copy the ISO image to the
+USB flash drive. First find the correct device name of the USB flash drive (see
+below). Then run the `dd` command.
-dd if=proxmox-ve_*.iso of=/dev/XYZ bs=1M
+# dd if=proxmox-ve_*.iso of=/dev/XYZ bs=1M
NOTE: Be sure to replace /dev/XYZ with the correct device name.
-CAUTION: Be very careful, and do not overwrite the hard disk!
+CAUTION: Be very careful, and do not overwrite the wrong disk!
-Find Correct USB Device Name
-
-
-You can compare the last lines of 'dmesg' command before and after the
-insertion, or use the 'lsblk' command. Open a terminal and run:
+Find the correct USB device name
+
+There are two ways to find out the name of the USB flash drive. The first one
is
+to compare the last lines of the `dmesg` command output before and after
+plugging in the flash drive. The second way is to compare the output of the
+`lsblk` command. Open a terminal and run:
- lsblk
+# lsblk
-Then plug in your USB media and run the command again:
+Then plug in your USB flash drive and run the command again:
- lsblk
+# lsblk
-A new device will appear, and this is the USB device you want to use.
+A new device will appear. This is the one you want to use. To be on the extra
+safe side check if the reported size matches your USB flash drive.
-Instructions for OSX
-
+Instructions for macOS
+~~
Open the terminal (query Terminal in Spotlight).
-Convert the .iso file to .img using the convert option of hdiutil for example.
+Convert the .iso file to .img using the convert option of `hdiutil` for
example.
-hdiutil convert -format UDRW -o proxmox-ve_*.dmg proxmox-ve_*.iso
+# hdiutil convert -format UDRW -o proxmox-ve_*.dmg proxmox-ve_*.iso
-TIP: OS X tends to put the .dmg ending on the output file automatically.
+TIP: macOS tends to automatically add '.dmg' to the output file name.
-To get the current list of devices run the command again:
+To get the current list of devices run the command:
-diskutil list
+# diskutil list
-Now insert your USB flash media and run this command again to
-determine the device node assigned to your flash media
-(e.g. /dev/diskX).
+Now insert the USB flash drive and run this command again to determine which
+device node has been assigned to it. (e.g., /dev/diskX).
-diskutil list
-
-diskutil unmountDisk /dev/diskX
+# diskutil list
+# diskutil unmountDisk /dev/diskX
NOTE: replace X with the disk number from the last command.
[pve-devel] [PATCH v4 docs 0/7] Documenation overhaul chapt. 1.12 to 3.2
This is the first patch series aimed to overhaul our documentation. The main goal is to make it easier to understand and more consistent. Therefore the phrasing is changed in a lot of places, sometimes the ordering of content as well. I tried to align the source to the 80 characters per line wherever possible. The reason why this first patch series doesn't start at the very beginning is because we are not yet happy with few things there. v3 -> v4: fixed some phrasings and minor issues reported on v3 v2 -> v3: rebased on current master v1[0] -> v2: * incorporating suggestions received * moved line length and white space fixes to separate patch [0] https://pve.proxmox.com/pipermail/pve-devel/2019-September/038938.html Aaron Lauterer (7): Overhaul Translation Overhaul System Requirements Overhaul Install from USB flash drive Overhaul Sysadmin Overhaul Package Repositories OVerhaul System Software Updates Fix whitespace and line length getting-help.adoc| 9 +- howto-improve-pve-docs.adoc | 4 +- pve-installation.adoc| 14 ++-- pve-package-repos.adoc | 154 ++- pve-system-requirements.adoc | 75 + pve-usbstick.adoc| 109 - sysadmin.adoc| 40 - system-software-updates.adoc | 25 +++--- translation.adoc | 37 + 9 files changed, 229 insertions(+), 238 deletions(-) -- 2.20.1 ___ pve-devel mailing list pve-devel@pve.proxmox.com https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] [PATCH v4 docs 6/7] Overhaul System Software Updates
improve phrasing, align style of CLI commands
Signed-off-by: Aaron Lauterer
---
v2 -> v3:
rebased on current master
v1 -> v2:
applied suggestions from oguz [0]
[0] https://pve.proxmox.com/pipermail/pve-devel/2019-September/038965.html
system-software-updates.adoc | 25 ++---
1 file changed, 10 insertions(+), 15 deletions(-)
diff --git a/system-software-updates.adoc b/system-software-updates.adoc
index 04c17f3..013e171 100644
--- a/system-software-updates.adoc
+++ b/system-software-updates.adoc
@@ -4,21 +4,16 @@ ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
-We provide regular package updates on all repositories. You can
-install those update using the GUI, or you can directly run the CLI
-command `apt-get`:
+Proxmox provides updates on a regular basis for all repositories. To install
+updates use the web-based GUI or the following CLI commands:
- apt-get update
- apt-get dist-upgrade
+
+# apt-get update
+# apt-get dist-upgrade
+
-NOTE: The `apt` package management system is extremely flexible and
-provides countless of feature - see `man apt-get` or <> for
-additional information.
+NOTE: The APT package management system is very flexible and provides many
+features, see `man apt-get`, or <> for additional information.
-You should do such updates at regular intervals, or when we release
-versions with security related fixes. Major system upgrades are
-announced at the {forum}. Those announcement also contain detailed
-upgrade instructions.
-
-TIP: We recommend to run regular upgrades, because it is important to
-get the latest security updates.
+TIP: Regular updates are essential to get the latest patches and security
+related fixes. Major system upgrades are announced in the {forum}.
--
2.20.1
___
pve-devel mailing list
pve-devel@pve.proxmox.com
https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] [PATCH v4 docs 1/7] Overhaul Translation
improve phrasing
Signed-off-by: Aaron Lauterer
---
v3 -> v4:
fixed UTF-8 dots
v2 -> v3:
rebased on current master
v1 -> v2:
applied suggestion from oguz [0]
[0] https://pve.proxmox.com/pipermail/pve-devel/2019-September/038952.html
translation.adoc | 37 +++--
1 file changed, 19 insertions(+), 18 deletions(-)
diff --git a/translation.adoc b/translation.adoc
index ff99296..2dc156b 100644
--- a/translation.adoc
+++ b/translation.adoc
@@ -6,24 +6,25 @@ ifdef::wiki[]
endif::wiki[]
-A lot of users speak a language other than English and we depend on
contributions
-to make {pve} available to users all over the world.
-We are always happy to welcome new localizers and invite you to help shape
-{pve}.
+The {pve} user interface is in English by default. Thanks to contributions by
+the community, translations to other languages are available. We welcome help
to
+add new languages, translate the newest features, and improve incomplete or
+inconsistent translations.
-Our language files are available as
https://git.proxmox.com/?p=proxmox-i18n.git[git repository].
-If you are familiar with git we would be glad to see your contribution
according
-to our {webwiki-url}Developer_Documentation[Developer Documentation].
+The language files are available as a
+https://git.proxmox.com/?p=proxmox-i18n.git[git repository]. If you are
familiar
+with git, please contribute according to our
+{webwiki-url}Developer_Documentation[Developer Documentation].
-Nonetheless, translating does not require special technical skills.
-You can get the language files without setting up a development environment
-https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here].
-Right click on the "raw" link of your language and choose "Save Link As...".
-Do not hesitate to send your translation directly to office(at)proxmox.com with
-your signed
{webwiki-url}Developer_Documentation#Software_License_and_Copyright[contributor
license agreement].
+Even if you are not familiar with git, you can help with translating {pve}.
+Download the language files
+https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here]. Then choose the
+language you want to improve. Right click on the "raw" link of this language
+file, and select 'Save Link As...'. Make your changes to the file, and then
+send your final translation directly to office(at)proxmox.com together with a
+signed
+{webwiki-url}Developer_Documentation#Software_License_and_Copyright[contributor
license agreement].
-We use https://www.gnu.org/software/gettext/[gettext] to translate {pve}.
-As a result, the actual translation task is to write a translation of the
-`msgid` into the `msgstr` below it.
-Tools like https://poedit.net/[Poedit] make this process more convenient,
-especially for contributors who are not programmers.
+We use https://www.gnu.org/software/gettext/[gettext] for the management of the
+translation files. Tools like https://poedit.net/[Poedit] offer a nice user
+interface to edit the translation files.
--
2.20.1
___
pve-devel mailing list
pve-devel@pve.proxmox.com
https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] [PATCH v4 docs 5/7] Overhaul Package Repositories
improve phrasing, align style of CLI commands
Signed-off-by: Aaron Lauterer
---
v2 -> v3:
rebased on current master
pve-package-repos.adoc | 143 +
1 file changed, 74 insertions(+), 69 deletions(-)
diff --git a/pve-package-repos.adoc b/pve-package-repos.adoc
index 078de95..e11f8ec 100644
--- a/pve-package-repos.adoc
+++ b/pve-package-repos.adoc
@@ -5,18 +5,16 @@ ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
-All Debian based systems use
-http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as package
-management tool. The list of repositories is defined in
-`/etc/apt/sources.list` and `.list` files found inside
-`/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
-`#` 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`.
+{pve} uses http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as package
+management tool like any other Debian-based system. Repositories are defined in
+the file `/etc/apt/sources.list` and in `.list` files placed in
+`/etc/apt/sources.list.d/`.
+
+Each line defines a package repository. The preferred source must come first.
+Empty lines are ignored. A `#` character anywhere on a line marks the remainder
+of that line as a comment. The available packages from a repository are
acquired
+by running `apt-get update`. Updates can be installed directly using `apt-get`,
+or via the GUI.
.File `/etc/apt/sources.list`
@@ -28,7 +26,7 @@ deb http://security.debian.org/debian-security buster/updates
main contrib
// FIXME for 7.0: change security update suite to bullseye-security
-In addition, {pve} provides three different package repositories.
+{pve} additionally provides three different package repositories.
[[sysadmin_enterprise_repo]]
{pve} Enterprise Repository
@@ -44,29 +42,25 @@ enabled by default:
deb https://enterprise.proxmox.com/debian/pve buster pve-enterprise
-As soon as updates are available, the `root@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.
-
-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.
+The `root@pam` user is notified via email about available updates. Click the
+'Changelog' button in the GUI to see more details about the selected update.
-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.
+You need a valid subscription key to access the `pve-enterprise` repository.
+Different support levels are available. 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.
[[sysadmin_no_subscription_repo]]
{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.
+This is the recommended repository for testing and non-production use. The
+packages are not headily tested and validated. You don't need a subscription
key
+to access the `pve-no-subscription` repository.
We recommend to configure this repository in `/etc/apt/sources.list`.
@@ -88,26 +82,25 @@ deb http://security.debian.org/debian-security
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:
+This repository contains the latest packages and is primarily used by
developers
+to test new features. To configure it, add 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
[pve-devel] [PATCH v4 docs 7/7] Fix whitespace and line length
Signed-off-by: Aaron Lauterer
---
v2 -> v3:
rebased on current master
getting-help.adoc| 9 -
howto-improve-pve-docs.adoc | 4 ++--
pve-installation.adoc| 14 +++---
pve-package-repos.adoc | 11 +--
pve-system-requirements.adoc | 4 ++--
sysadmin.adoc| 2 +-
6 files changed, 21 insertions(+), 23 deletions(-)
diff --git a/getting-help.adoc b/getting-help.adoc
index 8e81483..9f561c7 100644
--- a/getting-help.adoc
+++ b/getting-help.adoc
@@ -27,15 +27,14 @@ Mailing Lists
This is a fast way to communicate with the {pve} community via email.
* Mailing list for users:
- http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-user[PVE User
- List]
+ http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-user[PVE User List]
{pve} is fully open source and contributions are welcome! The primary
communication channel for developers is the:
-* Mailing list for developer:
- http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel[PVE
- development discussion]
+* Mailing list for developers:
+ http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel[PVE development
+ discussion]
Commercial Support
diff --git a/howto-improve-pve-docs.adoc b/howto-improve-pve-docs.adoc
index d96bb03..940e050 100644
--- a/howto-improve-pve-docs.adoc
+++ b/howto-improve-pve-docs.adoc
@@ -28,5 +28,5 @@ right option to contribute.
document.
NOTE: If you are interested in working on the {pve} codebase, the
-{webwiki-url}Developer_Documentation[Developer Documentation] wiki
-article will show you where to start.
+{webwiki-url}Developer_Documentation[Developer Documentation] wiki article will
+show you where to start.
diff --git a/pve-installation.adoc b/pve-installation.adoc
index 2ac47b2..2eb7cd6 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -35,13 +35,13 @@ Download the installer ISO at {website}en/downloads. It
includes the following:
* Complete operating system (Debian Linux, 64-bit)
-* The {pve} installer, which partitions the local disk(s) with ext4,
- ext3, xfs or ZFS and installs the operating system.
+* The {pve} installer, which partitions the local disk(s) with ext4, ext3, xfs
+ or ZFS and installs the operating system.
* {pve} kernel (Linux) with KVM and LXC support
-* Complete toolset for administering virtual machines, containers and
- all necessary resources
+* Complete toolset for administering virtual machines, containers, and all
+ necessary resources
* Web-based management interface
@@ -175,9 +175,9 @@ VG on the same hard disk that can be used for LVM storage).
`swapsize`::
-Defines the size of the `swap` volume. The default is the size of the
-installed memory, minimum 4 GB and maximum 8 GB. The resulting value cannot
-be greater than `hdsize/8`.
+Defines the size of the `swap` volume. The default is the size of the installed
+memory, minimum 4 GB and maximum 8 GB. The resulting value cannot be greater
+than `hdsize/8`.
+
NOTE: If set to `0`, no `swap` volume will be created.
diff --git a/pve-package-repos.adoc b/pve-package-repos.adoc
index e11f8ec..b7e7674 100644
--- a/pve-package-repos.adoc
+++ b/pve-package-repos.adoc
@@ -32,10 +32,9 @@ deb http://security.debian.org/debian-security
buster/updates main contrib
{pve} Enterprise Repository
~~~
-This is the default, stable and recommended repository, available for
-all {pve} subscription users. It contains the most stable packages,
-and is suitable for production use. The `pve-enterprise` repository is
-enabled by default:
+This is the default, stable, and recommended repository, available for all
{pve}
+subscription users. It contains the most stable packages and is suitable for
+production use. The `pve-enterprise` repository is enabled by default:
.File `/etc/apt/sources.list.d/pve-enterprise.list`
@@ -277,8 +276,8 @@ deb http://security.debian.org/ squeeze/updates main contrib
Outdated: {pve} VE 1.x Repositories
~~~
-{pve} 1.x is based on Debian 5.0 (``lenny'') and very outdated. Please
-upgrade to latest version as soon as possible.
+{pve} 1.x is based on Debian 5.0 (``lenny'') and very outdated. Please upgrade
+to latest version as soon as possible.
endif::wiki[]
diff --git a/pve-system-requirements.adoc b/pve-system-requirements.adoc
index c0e6258..5b09058 100644
--- a/pve-system-requirements.adoc
+++ b/pve-system-requirements.adoc
@@ -62,8 +62,8 @@ Simple performance overview
To get an overview of the CPU and hard disk performance on an installed {pve}
system, run the included `pveperf` tool.
-NOTE: this is just a very quick and general benchmark. More detailed tests
-are recommended, especially regarding the I/O performance of your system.
+NOTE: this is just a very quick and general benchmark. More detailed tests are
+recommended, especially regarding the I/O performance of your system.
Supported web browsers for accessing the web
[pve-devel] [PATCH v4 docs 2/7] Overhaul System Requirements
improve phrasing, align headlines, rearrange requirement lists
Signed-off-by: Aaron Lauterer
---
v3 -> v4:
rephrased OS storage and NIC requirements to be more specific
aligned third level headlines to sentence style to conform to style
guide
v2 -> v3:
rebased on current master
v1 -> v2:
applied (some) suggestions from oguz [0], IO performance is based on the
whole system, not just disks
[0] https://pve.proxmox.com/pipermail/pve-devel/2019-September/038953.html
pve-system-requirements.adoc | 71 +++-
1 file changed, 37 insertions(+), 34 deletions(-)
diff --git a/pve-system-requirements.adoc b/pve-system-requirements.adoc
index 0a4ba6c..c0e6258 100644
--- a/pve-system-requirements.adoc
+++ b/pve-system-requirements.adoc
@@ -4,22 +4,23 @@ ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
-For production servers, high quality server equipment is needed. Keep
-in mind, if you run 10 Virtual Servers on one machine and you then
-experience a hardware failure, 10 services are lost. {pve}
-supports clustering, this means that multiple {pve} installations
-can be centrally managed thanks to the included cluster functionality.
+We recommend to use high quality server hardware when running {pve} in
+production. To further decrease the impact of a failed host you can run {pve}
in
+a cluster with highly available (HA) virtual machines and containers.
-{pve} can use local storage (DAS), SAN, NAS and also distributed
-storage (Ceph RBD). For details see xref:chapter_storage[chapter storage].
+{pve} can use local storage (DAS), SAN, NAS, and distributed storage like Ceph
+RBD. For details see xref:chapter_storage[chapter storage].
[[install_minimal_requirements]]
-Minimum Requirements, for Evaluation
+Minimum requirements, for evaluation
+These minimum requirements are for evaluation purposes only and should not be
+used in production.
+
* CPU: 64bit (Intel EMT64 or AMD64)
-* Intel VT/AMD-V capable CPU/Mainboard for KVM Full Virtualization support
+* Intel VT/AMD-V capable CPU/Mainboard for KVM full virtualization support
* RAM: 1 GB RAM, plus additional RAM used for guests
@@ -29,49 +30,51 @@ Minimum Requirements, for Evaluation
[[install_recommended_requirements]]
-Recommended System Requirements
+Recommended system requirements
~~~
* Intel EMT64 or AMD64 with Intel VT/AMD-V CPU flag.
-* Memory, minimum 2 GB for OS and Proxmox VE services. Plus designated memory
- for guests. For Ceph or ZFS additional memory is required, approximately 1 GB
- memory for every TB used storage.
+* Memory, minimum 2 GB for the OS and {pve} services. Plus designated memory
for
+ guests. For Ceph and ZFS additional memory is required; approximately 1GB of
+ memory for every TB of used storage.
-* Fast and redundant storage, best results with SSD disks.
+* Fast and redundant storage, best results are achieved with SSDs.
-* OS storage: Hardware RAID with batteries protected write cache (``BBU'') or
- non-RAID with ZFS and SSD cache.
+* OS storage: Use a hardware RAID with battery protected write cache (``BBU'')
+ or non-RAID with ZFS (optional SSD for ZIL).
-* VM storage: For local storage use a hardware RAID with battery backed
- write cache (BBU) or non-RAID for ZFS. Neither ZFS nor Ceph are compatible
- with a hardware RAID controller. Shared and distributed storage is also
- possible.
+* VM storage:
+** For local storage use either a hardware RAID with battery backed write cache
+ (BBU) or non-RAID for ZFS and Ceph. Neither ZFS nor Ceph are compatible with
a
+ hardware RAID controller.
+** Shared and distributed storage is possible.
-* Redundant Gbit NICs, additional NICs depending on the preferred storage
- technology and cluster setup – 10 Gbit and higher is also supported.
+* Redundant (Multi-)Gbit NICs with additional NICs depending on the preferred
+ storage technology and cluster setup.
-* For PCI passthrough a CPU with VT-d/AMD-d CPU flag is needed.
+* For PCI(e) passthrough the CPU needs to support the VT-d/AMD-d flag.
-Simple Performance Overview
+Simple performance overview
~~~
-On an installed {pve} system, you can run the included `pveperf` script
-to obtain an overview of the CPU and hard disk performance.
+To get an overview of the CPU and hard disk performance on an installed {pve}
+system, run the included `pveperf` tool.
NOTE: this is just a very quick and general benchmark. More detailed tests
are recommended, especially regarding the I/O performance of your system.
Supported web browsers for accessing the web interface
~~
-To use the web interface you need a modern browser, this includes:
-* Firefox, a release from the current year, or the latest Extended
-Support Release
-* Chrome, a release from the current year
-* Microsofts currently supported version of Edge
-* Safari, a
[pve-devel] [PATCH v4 docs 4/7] Overhaul Sysadmin
improve phrasing
Signed-off-by: Aaron Lauterer
---
v2 -> v3:
rebased on current master
v1 -> v2:
applied suggestions from oguz [0]
[0] https://pve.proxmox.com/pipermail/pve-devel/2019-September/038966.html
sysadmin.adoc | 38 ++
1 file changed, 14 insertions(+), 24 deletions(-)
diff --git a/sysadmin.adoc b/sysadmin.adoc
index e045610..86b61f0 100644
--- a/sysadmin.adoc
+++ b/sysadmin.adoc
@@ -5,31 +5,21 @@ ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]
-{pve} is based on the famous https://www.debian.org/[Debian] Linux
-distribution. That means that you have access to the whole world of
-Debian packages, and the base system is well documented. The
+The following sections will focus on common virtualization tasks and explain
the
+{pve} specifics regarding the administration and management of the host
machine.
+
+{pve} is based on https://www.debian.org/[Debian GNU/Linux] with additional
+repositories to provide the {pve} related packages. This means that the full
+range of Debian packages is available including security updates and bug fixes.
+{pve} provides it's own Linux kernel based on the Ubuntu kernel. It has all the
+necessary virtualization and container features enabled and includes
+https://zfsonlinux.org[ZFS] and several extra hardware drivers.
+
+For other topics not included in the following sections, please refer to the
+Debian documentation. The
https://debian-handbook.info/download/stable/debian-handbook.pdf[Debian
-Administrator\'s Handbook] is available online, and provides a
-comprehensive introduction to the Debian operating system (see
-xref:Hertzog13[]).
-
-A standard {pve} installation uses the default repositories from
-Debian, so you get bug fixes and security updates through that
-channel. In addition, we provide our own package repository to roll
-out all {pve} related packages. This includes updates to some
-Debian packages when necessary.
-
-We also deliver a specially optimized Linux kernel, where we enable all
-required virtualization and container features. That kernel includes
-drivers for http://zfsonlinux.org/[ZFS], and several hardware drivers.
-For example, we ship Intel network card drivers to support their
-newest hardware.
-
-The following sections will concentrate on virtualization related
-topics. They either explain things which are different on {pve}, or
-tasks which are commonly used on {pve}. For other topics, please refer
-to the standard Debian documentation.
-
+Administrator\'s Handbook] is available online, and provides a comprehensive
+introduction to the Debian operating system (see xref:Hertzog13[]).
ifdef::wiki[]
--
2.20.1
___
pve-devel mailing list
pve-devel@pve.proxmox.com
https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] [PATCH v5 docs 1/3] Overhaul Package Repositories
improve phrasing, align style of CLI commands
Signed-off-by: Aaron Lauterer
---
Please use this patch instead. I forgot to incorporate some changes.
v4 -> v5: actually incroporate reported issues
pve-package-repos.adoc | 143 +
1 file changed, 74 insertions(+), 69 deletions(-)
diff --git a/pve-package-repos.adoc b/pve-package-repos.adoc
index 078de95..3358232 100644
--- a/pve-package-repos.adoc
+++ b/pve-package-repos.adoc
@@ -5,18 +5,16 @@ ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
-All Debian based systems use
-http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as package
-management tool. The list of repositories is defined in
-`/etc/apt/sources.list` and `.list` files found inside
-`/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
-`#` 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`.
+{pve} uses http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as its
+package management tool like any other Debian-based system. Repositories are
+defined in the file `/etc/apt/sources.list` and in `.list` files placed in
+`/etc/apt/sources.list.d/`.
+
+Each line defines a package repository. The preferred source must come first.
+Empty lines are ignored. A `#` character anywhere on a line marks the remainder
+of that line as a comment. The available packages from a repository are
acquired
+by running `apt-get update`. Updates can be installed directly using `apt-get`,
+or via the GUI.
.File `/etc/apt/sources.list`
@@ -28,7 +26,7 @@ deb http://security.debian.org/debian-security buster/updates
main contrib
// FIXME for 7.0: change security update suite to bullseye-security
-In addition, {pve} provides three different package repositories.
+{pve} additionally provides three different package repositories.
[[sysadmin_enterprise_repo]]
{pve} Enterprise Repository
@@ -44,29 +42,25 @@ enabled by default:
deb https://enterprise.proxmox.com/debian/pve buster pve-enterprise
-As soon as updates are available, the `root@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.
-
-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.
+The `root@pam` user is notified via email about available updates. Click the
+'Changelog' button in the GUI to see more details about the selected update.
-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.
+You need a valid subscription key to access the `pve-enterprise` repository.
+Different support levels are available. 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.
[[sysadmin_no_subscription_repo]]
{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.
+This is the recommended repository for testing and non-production use. Its
+packages are not as heavily tested and validated. You don't need a
subscription key
+to access the `pve-no-subscription` repository.
We recommend to configure this repository in `/etc/apt/sources.list`.
@@ -88,26 +82,25 @@ deb http://security.debian.org/debian-security
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:
+This repository contains the latest packages and is primarily used by
developers
+to test new features. To configure it, add 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
[pve-devel] applied: [PATCH ha-manager] fix service name for pve-ha-crm
On 2/11/20 9:26 AM, Oguz Bektas wrote: > "PVE Cluster Resource Manager Daemon" should be "PVE Cluster HA Resource > Manager Daemon" > > [0]: https://forum.proxmox.com/threads/typo-omission.65107/ > > Signed-off-by: Oguz Bektas > --- > debian/pve-ha-crm.service | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > applied, thanks! ___ pve-devel mailing list pve-devel@pve.proxmox.com https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] [PATCH manager v2 1/2] gui: TFAEdit: use viemodel binding for hiding/showing qr code
the verification textfield, and the selected tab.
also remove the code that used the value by the userview panel, since
this is the only way to have a consistent behaviour on the userview
setting and the usermenu tfa setting
this fixes the issue that on the 'user menu' we accidentally showed
the qr code and verification field, even if the user already had a
totp code
now it shows 'Unchanged' like when opened via dc/UserView
Signed-off-by: Dominik Csapak
---
changes from v1:
* remove the code that handles the tfa type of the user.cfg and
always rely on the tfa api call, to get consistent behaviour
everywhere
* control the active tab via bind (this is not a two-way bind)
www/manager6/dc/TFAEdit.js | 51 +-
1 file changed, 34 insertions(+), 17 deletions(-)
diff --git a/www/manager6/dc/TFAEdit.js b/www/manager6/dc/TFAEdit.js
index 8f3017f6..f8afa0a5 100644
--- a/www/manager6/dc/TFAEdit.js
+++ b/www/manager6/dc/TFAEdit.js
@@ -102,9 +102,13 @@ Ext.define('PVE.window.TFAEdit', {
tfa_required: false,
tfa_type: null, // dependencies of formulas should not be undefined
valid: false,
- u2f_available: true
+ u2f_available: true,
+ secret: "",
},
formulas: {
+ showTOTPVerifiction: function(get) {
+ return get('secret').length > 0 && get('canSetupTOTP');
+ },
canDeleteTFA: function(get) {
return (get('tfa_type') !== null && !get('tfa_required'));
},
@@ -115,7 +119,13 @@ Ext.define('PVE.window.TFAEdit', {
canSetupU2F: function(get) {
var tfa = get('tfa_type');
return (get('u2f_available') && (tfa === null || tfa === 'u2f'
|| tfa === 1));
- }
+ },
+ secretEmpty: function(get) {
+ return get('secret').length === 0;
+ },
+ selectedTab: function(get) {
+ return (get('tfa_type') || 'totp') + '-panel';
+ },
}
},
@@ -124,7 +134,14 @@ Ext.define('PVE.window.TFAEdit', {
var viewmodel = me.getViewModel();
if (user_tfa_type === 'oath') {
user_tfa_type = 'totp';
+ viewmodel.set('secret', '');
+ }
+
+ // if the user has no tfa, generate a secret for him
+ if (!user_tfa_type) {
+ me.getController().randomizeSecret();
}
+
viewmodel.set('tfa_type', user_tfa_type || null);
if (!realm_tfa_type) {
// There's no TFA enforced by the realm, everything works.
@@ -136,8 +153,7 @@ Ext.define('PVE.window.TFAEdit', {
// user had a different tfa method, so
// we have to change back to the totp tab and
// generate a secret
- viewmodel.set('tfa_type', null);
- me.lookup('tfatabs').setActiveTab(me.lookup('totp_panel'));
+ viewmodel.set('tfa_type', 'totp');
me.getController().randomizeSecret();
}
viewmodel.set('tfa_required', true);
@@ -201,18 +217,6 @@ Ext.define('PVE.window.TFAEdit', {
});
me.down('#qrbox').getEl().appendChild(me.qrdiv);
- viewmodel.set('tfa_type', me.tfa_type || null);
- if (!me.tfa_type) {
- this.randomizeSecret();
- } else {
- me.down('#qrbox').setVisible(false);
- me.lookup('challenge').setVisible(false);
- if (me.tfa_type === 'u2f') {
- var u2f_panel = me.lookup('u2f_panel');
- me.lookup('tfatabs').setActiveTab(u2f_panel);
- }
- }
-
if (Proxmox.UserName === 'root@pam') {
me.lookup('password').setVisible(false);
me.lookup('password').setDisabled(true);
@@ -303,7 +307,7 @@ Ext.define('PVE.window.TFAEdit', {
data += String.fromCharCode(b-26 + 0x32);
}
});
- me.lookup('tfa_secret').setValue(data);
+ me.getViewModel().set('secret', data);
},
startU2FRegistration: function() {
@@ -339,6 +343,9 @@ Ext.define('PVE.window.TFAEdit', {
itemId: 'tfatabs',
reference: 'tfatabs',
border: false,
+ bind: {
+ activeTab: '{selectedTab}',
+ },
items: [
{
xtype: 'panel',
@@ -386,6 +393,9 @@ Ext.define('PVE.window.TFAEdit', {
regexText: 'Must be base32 [A-Z2-7=]',
maskRe: /[A-Z2-7=]/,
qrupdate: true,
+ bind: {
+ value: "{secret}",
+
[pve-devel] [PATCH manager v2 2/2] gui: dc/TFAEdit: show an error message if tfa api call fails
setting the loadmask did not really work, so show a messagebox instead
and close the window
Signed-off-by: Dominik Csapak
---
new in v2
www/manager6/dc/TFAEdit.js | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/www/manager6/dc/TFAEdit.js b/www/manager6/dc/TFAEdit.js
index f8afa0a5..bf51b8c9 100644
--- a/www/manager6/dc/TFAEdit.js
+++ b/www/manager6/dc/TFAEdit.js
@@ -205,7 +205,8 @@ Ext.define('PVE.window.TFAEdit', {
me.afterLoading(data.realm, data.user);
},
failure: function(response, opts) {
- Proxmox.Utils.setErrorMask(loadMaskContainer,
response.htmlStatus);
+ me.close();
+ Ext.Msg.alert(gettext('Error'),
response.htmlStatus);
}
});
--
2.20.1
___
pve-devel mailing list
pve-devel@pve.proxmox.com
https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] [PATCH ha-manager] fix service name for pve-ha-crm
"PVE Cluster Resource Manager Daemon" should be "PVE Cluster HA Resource Manager Daemon" [0]: https://forum.proxmox.com/threads/typo-omission.65107/ Signed-off-by: Oguz Bektas --- debian/pve-ha-crm.service | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/debian/pve-ha-crm.service b/debian/pve-ha-crm.service index b54992f..6b57e9f 100644 --- a/debian/pve-ha-crm.service +++ b/debian/pve-ha-crm.service @@ -1,5 +1,5 @@ [Unit] -Description=PVE Cluster Resource Manager Daemon +Description=PVE Cluster HA Resource Manager Daemon ConditionPathExists=/usr/sbin/pve-ha-crm Wants=pve-cluster.service Wants=watchdog-mux.service -- 2.20.1 ___ pve-devel mailing list pve-devel@pve.proxmox.com https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] applied-series: [PATCH v4 docs 0/7] Documenation overhaul chapt. 1.12 to 3.2
On 2/11/20 9:55 AM, Aaron Lauterer wrote: > This is the first patch series aimed to overhaul our documentation. The > main goal is to make it easier to understand and more consistent. > Therefore the phrasing is changed in a lot of places, sometimes the > ordering of content as well. I tried to align the source to the 80 > characters per line wherever possible. > > The reason why this first patch series doesn't start at the very > beginning is because we are not yet happy with few things there. > applied series, but not really happy how you just ignored Stefan's and my comment about why you change title capitalization in just a single patch (sys requirements one) to something nowhere else used in the docs.. Fixed that up and made a few general followup patches, renaming the "USB flash drive" to "Prepare Installation Media" and re-ordering it before "Using the Proxmox VE Installer" which makes quite more sense. IMO, a series and months-of-work effort called "overhauling the documentation" should also care for such details, i.e., do a step backward and see if the general order, flow, .. is all right and somewhat sound. As else I'd rather just have "grammar + typo fixes" getting in in continuous small patches and see bigger effort on expanding the documentation with new content. Thanks! > v3 -> v4: > fixed some phrasings and minor issues reported on v3 > > v2 -> v3: > rebased on current master > > v1[0] -> v2: > > * incorporating suggestions received > * moved line length and white space fixes to separate patch > > [0] https://pve.proxmox.com/pipermail/pve-devel/2019-September/038938.html > > Aaron Lauterer (7): > Overhaul Translation > Overhaul System Requirements > Overhaul Install from USB flash drive > Overhaul Sysadmin > Overhaul Package Repositories > OVerhaul System Software Updates > Fix whitespace and line length > > getting-help.adoc| 9 +- > howto-improve-pve-docs.adoc | 4 +- > pve-installation.adoc| 14 ++-- > pve-package-repos.adoc | 154 ++- > pve-system-requirements.adoc | 75 + > pve-usbstick.adoc| 109 - > sysadmin.adoc| 40 - > system-software-updates.adoc | 25 +++--- > translation.adoc | 37 + > 9 files changed, 229 insertions(+), 238 deletions(-) > ___ pve-devel mailing list pve-devel@pve.proxmox.com https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] applied: [PATCH manager v2 1/2] gui: TFAEdit: use viemodel binding for hiding/showing qr code
On 2/11/20 10:01 AM, Dominik Csapak wrote: > the verification textfield, and the selected tab. > > also remove the code that used the value by the userview panel, since > this is the only way to have a consistent behaviour on the userview > setting and the usermenu tfa setting > > this fixes the issue that on the 'user menu' we accidentally showed > the qr code and verification field, even if the user already had a > totp code > > now it shows 'Unchanged' like when opened via dc/UserView > > Signed-off-by: Dominik Csapak > --- > changes from v1: > * remove the code that handles the tfa type of the user.cfg and > always rely on the tfa api call, to get consistent behaviour > everywhere > * control the active tab via bind (this is not a two-way bind) > > www/manager6/dc/TFAEdit.js | 51 +- > 1 file changed, 34 insertions(+), 17 deletions(-) > now all works well, much thanks! applied ___ pve-devel mailing list pve-devel@pve.proxmox.com https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] applied: [PATCH manager v2 2/2] gui: dc/TFAEdit: show an error message if tfa api call fails
On 2/11/20 10:01 AM, Dominik Csapak wrote:
> setting the loadmask did not really work, so show a messagebox instead
> and close the window
>
> Signed-off-by: Dominik Csapak
> ---
> new in v2
> www/manager6/dc/TFAEdit.js | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/www/manager6/dc/TFAEdit.js b/www/manager6/dc/TFAEdit.js
> index f8afa0a5..bf51b8c9 100644
> --- a/www/manager6/dc/TFAEdit.js
> +++ b/www/manager6/dc/TFAEdit.js
> @@ -205,7 +205,8 @@ Ext.define('PVE.window.TFAEdit', {
> me.afterLoading(data.realm, data.user);
> },
> failure: function(response, opts) {
> - Proxmox.Utils.setErrorMask(loadMaskContainer,
> response.htmlStatus);
> + me.close();
> + Ext.Msg.alert(gettext('Error'),
> response.htmlStatus);
> }
> });
>
>
applied, thanks
___
pve-devel mailing list
pve-devel@pve.proxmox.com
https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
[pve-devel] applied-series: [PATCH pve-network 0/7] vlan|qinq : use bridge instead uplink-id
On 2/10/20 5:26 PM, Alexandre Derumier wrote: > This patch series remove the uplink-id option for vlan|qinq plugin, > and now use "bridge" options. > > This will use an already local vmbr defined bridge. > This is working with vlan-aware bridge and also ovs bridge. > > > Alexandre Derumier (7): > vlan/qinq: use bridge option instead uplink-id > move status code to zone plugin > vlanplugin: add status > qinq plugin :add status > api2: fix vnet status > move mtu properties to zone > add get_bridge_vlan > > PVE/API2/Network/SDN/Zones/Content.pm | 2 +- > PVE/Network/SDN/VnetPlugin.pm | 6 -- > PVE/Network/SDN/Zones.pm | 55 -- > PVE/Network/SDN/Zones/EvpnPlugin.pm | 3 +- > PVE/Network/SDN/Zones/FaucetPlugin.pm | 2 +- > PVE/Network/SDN/Zones/Plugin.pm | 40 ++ > PVE/Network/SDN/Zones/QinQPlugin.pm | 104 +++--- > PVE/Network/SDN/Zones/VlanPlugin.pm | 58 +++--- > PVE/Network/SDN/Zones/VxlanPlugin.pm | 3 +- > test/documentation.txt| 8 +- > 10 files changed, 174 insertions(+), 107 deletions(-) > applied series, thanks! ___ pve-devel mailing list pve-devel@pve.proxmox.com https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
