openstack/openstack-manuals
Code Issues Proposed changes

Do not use os= in Config Reference

Browse Source 
The Config Reference does not profile for the os variable and thus
all occurences of os=... are shown which leads to confusion. Add proper
wording for all examples.

Change-Id: I77c81b92e95d1b8737b507ea439a9622ebc3d6f1
Closes-Bug: #1232864
This commit is contained in:
Andreas Jaeger 2013-10-10 09:20:09 +02:00
parent 20da9f662f
commit 93140c9453
4 changed files with 70 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/common/section_dashboard_customizing.xml
View File

@ -125,9 +125,15 @@ text-decoration: none;
</step>
<step>
<para>Restart apache:</para>
<screen os="ubuntu"><prompt>$</prompt> <userinput>sudo service apache2 restart</userinput></screen>
<screen os="centos;fedora;rhel"><prompt>$</prompt> <userinput>sudo service httpd restart</userinput></screen>
<screen os="opensuse"><prompt>$</prompt> <userinput>sudo service apache2 restart</userinput></screen>
<para>On Ubuntu:
<screen><prompt>$</prompt> <userinput>sudo service apache2 restart</userinput></screen>
</para>
<para>On Fedora, RHEL, CentOS:
<screen><prompt>$</prompt> <userinput>sudo service httpd restart</userinput></screen>
</para>
<para>On openSUSE:
<screen><prompt>$</prompt> <userinput>sudo service apache2 restart</userinput></screen>
</para>
</step>
<step>
<para>Reload the dashboard in your browser to view your

30
doc/common/section_hyper-v.xml
View File

@ -38,13 +38,13 @@
<para>Network time services must be configured to ensure proper operation of the Hyper-V
compute node. To set network time on your Hyper-V host you will need to run the
following commands</para>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>net stop w32time</userinput>
</screen>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>w32tm /config /manualpeerlist:pool.ntp.org,0x8 /syncfromflags:MANUAL</userinput>
</screen>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>net start w32time</userinput>
</screen>
</section>
@ -56,10 +56,10 @@
</para>
<para>To quickly enable an interface to be used as a Virtual Interface the following
PowerShell may be used:</para>
<screen os="windows">
<screen>
<prompt>PS C:\</prompt><userinput>$if = Get-NetIPAddress –IPAddress 192* | Get-NetIPInterface</userinput>
</screen>
<screen os="windows">
<screen>
<prompt>PS C:\</prompt><userinput>New-VMSwitch -NetAdapterName $if.ifAlias -Name yourbridgename –AllowManagementOS $false</userinput>
</screen>
</section>
@ -68,10 +68,10 @@
<para>To prepare the Hyper-V node to be able to attach to volumes provided by cinder
you must first make sure the Windows iSCSI initiator service is running and
started automatically.</para>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>sc start MSiSCSI</userinput>
</screen>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>sc config MSiSCSI start="auto"</userinput>
</screen>
</section>
@ -138,20 +138,20 @@
<listitem>
<para>The openstack-compute service deployed with the setup must run with domain
credentials. You can set the service credentials with:</para>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>sc config openstack-compute obj="DOMAIN\username" password="password"</userinput></screen>
</listitem>
</itemizedlist>
<para><emphasis role="bold">How to setup live migration on Hyper-V</emphasis></para>
<para>To enable shared nothing live migration run the 3 PowerShell instructions below on
each Hyper-V host:</para>
<screen os="windows">
<screen>
<prompt>PS C:\</prompt><userinput>Enable-VMMigration</userinput>
</screen>
<screen os="windows">
<screen>
<prompt>PS C:\</prompt><userinput>Set-VMMigrationNetwork <replaceable>IP_ADDRESS</replaceable></userinput>
</screen>
<screen os="windows">
<screen>
<prompt>PS C:\</prompt><userinput>Set-VMHost –VirtualMachineMigrationAuthenticationTypeKerberos</userinput>
</screen>
<note>
@ -227,7 +227,7 @@
</itemizedlist>
<para>The following python packages need to be installed via easy_install or pip. Run the
following replacing PACKAGENAME with the packages below:</para>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>c:\Python27\Scripts\pip.exe install <replaceable>PACKAGE_NAME</replaceable></userinput>
</screen>
<itemizedlist>
@ -313,7 +313,7 @@
installer and follow the prompts in the installation wizard. The default should be
acceptable for the needs of the document.</para>
<para>Once installed you may run the following to clone the Nova code.</para>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>git.exe clone https://github.com/openstack/nova.git</userinput>
</screen>
</section>
@ -355,7 +355,7 @@ connection=mysql://nova:passwd@<replaceable>IP_ADDRESS</replaceable>/nova</progr
>http://technet.microsoft.com/en-us/library/cc772480.aspx</link></para>
<para>Once you have successfully created a virtual machine, you can then upload the image to
glance using the native glance-client:</para>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>glance image-create --name="<replaceable>VM_IMAGE_NAME</replaceable>" --is-public=true --container-format=bare --disk-format=vhd</userinput>
</screen>
</section>
@ -363,7 +363,7 @@ connection=mysql://nova:passwd@<replaceable>IP_ADDRESS</replaceable>/nova</progr
<title>Running Compute with Hyper-V</title>
<para>To start the <systemitem class="service">nova-compute</systemitem> service, run this command from a console in the Windows
server:</para>
<screen os="windows">
<screen>
<prompt>C:\</prompt><userinput>C:\python27\python.exe c:\openstack\nova\bin\nova-compute.py</userinput>
</screen>
</section>

44
doc/common/section_kvm.xml
View File

@ -81,20 +81,38 @@ libvirt_type=kvm</programlisting>
(mainly Intel <emphasis role="italic">VT -x</emphasis> or AMD <emphasis role="italic"
>AMD-v</emphasis> technologies) to use KVM.</para>
<para>In order to check if your processor has VT support (which has to be enabled in the
BIOS), issue as
root:<screen os="ubuntu"><prompt>#</prompt> <userinput>apt-get install cpu-checker</userinput>
BIOS), follow on Ubuntu these steps:</para>
<itemizedlist>
<listitem>
<para>Issue as root on Ubuntu:</para>
<screen><prompt>#</prompt> <userinput>apt-get install cpu-checker</userinput>
<prompt>#</prompt> <userinput>kvm-ok</userinput></screen>
<screen os="rhel;fedoa;centos"><prompt>$</prompt> <userinput>egrep '(vmx|svm)' --color=always /proc/cpuinfo</userinput></screen>
</para>
<para>If KVM is supported, the output should look something like:<screen os="ubuntu">
<computeroutput>INFO: /dev/kvm exists
</listitem>
<listitem>
<para>If KVM is supported, the output should look something like:</para>
<screen><computeroutput>INFO: /dev/kvm exists
KVM acceleration can be used</computeroutput></screen>
<screen os="rhel;fedora;centos"><computeroutput>flags : fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx rdtscp lm constant_tsc arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc aperfmperf pni dtes64 monitor ds_cpl vmx est tm2 ssse3 cx16 xtpr pdcm pcid sse4_1 sse4_2 popcnt lahf_lm arat dtherm tpr_shadow vnmi flexpriority ept vpid</computeroutput></screen>
</para>
<para os="ubuntu">If KVM is not supported, the output should look something
like:<screen><computeroutput>INFO: Your CPU does not support KVM extensions
KVM acceleration can NOT be used</computeroutput></screen></para>
<para os="rhel;fedora;centos">If KVM is not supported, you should get no output.</para>
</listitem>
<listitem>
<para>If KVM is supported, the output should look something like:</para>
<screen><computeroutput>INFO: /dev/kvm exists
KVM acceleration can be used</computeroutput></screen>
</listitem>
</itemizedlist>
<para>On other distributions, follow these steps:</para>
<itemizedlist>
<listitem>
<para>Run the following as user:</para>
<screen><prompt>$</prompt> <userinput>egrep '(vmx|svm)' --color=always /proc/cpuinfo</userinput></screen>
</listitem>
<listitem>
<para>If KVM is supported, the output should look something like:</para>
<screen><computeroutput>flags : fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx rdtscp lm constant_tsc arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc aperfmperf pni dtes64 monitor ds_cpl vmx est tm2 ssse3 cx16 xtpr pdcm pcid sse4_1 sse4_2 popcnt lahf_lm arat dtherm tpr_shadow vnmi flexpriority ept vpid</computeroutput></screen>
</listitem>
<listitem>
<para>If KVM is not supported, you should get no output.</para>
</listitem>
</itemizedlist>
<note><para>Some systems require that you enable VT support in the system BIOS. If you believe
your processor supports hardware acceleration but the above command produced no output,
you may need to reboot your machine, enter the system BIOS, and enable the VT
@ -215,7 +233,7 @@ libvirt_cpu_model=Nehalem</programlisting>
kernel module, as root:
<screen><prompt>#</prompt> <userinput>modprobe vhost_net</userinput></screen></para>
</section>
<section xml:id="xml-troubleshooting">
<section xml:id="kvm-troubleshooting">
<title>Troubleshooting</title>
<para>Trying to launch a new virtual machine instance fails
with the <literal>ERROR</literal> state, and the following

23
doc/common/section_qemu.xml
View File

@ -28,8 +28,15 @@
libvirt_type=qemu</programlisting></para>
<para>
For some operations you may also have to install the <command>guestmount</command> utility:</para>
<screen os="ubuntu"><prompt>$></prompt> <userinput>sudo apt-get install guestmount</userinput></screen>
<screen os="rhel;fedora;centos"><prompt>$></prompt> <userinput>sudo yum install libguestfs-tools</userinput></screen>
<para>On Ubuntu:
<screen><prompt>$></prompt> <userinput>sudo apt-get install guestmount</userinput></screen>
</para>
<para>On RHEL, Fedora or CentOS:
<screen><prompt>$></prompt> <userinput>sudo yum install libguestfs-tools</userinput></screen>
</para>
<para>On openSUSE:
<screen><prompt>$></prompt> <userinput>sudo zypper install guestfs-tools</userinput></screen>
</para>
<para>The QEMU hypervisor supports the following virtual machine image formats:</para>
<itemizedlist>
<listitem>
@ -42,24 +49,24 @@ libvirt_type=qemu</programlisting></para>
<para>VMWare virtual machine disk format (vmdk)</para>
</listitem>
</itemizedlist>
<section xml:id="fixes-rhel-qemu" os="rhel;fedora;centos"><title>Tips and fixes for QEMU on RHEL</title>
<section xml:id="fixes-rhel-qemu">
<title>Tips and fixes for QEMU on RHEL</title>
<para>If you are testing OpenStack in a virtual machine, you need
to configure nova to use qemu without KVM and hardware
virtualization. The second command relaxes SELinux rules
to allow this mode of operation
(https://bugzilla.redhat.com/show_bug.cgi?id=753589). The
(<link xlink:href="https://bugzilla.redhat.com/show_bug.cgi?id=753589">
https://bugzilla.redhat.com/show_bug.cgi?id=753589</link>). The
last two commands here work around a libvirt issue fixed in
RHEL 6.4. Note nested virtualization will be the much
slower TCG variety, and you should provide lots of memory
to the top level guest, as the OpenStack-created guests
default to 2GM RAM with no overcommit.</para>
<note><para>The second command, <command>setsebool</command>, may take a while.</para></note>
<note><para>The second command, <command>setsebool</command>, may take a while.
</para></note>
<screen><prompt>$></prompt> <userinput>sudo openstack-config --set /etc/nova/nova.conf DEFAULT libvirt_type qemu</userinput>
<prompt>$></prompt> <userinput>sudo setsebool -P virt_use_execmem on</userinput>
<prompt>$></prompt> <userinput>sudo ln -s /usr/libexec/qemu-kvm /usr/bin/qemu-system-x86_64</userinput>
<prompt>$></prompt> <userinput>sudo service libvirtd restart</userinput></screen>
</section>
</section>