Add a table of contents in the README.md file.

This commit is contained in:
gardouille 2015-01-19 14:40:17 +01:00
parent f9f5aa6f2e
commit 21a58b6934
2 changed files with 25 additions and 4 deletions

View File

@ -1,7 +1,7 @@
---------------------------------------
##### Changes
* Add examples in README.md file.
* README.md: Add examples, a table of contents.
* Correct indentation, double quote, ...
* (#2) Add an array and a file to load additionnal module.

View File

@ -1,5 +1,23 @@
# proxmox
#### Table of Contents
1. [Overview](#overview)
2. [Module Description](#module-description)
3. [Setup](#setup)
* [What Proxmox affects](#what-proxmox-affects)
* [Beginning with Proxmox](#beginning-with-proxmox)
4. [Usage](#usage)
* [Hypervisor](#hypervisor)
* [VM](#vm)
5. [Reference](#reference)
* [Classes](#classes)
* [Defined types](#defined-types)
* [Parameters](#parameters)
6. [Limitations](#limitations)
7. [Development](#development)
8. [License](#license)
## Overview
The proxmox module provide a simple way to manage Proxmox hypervisor and (soon) it's virtual machines (KVM/OpenVZ) with Puppet.
@ -10,7 +28,7 @@ The proxmox module automates installing Proxmox on Debian systems.
## Setup
### What proxmox affects:
### What Proxmox affects:
* Package/service/configuration files for Proxmox
* A new `sources.list` file for Proxmox
@ -18,8 +36,9 @@ The proxmox module automates installing Proxmox on Debian systems.
* The static table lookup for hostnames `hosts`
* Users and group permissions for WebGUI.
* WebGUI's service (pveproxy)
* Kernel modules loaded at the boot time
### Beginning with proxmox
### Beginning with Proxmox
To begin using proxmox module with default parameters, declare the hypervisor's class with `include proxmox::hypervisor`.
@ -41,7 +60,6 @@ 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
...
## Reference
@ -94,6 +112,9 @@ proxmox::hypervisor::user { 'marvin':
* `pveproxy_service_name`: WebGUI's service name (replace Apache2 since v3.0). Defaults to 'pveproxy'.
* `pveproxy_service_manage`: If set to 'true', Puppet will manage the WebGUI's service. Can be 'true' or 'false'. Defaults to 'true'.
* `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'.
Limitations
-----------