[pve-devel] [PATCH docs] pct: add section for supported distributions

[pve-devel] [PATCH docs] pct: add section for supported distributions

[Oguz Bektas]

adds a simple section with a list of officially supported templates

Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
---
 pct.adoc | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 70 insertions(+), 6 deletions(-)

diff --git a/pct.adoc b/pct.adoc
index d01e6d7..1415f67 100644
--- a/pct.adoc
+++ b/pct.adoc
@@ -84,13 +84,77 @@ Technology Overview
 
 * Modern Linux kernels
 
-* Image based deployment (templates)
+* Image based deployment (xref:pct_supported_distributions[templates])
 
 * Uses {pve} xref:chapter_storage[storage library]
 
 * Container setup from host (network, DNS, storage, etc.)
 
 
+[[pct_supported_distributions]]
+Supported Distributions
+~~~~~~~~~~~~~~~~~~~~~~~
+
+List of officially supported distributions can be found below.
+
+Templates for the following distributions are available through our
+repositories. You can use xref:pct_container_images[pveam] tool or the
+Graphical User Interface to download them.
+
+Alma Linux
+^^^^^^^^^^
+* Almalinux 8
+
+Alpine Linux
+^^^^^^^^^^^^
+* Alpine 3.12
+* Alpine 3.13
+* Alpine 3.14
+
+Archlinux
+^^^^^^^^^
+* Archlinux Base (20210420)
+
+CentOS
+^^^^^^
+* CentOS 7
+* CentOS 8
+
+Debian
+^^^^^^
+* Debian 10 (Buster)
+* Debian 11 (Bullseye)
+
+Devuan
+^^^^^^
+* Devuan 3.0
+
+Fedora
+^^^^^^
+* Fedora 33
+* Fedora 34
+
+Gentoo
+^^^^^^
+* Gentoo Current (20200310)
+
+OpenSUSE
+^^^^^^^^
+* OpenSUSE 15.3
+
+Rocky Linux
+^^^^^^^^^^^
+* Rocky Linux 8
+
+Ubuntu
+^^^^^^
+* Ubuntu 16.04 (Xenial Xerus)
+* Ubuntu 18.04 (Bionic Beaver)
+* Ubuntu 20.04 (Focal Fossa)
+* Ubuntu 21.04 (Hirsute Hippo)
+* Ubuntu 21.10 (Impish Indri)
+
+
 [[pct_container_images]]
 Container Images
 ----------------
@@ -98,11 +162,11 @@ Container Images
 Container images, sometimes also referred to as ``templates'' or
 ``appliances'', are `tar` archives which contain everything to run a container.
 
-{pve} itself provides a variety of basic templates for the most common Linux
-distributions. They can be downloaded using the GUI or the `pveam` (short for
-{pve} Appliance Manager) command line utility.
-Additionally, https://www.turnkeylinux.org/[TurnKey Linux] container templates
-are also available to download.
+{pve} itself provides a variety of basic templates for the
+xref:pct_supported_distributions[most common Linuxdistributions].  They can be
+downloaded using the GUI or the `pveam` (short for {pve} Appliance Manager)
+command line utility.  Additionally, https://www.turnkeylinux.org/[TurnKey
+Linux] container templates are also available to download.
 
 The list of available templates is updated daily through the 'pve-daily-update'
 timer. You can also trigger an update manually by executing:
-- 
2.30.2

Re: [pve-devel] [PATCH docs] pct: add section for supported distributions

[Thomas Lamprecht]

On 13.10.21 12:59, Oguz Bektas wrote:
> adds a simple section with a list of officially supported templates
> 
> Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
> ---
>  pct.adoc | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++-----
>  1 file changed, 70 insertions(+), 6 deletions(-)
> 
> diff --git a/pct.adoc b/pct.adoc
> index d01e6d7..1415f67 100644
> --- a/pct.adoc
> +++ b/pct.adoc
> @@ -84,13 +84,77 @@ Technology Overview
>  
>  * Modern Linux kernels
>  
> -* Image based deployment (templates)
> +* Image based deployment (xref:pct_supported_distributions[templates])
>  
>  * Uses {pve} xref:chapter_storage[storage library]
>  
>  * Container setup from host (network, DNS, storage, etc.)
>  
>  
> +[[pct_supported_distributions]]
> +Supported Distributions
> +~~~~~~~~~~~~~~~~~~~~~~~
> +
> +List of officially supported distributions can be found below.
> +
> +Templates for the following distributions are available through our
> +repositories. You can use xref:pct_container_images[pveam] tool or the
> +Graphical User Interface to download them.
> +
> +Alma Linux
> +^^^^^^^^^^
> +* Almalinux 8
> +

I'd throw Alma and Rocky into the section with CentOS, i.e.

CentOS, AlmaLinux, Rocky Linux
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

(AlmaLinux is spelled without a space)

> +Alpine Linux
> +^^^^^^^^^^^^

Can we add a small sentence describing the distro in short to readers and linking
to the project page here and for the other distro sections?

E.g., the quote from the alpine linux site:

"Alpine Linux is a security-oriented, lightweight Linux distribution based on musl libc and busybox."
-- https://alpinelinux.org/

> +* Alpine 3.12
> +* Alpine 3.13
> +* Alpine 3.14


Hmm, I'd maybe avoid the list of exact release, tends to be outdated to fast
for some.

Maybe we can link to the respective upstream release pages?

E.g.,
- https://alpinelinux.org/releases/
- https://wiki.ubuntu.com/Releases
- https://fedoraproject.org/wiki/Releases
- ...

> +
> +Archlinux
> +^^^^^^^^^
> +* Archlinux Base (20210420)
> +
> +CentOS
> +^^^^^^
> +* CentOS 7
> +* CentOS 8
> +
> +Debian
> +^^^^^^
> +* Debian 10 (Buster)
> +* Debian 11 (Bullseye)
> +
> +Devuan
> +^^^^^^
> +* Devuan 3.0
> +
> +Fedora
> +^^^^^^
> +* Fedora 33
> +* Fedora 34
> +
> +Gentoo
> +^^^^^^
> +* Gentoo Current (20200310)
> +
> +OpenSUSE
> +^^^^^^^^
> +* OpenSUSE 15.3
> +
> +Rocky Linux
> +^^^^^^^^^^^
> +* Rocky Linux 8
> +
> +Ubuntu
> +^^^^^^
> +* Ubuntu 16.04 (Xenial Xerus)
> +* Ubuntu 18.04 (Bionic Beaver)
> +* Ubuntu 20.04 (Focal Fossa)
> +* Ubuntu 21.04 (Hirsute Hippo)
> +* Ubuntu 21.10 (Impish Indri)
> +
> +
>  [[pct_container_images]]
>  Container Images
>  ----------------
> @@ -98,11 +162,11 @@ Container Images
>  Container images, sometimes also referred to as ``templates'' or
>  ``appliances'', are `tar` archives which contain everything to run a container.
>  
> -{pve} itself provides a variety of basic templates for the most common Linux
> -distributions. They can be downloaded using the GUI or the `pveam` (short for
> -{pve} Appliance Manager) command line utility.
> -Additionally, https://www.turnkeylinux.org/[TurnKey Linux] container templates
> -are also available to download.
> +{pve} itself provides a variety of basic templates for the
> +xref:pct_supported_distributions[most common Linuxdistributions].  They can be

"Linux distributions" needs a space in-between I'd figure?

> +downloaded using the GUI or the `pveam` (short for {pve} Appliance Manager)
> +command line utility.  Additionally, https://www.turnkeylinux.org/[TurnKey
> +Linux] container templates are also available to download.
>  
>  The list of available templates is updated daily through the 'pve-daily-update'
>  timer. You can also trigger an update manually by executing:
> 

Re: [pve-devel] [PATCH docs] pct: add section for supported distributions

[Oguz Bektas]

hi,

On Thu, Oct 14, 2021 at 07:35:23AM +0200, Thomas Lamprecht wrote:
> On 13.10.21 12:59, Oguz Bektas wrote:
> > adds a simple section with a list of officially supported templates
> > 
> > Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
> > ---
> >  pct.adoc | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++-----
> >  1 file changed, 70 insertions(+), 6 deletions(-)
> > 
> > diff --git a/pct.adoc b/pct.adoc
> > index d01e6d7..1415f67 100644
> > --- a/pct.adoc
> > +++ b/pct.adoc
> > @@ -84,13 +84,77 @@ Technology Overview
> >  
> >  * Modern Linux kernels
> >  
> > -* Image based deployment (templates)
> > +* Image based deployment (xref:pct_supported_distributions[templates])
> >  
> >  * Uses {pve} xref:chapter_storage[storage library]
> >  
> >  * Container setup from host (network, DNS, storage, etc.)
> >  
> >  
> > +[[pct_supported_distributions]]
> > +Supported Distributions
> > +~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +List of officially supported distributions can be found below.
> > +
> > +Templates for the following distributions are available through our
> > +repositories. You can use xref:pct_container_images[pveam] tool or the
> > +Graphical User Interface to download them.
> > +
> > +Alma Linux
> > +^^^^^^^^^^
> > +* Almalinux 8
> > +
> 
> I'd throw Alma and Rocky into the section with CentOS, i.e.
> 
> CentOS, AlmaLinux, Rocky Linux
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> (AlmaLinux is spelled without a space)


yep okay
> 
> > +Alpine Linux
> > +^^^^^^^^^^^^
> 
> Can we add a small sentence describing the distro in short to readers and linking
> to the project page here and for the other distro sections?

yeah sounds good

> 
> E.g., the quote from the alpine linux site:
> 
> "Alpine Linux is a security-oriented, lightweight Linux distribution based on musl libc and busybox."
> -- https://alpinelinux.org/
> 
> > +* Alpine 3.12
> > +* Alpine 3.13
> > +* Alpine 3.14
> 
> 
> Hmm, I'd maybe avoid the list of exact release, tends to be outdated to fast
> for some.
> 
> Maybe we can link to the respective upstream release pages?

i thought it'd make sense to have a list, but yeah i suppose we can link
to their release pages. 

> 
> E.g.,
> - https://alpinelinux.org/releases/
> - https://wiki.ubuntu.com/Releases
> - https://fedoraproject.org/wiki/Releases
> - ...
> 
> > +
> > +Archlinux
> > +^^^^^^^^^
> > +* Archlinux Base (20210420)
> > +
> > +CentOS
> > +^^^^^^
> > +* CentOS 7
> > +* CentOS 8
> > +
> > +Debian
> > +^^^^^^
> > +* Debian 10 (Buster)
> > +* Debian 11 (Bullseye)
> > +
> > +Devuan
> > +^^^^^^
> > +* Devuan 3.0
> > +
> > +Fedora
> > +^^^^^^
> > +* Fedora 33
> > +* Fedora 34
> > +
> > +Gentoo
> > +^^^^^^
> > +* Gentoo Current (20200310)
> > +
> > +OpenSUSE
> > +^^^^^^^^
> > +* OpenSUSE 15.3
> > +
> > +Rocky Linux
> > +^^^^^^^^^^^
> > +* Rocky Linux 8
> > +
> > +Ubuntu
> > +^^^^^^
> > +* Ubuntu 16.04 (Xenial Xerus)
> > +* Ubuntu 18.04 (Bionic Beaver)
> > +* Ubuntu 20.04 (Focal Fossa)
> > +* Ubuntu 21.04 (Hirsute Hippo)
> > +* Ubuntu 21.10 (Impish Indri)
> > +
> > +
> >  [[pct_container_images]]
> >  Container Images
> >  ----------------
> > @@ -98,11 +162,11 @@ Container Images
> >  Container images, sometimes also referred to as ``templates'' or
> >  ``appliances'', are `tar` archives which contain everything to run a container.
> >  
> > -{pve} itself provides a variety of basic templates for the most common Linux
> > -distributions. They can be downloaded using the GUI or the `pveam` (short for
> > -{pve} Appliance Manager) command line utility.
> > -Additionally, https://www.turnkeylinux.org/[TurnKey Linux] container templates
> > -are also available to download.
> > +{pve} itself provides a variety of basic templates for the
> > +xref:pct_supported_distributions[most common Linuxdistributions].  They can be
> 
> "Linux distributions" needs a space in-between I'd figure?

indeed, vim decided it doesn't :D

> 
> > +downloaded using the GUI or the `pveam` (short for {pve} Appliance Manager)
> > +command line utility.  Additionally, https://www.turnkeylinux.org/[TurnKey
> > +Linux] container templates are also available to download.
> >  
> >  The list of available templates is updated daily through the 'pve-daily-update'
> >  timer. You can also trigger an update manually by executing:
> > 
> 

Re: [pve-devel] [PATCH docs] pct: add section for supported distributions

[Thomas Lamprecht]

On 14.10.21 08:22, Oguz Bektas wrote:
>> Hmm, I'd maybe avoid the list of exact release, tends to be outdated to fast
>> for some.
>>
>> Maybe we can link to the respective upstream release pages?
> i thought it'd make sense to have a list, but yeah i suppose we can link
> to their release pages. 
> 

I get where you come from, but I think we could generate a html page with the up-to-date
list in a table from the source of truth (aplindex on download server) and then link
to that once its available.

I need to make some changes there anyway (for ensuring that we can update the pve 7
index without touching the pve 6 one), and outputting a HTML table isn't to hard,
so maybe I can take a stab at that too while at it.