pve-doc-generator: add rules for API verification

since API verification happens in the same places as man page and bash
completion generation, and is identical across the board.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

pve-doc-generator: add rules for bash-completion

while these are not strictly documentation, they use the same mechanisms
and are generated at the same time as the man pages.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

pve-doc-generator: make include dirs configurable

by setting PERL_DOC_INC_DIRS before including pve-doc-generator.mk

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

Adjust example cipher string in doc for default

Even though this is meant as an example, it makes sense to keep it in
sync with what the actual default is.

Signed-off-by: Rhonda D'Vine <rhonda@proxmox.com>

minor cleanups, typo and whitespace fixes

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

improve spectre/meltdown cpu flags documentation

-add new cpuflags for spectre v4.
-split cpuflags between amd && intel processors

firewall doc : remove wrong note

Documentation said that vm need to be restart after enable/disable
firewall option on interface.

This is wrong, the fwbr is added/removed online, and tap are
unplug/plug to fwbr online too

qm: vmgenid: add note for initial addition on existing VMs

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

qm: vmgenid: fix spacing and reword,

also pass links as footnote, link to a conmon guid generator, ...

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

qm: add vmgenid documentation

explain how to use it, what it is and a link to further documentation

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

api-viewer: correctly escape html when displaying return types.

Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>

buildsys: allow missing pve-doc-generator.mk on build/clean

Avoids the following warning when running initial building or
running make clean (initially, or twice):

> Makefile:38: pve-doc-generator.mk: No such file or directory

As we can do without this, simply tell make to ignore it if missing.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

use https for the website

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

change pricing link to en

since the language on proxmox.com depends on the cookie,
using no language in the url leads to a 404 if the
cookie says 'german', so always link to the english site

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

d/compat: bump to 10

(enables parallel builds by default)

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

build: fix broken parallel builds

a2x only supports destination folders for HTML based variants, but fortunately
that is enough in our case without needing extra workarounds.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

d/control: add missing build-dependencies

gathered by building in a minimal Debian Stretch chroot with just the
listed build-dependencies installed.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

d/control: bump debhelper build-dependency

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

build: wrap-and-sort debian/

for consistency and easier diffing

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

build: refactor build process

build packages in one go by moving individual .deb targets into install
targets called by dpkg-buildpackage.

all three binary packages are bootstrappable on a straight Debian host,
so there is no need to call dpkg-buildpackage separately for each of
them.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

remove note about vlan management interface

This seem wrong,
it's possible to setup management vlan interface
on vlanaware bridge without conflict with vm.

(If vlan management is setup with vmbrX.Y)

add vlanaware bridge management vlan configuration

used proxmox CI colors for network graphics

vxlan: increase mtu to 1550

vxlan encapsulation have 50 bytes overhead,so we need to increase
mtu on physical interfaces to avoid fragmentation.

vrf : remove net.ipv4.tcp_l3mdev_accept=1 sysctl tuning

kernel has been patched
https://git.proxmox.com/?p=pve-kernel.git;a=commit;h=49b6d16422120bf40204c40729c17a72e177e690

fix typos/wording

Signed-off-by: David Limbeck <d.limbeck@proxmox.com>

pve-patch-process.tt: another graphviz example graph

Not used currently.

remove nwdiag related things

We do not use those graphics.

pve-software-stack.tt: cleanup - set global fontname

pve-software-stack.tt: add AppArmor and cgroups

pve-software-stack.tt: s/Daemons/Services/

use graphviz to generate pve-software-stack.svg

Produces much smaller .svg file

add generated svg images

install and use new network diagrams

thumbnail: allow to reference all images inside /images subdir

Before, we was limited to /images/screenshots/

add graphviz picture for our default bonded network setup

add graphviz picture for our default routed network setup

pve_network_templates.tt: add macro for ethernet interfaces

add graphviz picture for our default bridged network setup

add framework to generate network graphs using graphviz

vxlan-evpn : add documentation to external routing

without bgp between proxmox and external router

split sysctl.conf to symmetric and asymmetric setup

vxlan : remove vlanaware bridge documentation

fix #1850: small additions

add vxlan l3 routing

This add documentation for inter vxlan routing, with frr and anycast gateway.

add documentation for vxlan layer 2 network

Thank to Alexandre Derumier <aderumier@odiso.com> for providing these docs.

bump version to 5.2-8

add lvm/zfs anchors

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

follow up: fix preformatted-block syntax and newlines

four '-' are enough, common use and as they need to be symmetric also
easier to handle manually.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

follow up: use higher heading level

else this is not visible in the one-page html document

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

certificate-managment.adoc: describe dir change

Adds a section with example of how to change the default ACME account from the
LE staging to production directory.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

bump version to 5.2-7

gen-output-format-opts.pl: use correct argument syntax

output-format.adoc: fix typo

bump version to 5.2-6

Makefile GEN_SCRIPTS: add gen-output-format-opts.pl

pve-admin-guide: include pvenode and pvesh docs

pvenode.adoc: include output-format.adoc

pvesh.adoc: include output-format.adoc

output-format.adoc: documentation for output format options

pvesh.1-synopsis.adoc: update

update pvenode.1-synopsis.adoc

add pvesh.adoc

api-viewer: use our extjs package

The loading of an external hosted ExtJS is from a time where we did
not have a extra ExtJS package as it still was in the pve-manager
one, which was not desired to be installed on a non-pve machine.
Add a dependency on libjs-extjs and a link from api-viewer/extjs to
the installation directory of the ExtJS package, this allows to reuse
ExtJS on PVE node hosted docs and on the hosted docs from proxmox.com
at the same time.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

api-viewer: use 'normal' over 'touch' theme

The touch feels super zoomed, and the api-viewer is probably much
more viewed through a desktop/laptop not a mobile device with small
high-dpi touch screen.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

api-viewer: use much smaller minified extjs

Use the over 4 times smaller minfied version of ExtJS, not the debug
one.

Any developer can easily use the debug version if needed, but most of
the times it this isn't the case.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 5.2-5

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

wiki: add CephFS link to storage page

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

update static files

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

add references to storage docs

so that they can be easily referenced, by the WebUI for example

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

storage: iscsi: don't use links in headers

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

pveceph: followup: fix grammar

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

pveceph: reword RAID paragraph

The "While ..." sentence seemed unfinished, reword paragraph

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

pveceph: followup: refactor advantage list

remove duplicated 'Easy management' point.
Remove 'no signle point of failure' as it's very easy to setup a
ceph cluster with lot's of single point of failures, ceph allows to
avoid them, but does not magically do so - so do not lull an unknown
user into false hope.
Use {pve} makro and rewor heading to a more "what's cool on ceph
_with_ pve" one.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

Update pveceph

* Combine sections from the wiki
* add section for avoiding RAID controllers
* correct command line for bluestore DB device creation
* minor rewording

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>

cephfs: reduce duplication of RBD docs and reword

No point in having half of RBD section duplicated here.
Reference pveceph-chapter, note that upstream considers snapshots
still not completely stable and remind user that he needs to setup a
ceph user secret...

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

Add storage plugin CephFS to docs

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>

fix #1818: use NTP instead of Servers in timesyncd.conf

'Servers' should still work but it was changed to 'NTP'
quite a while ago...

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

faq: add upgrade point

add a short FAQ point regarding upgrades (minor and major), with
anchor so that we can link better to it, e.g., from a EOL notice.

use new helper PVE::RESTHandler::api_dump_remove_refs()

bump version to 5.2-4

certificate-managment.adoc: use xref to refer to chapter_pmxcfs

use separate wiki page for qm-cloud-init.adoc

bump version to 5.2-3

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

installation: extend parameter description

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

fixup: cloud init: correct header syntax

The header markup need to be the same length as the header itself,
else we may get an incorrect output in the following lines.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 5.2-2

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

cloud init: improve wording/grammar

Integrate grammar and wording improvements from Daniela.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 5.2-1

update API

pve-admin-guide.adoc: include pvenode synopsys

Makefile: do not use ordered dependencies

Instead, make odering explicit.

add missing file

more ACME documentation

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

add documentation for certificate managment

* new section about certificate management in sysadmin chapter.
* adaptation of pveproxy and pvenode documentation

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Co-authored-by: René Jochum <r.jochum@proxmox.com>

bump version to 5.1-18

add two screenshots for cloud-init GUI

pvenode: extend to minimal complete chapter

add pvenode.adoc

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

qm.adoc: use new screenshots