diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 44ac1c6f963ff4aa65da50d233f0db9b7c31f915..d280c2d72b84bb802eebd718157c8c95322ab056 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -1,2 +1,131 @@ Role Reference ============== + + +Preseed +------- + +This role can be used for generating simple preseed files for Debian Wheezy +installations. + +The generated preseed files allow simplified installation, with a single root +partition. A number of common parameters can be provided. + + +Parameters +~~~~~~~~~~ + +**preseed_directory** (mandatory) + Destination directory where the preseed files should be stored. + +**preseed_servers** (mandatory) + List of servers for which a preseed file should be created. Each item in + this list defines options for a single server. The options are as follows: + + **name** (string, mandatory) + Name associated with the server. This name is used in the preseed + configuration filename. + + **language** (string, mandatory) + Language. + + **country** (string, mandatory) + Country. + + **locale** (string, mandatory) + Locale. + + **keymap** (string, mandatory) + Keymap. + + **network_interface** (string, mandatory) + Name of network interface (for example *eth0*) that should be + configured. + + **network_auto** (boolean, mandatory) + Specifies whether the network configuration should be automatic (using + DHCP) or manual. If manual configuration is selected a number of + additional options needs to be specified. + + **network_ip** (string, mandatory if **network_auto** if *False*) + IP address for the server network interface. + + **network_netmask** (string, mandatory if **network_auto** if *False*) + Netmask for the server network interface. + + **network_gateway** (string, mandatory if **network_auto** if *False*) + Default gateway for the server. + + **network_dns** (string, mandatory if **network_auto** if *False*) + Comma-separated list of DNS servers. + + **network_hostname** (string, mandatory if **network_auto** if *False*) + Server hostname. + + **network_domain** (string, mandatory if **network_auto** if *False*) + Server domain. + + **mirror_hostname** (string, mandatory) + Resolvable hostname of FQDN where the Debian apt repositories can be + found. Only HTTP mirrors are supported. + + **mirror_directory** (string, mandatory) + Directory under which the Debian apt repositories can be found on the + specified mirror. + + **mirror_proxy** (string, optional, default is *None*) + An HTTP proxy that should be used for accessing the Debian apt + repositories. + + **root_password** (string, mandatory) + Initial password that should be set for the server during the + installation. + + **timezone** (string, mandatory) + Timezone that should be used when calculating server time. It is assumed + that the local hardware clock is set to UTC. + + +Examples +~~~~~~~~ + +Here is an example configuration for a preseed file for two servers, one with +automatic and one with manual network configuration: + +.. code-block:: yaml + + --- + + preseed_directory: /var/www/preseed/ + + preseed_servers: + - name: test1.example.com + language: en + country: SE + locale: en_US.UTF-8 + keymap: us + network_interface: eth0 + network_auto: yes + mirror_hostname: ftp.se.debian.org + mirror_directory: /debian + mirror_proxy: http://proxy.example.com/ + root_password: testserver + timezone: Europe/Stockholm + - name: test2.example.com + language: en + country: SE + locale: en_US.UTF-8 + keymap: us + network_interface: eth0 + network_auto: no + network_ip: 10.0.0.10 + network_netmask: 255.255.255.0 + network_gateway: 10.0.0.1 + network_dns: 10.0.0.2,10.0.0.3 + network_hostname: test1 + network_domain: example.com + mirror_hostname: ftp.se.debian.org + mirror_proxy: http://proxy.example.com/ + mirror_directory: /debian + root_password: testserver + timezone: Europe/Stockholm