Add how-to for translations
[pve-docs.git] / pve-intro.adoc
index 031ae74..e4a8d99 100644 (file)
@@ -9,7 +9,7 @@ Kernel-based Virtual Machine (KVM) and container-based virtualization
 
 One main design goal was to make administration as easy as
 possible. You can use {pve} on a single node, or assemble a cluster of
-many nodes. All management task can be done using our web-based
+many nodes. All management tasks can be done using our web-based
 management interface, and even a novice user can setup and install
 {pve} within minutes.
 
@@ -23,15 +23,15 @@ While many people start with a single node, {pve} can scale out to a
 large set of clustered nodes. The cluster stack is fully integrated
 and ships with the default installation.
 
-.Unique Multi-master Design
+Unique Multi-Master Design::
 
 The integrated web-based management interface gives you a clean
 overview of all your KVM guests and Linux containers and even of your
 whole cluster. You can easily manage your VMs and containers, storage
 or cluster from the GUI. There is no need to install a separate,
-complex, and pricy management server.
+complex, and pricey management server.
 
-.Proxmox Cluster File System (pmxcfs)
+Proxmox Cluster File System (pmxcfs)::
 
 Proxmox VE uses the unique Proxmox Cluster file system (pmxcfs), a
 database-driven file system for storing configuration files. This
@@ -41,14 +41,14 @@ on all cluster nodes. The file system stores all data inside a
 persistent database on disk, nonetheless, a copy of the data resides
 in RAM which provides a maximum storage size is 30MB - more than
 enough for thousands of VMs.
-
++
 Proxmox VE is the only virtualization platform using this unique
 cluster file system.
 
-.Web-based Management Interface
+Web-based Management Interface::
 
 Proxmox VE is simple to use. Management tasks can be done via the
-included web based managment interface - there is no need to install a
+included web based management interface - there is no need to install a
 separate management tool or any additional management node with huge
 databases. The multi-master tool allows you to manage your whole
 cluster from any node of your cluster. The central web-based
@@ -57,7 +57,7 @@ you to control all functionalities from the GUI and overview history
 and syslogs of each single node. This includes running backup or
 restore jobs, live-migration or HA triggered activities.
 
-.Command Line
+Command Line::
 
 For advanced users who are used to the comfort of the Unix shell or
 Windows Powershell, Proxmox VE provides a command line interface to
@@ -65,30 +65,30 @@ manage all the components of your virtual environment. This command
 line interface has intelligent tab completion and full documentation
 in the form of UNIX man pages.
 
-.REST API
+REST API::
 
 Proxmox VE uses a RESTful API. We choose JSON as primary data format,
 and the whole API is formally defined using JSON Schema. This enables
 fast and easy integration for third party management tools like custom
 hosting environments.
 
-.Role-based Administration
+Role-based Administration::
 
-You can define granular access for all objects (like VMยดs, storages,
+You can define granular access for all objects (like VMs, storages,
 nodes, etc.) by using the role based user- and permission
 management. This allows you to define privileges and helps you to
 control access to objects. This concept is also known as access
 control lists: Each permission specifies a subject (a user or group)
 and a role (set of privileges) on a specific path.
 
-.Authentication Realms
+Authentication Realms::
 
 Proxmox VE supports multiple authentication sources like Microsoft
 Active Directory, LDAP, Linux PAM standard authentication or the
 built-in Proxmox VE authentication server.
 
 
-Flexible Storage 
+Flexible Storage
 ----------------
 
 The Proxmox VE storage model is very flexible. Virtual machine images
@@ -106,6 +106,7 @@ We currently support the following Network storage types:
 * LVM Group (network backing with iSCSI targets)
 * iSCSI target
 * NFS Share
+* CIFS Share
 * Ceph RBD
 * Directly use iSCSI LUNs
 * GlusterFS
@@ -116,17 +117,18 @@ Local storage types supported are:
 * Directory (storage on existing filesystem)
 * ZFS
 
+
 Integrated Backup and Restore
 -----------------------------
 
-The integrated backup tool (vzdump) creates consistent snapshots of
+The integrated backup tool (`vzdump`) creates consistent snapshots of
 running Containers and KVM guests. It basically creates an archive of
 the VM or CT data which includes the VM/CT configuration files.
 
 KVM live backup works for all storage types including VM images on
-NFS, iSCSI LUN, Ceph RBD or Sheepdog. The new backup format is
-optimized for storing VM backups fast and effective (sparse files, out
-of order data, minimized I/O).
+NFS, CIFS, iSCSI LUN, Ceph RBD. The new backup format is optimized for storing
+VM backups fast and effective (sparse files, out of order data, minimized I/O).
+
 
 High Availability Cluster
 -------------------------
@@ -136,6 +138,7 @@ available virtual servers. The Proxmox VE HA Cluster is based on
 proven Linux HA technologies, providing stable and reliable HA
 services.
 
+
 Flexible Networking
 -------------------
 
@@ -150,11 +153,14 @@ bonding/aggregation are possible. In this way it is possible to build
 complex, flexible virtual networks for the Proxmox VE hosts,
 leveraging the full power of the Linux network stack.
 
+
 Integrated Firewall
 -------------------
 
-The intergrated firewall allows you to filter network packets on
-any VM or Container interface. Common sets of firewall rules can be grouped into 'security groups'.
+The integrated firewall allows you to filter network packets on
+any VM or Container interface. Common sets of firewall rules can
+be grouped into ``security groups''.
+
 
 Why Open Source
 ---------------
@@ -176,6 +182,7 @@ the product always meets professional quality criteria.
 Open source software also helps to keep your costs low and makes your
 core infrastructure independent from a single vendor.
 
+
 Your benefit with {pve}
 -----------------------
 
@@ -188,11 +195,14 @@ Your benefit with {pve}
 * Huge active community
 * Low administration costs and simple deployment
 
+include::getting-help.adoc[]
+
+
 Project History
 ---------------
 
 The project started in 2007, followed by a first stable version in
-2008. By that time we used OpenVZ for containers, and KVM for virtual
+2008. At the time we used OpenVZ for containers, and KVM for virtual
 machines. The clustering features were limited, and the user interface
 was simple (server generated web page).
 
@@ -204,8 +214,8 @@ the user. Managing a cluster of 16 nodes is as simple as managing a
 single node.
 
 We also introduced a new REST API, with a complete declarative
-spezification written in JSON-Schema. This enabled other people to
-integrate {pve} into their infrastructur, and made it easy provide
+specification written in JSON-Schema. This enabled other people to
+integrate {pve} into their infrastructure, and made it easy to provide
 additional services.
 
 Also, the new REST API made it possible to replace the original user
@@ -222,7 +232,7 @@ are extremely cost effective.
 
 When we started we were among the first companies providing
 commercial support for KVM. The KVM project itself continuously
-evolved, and is now a widely used hypervisor. New features arrives
+evolved, and is now a widely used hypervisor. New features arrive
 with each release. We developed the KVM live backup feature, which
 makes it possible to create snapshot backups on any storage type.
 
@@ -230,3 +240,7 @@ The most notable change with version 4.0 was the move from OpenVZ to
 https://linuxcontainers.org/[LXC]. Containers are now deeply
 integrated, and they can use the same storage and network features
 as virtual machines.
+
+include::howto-improve-pve-docs.adoc[]
+include::translation.adoc[]
+