Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-07 17:17:48 +03:00
Code Releases Activity
7475d2c15f
pve-docs/pve-admin-guide.adoc

351 lines
5.6 KiB
Plaintext
Raw Normal View History

add logo to admin guide and index This only work with html based backends, so I defined an extra attribute 'pvelogo' to enable that.
2016-10-01 13:13:10 +03:00
ifdef::pvelogo[]
image:./images/proxmox-logo.svg[] pass:[<br>] Proxmox VE Administration Guide
=============================================================================
endif::pvelogo[]
ifndef::pvelogo[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
Proxmox VE Administration Guide
===============================
add logo to admin guide and index This only work with html based backends, so I defined an extra attribute 'pvelogo' to enable that.
2016-10-01 13:13:10 +03:00
endif::pvelogo[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
:doctype: book
add logo to admin guide and index This only work with html based backends, so I defined an extra attribute 'pvelogo' to enable that.
2016-10-01 13:13:10 +03:00
:title: Proxmox VE Administration Guide
move html table of content to sidebar Signed-off-by: Tim Marx <t.marx@proxmox.com>
2020-01-21 14:26:31 +03:00
:toc2:
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
:numbered:
:data-uri:
:icons:
skip content in pve-admin-guide.adoc for wiki/man environment so that scan_adoc_file do not find wrong blockid definitions.
2016-10-08 17:40:43 +03:00
ifndef::wiki[]
ifndef::manvolnum[]
mark toplevel docs
2016-10-08 18:22:48 +03:00
:pve-toplevel:
skip content in pve-admin-guide.adoc for wiki/man environment so that scan_adoc_file do not find wrong blockid definitions.
2016-10-08 17:40:43 +03:00
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
// Push titles down one level.
:leveloffset: 1
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pve-intro.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
move 'Installation' into its own chapter
2016-10-05 10:21:24 +03:00
include::pve-installation.adoc[]
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::sysadmin.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
pve-admin-guide.adoc: include chapter pve-gui.adoc
2016-12-06 11:30:29 +03:00
include::pve-gui.adoc[]
add cluster manager to pve-admin-guide.adoc
2016-04-07 09:27:55 +03:00
include::pvecm.adoc[]
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pmxcfs.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pvesm.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
ceph: move ceph docs to own top level chapter This change should help to make the meanwhile extensive documentation about ceph more visible, therefore ceph now has it's own chapter which is sorted more reasonable after the storage chapter. The formerly known "hyper converged infrastructure" chapter is now integrated in the intro chapter, as it only contains some general information about this topic, which is not specific for ceph. Signed-off-by: Tim Marx <t.marx@proxmox.com>
2019-04-18 12:49:57 +03:00
include::pveceph.adoc[]
include pvesr.adoc in pve-admin-guide Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2017-06-28 18:56:49 +03:00
include::pvesr.adoc[]
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::qm.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
reorder docs (pct after qm)
2016-09-21 13:35:41 +03:00
include::pct.adoc[]
adming guide: move SDN down, after VM/CT and before firewall While the rationale to put it before CT/VM isn't wrong at all it's and advanced and currently even experimental topic. Lot's of PVE admins/users won't require to get up and running initially. Those who search it will still find it easily. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-05-10 21:10:48 +03:00
include::pvesdn.adoc[]
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pve-firewall.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pveum.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
import ha-manager docs just copied what we have so far
2016-02-24 13:37:48 +03:00
include::ha-manager.adoc[]
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::vzdump.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
add documentation for the new notification system Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-08-03 15:17:19 +03:00
include::notifications.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
// Return to normal title levels.
:leveloffset: 0
pve-admin-guide.adoc: add new section for service daemons
2016-04-10 11:14:45 +03:00
Important Service Daemons
-------------------------
:leveloffset: 2
include::pvedaemon.adoc[]
add pveproxy man page
2016-04-10 11:33:40 +03:00
include::pveproxy.adoc[]
pve-admin-guide.adoc: add new section for service daemons
2016-04-10 11:14:45 +03:00
include::pvestatd.adoc[]
add spiceproxy man page
2016-04-10 15:35:23 +03:00
include::spiceproxy.adoc[]
add pvescheduler docs and manpage Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-11-11 14:07:04 +03:00
include::pvescheduler.adoc[]
pve-admin-guide.adoc: add new section for service daemons
2016-04-10 11:14:45 +03:00
:leveloffset: 0
Fix spelling of command line/command-line Commandline/command line/command-line where being used interchangeably, which is not correct (see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line). use command-line when it is an adjective (e.g. "command-line interface") and use command line when it is a noun (e.g. "change the setting from the command line") Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-07-03 15:04:34 +03:00
Useful Command-line Tools
add pvesubscription man page
2016-04-10 16:13:59 +03:00
-------------------------
:leveloffset: 2
add pveceph man page
2016-04-10 16:39:35 +03:00
add pvesubscription man page
2016-04-10 16:13:59 +03:00
include::pvesubscription.adoc[]
add pveperf section and man page this is a bit ugly, because pveperf is not an instance of PVE::CLIHandler - the actual installed man page is still generated via the pod data contained in pve-manager/bin/pveperf ...
2016-10-07 10:58:42 +03:00
include::pveperf.adoc[]
pve-admin-guide: include pvenode and pvesh docs
2018-07-27 11:21:57 +03:00
include::pvesh.adoc[]
fix section level
2016-04-30 11:53:23 +03:00
:leveloffset: 1
add pvesubscription man page
2016-04-10 16:13:59 +03:00
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pve-faq.adoc[]
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
include bibliography before Appendix This is dblatex sort order anyways.
2016-04-01 20:42:30 +03:00
include::pve-bibliography.adoc[]
fix section level
2016-04-30 11:53:23 +03:00
:leveloffset: 0
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
[appendix]
Fix spelling of command line/command-line Commandline/command line/command-line where being used interchangeably, which is not correct (see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line). use command-line when it is an adjective (e.g. "command-line interface") and use command line when it is a noun (e.g. "change the setting from the command line") Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-07-03 15:04:34 +03:00
Command-line Interface
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
----------------------
pve-admin-guide: include pvenode and pvesh docs
2018-07-27 11:21:57 +03:00
:leveloffset: 1
include::output-format.adoc[]
:leveloffset: 0
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
*pvesm* - {pve} Storage Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pvesm.1-synopsis.adoc[]
Update pve-admin-guide.adoc add space before leveloffset to make asciidoctor parser happy
2016-01-05 19:42:08 +03:00
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
:leveloffset: 0
add pvesubscription man page
2016-04-10 16:13:59 +03:00
*pvesubscription* - {pve} Subscription Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvesubscription.1-synopsis.adoc[]
:leveloffset: 0
add pveperf section and man page this is a bit ugly, because pveperf is not an instance of PVE::CLIHandler - the actual installed man page is still generated via the pod data contained in pve-manager/bin/pveperf ...
2016-10-07 10:58:42 +03:00
*pveperf* - {pve} Benchmark Script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pveperf.1-synopsis.adoc[]
:leveloffset: 0
add pveceph man page
2016-04-10 16:39:35 +03:00
*pveceph* - Manage CEPH Services on {pve} Nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pveceph.1-synopsis.adoc[]
:leveloffset: 0
pve-admin-guide.adoc: include pvenode synopsys
2018-05-14 13:27:34 +03:00
*pvenode* - {pve} Node Management
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvenode.1-synopsis.adoc[]
:leveloffset: 0
add pvesh.adoc
2018-07-26 16:18:45 +03:00
*pvesh* - Shell interface for the {pve} API
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvesh.1-synopsis.adoc[]
:leveloffset: 0
tree-wide: switch to offical spelling of QEMU Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2022-12-20 11:35:58 +03:00
*qm* - QEMU/KVM Virtual Machine Manager
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::qm.1-synopsis.adoc[]
Update pve-admin-guide.adoc add space before leveloffset to make asciidoctor parser happy
2016-01-05 19:42:08 +03:00
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
:leveloffset: 0
formatting cleanup reformat most existing 'text' as either `text` or ``text'' reformat most existing "text" as either ``text'' or `text` reformat 'x' as `x` harmonize bullet list syntax to use '*' instead of '-'
2016-09-27 11:58:50 +03:00
*qmrestore* - Restore QemuServer `vzdump` Backups
add qmrestore man page
2016-04-08 08:30:48 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::qmrestore.1-synopsis.adoc[]
:leveloffset: 0
include pct sysnopsys
2016-01-05 13:12:09 +03:00
*pct* - Proxmox Container Toolkit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pct.1-synopsis.adoc[]
Update pve-admin-guide.adoc add space before leveloffset to make asciidoctor parser happy
2016-01-05 19:42:08 +03:00
include pct sysnopsys
2016-01-05 13:12:09 +03:00
:leveloffset: 0
add section about container images/templates
2016-03-05 16:37:58 +03:00
*pveam* - {pve} Appliance Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pveam.1-synopsis.adoc[]
:leveloffset: 0
add pvecm man page
2016-04-06 18:36:10 +03:00
*pvecm* - {pve} Cluster Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvecm.1-synopsis.adoc[]
:leveloffset: 0
add pvesr synopsis to full page admin guide
2017-10-18 11:12:45 +03:00
*pvesr* - {pve} Storage Replication
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvesr.1-synopsis.adoc[]
:leveloffset: 0
add pvecm man page
2016-04-06 18:36:10 +03:00
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
*pveum* - {pve} User Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::pveum.1-synopsis.adoc[]
Update pve-admin-guide.adoc add space before leveloffset to make asciidoctor parser happy
2016-01-05 19:42:08 +03:00
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
:leveloffset: 0
*vzdump* - Backup Utility for VMs and Containers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
fix file name extension (use .adoc)
2016-01-05 12:49:56 +03:00
include::vzdump.1-synopsis.adoc[]
Update pve-admin-guide.adoc add space before leveloffset to make asciidoctor parser happy
2016-01-05 19:42:08 +03:00
add all in one document (admin guide)
2016-01-05 12:48:31 +03:00
:leveloffset: 0
use pve macro more often
2016-09-27 11:58:58 +03:00
*ha-manager* - {pve} HA Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
import ha-manager docs just copied what we have so far
2016-02-24 13:37:48 +03:00
:leveloffset: 1
include::ha-manager.1-synopsis.adoc[]
:leveloffset: 0
add pvedaemon man page
2016-04-10 10:51:11 +03:00
[appendix]
Service Daemons
---------------
minor cleanups, use {pve} instead of {PVE}
2016-04-10 10:59:25 +03:00
*pve-firewall* - {pve} Firewall Daemon
pve-admin-guide.adoc: fix headers
2016-04-10 11:57:47 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
add pve-ha-crm man page
2016-04-08 09:13:23 +03:00
:leveloffset: 1
add pvedaemon man page
2016-04-10 10:51:11 +03:00
include::pve-firewall.8-synopsis.adoc[]
add pve-ha-crm man page
2016-04-08 09:13:23 +03:00
:leveloffset: 0
minor cleanups, use {pve} instead of {PVE}
2016-04-10 10:59:25 +03:00
*pvedaemon* - {pve} API Daemon
pve-admin-guide.adoc: fix headers
2016-04-10 11:57:47 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
add pve-ha-lrm man page
2016-04-08 09:20:12 +03:00
:leveloffset: 1
add pvedaemon man page
2016-04-10 10:51:11 +03:00
include::pvedaemon.8-synopsis.adoc[]
add pve-ha-lrm man page
2016-04-08 09:20:12 +03:00
:leveloffset: 0
add spiceproxy man page
2016-04-10 15:35:23 +03:00
add pveproxy man page
2016-04-10 11:33:40 +03:00
*pveproxy* - {pve} API Proxy Daemon
pve-admin-guide.adoc: fix headers
2016-04-10 11:57:47 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
add pveproxy man page
2016-04-10 11:33:40 +03:00
:leveloffset: 1
pve-admin-guide.adoc: fix headers
2016-04-10 11:57:47 +03:00
add pveproxy man page
2016-04-10 11:33:40 +03:00
include::pveproxy.8-synopsis.adoc[]
:leveloffset: 0
minor cleanups, use {pve} instead of {PVE}
2016-04-10 10:59:25 +03:00
*pvestatd* - {pve} Status Daemon
add pvestatd manual page
2016-04-09 11:41:09 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvestatd.8-synopsis.adoc[]
:leveloffset: 0
add spiceproxy man page
2016-04-10 15:35:23 +03:00
*spiceproxy* - SPICE Proxy Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::spiceproxy.8-synopsis.adoc[]
:leveloffset: 0
add pmxcfs cli to admin guide and index
2016-04-09 14:36:31 +03:00
*pmxcfs* - Proxmox Cluster File System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
renamed pmxcfs.8-cli.adoc to pmxcfs.8-synopsis.adoc And removed duplicate Makefile rules.
2016-10-14 14:35:03 +03:00
include::pmxcfs.8-synopsis.adoc[]
add pmxcfs cli to admin guide and index
2016-04-09 14:36:31 +03:00
:leveloffset: 0
spelling/grammar/capitalization especially: - filesystem -> file system - mountpoint -> mount point - lxc -> LXC - pve -> PVE - it's -> its (where appropriate) - VM´s -> VMs (and similar) - Ressource -> Resource - maximal -> maximum or at most - format of section headers and block headers
2016-09-27 11:58:51 +03:00
*pve-ha-crm* - Cluster Resource Manager Daemon
add pvedaemon man page
2016-04-10 10:51:11 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pve-ha-crm.8-synopsis.adoc[]
:leveloffset: 0
spelling/grammar/capitalization especially: - filesystem -> file system - mountpoint -> mount point - lxc -> LXC - pve -> PVE - it's -> its (where appropriate) - VM´s -> VMs (and similar) - Ressource -> Resource - maximal -> maximum or at most - format of section headers and block headers
2016-09-27 11:58:51 +03:00
*pve-ha-lrm* - Local Resource Manager Daemon
add pvedaemon man page
2016-04-10 10:51:11 +03:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pve-ha-lrm.8-synopsis.adoc[]
:leveloffset: 0
add pvescheduler docs and manpage Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-11-11 14:07:04 +03:00
*pvescheduler* - {pve} Scheduler Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:leveloffset: 1
include::pvescheduler.8-synopsis.adoc[]
:leveloffset: 0
add pvestatd manual page
2016-04-09 11:41:09 +03:00
add datacenter.cfg.5
2016-03-23 09:32:27 +03:00
[appendix]
Configuration Files
-------------------
:leveloffset: 2
include correct datacenter.cfg.adoc file
2016-03-23 11:32:28 +03:00
include::datacenter.cfg.adoc[]
add datacenter.cfg.5
2016-03-23 09:32:27 +03:00
:leveloffset: 0
add pvescheduler docs and manpage Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-11-11 14:07:04 +03:00
[appendix]
Calendar Events
---------------
:leveloffset: 1
include::calendar-events.adoc[]
:leveloffset: 0
qm: move out known vCPU list to actual appendix Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-21 13:14:47 +03:00
[appendix]
QEMU vCPU List
--------------
:leveloffset: 1
include::qm-vcpu-list.adoc[]
:leveloffset: 0
add auto-generated firewall macro definitions
2016-03-31 20:39:58 +03:00
[appendix]
Firewall Macro Definitions
--------------------------
include::pve-firewall-macros.adoc[]
add markdown primer for gui notes onlineHelp Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-07-05 15:16:37 +03:00
:leveloffset: 1
[appendix]
include::markdown-primer.adoc[]
add datacenter.cfg.5
2016-03-23 09:32:27 +03:00
try to correctly include the GFDL license
2016-01-05 19:36:56 +03:00
:leveloffset: 1
[appendix]
include::GFDL.adoc[]
Update pve-admin-guide.adoc add space before leveloffset to make asciidoctor parser happy
2016-01-05 19:42:08 +03:00
try to correctly include the GFDL license
2016-01-05 19:36:56 +03:00
:leveloffset: 0
skip content in pve-admin-guide.adoc for wiki/man environment so that scan_adoc_file do not find wrong blockid definitions.
2016-10-08 17:40:43 +03:00
endif::manvolnum[]
endif::wiki[]
Copy Permalink