Commit 798d4779 authored by Nikos Skalkotos's avatar Nikos Skalkotos
Browse files

docs: Add a Windows deployment section

This contains basic info on how the Windows images get deployed and
instruction on how to use a custom Unattend.xml file.
parent efac3748
......@@ -52,8 +52,7 @@ Although diskdump is a lot more flexible than the older formats, there are
still some rules to follow:
* For Linux:
* All block devices in */etc/fstab* should be specified using persistent
names (UUID or LABEL)
* All block devices in */etc/fstab* should be specified using persistent names (UUID or LABEL)
* LVM partitions are not supported
* Only ext{2,3,4} file systems are supported
* For FreeBSD:
......@@ -63,6 +62,64 @@ still some rules to follow:
* For {Open,Net}BSD:
* Only FFS file systems should be used
.. _windows-deployment:
Windows Deployment
^^^^^^^^^^^^^^^^^^
snf-image performs Windows customization by installing an Answer File for
Unattended Installation (typically named Unattend.xml) into the VM's hard
disk and customizing the file accordingly. The VM will auto-configure itself
the first time it boots. For this to work, the used Windows image must have
previously been generalized [#f1]_ with a command like this:
.. code-block:: console
Sysprep /generalize /shutdown /oobe
The pre-included Unattend.xml file that snf-image will by default install on
the VM's hard disk is this one:
.. literalinclude:: ../snf-image-helper/unattend.xml
:language: xml
:emphasize-lines: 7,21-30
:linenos:
The file above is expected to work with all AMD64 releases (Server or Desktop)
of Microsoft Windows starting from version 6.1. The table below lists the
releases the developers have confirmed it to work with:
+-------+----------------------+----------------------+
|Version|Marketing name | Editions |
+=======+======================+======================+
|6.1 |Windows 7 |Professional, Ultimate|
| +----------------------+----------------------+
| |Windows Server 2008 R2|Datacenter |
+-------+----------------------+----------------------+
|6.2 |Windows 8 |Professional |
| +----------------------+----------------------+
| |Windows Server 2012 |Datacenter |
+-------+----------------------+----------------------+
|6.3 |Windows 8.1 |Professional |
| +----------------------+----------------------+
| |Windows Server 2012 R2|Datacenter |
+-------+----------------------+----------------------+
Nevertheless, the user may want to use a custom Unattend.xml file that better
fits his needs. To do so, he can either update the **UNATTEND** configuration
parameter in ``/etc/default/snf-image`` to point to such a file in the host
system or put his copy of the file in the root directory of the image's
%SystemDrive% (snf-image will not install an Unattend.xml file if it is already
present in the image, unless IGNORE_UNATTEND image property is defined). The
latter is the recommended way to do it since it allows to provide answer files
in a per-image basis.
.. warning::
When using custom Unattend.xml files, keep in mind that the highlighted
entries (lines 7 & 21-30) are crucial for snf-image to work. You may remove
or add settings in the file but the highlighted entries must be present.
Progress Monitoring Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
......@@ -156,3 +213,7 @@ standard error output stream of *snf-image-helper*. Valid *error* messages look
like this:
``{"subtype": "error", "type": "image-helper", "messages": ["The image contains a(n) MSDOS partition table. For FreeBSD images only GUID Partition Tables are supported."], "timestamp": 1379507910.799365}``
.. rubric:: Footnotes
.. [#f1] http://technet.microsoft.com/en-us/library/hh824938.aspx
......@@ -143,12 +143,13 @@ Optional properties
* **IGNORE_UNATTEND=yes**
When deploying a Windows image, the InstallUnattend configuration task will
put its own copy of the Unattend.xml file in the hard disk of the VM that
gets deployed, only if such a file is not already present at the root
directory of the %SystemDrive%. If this property is defined, the behavior of
the aforementioned configuration task will change and the installation of
the Unattend.xml is always performed even if such a file already exists
inside the image.
install an Answer File for Unattended Installation (the one shipped with
snf-image or the one pointed out by the UNATTEND configuration parameter)
only if such a file is not already present in the root directory of the
image's %SystemDrive%. By defining this property, the installation of the
external answer file is always performed, even if such a file already exists
in the above-mentioned location. For more information on "answer files"
please refer to :ref:`windows-deployment`.
* **PASSWORD_HASHING_METHOD=md5|sha1|blowfish|sha256|sha512**
This property can be used on Unix instances to specify the method to be used
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment