* README.md: information about proxmox::vm::openvz (#3).

CHANGELOG.md

@@ -1,13 +1,13 @@
 ---------------------------------------
 
 ##### Changes
-* README.md: Add examples, a table of contents.
+* README.md: Add examples, a table of contents, information about proxmox::vm::openvz (#3).
 * Correct indentation, double quote, ...
 * (#2) Add an array and a file to load additionnal modules.
 * Correct module's dependencies.
 * (#9) Add a puppetlabs-firewall rule.
 * (#3) Add a new class and subclass: proxmox::vm::openvz to manage OpenVZ CT.
-* (#3) Add a new fact to calculate venet's network with /24 instead of /32.
+* (#3) Add a new fact to calculate venet's network with /24 instead of /32.)
 
 ---------------------------------------
 

README.md

@@ -20,7 +20,7 @@
 
 ## Overview
 
-The proxmox module provide a simple way to manage Proxmox hypervisor and (soon) it's virtual machines (KVM/OpenVZ) with Puppet.
+The proxmox module provide a simple way to manage Proxmox hypervisor and OpenVZ network's configuration with Puppet.
 
 ## Module Description
 
@@ -37,6 +37,7 @@ The proxmox module automates installing Proxmox on Debian systems.
 * Users and group permissions for WebGUI.
 * WebGUI's service (pveproxy)
 * Kernel modules loaded at the boot time
+* OpenVZ network's configuration
 
 ### Beginning with Proxmox
 
@@ -60,7 +61,19 @@ class { 'proxmox::hypervisor':
 **Note**: The module will automatically reboot the system on the PVE Kernel. You will need to start again the puppet agent.
 
 ### VM
-...
+
+Only OpenVZ is supported right now but the vm's class will check-it by it self:
+```
+include proxmox::vm
+```
+
+#### proxmox::vm::openvz
+
+Automatically call by the `proxmox::vm` class, it will manage network configuration, but only few configurations are possible:
+* Only one Virtual Ethernet device (aka veth) and it will work with **DHCP**.
+* If a veth is available, it will be the main network's interface (set the default gateway throught eth0).
+* If a veth is available, only one Virtual Network device (aka venet) as chance to work (the first one), because all others routes will be flushed.
+* If there are only venet: no changes.
 
 ## Reference
 
@@ -70,6 +83,8 @@ class { 'proxmox::hypervisor':
 
 * `proxmox::hypervisor`: Install the Proxmox hypervisor on the system.
 
+* `proxmox::vm`: Manage virtual machines and containers.
+
 ### Defined types
 
 * `proxmox::hypervisor::group`: Manage groups for Proxmox WebGUI and set permissions.
@@ -114,12 +129,21 @@ proxmox::hypervisor::user { 'marvin':
 * `pveproxy_service_enabled`: If set to 'true', Puppet will ensure the WebGUI's service is running. Can be 'true' or 'false'. Defaults to 'true'.
 * `pve_modules_list`: The list of additionnal modules to load at boot time.
 * `pve_modules_file_path`: The configuration file that will contain the modules list. Defaults to '/etc/modules-load.d/proxmox.conf'.
-* `pve_modules_file_content`: Template file to use to generate the previous configuration file. Defaults to 'proxmox/hypervisor/proxmox_modules.conf.erb'.
+* `pve_modules_file_content`: Template file used to generate the previous configuration file. Defaults to 'proxmox/hypervisor/proxmox_modules.conf.erb'.
+
+#### proxmox::vm
+* `vm_interfaces_path`: The main network configuration's file. Defaults to '/etc/network/interfaces'.
+* `vm_interfaces_content`: Template file used to generate the previous configuration file. Defaults to 'proxmox/vm/openvz_interfaces.erb'.
+* `vm_interfaces_tail_path`: A second network configuration file that will be concatenated in the main. Defaults to '/etc/network/interfaces.tail'.
+* `vm_interfaces_tail_content`: Template file used to generate the previous configuration file. Defaults to 'proxmox/vm/openzv_interfaces.tail.erb'.
+* `network_service_name`: Network's service name. Defaults to 'networking'.
+* `network_service_manage`: If set to 'true', Puppet will manage the network's service. Can be 'true' or 'false'. Defaults to 'true'.
+* `network_service_enabled`: If set to 'true', Puppet will ensure the network's service is running. Can be 'true' or 'false'. Defaults to 'true'.
 
 Limitations
 -----------
 
-This module will work only on Debian 7.x versions.
+This module will only work on Debian 7.x versions.
 
 Development
 -----------