stackforge-attic/murano-docs
Code Issues Proposed changes

Cherry-pick from master:

Browse Source 
* Documentation updated
* Update user-guide with Murano Repository
* (from release-0.3) Add Linux image build chapter

Change-Id: I5987a5b8abd2db65b64e11a80a5cf08a72c236c4
This commit is contained in:
Dmitry Teselkin
2013-12-11 11:36:25 +04:00
committed by Ekaterina Fedorova
parent 9c1a1170fc
commit 81a15d9ddf
27 changed files with 1736 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/administrators-guide/src/docbkx/administrators-guide.xml
View File

@@ -33,7 +33,8 @@
</info>
<xi:include href="./content/general.xml" xlink:title="General Deployment Steps"/>
<xi:include href="./content/installation-guide.xml" xlink:title="Install Murano"/>
<xi:include href="./content/image-bulder.xml" xlink:title="Image Builder"/>
<xi:include href="./content/windows-image-bulder.xml" xlink:title="Building Windows Image"/>
<xi:include href="./content/linux-image-bulder.xml" xlink:title="Building Linux Image"/>
<xi:include href="./content/troubleshooting.xml" xlink:title="Troubleshooting"/>
<xi:include href="./content/appendix.xml" xlink:title="Appendix"/>
</book>

426
src/administrators-guide/src/docbkx/content/linux-image-bulder.xml Normal file
View File

@@ -0,0 +1,426 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2013 Mirantis, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xlink="http://www.w3.org/1999/xlink"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
version="5.0">
<title>Building Linux Image</title>
<section>
<title>Install Required Packages</title>
<note>
<para>
Please check that hardware virtualization is supported and enabled in BIOS.
</para>
</note>
<para>
The following packages should be installed on any host which will be used to build Linux Image:
<itemizedlist>
<listitem>
<para>
ipxe-qemu
</para>
</listitem>
<listitem>
<para>
kvm-ipxe
</para>
</listitem>
<listitem>
<para>
qemu-kvm
</para>
</listitem>
<listitem>
<para>
munin-libvirt-plugins
</para>
</listitem>
<listitem>
<para>
python-libvirt
</para>
</listitem>
<listitem>
<para>
libvirt-bin
</para>
</listitem>
<listitem>
<para>
libvirt0
</para>
</listitem>
<listitem>
<para>
munin-libvirt-plugins
</para>
</listitem>
<listitem>
<para>
python-libvirt
</para>
</listitem>
<listitem>
<para>
virt-goodies
</para>
</listitem>
<listitem>
<para>
virt-manager
</para>
</listitem>
<listitem>
<para>
virt-top
</para>
</listitem>
<listitem>
<para>
virt-what
</para>
</listitem>
<listitem>
<para>
virtinst
</para>
</listitem>
<listitem>
<para>
python
</para>
</listitem>
</itemizedlist>
</para>
<para>
On Ubuntu you could install them using the command below:
</para>
<screen>
># apt-get install ipxe-qemu kvm-ipxe qemu-kvm virt-goodies \
virtinst virt-manager libvirt0 libvirt-bin \
munin-libvirt-plugins python python-libvirt \
python-libxml2 python-minimal python-pycurl \
python-pyorbit python-requests python-six \
samba samba-common openssh-server virt-top virt-what
</screen>
</section>
<section>
<title>Build Linux Image</title>
<para>
<emphasis role="strong">Create a VM</emphasis>
</para>
<para>This section describes steps required to build an image of Linux Virtual Machine
which could be used with Murano. There are two possible ways to create it - from
CLI or using GUI tools. We describe both in this section.
</para>
<note>
<para>
Run all commands as root.
</para>
</note>
<para>
<emphasis role="strong">Way 1: Using CLI Tools</emphasis>
</para>
<para>
This section describes the required step to launch a VM using CLI tools only.
</para>
<para>
<orderedlist>
<listitem>
<para>
Preallocate disk image
</para>
<screen>
># qemu-img create -f qcow2 /var/lib/libvirt/images/cloud-linux.img 10G
</screen>
</listitem>
<listitem>
<para>
Start the VM
</para>
<screen>
># virt-install --connect qemu:///system --hvm --name cloud-linux \
--ram 2048 --vcpus 2 --cdrom /PATH_TO_YOUR_LINUX.ISO \
--disk path=/var/lib/libvirt/images/cloud-linux.img, \
format=qcow2,bus=virtio,cache=none \
--network network=default,model=virtio \
--memballoon model=virtio --vnc --os-type=linux \
--accelerate --noapic --keymap=en-us --video=cirrus --force
</screen>
</listitem>
</orderedlist>
</para>
<para>
<emphasis role="strong">Way 2: Using virt-manager UI</emphasis>
</para>
<para>
A VM also could be lauched via GUI tools like virt-manager.
</para>
<para>
<orderedlist>
<listitem>
<para>Launch <emphasis role="italic">virt-manager</emphasis> from shell
as root </para>
</listitem>
<listitem>
<para>
Set a name for VM and select Local install media
</para>
</listitem>
<listitem>
<para>
Add one cdrom and attach your linux ISO image to it
</para>
</listitem>
<listitem>
<para>
Select OS type <emphasis role="bold">Linux</emphasis> and it's
version <emphasis role="bold">choose yours</emphasis>
</para>
</listitem>
<listitem>
<para>
Set CPU and RAM amount
</para>
</listitem>
<listitem>
<para>
Deselect option <emphasis role="bold">Enable storage for this
virtual machine</emphasis>
</para>
</listitem>
<listitem>
<para>
Select option <emphasis role="bold">Customize configuration before
install</emphasis>
</para>
</listitem>
<listitem>
<para>
Add (or create new) HDD image with Disk bus <emphasis role="bold">VirtIO</emphasis> and storage format <emphasis role="bold">QCOW2</emphasis>
</para>
</listitem>
<listitem>
<para>Set network device model <emphasis role="bold">VirtIO</emphasis>
</para>
</listitem>
<listitem>
<para>Start installation process and open guest vm screen through
<emphasis role="bold">Console</emphasis> button
</para>
</listitem>
</orderedlist>
</para>
</section>
<section>
<title>Guest VM Linux OS preparation</title>
<para>
<emphasis role="strong">Ubuntu 12.04 LTS x86_64</emphasis>
</para>
<screen>
># for action in update upgrade dist-upgrade;do apt-get -y $action;done
># apt-get install -y git unzip make cmake gcc python-dev python-pip openssh-server sudo
</screen>
<para>
<emphasis role="strong">CentOS 6.4 x86_64</emphasis>
</para>
<screen>
># rpm -ivh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
># for action in update upgrade;do yum -y $action; done
># yum install -y git unzip make cmake gcc python-devel python-pip openssh-server openssh-clients sudo
</screen>
<para>
<emphasis role="strong">murano-agent installation steps</emphasis>
</para>
<screen>
># mkdir -p /opt/git
># cd /opt/git
># git clone https://github.com/stackforge/murano-agent.git
># cd murano-agent/python-agent
># git checkout release-0.3
># chmod a+x setup*.sh
># ./setup.sh install
or
># ./setup-centos.sh install
</screen>
<para>
<emphasis role="strong">cloud-init installation steps</emphasis>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Ubuntu</emphasis>
</para>
<screen>
># apt-get install -y cloud-init cloud-initramfs-growroot
</screen>
</listitem>
<listitem>
<para>
<emphasis role="bold">CentOS</emphasis>
</para>
<screen>
># yum install -y cloud-init
</screen>
<note>
<para>
<emphasis role="bold">Ubuntu only</emphasis>
</para>
<screen>
># dpkg-reconfigure cloud-init
</screen>
<para>
Mark <emphasis role="bold">EC2</emphasis> data source support, save and exit or add manualy <emphasis role="bold">Ec2</emphasis> to the datasource_list variable in the /etc/cloud/cloud.cfg.d/90_dfkg.cfg
</para>
</note>
</listitem>
<listitem>
<para>
<emphasis role="strong">Minimal cloud-init configuration options</emphasis>
</para>
<screen>
># vi /etc/cloud/cloud.cfg:
user: ec2-user
disable_root: 1
preserve_hostname: False
</screen>
</listitem>
</itemizedlist>
</para>
<para>
<emphasis role="strong">Security setup</emphasis>
</para>
<para>
Create user and make it able to run commands through sudo without password prompt.
<itemizedlist>
<listitem>
<para>
<emphasis role="strong">Ubuntu</emphasis>
</para>
<screen>
># useradd -m -G sudo -s /bin/bash ec2-user
># passwd ec2-user
</screen>
</listitem>
<listitem>
<para>
<emphasis role="strong">CentOS</emphasis>
</para>
<screen>
># useradd -m -G wheel -s /bin/bash ec2-user
># passwd ec2-user
</screen>
</listitem>
<listitem>
<para>
<emphasis role="strong">Sudo</emphasis>
</para>
<screen>
># echo "ec2-user ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/ec2-user
># chmod 440 /etc/sudoers.d/ec2-user
</screen>
</listitem>
<listitem>
<para>
<emphasis role="strong">Disable SSH password-based logins in the /etc/ssh/sshd_config.</emphasis>
</para>
<screen>
...
GSSAPIAuthentication no
PasswordAuthentication no
PermitRootLogin no
...
</screen>
</listitem>
</itemizedlist>
</para>
<para>
<emphasis role="strong">Network handling</emphasis>
<itemizedlist>
<listitem>
<para>
<emphasis role="strong">Ubuntu</emphasis>
</para>
<screen>
># rm -rf /etc/udev/rules.d/70-persistent-net.rules
</screen>
</listitem>
<listitem>
<para>
<emphasis role="strong">CentOS</emphasis>
Remove or comment out HWADDR and UUID in /etc/sysconfig/network-scripts/ifcfg-eth*
</para>
<screen>
># rm -rf /etc/udev/rules.d/70-persistent-net.rules
</screen>
</listitem>
</itemizedlist>
</para>
<para>
<emphasis role="strong">Shutdown VM</emphasis>
</para>
<formalpara>
<title>Convert the image from RAW to QCOW2 format if you made it as RAW</title>
<para>
The image must be converted from RAW format to QCOW2 before being imorted into Glance.
</para>
</formalpara>
<para>
<screen>
># qemu-img convert -O qcow2 /var/lib/libvirt/images/cloud-linux.img \
/var/lib/libvirt/images/cloud-linux.img.qcow2
</screen>
</para>
</section>
<section>
<title>Upload Image Into Glance</title>
<para>
Services deployed by Murano require specially prepared images.
After images are created they should be registered in Openstack Glance - image operation service.
</para>
<screen>
># glance image-create --disk-format=qcow2 --container-format=bare --is-public=true --file=cloud-linux.img --name=cloud-linux
</screen>
<note>
<para>Image should be marked with an appropriate type. That could be done through the Horizon UI.
Navigate to Project -&gt; Environments -&gt; Marked Images -&gt; Mark Image and fill up form:
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Image</emphasis> - cloud-linux
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Title</emphasis> - My Cloud-ready Linux
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Type</emphasis> - Generic Linux
</para>
</listitem>
</itemizedlist>
</para>
</note>
<para>
After these steps desired image can be chosen in Murano dashboard and used for services platform.
</para>
</section>
</chapter>

775
src/administrators-guide/src/docbkx/content/windows-image-bulder.xml Normal file
View File

@@ -0,0 +1,775 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2013 Mirantis, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xlink="http://www.w3.org/1999/xlink"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
version="5.0">
<title>Building Windows Image</title>
<para>
Murano requires a Windows Image in QCOW2 format to be built and uploaded into Glance.
</para>
<para>
The easiest way to build Windows image for Murano is to build it on the host where your OpenStack is installed.
</para>
<section>
<title>Install Required Packages</title>
<note>
<para>
Please check that hardware virtualization supported and enabled in BIOS.
</para>
</note>
<para>
The following packages should be installed on any host which will be used to build Windows Image:
<itemizedlist>
<listitem>
<para>
ipxe-qemu
</para>
</listitem>
<listitem>
<para>
kvm-ipxe
</para>
</listitem>
<listitem>
<para>
qemu-kvm
</para>
</listitem>
<listitem>
<para>
munin-libvirt-plugins
</para>
</listitem>
<listitem>
<para>
python-libvirt
</para>
</listitem>
<listitem>
<para>
libvirt-bin
</para>
</listitem>
<listitem>
<para>
libvirt0
</para>
</listitem>
<listitem>
<para>
munin-libvirt-plugins
</para>
</listitem>
<listitem>
<para>
python-libvirt
</para>
</listitem>
<listitem>
<para>
virt-goodies
</para>
</listitem>
<listitem>
<para>
virt-manager
</para>
</listitem>
<listitem>
<para>
virt-top
</para>
</listitem>
<listitem>
<para>
virt-what
</para>
</listitem>
<listitem>
<para>
virtinst
</para>
</listitem>
<listitem>
<para>
python
</para>
</listitem>
</itemizedlist>
</para>
<para>
On Ubuntu you could install them using the command below:
</para>
<screen>
># apt-get install ipxe-qemu kvm-ipxe qemu-kvm virt-goodies \
virtinst virt-manager libvirt0 libvirt-bin \
munin-libvirt-plugins python python-libvirt \
python-libxml2 python-minimal python-pycurl \
python-pyorbit python-requests python-six \
samba samba-common openssh-server virt-top virt-what
</screen>
</section>
<section>
<title>Configure Shared Resource</title>
<formalpara>
<title>Configure samba based share</title>
<para>
<screen>
># mkdir -p /opt/samba/share
># chown -R nobody:nogroup /opt/samba/share
</screen>
</para>
</formalpara>
<formalpara>
<title>Configure samba server (/etc/samba/smb.conf)</title>
<para>
<screen>
...
[global]
...
security = user
...
[share]
comment = Deployment Share
path = /opt/samba/share
browsable = yes
read only = no
create mask = 0755
guest ok = yes
guest account = nobody
...
</screen>
</para>
</formalpara>
<formalpara>
<title>Restart services</title>
<para>
<screen>
># service smbd restart
># service nmbd restart
</screen>
</para>
</formalpara>
</section>
<section>
<title>Prerequisites</title>
<para>Download the files below and copy them into their places in your <emphasis
role="bold">${SHARE_PATH}</emphasis> folder (we usually use <emphasis
role="bold">/opt/samba/share</emphasis> as <emphasis role="bold"
>${SHARE_PATH}</emphasis>):<itemizedlist>
<listitem>
<para>Windows 2012 Server ISO evaluation version<itemizedlist>
<listitem>
<para>${SHARE_PATH}/libvirt/images/ws-2012-eval.iso</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://technet.microsoft.com/en-us/evalcenter/hh670538.aspx">
http://technet.microsoft.com/en-us/evalcenter/hh670538.aspx
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>VirtIO drivers for Windows<itemizedlist>
<listitem>
<para>${SHARE_PATH}/libvirt/images/virtio-win-0.1-52.iso</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://alt.fedoraproject.org/pub/alt/virtio-win/stable/virtio-win-0.1-52.iso">
http://alt.fedoraproject.org/pub/alt/virtio-win/stable/virtio-win-0.1-52.iso
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>CloudBase-Init for Windows<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/CloudbaseInitSetup_Beta.msi</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://www.cloudbase.it/downloads/CloudbaseInitSetup_Beta.msi">
http://www.cloudbase.it/downloads/CloudbaseInitSetup_Beta.msi
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>Far Manager<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/Far30b3367.x64.20130426.msi</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://www.farmanager.com/files/Far30b3525.x64.20130717.msi">
http://www.farmanager.com/files/Far30b3525.x64.20130717.msi
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>Git client<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/Git-1.8.1.2-preview20130201.exe</para>
</listitem>
<listitem>
<para>
<link xlink:href="https://msysgit.googlecode.com/files/Git-1.8.3-preview20130601.exe">
https://msysgit.googlecode.com/files/Git-1.8.3-preview20130601.exe
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>Sysinternals Suite<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/SysinternalsSuite.zip</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://download.sysinternals.com/files/SysinternalsSuite.zip">
http://download.sysinternals.com/files/SysinternalsSuite.zip
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>unzip.exe tool<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/unzip.exe</para>
</listitem>
<listitem>
<para>
<link xlink:href="https://www.dropbox.com/sh/zthldcxnp6r4flm/-k1Om_V6XR">
https://www.dropbox.com/sh/zthldcxnp6r4flm/-k1Om_V6XR
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>PowerShell v3<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/Windows6.1-KB2506143-x64.msu</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://www.microsoft.com/en-us/download/details.aspx?id=34595">
http://www.microsoft.com/en-us/download/details.aspx?id=34595
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>.NET 4.0<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/dotNetFx40_Full_x86_x64.exe</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://www.microsoft.com/en-us/download/details.aspx?id=17718">
http://www.microsoft.com/en-us/download/details.aspx?id=17718
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>.NET 4.5<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/dotNetFx45_Full_setup.exe</para>
</listitem>
<listitem>
<para>
<link xlink:href="http://www.microsoft.com/en-us/download/details.aspx?id=30653">
http://www.microsoft.com/en-us/download/details.aspx?id=30653
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>Murano Agent<itemizedlist>
<listitem>
<para>${SHARE_PATH}/share/files/MuranoAgent.zip</para>
</listitem>
<listitem>
<para>
<link xlink:href="https://www.dropbox.com/sh/zthldcxnp6r4flm/-k1Om_V6XR">
https://www.dropbox.com/sh/zthldcxnp6r4flm/-k1Om_V6XR
</link>
</para>
</listitem>
</itemizedlist></para>
</listitem>
</itemizedlist></para>
</section>
<section>
<title>Additional Software</title>
<para> This section describes additional software which is required to build an Windows
Image.</para>
<para><emphasis role="bold">Windows ADK</emphasis></para>
<para>
<emphasis role="italic">Windows Assessment and Deployment Kit (ADK) for Windows®
8</emphasis> is required to build your own answer files for auto unattended
Windows installation. </para>
<para>
You can dowload it from <link xlink:href="http://www.microsoft.com/en-us/download/details.aspx?id=30652">
http://www.microsoft.com/en-us/download/details.aspx?id=30652</link>.
</para>
<para><emphasis role="bold">PuTTY</emphasis></para>
<para>PuTTY is a useful tool to manage your Linux boxes via SSH.</para>
<para>
You can download it from <link xlink:href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">
http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html</link>.
</para>
<para><emphasis role="bold">Windows Server 2012 ISO image</emphasis></para>
<para>We use the following Windows installation images:<itemizedlist>
<listitem>
<para>Windows Server 2008 R2<itemizedlist>
<listitem>
<para>Image Name:
7601.17514.101119-1850_x64fre_server_eval_en-us-GRMSXEVAL_EN_DVD.iso</para>
</listitem>
<listitem>
<para>URL: <link
xlink:href="http://www.microsoft.com/en-us/download/details.aspx?id=11093"
>
http://www.microsoft.com/en-us/download/details.aspx?id=11093
</link></para>
</listitem>
</itemizedlist></para>
</listitem>
<listitem>
<para>Windows Server 2012<itemizedlist>
<listitem>
<para>Image Name:
9200.16384.WIN8_RTM.120725-1247_X64FRE_SERVER_EVAL_EN-US-HRM_SSS_X64FREE_EN-US_DV5.iso</para>
</listitem>
<listitem>
<para>URL: <link
xlink:href="http://technet.microsoft.com/en-US/evalcenter/hh670538.aspx?ocid=&amp;wt.mc_id=TEC_108_1_33"
>
http://technet.microsoft.com/en-US/evalcenter/hh670538.aspx?ocid=&amp;wt.mc_id=TEC_108_1_33
</link></para>
</listitem>
</itemizedlist></para>
</listitem>
</itemizedlist></para>
<para><emphasis role="bold">VirtIO Red Hat drivers ISO image</emphasis></para>
<warning>
<para>
Please, choose stable version instead of latest, We&#8217;ve got errors with unstable drivers during guest unattended install.
</para>
</warning>
<para>Download drivers from <link xlink:href="http://alt.fedoraproject.org/pub/alt/virtio-win/stable/">
http://alt.fedoraproject.org/pub/alt/virtio-win/stable/</link>
</para>
<para><emphasis role="bold">Floppy Image With Unattended File</emphasis></para>
<para>
Run following commands as root:
</para>
<orderedlist numeration="arabic">
<listitem>
<para>
Create emtpy floppy image in your home folder
</para>
<screen>
># dd bs=512 count=2880 \
if=/dev/zero of=~/floppy.img \
mkfs.msdos ~/floppy.img
</screen>
</listitem>
<listitem>
<para>
Mount the image to <emphasis role="strong">/media/floppy</emphasis>
</para>
<screen>
># mkdir /media/floppy mount -o loop \
~/floppy.img /media/floppy
</screen>
</listitem>
<listitem>
<para>
Download <emphasis role="strong">autounattend.xml</emphasis> file from <link
xlink:href="https://raw.github.com/stackforge/murano-deployment/master/image-builder/share/files/ws-2012-std/autounattend.xml">
https://raw.github.com/stackforge/murano-deployment/master/image-builder/share/files/ws-2012-std/autounattend.xml
</link>
</para>
<screen>
># cd ~
># wget https://raw.github.com/stackforge/murano-deployment\
/master/image-builder/share/files/ws-2012-std/autounattend.xml
</screen>
</listitem>
<listitem>
<para>
Copy our <emphasis role="strong">autounattend.xml</emphasis> to <emphasis role="strong">/media/floppy</emphasis>
</para>
<screen>
># cp ~/autounattend.xml /media/floppy
</screen>
</listitem>
<listitem>
<para>
Unmount the image
</para>
<screen>
># umount /media/floppy
</screen>
</listitem>
</orderedlist>
</section>
<section>
<title>Build Windows Image (Automatic Way)</title>
<orderedlist numeration="arabic">
<listitem>
<para>Clone <emphasis role="strong">murano-deployment</emphasis> repository </para>
<screen>
># git clone git://github.com/stackforge/murano-deployment.git
</screen>
</listitem>
<listitem>
<para>Change directory to <emphasis role="strong"
>murano-deployment/image-builder</emphasis> folder. </para>
</listitem>
<listitem>
<para>Create folder structure for image builder </para>
<screen>
># make build-root
</screen>
</listitem>
<listitem>
<para>Create shared resource </para>
<formalpara>
<title>Add to /etc/samba/smb.conf</title>
<para>
<screen>
[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
</screen>
</para>
</formalpara>
<formalpara>
<title>Restart samba services</title>
<para>
<screen>
># restart smbd &amp;&amp; restart nmbd
</screen>
</para>
</formalpara>
</listitem>
<listitem>
<para>Test that all required files are in place </para>
<screen>
># make test-build-files
</screen>
</listitem>
<listitem>
<para>Get list of available images </para>
<screen>
># make
</screen>
</listitem>
<listitem>
<para>Run image build process </para>
<screen>
># make ws-2012-std
</screen>
</listitem>
<listitem>
<para>Wait until process finishes </para>
</listitem>
<listitem>
<para>The image file <emphasis role="strong">ws-2012-std.qcow2</emphasis> should be
stored under <emphasis role="strong">/opt/image-builder/share/images</emphasis>
folder. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Build Windows Image (Manual Way)</title>
<warning>
<para> Please note that the preferred way to build images is to use <emphasis
role="strong">Automated Build</emphasis> described in the previous chapter. </para>
</warning>
<para><emphasis role="strong">Get Post-Install Scripts</emphasis></para>
<para>There are a few scripts which perform all the required post-installation tasks. </para>
<para>Package installation tasks are performed by script named <emphasis role="strong"
>wpi.ps1</emphasis>. </para>
<para>Download it from <link
xlink:href="https://raw.github.com/stackforge/murano-deployment/master/image-builder/share/scripts/ws-2012-std/wpi.ps1"
>
https://raw.github.com/stackforge/murano-deployment/master/image-builder/share/scripts/ws-2012-std/wpi.ps1</link>
</para>
<note>
<para>There are a few scripts named <emphasis role="strong">wpi.ps1</emphasis>, each
supports only one version of Windows image. The script above is intended to be
used to create Windows Server 2012 Standard. To build other version of Windows
please use appropriate script from <emphasis role="strong">scripts</emphasis>
folder. </para>
</note>
<para>Clean-up actions to finish image preparation are performed by <emphasis role="strong">Start-Sysprep.ps1</emphasis>
script.</para>
<para>Download it from <link
xlink:href="https://raw.github.com/stackforge/murano-deployment/master/image-builder/share/scripts/ws-2012-std/Start-Sysprep.ps1"
>
https://raw.github.com/stackforge/murano-deployment/master/image-builder/share/scripts/ws-2012-std/Start-Sysprep.ps1</link>
</para>
<para>These scripts should be copied to the shared resource folder, subfolder <emphasis
role="strong">Scripts</emphasis>.</para>
<para><emphasis role="strong">Create a VM</emphasis></para>
<para>This section describes steps required to build an image of Windows Virtual Machine
which could be used with Murano. There are two possible ways to create it - from
CLI or using GUI tools. We describe both in this section. </para>
<note>
<para>
Run all commands as root.
</para>
</note>
<para><emphasis role="strong">Way 1: Using CLI Tools</emphasis></para>
<para>This section describes the required step to launch a VM using CLI tools only. </para>
<para>
<orderedlist>
<listitem>
<para>
Preallocate disk image
</para>
<screen>
># qemu-img create -f raw /var/lib/libvirt/images/ws-2012.img 40G
</screen>
</listitem>
<listitem>
<para>
Start the VM
</para>
<screen>
># 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
</screen>
</listitem>
</orderedlist>
</para>
<para><emphasis role="strong">Way 2: Using virt-manager UI</emphasis></para>
<para>A VM also could be lauched via GUI tools like virt-manager. </para>
<para>
<orderedlist>
<listitem>
<para>Launch <emphasis role="italic">virt-manager</emphasis> from shell
as root </para>
</listitem>
<listitem>
<para>Set a name for VM and select Local install media</para>
</listitem>
<listitem>
<para>Add one cdrom and attach Windows Server ISO image to it</para>
</listitem>
<listitem>
<para>Select OS type <emphasis role="bold">Windows</emphasis> and it's
version <emphasis role="bold">Windows Server 2008</emphasis>
</para>
</listitem>
<listitem>
<para>Set CPU and RAM amount </para>
</listitem>
<listitem>
<para>Deselect option <emphasis role="bold">Enable storage for this
virtual machine</emphasis>
</para>
</listitem>
<listitem>
<para>Select option <emphasis role="bold">Customize configuration before
install</emphasis>
</para>
</listitem>
<listitem>
<para>Add second cdrom for ISO image with virtio drivers</para>
</listitem>
<listitem>
<para>Add a floppy drive and attach our floppy image to it</para>
</listitem>
<listitem>
<para>Add (or create new) HDD image with Disk bus <emphasis role="bold"
>VirtIO</emphasis> and storage format <emphasis role="bold"
>RAW</emphasis>
</para>
</listitem>
<listitem>
<para>Set network device model <emphasis role="bold">VirtIO</emphasis>
</para>
</listitem>
<listitem>
<para>Start installation process and open guest vm screen through
<emphasis role="bold">Console</emphasis> button </para>
</listitem>
</orderedlist>
</para>
<formalpara>
<title>Convert the image from RAW to QCOW2 format</title>
<para>The image must be converted from RAW format to QCOW2 before being imorted into
Glance. </para>
</formalpara>
<para>
<screen>
># qemu-img convert -O qcow2 /var/lib/libvirt/images/ws-2012.raw \
/var/lib/libvirt/images/ws-2012-ref.qcow2
</screen>
</para>
</section>
<section>
<title>Upload Image Into Glance</title>
<para>
Services deployed by Murano require specially prepared images, that can be created manually or via automated scripts.
Please refer to corresponding chapters of this book to create image. After images are created they should be registered in Openstack Glance - image operation service.
</para>
<orderedlist>
<listitem>
<para>
Use the glance image-create command to import your disk image to Glance:
<screen>
>$ glance image-create --name &lt;NAME> \
--is-public true --disk-format qcow2 \
--container-format bare \
--file &lt;IMAGE_FILE> \
--property &lt;IMAGE_METADATA>
</screen>
</para>
<para>
Replace the command line arguments to glance image-create with the appropriate values for your environment and disk image:
</para>
<itemizedlist>
<listitem>
<para>
Replace <emphasis role="bold">&lt;NAME></emphasis> with the name that users will refer to the disk image by.
E.g. '<emphasis role="bold">ws-2012-std</emphasis>'
</para>
</listitem>
<listitem>
<para>
Replace <emphasis role="bold">&lt;IMAGE_FILE></emphasis> with the local path to the image file to upload.
E.g. '<emphasis role="bold">ws-2012-std.qcow2</emphasis>'.
</para>
</listitem>
<listitem>
<para> Replace <emphasis role="bold">&lt;IMAGE_METADATA></emphasis> with the
following property string
<screen>
murano_image_info='{"title": "Windows 2012 Standart Edition", "type": "windows.2012"}'
</screen>
where <itemizedlist>
<listitem>
<para>title - user-friendly description of the image</para>
</listitem>
<listitem>
<para>type - is a image type, for example 'windows.2012'</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para> To update metadata of the existing image run the command:</para>
<screen>
>$ glance image-update &lt;IMAGE-ID> --property &lt;IMAGE_MATADATA>
</screen>
<itemizedlist>
<listitem>
<para>
Replace <emphasis role="bold">&lt;IMAGE-ID></emphasis> with image id from the previous command output.
</para>
</listitem>
<listitem>
<para> Replace <emphasis role="bold">&lt;IMAGE_METADATA></emphasis> with
murano_image_info property, e.g.
<screen>
murano_image_info='{"title": "Windows 2012 Standart Edition", "type": "windows.2012"}'
</screen>
</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
<warning>
<para>The value of the <emphasis role="bold"
>--property</emphasis> argument named <emphasis
role="bold">murano_image_info</emphasis> is a JSON
string. Only double quotes are valid in JSON, so please type
the string exactly as in the example above. </para>
</warning>
<para>
After these steps desired image can be chosen in Murano dashboard and used for services platform.
</para>
</section>
</chapter>

10
src/getting-started/src/docbkx/content/setup_lab_environment.xml
View File

@@ -87,12 +87,12 @@
</programlisting>
<itemizedlist>
<listitem>
<para>Checkout the <emphasis role="bold">stable/grizzly</emphasis> branch</para>
<para>Checkout the <emphasis role="bold">stable/havana</emphasis> branch</para>
</listitem>
</itemizedlist>
<programlisting>
>$ cd devstack
>$ git checkout stable/grizzly
>$ git checkout stable/havana
</programlisting>
<itemizedlist>
<listitem>
@@ -100,10 +100,10 @@
</listitem>
</itemizedlist>
<programlisting>
>$ wget https://raw.github.com/stackforge/murano-deployment/release-0.2/
>$ wget https://raw.github.com/stackforge/murano-deployment/release-0.4/
getting-started/localrc
>$ wget https://raw.github.com/stackforge/murano-deployment/release-0.2/
getting-started/local.sh -O local.sh-O local.sh
>$ wget https://raw.github.com/stackforge/murano-deployment/release-0.4/
getting-started/local.sh
>$ chmod +x local.sh
</programlisting>
<itemizedlist>

194
src/user-guide/src/docbkx/content/murano-dashboard.xml → src/user-guide/src/docbkx/content/environments.xml
View File

@@ -21,23 +21,33 @@
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
version="5.0">
<title>Murano dashboard plugin</title>
<title>Environments</title>
<para>
To use Murano you should be familiar with Openstack. Murano Dashboard is just a plugin to Openstack dashboard - Horizon.
Please visit
<link xlink:href="http://docs.openstack.org/user-guide/content/"> horizon user guide </link>
first to see how dashboard is organized and how to login to it.
<emphasis role="bold"> Murano Environment </emphasis> - a virtual unit to store different services (applications).
They can be connected with each other or be individual. The following actions with environment are available:
<itemizedlist>
<listitem>
<para>Create;</para>
</listitem>
<listitem>
<para>Delete;</para>
</listitem>
<listitem>
<para>Deploy.</para>
</listitem>
</itemizedlist>
More information about actions with environment are described in this chapter.
</para>
<section>
<title>Creating environment</title>
<para> Once you installed all Murano components and login to horizon dashboard successfully you will see Environments panel:</para>
<para>Once you installed all Murano components and logged-in to horizon dashboard successfully you will see Murano tab:</para>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/env_panel.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<para>
First thing you need to do is to create an environment - virtual Windows Data Center which will contain different Windows services.
First thing you need to do is to create an environment.
To do this, navigate to the "Environments" page and click the "Create Environment". After setting name to your virtual environment it will be created.
</para>
<mediaobject>
@@ -59,8 +69,7 @@
<section>
<title>Creating service prototype</title>
<para >
All services should be created in the context of Environment
- virtual Windows Data Center. After Environment is created, you need to create services prototypes
All services should be created in the context of Environment. After Environment is created, you need to create service prototypes
and then deploy the Environment. When deploy process is done instances
with your services will be spawned in Openstack.
To create a service prototype navigate to page with the list of environment services by
@@ -86,6 +95,26 @@
To see more information about filling the form for a specific service follow one of the link below:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">
<link linkend="ASP">ASP.NET Service:</link>
</emphasis>
is a server-side Web application framework designed for Web
development to produce dynamic Web pages. Service is able
to install custom application onto one IIS Web Server. Murano installs
all needed components and makes proper configuration.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="ASPfarm">ASP.NET Farm Service:</link>
</emphasis>
ASP.NET Farm Service installs a custom application on a
load-balanced array of IIS servers.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold"><link linkend="AD">Active Directory:</link></emphasis>
@@ -95,6 +124,22 @@
Any other services you are intending to create can be
joined to that domain.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="Apache">Apache Service:</link></emphasis>
Apache HTTP Server is a web server application notable for playing a key role in the initial growth of the World Wide Web.
This service can install Apache with PHP module or without it.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="Demo">Demo Service:</link></emphasis>
Installs test service that demonstrates how to Murano interconnects with Murano Demo Agent.
For this service light-weight Linux Cirros image can be used.
</para>
</listitem>
<listitem>
<para>
@@ -115,22 +160,9 @@
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="ASP">ASP.NET Service:</link>
</emphasis>
is a server-side Web application framework designed for Web
development to produce dynamic Web pages. Service is able
to install custom application onto one IIS Web Server. Murano installs
all needed components and makes proper configuration.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">
<link linkend="ASPfarm">ASP.NET Farm Service:</link>
</emphasis>
ASP.NET Farm Service installs a custom application on a
load-balanced array of IIS servers
<emphasis role="bold"><link linkend="Telnet">Linux Telnet:</link></emphasis>
Telnet - is a network protocol used to provide a bidirectional interactive
text-oriented communication facility using a virtual terminal connection.
</para>
</listitem>
<listitem>
@@ -142,7 +174,7 @@
<listitem>
<para>
<emphasis role="bold">
<link linkend="SQLfarm">SQL Server Failover Cluster:</link>
<link linkend="SQLfarm">MS SQL Server Failover Cluster:</link>
</emphasis>
Murano installs all needed components and configures your
SQL Server Cluster the way you want.
@@ -304,7 +336,7 @@
</mediaobject>
</section>
<section xml:id="SQLfarm">
<title>SQL Server Failover Cluster</title>
<title>MS SQL Server Failover Cluster</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/cluster1.png" scalefit="1" width="100%" contentdepth="100%"/>
@@ -442,6 +474,114 @@
</imageobject>
</mediaobject>
</section>
<section xml:id="Apache">
<title>Linux Apache Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/apache.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<informaltable rules="all" frame="border" width="100%" cellpadding="3"
cellspacing="3">
<col width="25%" align="left" style="font-weight:bold"
valign="top"/>
<col width="70%" style="padding:6px"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Service Name</para>
</td>
<td>
<para>
Enter a desired name for a service. Just A-Z,
a-z, 0-9, dash and underline are allowed.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>PHP module</para>
</td>
<td>
<para>
PHP module can be installed with Apache.
Enable or disable this options via checkbox.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Key Pair</para>
</td>
<td>
<para>
Select SSH Key Pair from the existing to
control access to your instance.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Hostname</para>
</td>
<td>
<para>
Machine hostname.
If blank - random name will be used.
</para>
</td>
</tr>
</tbody>
</informaltable>
</section>
<section xml:id="Telnet">
<title>Linux Telnet Service</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="../images/telnet.png" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
<informaltable rules="all" frame="border" width="100%" cellpadding="3"
cellspacing="3">
<col width="25%" align="left" style="font-weight:bold"
valign="top"/>
<col width="70%" style="padding:6px"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Service Name</para>
</td>
<td>
<para>
Enter a desired name for a service. Just A-Z,
a-z, 0-9, dash and underline are allowed.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Key Pair</para>
</td>
<td>
<para>
Select SSH Key Pair from the existing.
</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Hostname</para>
</td>
<td>
<para>
Machine hostname.
If blank - random name will be used.
</para>
</td>
</tr>
</tbody>
</informaltable>
</section>
</section>
<section>
<title>Deploying environment</title>

105
src/user-guide/src/docbkx/content/images.xml Normal file
View File

@@ -0,0 +1,105 @@
<?xml version='1.0' encoding='UTF-8'?>
<!--
Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
Version 2.0 (the &quot;License&quot;); you may not use this file
except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
by applicable law or agreed to in writing, software distributed under
the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
the License for the specific language governing permissions and
limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="5.0" xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd">
<title>Images</title>
<para>
Murano uses preconfigured images for spawning instances. Image
suitable for Murano should have Murano Agent installed at least. See
<link xlink:href="http://murano-docs.github.io/latest/administrators-guide/content/ch03.html">
here</link> how to build Murano images and upload it to Glance. Since Murano
supports different operating systems it&apos;s not possible to use
one image to build every single application. To classify images
Metadata property of Glance image is used. Murano Dashboard allows to
add that property from a separate view. Navigate to the Murano tab
and go to
<filename>Images</filename>
panel.
<warning>
<para>To operate with Glance Images you need to have admin
rights!</para>
</warning>
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Images/index.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
You are browsing Glance images with correctly set
&quot;murano_image_info&quot; property - image metadata. From this
view you are able to:
<itemizedlist>
<listitem>
<para>Delete an existing image metadata with <filename>&quot;Delete
Metadata&quot;</filename> button (only image's property get deleted,
the image itself stays in Glance)</para>
</listitem>
<listitem>
<para>Add new murano metadata to an image that is already registered
in Glance by clicking on <filename>&quot;Mark
Image&quot;</filename> button</para>
</listitem>
</itemizedlist>
Take a look at the &quot;Mark Image&quot; form:
</para>
<para>
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Images/mark_image.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
<informaltable cellpadding="3" cellspacing="3" frame="border" rules="all" width="100%">
<col align="left" style="font-weight:bold" valign="top" width="25%"/>
<col style="padding:6px" width="70%"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Image</para>
</td>
<td>
<para>From all images registered in Glance pick one that was created with
<link linked="http://murano-docs.github.io/latest/administrators-guide/content/ch03.html">Murano Image Builder</link>.</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Title</para>
</td>
<td>
<para>Set name for a selected image to recognize it easier during
service creation.</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>Type</para>
</td>
<td>
<para>
For now there are three supported types:
<itemizedlist>
<listitem>
<para>Windows Server 2012 - used to build Windows-based
applications</para>
</listitem>
<listitem>
<para>Murano Demo - light-weight Linux Cirros image with
Murano Demo Agent</para>
</listitem>
<listitem>
<para>Generic Linux - used to build Linux-based
applications</para>
</listitem>
</itemizedlist>
</para>
</td>
</tr>
</tbody>
</informaltable>
</para>
</chapter>

208
src/user-guide/src/docbkx/content/metadata.xml Normal file
View File

@@ -0,0 +1,208 @@
<?xml version='1.0' encoding='UTF-8'?>
<!--
Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
Version 2.0 (the &amp;quot;License&amp;quot;); you may not use this
file except in compliance with the License. You may obtain a copy of
the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
required by applicable law or agreed to in writing, software
distributed under the License is distributed on an &amp;quot;AS
IS&amp;quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language
governing permissions and limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="5.0" xsi:schemaLocation="http://docbook.org/ns/docbook
http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd">
<title>Metadata Repository</title>
<para>This chapter describes how to operate with Murano Metadata
Repository via UI. </para>
<para>
Metadata Repository is a REST API server stores all data
necessary for a service deployment. Information about service and
it&apos;s dependencies is called <emphasis>service definition</emphasis>
or <emphasis>manifest</emphasis>. Murano Conductor and Dashboard will
load these service definitions and service or application will be available
for creation. Besides manifests Murano Repository stores this types
of data:
<itemizedlist>
<listitem>
<para><emphasis>ui</emphasis> - UI definitions for Murano
dashboard</para>
</listitem>
<listitem>
<para><emphasis>workflows</emphasis> - set of rules for Murano
Conductor</para>
</listitem>
<listitem>
<para><emphasis>heat</emphasis> - templates for spawning instance
with Heat</para>
</listitem>
<listitem>
<para><emphasis>agent</emphasis> - Murano Agent templates</para>
</listitem>
<listitem>
<para><emphasis>scripts</emphasis> - Murano Execution Plans</para>
</listitem>
</itemizedlist>
In &quot;Murano&quot; tab go to the <filename>"Service Definitions"</filename> panel:
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/index.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
</para>
<para>
From this view you are able to perform the following actions:
<itemizedlist>
<listitem>
<para><filename>Compose Service</filename> provides a form for
creating new service manifest. After this operation is complete new service
will appear in Service Definitions table and you will be allowed
to download this service definition, modify or delete it.</para>
</listitem>
<listitem>
<para><filename>Upload Service</filename> provides a form for
uploading tar.gz archive with already composed service manifest and
other dependency files.</para>
</listitem>
<listitem>
<para><filename>Manage Files</filename> button will redirect you to
a view where you can manipulate with all files stored in Metadata
Repository: download, delete or upload new ones.</para>
</listitem>
<listitem>
<para><filename>Toggle Active</filename> button will make service
active or inactive depending on the current state.</para>
</listitem>
<listitem>
<para><filename>Modify Service</filename> gives you opportunity to
modify attributes of service definition.</para>
</listitem>
<listitem>
<para><filename>Manage Service</filename> redirects you to a view
with information about selected service and service files for all
data types that Murano Repository supports. From here you can
upload file and add it to service dependency in one click.</para>
</listitem>
<listitem>
<para><filename>Download Service</filename> saves archive with all
files used by specified service.</para>
</listitem>
<listitem>
<para><filename>Delete Service</filename> removes service manifest
and all dependencies that are not used by other services from
Murano Repository server.</para>
<para/>
</listitem>
</itemizedlist>
</para>
<section>
<title>
Compose Service
</title>
<para>
Let's review service creation in details.
After clicking on "Compose Service" button from "Service Definitions" view you'll see the following form:
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/compose_service1.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
It consists of several tabs. On the first tab you need to fill up general information about service.
On the next tab select one of the UI definitions you want to use for this service.
You can upload new definition in the <emphasis><link linked="manage_files">Manage Files</link></emphasis> view.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/compose_service2.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
All other tabs correspond to data types. Navigate to desired tab and select files for service dependency.
The only mandatory requirement for a new service is a UI definition file - if a service doesn't reference any, it won't be shown in the
<filename>"Create Service"</filename> form. All other tabs refer to a files required for a service's deployment phase.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/compose_service3.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
</para>
</section>
<section xml:id="manage_files">
<title>Manage Files</title>
<para>
Murano Repository table shows all files stored in Metadata
Repository. Files are divided into categories by data types.
Button name of each category also contains the number of files in that category.
Click on the type name to browse all files of this type.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/manage_files.png " scalefit="1" width="100%"/>
</imageobject></mediaobject>
The following actions are available:
<itemizedlist>
<listitem>
<para>Download file,</para>
</listitem>
<listitem>
<para>Delete file,</para>
</listitem>
<listitem>
<para>Upload file.</para>
</listitem>
</itemizedlist>
To upload file to repository you need to fill up this form:
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/manage_files_upload.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
<informaltable cellpadding="3" cellspacing="3" frame="border" rules="all" width="100%">
<col align="left" style="font-weight:bold" valign="top" width="25%"/>
<col style="padding:6px" width="70%"/>
<tbody>
<tr>
<td style="font-weight:bold">
<para>Murano Repository File</para>
</td>
<td>
<para>Select file for uploading. It should be not bigger than 5Mb.</para>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<para>File Type</para>
</td>
<td>
<para>
Select one of supported type. It will be loaded directly to a directory that stores corresponding file types.
</para>
</td>
</tr>
</tbody>
</informaltable>
</para>
</section>
<section>
<title>
Manage Service
</title>
<para>
Manage Service view displays general information about service and list of file dependency grouped by a separate tables.
<mediaobject><imageobject role="fo">
<imagedata contentdepth="100%" fileref="../images/Metadata/manage_service.png" scalefit="1" width="100%"/>
</imageobject></mediaobject>
In the following view these actions are available:
<itemizedlist>
<listitem>
<para>
View service detail information.
</para>
</listitem>
<listitem>
<para>
Download File.
</para>
</listitem>
<listitem>
Delete file.
</listitem>
<listitem>
<para>
Upload file of the exact type by pressing the &#60;File type&#62;" button in the appropriate table.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</chapter>

48
src/user-guide/src/docbkx/content/overview.xml
View File

@@ -24,32 +24,52 @@
<title>How can I use Murano Service?</title>
<para>
Murano is intended to get opportunity for non-experienced
users to deploy reliable Windows-based environments extremely simple.
This document describes process of creation virtual Windows Environment with different services.
users to deploy different kinds of applications extremely simple.
To use Murano you should be familiar with Openstack.
Murano Dashboard is just a plugin to Openstack dashboard - Horizon.
Please visit horizon user guide first to see how dashboard is organized and how to login into it.
This document describes Murano Dashboard usage in detail.
</para>
<section>
<title>Document change history</title>
<para>The following table describes the most recent changes:</para>
<informaltable rules="all">
<tgroup cols='2'>
<colspec colname="col1" colnum="1" colwidth="1*"/>
<colspec colname="col2" colnum="2" colwidth="1*"/>
<thead>
<tr>
<td align="center" colspan="1">Revision Date</td>
<td align="center" colspan="4">Summary of Changes</td>
</tr>
<row>
<entry>Revision Date</entry>
<entry>Summary of Changes</entry>
</row>
</thead>
<tbody>
<tr>
<td colspan="1" align="center">September. 4, 2013</td>
<td colspan="4">
<itemizedlist>
<row>
<entry>
September. 4, 2013
</entry>
<entry>
<itemizedlist spacing="compact">
<listitem>
<para>Initial document creation.</para>
<para>Update for Release-0.2</para>
</listitem>
</itemizedlist>
</td>
</tr>
</entry>
</row>
<row>
<entry>
December. 9, 2013
</entry>
<entry>
<itemizedlist spacing="compact">
<listitem>
<para>Update for Release-0.4</para>
</listitem>
</itemizedlist>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</chapter>

BIN
src/user-guide/src/docbkx/images/Images/Image 13.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
src/user-guide/src/docbkx/images/Images/index.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
src/user-guide/src/docbkx/images/Images/mark_image.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/compose_service1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/compose_service2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/compose_service3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/index.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/manage_files.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 67 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/manage_files_upload.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/manage_service.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 92 KiB

BIN
src/user-guide/src/docbkx/images/Metadata/upload_tofile.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.7 KiB

BIN
src/user-guide/src/docbkx/images/apache.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

BIN
src/user-guide/src/docbkx/images/cluster2.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 45 KiB

BIN
src/user-guide/src/docbkx/images/env_btn.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 21 KiB

BIN
src/user-guide/src/docbkx/images/env_created.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 27 KiB

BIN
src/user-guide/src/docbkx/images/env_panel.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 21 KiB

BIN
src/user-guide/src/docbkx/images/service_list.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 15 KiB

BIN
src/user-guide/src/docbkx/images/telnet.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

6
src/user-guide/src/docbkx/user-guide.xml
View File

@@ -24,7 +24,7 @@
version="5.0">
<title>Murano User Guide</title>
<info>
<releaseinfo>v0.3</releaseinfo>
<releaseinfo>v0.4</releaseinfo>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the template. Change
@@ -35,5 +35,7 @@
</legalnotice>
</info>
<xi:include href="./content/overview.xml" xlink:title="Overview" />
<xi:include href="./content/murano-dashboard.xml" xlink:title="Murano Dashboard" />
<xi:include href="./content/images.xml" xlink:title="Murano Images" />
<xi:include href="./content/environments.xml" xlink:title="Murano Environments"/>
<xi:include href="./content/metadata.xml" xlink:title="Murano Metadata"/>
</book>