openstack/murano
Code Issues Proposed changes

cleanup murano docs in the image_builders folder

Browse Source 
standart to standard
clean up capitalizations that are unnecessary
harware to hardware
added transition words “the” “a” where needed
avaible changed to available
emtpy should be empty
unatteded should be unattended
Manualy should be manually
Performes should be performs
scrtips should be scripts
changed docs to comply with doc conventions
https://wiki.openstack.org/wiki/Documentation/Conventions

Change-Id: I5324053f4eed28a3f7b37b5fe2b334e7d374ad13
This commit is contained in:
Shilla Saebi 2015-05-28 16:12:19 -04:00
parent 46362edb04
commit 98b6030332
3 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/image_builders/linux.rst
View File

@ -17,7 +17,7 @@
Linux Image Linux Image
=========== ===========
At the moment the best way to build a Linux image with Murano agent is At the moment the best way to build a Linux image with the murano agent is
to use disk image builder. to use disk image builder.
@ -68,7 +68,7 @@ Export paths where additional dib elements are located:
$ export ELEMENTS_PATH=$GITDIR/murano/contrib/elements:$GITDIR/murano-agent/contrib/elements $ export ELEMENTS_PATH=$GITDIR/murano/contrib/elements:$GITDIR/murano-agent/contrib/elements
And build Ubuntu-based image with Murano agent: And build Ubuntu-based image with the murano agent:
.. code-block:: console .. code-block:: console
@ -76,8 +76,8 @@ And build Ubuntu-based image with Murano agent:
$ tox -e venv -- disk-image-create vm ubuntu murano-agent -o ../murano-agent.qcow2 $ tox -e venv -- disk-image-create vm ubuntu murano-agent -o ../murano-agent.qcow2
If you need Fedora based image replace 'ubuntu' to 'fedora' in the last command. If you need a Fedora based image, replace 'ubuntu' to 'fedora' in the last command.
It'll take a while (up to 30 minutes if your hard drive and internet connection are slow). It'll take a while (up to 30 minutes if your hard drive and internet connection are slow).
When done upload murano-agent.qcow2 image to Glance and play :) When you are done upload the murano-agent.qcow2 image to glance and play :)

14
doc/source/image_builders/upload.rst
View File

@ -16,12 +16,12 @@
======================== ========================
Upload Image Into Glance Upload image into glance
======================== ========================
To deploy applications with Murano, virtual machine images should be uploaded into Glance in a special way - *murano_image_info* property should be set. To deploy applications with murano, virtual machine images should be uploaded into glance in a special way - *murano_image_info* property should be set.
1. Use the glance image-create command to import your disk image to Glance: 1. Use the glance image-create command to import your disk image to glance:
.. code-block:: console .. code-block:: console
@ -40,7 +40,7 @@ Replace the command line arguments to glance image-create with the appropriate v
.. code-block:: text .. code-block:: text
murano_image_info='{"title": "Windows 2012 Standart Edition", "type": "windows.2012"}' murano_image_info='{"title": "Windows 2012 Standard Edition", "type": "windows.2012"}'
.. ..
where: where:
@ -61,7 +61,7 @@ where:
.. code-block:: text .. code-block:: text
murano_image_info='{"title": "Windows 2012 Standart Edition", "type": "windows.2012"}' murano_image_info='{"title": "Windows 2012 Standard Edition", "type": "windows.2012"}'
.. ..
.. warning:: .. warning::
@ -72,7 +72,7 @@ where:
.. note:: .. note::
Already existing image could be marked in a simple way in Horizon UI with Murano dashboard installed. Existing images could be marked in a simple way in the horizon UI with the murano dashboard installed.
Navigate to *Murano -> Manage -> Images -> Mark Image* and fill up a form: Navigate to *Murano -> Manage -> Images -> Mark Image* and fill up a form:
* **Image** - ws-2012-std * **Image** - ws-2012-std
@ -85,7 +85,7 @@ After these steps desired image can be chosen in application creation wizard.
.. _murano_image_types: .. _murano_image_types:
Murano Image Types Murano image types
------------------ ------------------
.. list-table:: .. list-table::

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

@ -16,16 +16,16 @@
============= =============
Windows Image Windows image
============= =============
Murano requires a Windows Image in QCOW2 format to be built and uploaded into Glance. Murano requires a Windows image in QCOW2 format to be built and uploaded into glance.
The easiest way to build Windows image for Murano is to build it on the host where your OpenStack is installed. 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 Prepare image builder host
========================== ==========================
@ -37,7 +37,7 @@ Install KVM
This guide was tested on Ubuntu Server 12.04 x64. 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 future, though. 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 Install KVM and some additional packages that are required by our scripts
@ -55,7 +55,7 @@ Check that your hardware supports hardware virtualization.
KVM acceleration can be used KVM acceleration can be used
.. ..
If your output differs, check that harware virtualization is enabled in your BIOS settings. You also could try import KVM kernel module 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 .. code-block:: console
@ -73,11 +73,11 @@ It might be helpful to add an appropriate module name into **/etc/modules** file
Configure Shared Resource Configure shared resource
========================= =========================
Murano Image Builder uses a shared folder located on the host system as an installation source for components. The murano image builder uses a shared folder located on the host system as an installation source for components.
Makefile from image builder will copy required files to their locations, but you have to manually configure samba share. 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. To do this, use the steps below.
* Install samba * Install samba
@ -126,13 +126,13 @@ To do this, use the steps below.
Download Prerequisites Download prerequisites
====================== ======================
.. _windows_installation_iso: .. _windows_installation_iso:
Windows Server Installation ISO Windows server installation ISO
------------------------------- -------------------------------
.. list-table:: .. list-table::
@ -154,7 +154,7 @@ Windows Server Installation ISO
.. warning:: .. warning::
Windows Server 2008 R2 must include Service Pack 1 updates. This is required to install PowerShell V3 which is required by Murano Agent. Windows Server 2008 R2 must include Service Pack 1 updates. This is required to install PowerShell V3 which is required by the murano Agent.
.. ..
| |
@ -195,14 +195,14 @@ Required Components
.. warning:: .. warning::
PowerShell V3 is a **mandatory** prerequisite. It is required by Murano Agent. To check your PowerShell version use PowerShell command *Get-Host*. PowerShell V3 is a **mandatory** prerequisite. It is required by the murano Agent. To check your PowerShell version use PowerShell command *Get-Host*.
.. ..
.. warning:: .. warning::
When downloading VirtIO drivers choose only stable versions. When downloading VirtIO drivers choose only stable versions.
Unstable versions might lead to errors during guest unattended installation. Unstable versions might lead to errors during guest unattended installation.
You can check the latest version avaible here: http://alt.fedoraproject.org/pub/alt/virtio-win/stable You can check the latest version available here: http://alt.fedoraproject.org/pub/alt/virtio-win/stable
.. ..
| |
@ -220,7 +220,7 @@ Required Components
Optional Components Optional Components
------------------- -------------------
These components are not mandatory for Murano Agent to function properly. These components are not mandatory for the murano agent to function properly.
However, they may help you work with the image after deployment. However, they may help you work with the image after deployment.
.. list-table:: .. list-table::
@ -253,14 +253,14 @@ However, they may help you work with the image after deployment.
Additional Tools Additional tools
================ ================
Tools from this section are not necessary to build an image. Tools from this section are not necessary to build an image.
However, they may be helpful if you want to create an image with different configuration. However, they may be helpful if you want to create an image with a different configuration.
Windows Assessment and Deployment Kit (ADK) Windows assessment and deployment kit (ADK)
------------------------------------------- -------------------------------------------
*Windows ADK* is required if you want to build your own answer files for auto unattended Windows installation. *Windows ADK* is required if you want to build your own answer files for auto unattended Windows installation.
@ -268,12 +268,12 @@ Windows Assessment and Deployment Kit (ADK)
Download it from http://www.microsoft.com/en-us/download/details.aspx?id=30652 Download it from http://www.microsoft.com/en-us/download/details.aspx?id=30652
Floppy Image With Unattended File Floppy image with unattended file
--------------------------------- ---------------------------------
Floppy image with answer file for unattended installation is needed to automate Windows installation process. Floppy image with answer file for unattended installation is needed to automate Windows installation process.
* Create emtpy floppy image in your home folder * Create empty floppy image in your home folder
.. code-block:: console .. code-block:: console
@ -297,7 +297,7 @@ Floppy image with answer file for unattended installation is needed to automate
* Download **autounattend.xml.template** file from https://github.com/openstack/murano-deployment/tree/master/contrib/windows/image-builder/share/files * Download **autounattend.xml.template** file from https://github.com/openstack/murano-deployment/tree/master/contrib/windows/image-builder/share/files
This folder contains unatteded files for several Windows versions, choose one that matches your Windows version. This folder contains unattended files for several Windows versions, choose one that matches your Windows version.
* Copy that file to mounted floppy image * Copy that file to mounted floppy image
@ -317,13 +317,13 @@ Floppy image with answer file for unattended installation is needed to automate
Build Windows Image with Murano Build Windows image with murano
=============================== ===============================
.. _build_image_using_image_builder_scripts: .. _build_image_using_image_builder_scripts:
Build Windows Image Using Image Builder Script Build Windows image using image builder script
---------------------------------------------- ----------------------------------------------
* Clone **murano-deployment** repository * Clone **murano-deployment** repository
@ -380,8 +380,8 @@ Build Windows Image Using Image Builder Script
Build Windows Image Manualy Build windows image manually
--------------------------- ----------------------------
.. note:: .. note::
@ -389,7 +389,7 @@ Build Windows Image Manualy
.. ..
Get Post-Install Scripts Get post-install scripts
------------------------ ------------------------
There are a few scripts which perform all the required post-installation tasks. There are a few scripts which perform all the required post-installation tasks.
@ -399,8 +399,8 @@ They all are located in http://git.openstack.org/cgit/openstack/murano-deploymen
.. note:: .. note::
There are subfolders for each supported Windows Version. There are subfolders for each supported Windows version.
Choose one that matches Windows Version you are building. Choose one that matches Windows version you are building.
.. ..
This folder contains several scripts This folder contains several scripts
@ -419,7 +419,7 @@ This folder contains several scripts
- Prepares system to be syspreped (cleans log files, stops some services and so on), and starts sysprep - Prepares system to be syspreped (cleans log files, stops some services and so on), and starts sysprep
* - Start-AtFirstBoot.ps1 * - Start-AtFirstBoot.ps1
- Performes basic after-installation tasks - Performs basic after-installation tasks
.. ..
@ -491,10 +491,10 @@ Install OS
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. 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.
Install Prerequisites and Murano Install prerequisites and murano
-------------------------------- --------------------------------
* Create folders where Murano components will be installed * Create folders where murano components will be installed
.. list-table:: .. list-table::
:header-rows: 1 :header-rows: 1
@ -513,18 +513,18 @@ Install Prerequisites and Murano
- PowerShell modules required by Murano - PowerShell modules required by Murano
* - C:\\Murano\\Scripts * - C:\\Murano\\Scripts
- PowerShell scrtips and other files required by Murano - 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. * 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 Murano Agent files into C:\Murano\Agent * Copy the murano agent files into C:\Murano\Agent
* Copy CoreFunctions directory (entire directory!) into C:\Murano\Modules * Copy CoreFunctions directory (entire directory!) into C:\Murano\Modules
* Install .NET 4.0 * Install .NET 4.0
* Register Murano Agent * Register the murano agent
.. code-block:: cmd .. code-block:: cmd
@ -560,7 +560,7 @@ Install Prerequisites and Murano
Convert the image from RAW to QCOW2 format Convert the image from RAW to QCOW2 format
------------------------------------------ ------------------------------------------
The image must be converted from RAW format to QCOW2 before being imported into Glance. The image must be converted from RAW format to QCOW2 before being imported into glance.
.. code-block:: console .. code-block:: console