openstack/deb-murano
Code Issues Proposed changes

Update buiding windows image article

Browse Source 
Previous instruction is updated

Change-Id: Ic7545ecc2595f70eb9f8317e5c631bcfa5efe114
Closes-Bug: #1527531
This commit is contained in:
Ekaterina Chernova 2015-12-18 15:26:42 +03:00
parent 10d8593003
commit fd5bb61ea7
1 changed files with 117 additions and 499 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

616
doc/source/image_builders/windows.rst
View File

@ -13,557 +13,175 @@
License for the specific language governing permissions and limitations
under the License.
MS Windows image builder for OpenStack Murano
=============================================
Introduction
------------
=============
Windows image
=============
This repository contains MS Windows templates, powershell scripts and bash scripted logic used to create qcow2 images
for QEMU/KVM based virtual machines used in OpenStack.
Murano requires a Windows image in QCOW2 format to be built and uploaded into glance.
The easiest way to build a Windows image for murano is to build it on the host where your OpenStack is installed.
Prepare image builder host
==========================
Install KVM
-----------
.. note::
This guide was tested on Ubuntu Server 12.04 x64.
..
KVM is a default hypervisor in OpenStack, so our build scripts are targeted to this hypervisor only. It may change in the future, though.
Install KVM and some additional packages that are required by our scripts
.. code-block:: console
# apt-get install qemu-kvm virtinst virt-manager
..
Check that your hardware supports hardware virtualization.
.. code-block:: console
kvm-ok
# INFO: /dev/kvm exists
# KVM acceleration can be used
..
If your output differs, check that hardware virtualization is enabled in your BIOS settings. You also could try import KVM kernel module
.. code-block:: console
sudo modprobe kvm-intel
..
or
.. code-block:: cosole
sudo modprobe kvm-amd
..
It might be helpful to add an appropriate module name into **/etc/modules** file to auto-load it during system boot. Sometimes it is required on Ubuntu systems.
Configure shared resource
=========================
The murano image builder uses a shared folder located on the host system as an installation source for components.
Makefile from the image builder will copy the required files to their locations, but you have to manually configure samba share.
To do this, use the steps below.
* Install samba
.. code-block:: console
# apt-get install samba
..
* Create folder that will be shared
.. code-block:: console
# mkdir -p /opt/samba/share
# chown -R nobody:nogroup /opt/samba/share
..
* Configure samba server (/etc/samba/smb.conf)
.. code-block:: text
:linenos:
...
[global]
...
security = share
...
[image-builder-share]
comment = Image Builder Share
browsable = yes
path = /opt/image-builder/share
guest ok = yes
guest user = nobody
read only = no
create mask = 0755
...
..
* Restart samba services
.. code-block:: console
# service smbd restart
# service nmbd restart
..
Download prerequisites
======================
.. _windows_installation_iso:
Windows server installation ISO
-------------------------------
.. list-table::
:header-rows: 1
:widths: 30, 15, 55
* - Windows Version
- Version String
- Save to
* - Windows Server 2008 R2 [#win2k8r2_link]_
- 6.1.7601
- /opt/image-builder/share/libvirt/images/ws-2008-eval.iso
* - Windows Server 2012 [#win2k12_link]_
- 6.3.9200
- /opt/image-builder/share/libvirt/images/ws-2012-eval.iso
..
.. warning::
Windows Server 2008 R2 must include Service Pack 1 updates. This is required to install PowerShell V3 which is required by the murano Agent.
..
|
.. [#win2k8r2_link] http://www.microsoft.com/en-us/download/details.aspx?id=11093
.. [#win2k12_link] http://technet.microsoft.com/en-US/evalcenter/hh670538.aspx?ocid=&wt.mc_id=TEC_108_1_33
.. _required_prerequisites:
Required Components
MS Windows Versions
-------------------
.. list-table::
:header-rows: 1
:widths: 30, 70
Supported by builder versions with en_US localization:
* - Component
- Save to
* Windows 2012 R2
* Windows 2012 R2 Core
* Windows 2008 R2
* Windows 2008 R2 Core
* - VirtIO drivers for Windows [#virtio_iso_link]_
- /opt/image-builder/share/libvirt/images/virtio-win-0.1-74.iso
Getting Started
---------------
* - CloudBase-Init for Windows [#cloudbase_init_link]_
- /opt/image-builder/share/files/CloudbaseInitSetup_Beta.msi
Trial versions of Windows 2008 R2 / 2012 R2 used by default. You could use these images for 180 days without activation.
You could download evaluation versions from official Microsoft website:
* - .NET 4.0 [#dot_net_40_link]_
- /opt/image-builder/share/files/dotNetFx40_Full_x86_x64.exe
* `[Windows 2012 R2 - download] <https://www.microsoft.com/en-us/download/details.aspx?id=11093>`_
* `[Windows 2008 R2 - download] <https://www.microsoft.com/en-us/evalcenter/evaluate-windows-server-2012-r2>`_
* - PowerShell v3 [#powershell_v3_link]_
- /opt/image-builder/share/files/Windows6.1-KB2506143-x64.msu
System requirements
~~~~~~~~~~~~~~~~~~~
* - Murano Agent [#murano_agent_link]_
- /opt/image-builder/share/files/MuranoAgent.zip
* - Git client [#msysgit_link]_
- /opt/image-builder/share/files/Git-1.8.1.2-preview20130601.exe
..
.. warning::
PowerShell V3 is a **mandatory** prerequisite. It is required by the murano Agent. To check your PowerShell version use PowerShell command *Get-Host*.
..
.. warning::
When downloading VirtIO drivers choose only stable versions.
Unstable versions might lead to errors during guest unattended installation.
You can check the latest version available here: https://fedoraproject.org/wiki/Windows_Virtio_Drivers#Direct_download
..
|
.. [#ws2012iso_link] http://technet.microsoft.com/en-us/evalcenter/hh670538.aspx
.. [#virtio_iso_link] https://fedoraproject.org/wiki/Windows_Virtio_Drivers#Direct_download
.. [#cloudbase_init_link] https://www.cloudbase.it/downloads/CloudbaseInitSetup_Beta.msi
.. [#dot_net_40_link] http://www.microsoft.com/en-us/download/details.aspx?id=17718
.. [#powershell_v3_link] http://www.microsoft.com/en-us/download/details.aspx?id=34595
.. [#murano_agent_link] https://www.dropbox.com/sh/zthldcxnp6r4flm/AADh6LkVkcw2j8nKZevqedHja/MuranoAgent.zip
.. [#msysgit_link] https://msysgit.googlecode.com/files/Git-1.8.3-preview20130601.exe
.. _optional_prerequisites:
Optional Components
-------------------
These components are not mandatory for the murano agent to function properly.
However, they may help you work with the image after deployment.
.. list-table::
:header-rows: 1
:widths: 30, 70
* - Component
- Save to
* - Far Manager [#far_manager_link]_
- /opt/image-builder/share/files/Far30b3367.x64.20130717.msi
* - Sysinternals Suite [#sysinternals_link]_
- /opt/image-builder/share/files/SysinternalsSuite.zip
* - unzip.exe [#unzip_link]_
- /opt/image-builder/share/files/unzip.exe
* - .NET 4.5 [#dot_net_45_link]_
- /opt/image-builder/share/files/dotNetFx45_Full_setup.exe
..
|
.. [#far_manager_link] http://www.farmanager.com/files/Far30b3525.x64.20130717.msi
.. [#sysinternals_link] http://download.sysinternals.com/files/SysinternalsSuite.zip
.. [#unzip_link] https://www.dropbox.com/sh/zthldcxnp6r4flm/AACwiyfcrlGDt3ygCFHrbwMra/unzip.exe
.. [#dot_net_45_link] http://www.microsoft.com/en-us/download/details.aspx?id=30653
Additional tools
================
Tools from this section are not necessary to build an image.
However, they may be helpful if you want to create an image with a different configuration.
Windows Assessment and Deployment Kit (ADK)
-------------------------------------------
*Windows ADK* is required if you want to build your own answer files for auto unattended Windows installation.
Download it from http://www.microsoft.com/en-us/download/details.aspx?id=30652
Floppy image with unattended file
---------------------------------
Floppy image with answer file for unattended installation is needed to automate Windows installation process.
* Create empty floppy image in your home folder
* Debian based Linux distribution, like Ubuntu, Mint and so on.
* Packages required:
``qemu-kvm virt-manager virt-goodies virtinst bridge-utils libvirt-bin
uuid-runtime samba samba-common cifs-utils``
* User should be able to run sudo without password prompt!
.. code-block:: console
mkdir ~/flp/files
mkdir ~/flp/mnt
..
sudo echo "${USER} ALL = NOPASSWD: ALL" > /etc/sudoers.d/${USER}
sudo chmod 440 /etc/sudoers.d/${USER}
.. code-block:: console
* Free disk space > 50G on partition where script will spawn virtual machines because of ``40G`` required by virtual
machine HDD image.
* Internet connectivity.
* Samba shared resource.
dd bs=512 count=2880 if=/dev/zero of=~/flp/floppy.img
mkfs.msdos ~/flp/floppy.img
..
Configuring builder
~~~~~~~~~~~~~~~~~~~
* Mount the image
Configuration parameters to tweak:
.. code-block:: console
``[default]``
mkdir ~/flp/mnt
sudo mount -o loop ~/floppy.img ~/flp/mnt
..
* ``workdir`` - place where script would prepare all software required by build scenarios. By `default` is not set,
i.e. script directory would used as root of working space.
* ``vmsworkdir`` - must contain valid path, this parameter tells script where it should spawn virtual machines.
* ``runparallel`` - *true* of *false*, **false** set by default. This parameter describes how to start virtual machines,
one by one or in launch them in background.
* Download **autounattend.xml.template** file from https://github.com/openstack/murano-deployment/tree/master/contrib/windows/image-builder/lib/windowssetup/unattend/
``[samba]``
This folder contains unattended files for several Windows versions, choose one that matches your Windows version.
* ``mode`` - *local* or *remote*. In local mode script would try to install and configure Samba server locally. If set
to remote, you should also provide information about connection.
* ``host`` - in local mode - is 192.168.122.1, otherwise set proper ip address.
* ``user`` - set to **guest** by default in case of guest rw access.
* ``domain`` - Samba server user domain, if not set `host` value used.
* ``password`` - Samba server user password.
* ``image-builder-share`` - Samba server remote directory.
* Copy that file to mounted floppy image
MS Windows install preparation:
.. code-block:: console
``[win2k12r2]`` or ``[win2k8r2]`` - shortcuts for 2012 R2 and 2008 R2.
cp ~/autounattend.xml.template ~/flp/mnt/autounattend.xml
..
* ``enabled`` - *true* of *false*, include or exclude release processing by script.
* ``editions`` - standard, core or both(space used as delimiter).
* ``iso`` - local path to iso file
* Replace string **%_IMAGE_BUILDER_IP_%** in that file with **192.168.122.1**
By default ``[win2k8r2]`` - disabled, if you need you can enable this release in *config.ini* file.
* Unmount the image
Run
---
.. code-block:: console
Preparation
~~~~~~~~~~~
sudo umount ~/flp/mnt
..
Run ``chmod +x *.sh`` in builder directory to make script files executable.
Command line parameters:
~~~~~~~~~~~~~~~~~~~~~~~~
``runme.sh`` - the main script
Build Windows image with murano
===============================
* ``--help`` - shows usage
* ``--forceinstall-dependencies`` - Runs dependencies install.
* ``--check-smb`` - Run checks or configuration of Samba server.
* ``--download-requirements`` - Download all required and configures software except MS Windows ISO.
* ``--show-configured`` - Shows configured and available to use MS Windows releases.
* ``--run`` - normal run
.. _build_image_using_image_builder_scripts:
Build Windows image using image builder script
----------------------------------------------
* Clone **murano-deployment** repository
.. code-block:: console
git clone git://git.openstack.org/openstack/murano-deployment.git
..
* Change directory to image-builder folder
.. code-block:: console
cd murano-deployment/contrib/windows/image-builder
..
* Create folder structure for image builder
.. code-block:: console
sudo make build-root
..
* Download build prerequisites, and copy them to correct folders
* :ref:`windows_installation_iso`
* :ref:`required_prerequisites`
* :ref:`optional_prerequisites` (Optional)
* Test that all required files are in place
.. code-block:: console
sudo make test-build-files
..
* Get list of available images
.. code-block:: console
make
..
* Run image build process (e.g. to build Windows Server 2012)
.. code-block:: console
sudo make ws-2012-std
..
* Wait until process finishes
* The image file **ws-2012-std.qcow2** should be stored inside **/opt/image-builder/share/images** folder.
Build windows image manually
----------------------------
.. note::
Please note that the preferred way to build images is to use Image Builder scripts, see :ref:`build_image_using_image_builder_scripts`
..
Get post-install scripts
------------------------
There are a few scripts which perform all the required post-installation tasks.
They all are located in http://git.openstack.org/cgit/openstack/murano-deployment/tree/contrib/windows/image-builder/lib/windowssetup/scripts/
.. note::
There are subfolders for each supported Windows version.
Choose one that matches Windows version you are building.
..
This folder contains several scripts
.. list-table::
:header-rows: 1
:widths: 20, 80
* - Script Name
- Description
* - wpi.ps1
- Handles component installation and system configuration tasks
* - Start-Sysprep.ps1
- Prepares system to be syspreped (cleans log files, stops some services and so on), and starts sysprep
* - Start-AtFirstBoot.ps1
- Performs basic after-installation tasks
..
Download these scripts and save them into /opt/image-builder/share/scripts
Create a VM
-----------
Now you need a virtual machine instance. There are two possible ways to create it - using CLI or GUI tools. We describe both in this section.
Using CLI Tools
^^^^^^^^^^^^^^^
1. Preallocate disk image
.. code-block:: console
qemu-img create -f raw /var/lib/libvirt/images/ws-2012.img 40G
..
2. Start the VM
.. code-block:: console
# virt-install --connect qemu:///system --hvm --name WinServ \
> --ram 2048 --vcpus 2 --cdrom /opt/samba/share/9200.16384.WIN8_RTM\
>.120725-1247_X64FRE_SERVER_EVAL_EN-US-HRM_SSS_X64FREE_EN-US_DV5.ISO \
> --disk path=/opt/samba/share/virtio-win-0.1-52.iso,device=cdrom \
> --disk path=/opt/samba/share/floppy.img,device=floppy \
> --disk path=/var/lib/libvirt/images/ws-2012.qcow2\
>,format=qcow2,bus=virtio,cache=none \
> --network network=default,model=virtio \
> --memballoon model=virtio --vnc --os-type=windows \
> --os-variant=win2k8 --noautoconsole \
> --accelerate --noapic --keymap=en-us --video=cirrus --force
..
Using virt-manager UI
Experimental options:
^^^^^^^^^^^^^^^^^^^^^
1. Launch *virt-manager* from shell as root
* ``--config-file`` - Set configuration file location instead of default.
2. Set a name for VM and select Local install media
Use cases
---------
3. Add one cdrom and attach Windows Server ISO image to it
All examples below describes changes in ``config.ini`` file
4. Select OS type **Windows**
1. I want to build one image for specific version and edition. For example: version - **2012 R2** and edition -
**standard**. Steps to reach the goal:
5. Set CPU and RAM amount
* Disable ``[win2k8r2]`` from script processing.
6. Deselect option **Enable storage for this virtual machine**
.. code-block:: ini
7. Add second cdrom for ISO image with virtio drivers
[win2k8r2]
enabled=false
8. Add a floppy drive and attach our floppy image to it
- Update ``[win2k12r2]`` with desired edition(**standard**).
9. Add (or create new) HDD image with Disk bus **VirtIO** and storage format **RAW**
.. code-block:: ini
10. Set network device model **VirtIO**
[win2k12r2]
enabled=true
editions=standard
11. Start installation process and open guest vm screen through **Console** button
* Execute ``runme.sh --run``
2. I want to build two images for specific version with all supported by script editions. For example: **2012 R2** and
editions - **standard** and **core**. Steps to reach the goal:
* Disable `[win2k8r2]` from script processing.
.. code-block:: ini
[win2k8r2]
enabled=false
* Update ``[win2k12r2]`` with desired editions(**standard** and **core**).
.. code-block:: ini
[win2k12r2]
enabled=true
editions=standard core
Install OS
----------
* Execute ``runme.sh --run``
Launch your virtual machine, connect to its virtual console and complete OS installation. At the end of this step you should have Windows Server system that you are able to log into.
3. I want to build two images for all supported by script versions with specific editions. For example: versions -
**2012 R2** and **2008 R2** and edition - **core**. Steps to reach the goal:
Install prerequisites and murano
--------------------------------
* Update ``[win2k8r2]`` with desired edition(**core**).
* Create folders where murano components will be installed
.. code-block:: ini
.. list-table::
:header-rows: 1
:widths: 20, 80
[win2k8r2]
enabled=true
editions=core
* - Path
- Description
* Update ``[win2k12r2]`` with desired edition(**core**).
* - C:\\Murano
- Root directory for Murano
.. code-block:: ini
* - C:\\Murano\\Agent
- Murano Agent installation directory
[win2k12r2]
enabled=true
editions=core
* - C:\\Murano\\Modules
- PowerShell modules required by Murano
* Execute ``runme.sh --run``
* - C:\\Murano\\Scripts
- PowerShell scripts and other files required by murano
..
* Open **Explorer** and navigate to **\\192.168.122.1\share** **192.168.122.1** is an IP address of KVM hypervisor assigned by default.
* Copy the murano agent files into C:\Murano\Agent
* Copy CoreFunctions directory (entire directory!) into C:\Murano\Modules
* Install .NET 4.0
* Register the murano agent
.. code-block:: cmd
> cd C:\Murano\Agent
> .\WindowsMuranoAgent.exe /install
..
* Change PowerShell execution policy to less restricted
.. code-block:: powershell
Set-ExecutionPolicy RemoteSigned
..
* Register CoreFunctions modules
.. code-block:: powershell
Import-Module C:\Murano\Modules\CoreFunctions\CoreFunctions.psm1 -ArgumentList register
..
* Install CloudInit
* Run Sysprep
.. code-block:: powershell
C:\Murano\Scripts\Start-Sysprep.ps1 -BatchExecution
..
* Wait until sysprep phase finishes and system powers off.
Convert the image from RAW to QCOW2 format
------------------------------------------
The image must be converted from RAW format to QCOW2 before being imported into glance.
.. code-block:: console
# qemu-img convert -O qcow2 /var/lib/libvirt/images/ws-2012.raw \
> /var/lib/libvirt/images/ws-2012-ref.qcow2
..