5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-06 13:17:48 +03:00

mark toplevel docs

This commit is contained in:
Dietmar Maurer 2016-10-08 17:22:48 +02:00
parent 4a37b4f245
commit 5f09af76d7
36 changed files with 172 additions and 0 deletions

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -25,6 +27,10 @@ Datacenter Configuration
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
The file `/etc/pve/datacenter.cfg` is a configuration file for
{pve}. It contains cluster wide default values used by all nodes.

View File

@ -2,6 +2,10 @@ Getting Help
------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Proxmox VE Wiki
~~~~~~~~~~~~~~~

View File

@ -4,6 +4,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -24,6 +26,9 @@ High Availability
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Our modern society depends heavily on information provided by
computers over the network. Mobile devices amplified that dependency,

View File

@ -2,6 +2,10 @@ Logical Volume Manager (LVM)
----------------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Most people install {pve} directly on a local disk. The {pve}
installation CD offers several options for local disk management, and
the current default setup uses LVM. The installer let you select a

View File

@ -2,6 +2,10 @@ ZFS on Linux
------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
ZFS is a combined file system and logical volume manager designed by
Sun Microsystems. Starting with {pve} 3.4, the native Linux
kernel port of the ZFS file system is introduced as optional

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -24,6 +26,9 @@ Proxmox Container Toolkit
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Containers are a lightweight alternative to fully virtualized
VMs. Instead of emulating a complete Operating System (OS), containers

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -25,6 +27,10 @@ Container Configuration
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
The `/etc/pve/lxc/<CTID>.conf` files stores container configuration,
where `CTID` is the numeric ID of the given container.

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -23,6 +25,10 @@ Proxmox Cluster File System (pmxcfs)
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
The Proxmox Cluster file system (``pmxcfs'') is a database-driven file
system for storing configuration files, replicated in real time to all
cluster nodes using `corosync`. We use this to store all PVE related

View File

@ -16,6 +16,7 @@ include::attributes.txt[]
ifndef::wiki[]
ifndef::manvolnum[]
:pve-toplevel:
// Push titles down one level.
:leveloffset: 1

View File

@ -3,6 +3,10 @@ Bibliography
============
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
[bibliography]
.Books about {pve}

View File

@ -2,6 +2,10 @@ Disk Health Monitoring
----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Altough a robust and redundant storage is recommended,
it can be very helpful to monitor the health of your local disks.

View File

@ -2,6 +2,10 @@ Frequently Asked Questions
==========================
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
NOTE: New FAQs are appended to the bottom of this section.
/////////////////////////////////////////////////////////////////

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -25,6 +27,10 @@ ifndef::manvolnum[]
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
{pve} Firewall provides an easy way to protect your IT
infrastructure. You can setup firewall rules for all hosts
inside a cluster, or define rules for virtual machines and

View File

@ -2,6 +2,10 @@ Installing Proxmox VE
=====================
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
{pve} ships as a set of Debian packages, so you can simply install it
on top of a normal Debian installation, or download the installation
CD-ROM and use that to install {pve} on your hardware.

View File

@ -2,6 +2,10 @@ Network Configuration
---------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
{pve} uses a bridged networking model. Each host can have up to 4094
bridges. Bridges are like physical network switches implemented in
software. All VMs can share a single bridge, as if

View File

@ -2,6 +2,10 @@ Package Repositories
--------------------
include::attributes.txt[]
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

View File

@ -2,6 +2,10 @@ Directory Backend
-----------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `dir`
{pve} can use local directories or locally mounted shares for

View File

@ -2,6 +2,10 @@ GlusterFS Backend
-----------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `glusterfs`
GlusterFS is a salable network file system. The system uses a modular

View File

@ -2,6 +2,10 @@ http://www.open-iscsi.org/[Open-iSCSI] initiator
------------------------------------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `iscsi`
iSCSI is a widely employed technology used to connect to storage

View File

@ -2,6 +2,10 @@ User Mode iSCSI Backend
-----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `iscsidirect`
This backend provides basically the same functionality as the

View File

@ -2,6 +2,10 @@ LVM Backend
-----------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `lvm`
LVM is a thin software layer on top of hard disks and partitions. It

View File

@ -2,6 +2,10 @@ LVM thin Backend
----------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `lvmthin`
LVM normally allocates blocks when you create a volume. LVM thin pools

View File

@ -2,6 +2,10 @@ NFS Backend
-----------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `nfs`
The NFS backend is based on the directory backend, so it shares most

View File

@ -2,6 +2,10 @@ Ceph RADOS Block Devices (RBD)
------------------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `rbd`
http://ceph.com[Ceph] is a distributed object store and file system

View File

@ -2,6 +2,10 @@ Local ZFS Pool Backend
----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Storage pool type: `zfspool`
This backend allows you to access local ZFS pools (or ZFS file systems

View File

@ -2,6 +2,10 @@ System Requirements
-------------------
include::attributes.txt[]
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}

View File

@ -2,6 +2,10 @@ Install from USB Stick
----------------------
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
The {pve} installation media is now a hybrid ISO image, working in two
ways:

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -23,6 +25,10 @@ Cluster Manager
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
The {PVE} cluster manager `pvecm` is a tool to create a group of
physical servers. Such a group is called a *cluster*. We use the
http://www.corosync.org[Corosync Cluster Engine] for reliable group

View File

@ -4,6 +4,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -25,6 +27,10 @@ ifndef::manvolnum[]
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
The {pve} storage model is very flexible. Virtual machine images
can either be stored on one or several local storages, or on shared
storage like NFS or iSCSI (NAS, SAN). There are no limits, and you may

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -25,6 +27,10 @@ User Management
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
// Copied from pve wiki: Revision as of 16:10, 27 October 2015
Proxmox VE supports multiple authentication sources, e.g. Linux PAM,

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -24,6 +26,10 @@ Qemu/KVM Virtual Machines
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
// deprecates
// http://pve.proxmox.com/wiki/Container_and_Full_Virtualization
// http://pve.proxmox.com/wiki/KVM

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -25,6 +27,10 @@ ifndef::manvolnum[]
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
The `/etc/pve/qemu-server/<VMID>.conf` files stores VM configuration,
where "VMID" is the numeric ID of the given VM.

View File

@ -129,6 +129,19 @@ sub scan_adoc_file {
chomp $env_last_line->{$e};
}
if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) {
my ($key, $value) = ($1, $2);
if ($key eq 'pve-toplevel') {
foreach my $e (@{$env_stack->[-1]}) {
my $title = $fileinfo->{titles}->{$e}->{$filename};
die "not title for toplevel file '$filename' (env=$e)\n"
if !defined($title);
$fileinfo->{toplevel}->{$e}->{$filename} = 1;
}
}
}
if ($line =~ m/^\[\[(.*)\]\]\s*$/) {
my $blockid = $1;
die "implement me" if $blockid =~m/,/;

View File

@ -2,6 +2,10 @@ Host System Administration
==========================
include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
{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

View File

@ -2,6 +2,10 @@ System Software Updates
-----------------------
include::attributes.txt[]
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`:

View File

@ -3,6 +3,8 @@ PVE({manvolnum})
================
include::attributes.txt[]
:pve-toplevel:
NAME
----
@ -25,6 +27,10 @@ Backup and Restore
include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Backups are a requirements for any sensible IT deployment, and {pve}
provides a fully integrated solution, using the capabilities of each
storage and each guest system type. This allows the system