openstack/openstack-manuals
Code Issues Proposed changes

Use a $ prompt where possible

Browse Source 
Replace # prompts with $ prompts where root privileges are not required.

Change-Id: Ia7c0388e1b61d8de469d197e47cc5f95ca33bebe
This commit is contained in:
Gauvain Pocentek 2014-03-21 11:50:35 +01:00
parent 1d5442ceb8
commit 7822ef9cfd
12 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/common/section_cli_glance_manage_images.xml
View File

@ -258,7 +258,7 @@
<step>
<para>To annotate an image with a property that describes the <literal>disk_bus</literal>, <literal>cdrom_bus</literal>,
and <literal>vif_model</literal>:</para>
<screen><prompt>#</prompt> <userinput>glance image-update \
<screen><prompt>$</prompt> <userinput>glance image-update \
--property hw_disk_bus=scsi \
--property hw_cdrom_bus=ide \
--property hw_vif_model=e1000 \

8
doc/config-reference/block-storage/drivers/coraid-driver.xml
View File

@ -123,7 +123,7 @@
<step>
<para>Download the latest Coraid AoE driver.</para>
<para>
<screen><prompt>#</prompt> <userinput>wget http://support.coraid.com/support/linux/aoeXXX.tar.gz</userinput></screen>
<screen><prompt>$</prompt> <userinput>wget http://support.coraid.com/support/linux/aoeXXX.tar.gz</userinput></screen>
</para>
</step>
<step>
@ -131,8 +131,8 @@
</step>
<step>
<para>Install the AoE driver.</para>
<screen><prompt>#</prompt> <userinput>cd aoeXXX</userinput></screen>
<screen><prompt>#</prompt> <userinput>make</userinput></screen>
<screen><prompt>$</prompt> <userinput>cd aoeXXX</userinput></screen>
<screen><prompt>$</prompt> <userinput>make</userinput></screen>
<screen><prompt>#</prompt> <userinput>make install</userinput></screen>
</step>
<step>
@ -333,7 +333,7 @@ coraid_repository_key = <replaceable>coraid_repository_key</replaceable></progra
</step>
<step>
<para>Create a volume.</para>
<screen><prompt>#</prompt> <userinput>cinder type-create ‘<replaceable>volume_type_name</replaceable>’</userinput></screen>
<screen><prompt>$</prompt> <userinput>cinder type-create ‘<replaceable>volume_type_name</replaceable>’</userinput></screen>
<para>where <replaceable>volume_type_name</replaceable> is the
name you assign the volume. You will see output similar to
the following:</para>

2
doc/config-reference/block-storage/drivers/nfs-volume-driver.xml
View File

@ -114,7 +114,7 @@
<step>
<para>You can now create volumes as you normally
would:</para>
<screen><prompt>#</prompt> <userinput>nova volume-create --display-name=myvol 5</userinput>
<screen><prompt>$</prompt> <userinput>nova volume-create --display-name=myvol 5</userinput>
<prompt>#</prompt> <userinput>ls /var/lib/cinder/nfs/46c5db75dc3a3a50a10bfd1a456a9f3f</userinput>
<computeroutput>volume-a8862558-e6d6-4648-b5df-bb84f31c8935</computeroutput></screen>
<para>This volume can also be attached and deleted

8
doc/install-guide/section_ceilometer-install.xml
View File

@ -167,8 +167,8 @@ log_dir = /var/log/ceilometer</programlisting>
Telemetry service uses to authenticate with the Identity
Service. Use the <literal>service</literal> tenant and give
the user the <literal>admin</literal> role:</para>
<screen><prompt>#</prompt> <userinput>keystone user-create --name=ceilometer --pass=<replaceable>CEILOMETER_PASS</replaceable> --email=<replaceable>ceilometer@example.com</replaceable></userinput>
<prompt>#</prompt> <userinput>keystone user-role-add --user=ceilometer --tenant=service --role=admin</userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-create --name=ceilometer --pass=<replaceable>CEILOMETER_PASS</replaceable> --email=<replaceable>ceilometer@example.com</replaceable></userinput>
<prompt>$</prompt> <userinput>keystone user-role-add --user=ceilometer --tenant=service --role=admin</userinput></screen>
</step>
<step>
<para>Add the credentials to the configuration files for the
@ -215,9 +215,9 @@ os_password = <replaceable>CEILOMETER_PASS</replaceable></programlisting>
that other OpenStack services can locate it. Use the
<command>keystone</command> command to register the service
and specify the endpoint:</para>
<screen><prompt>#</prompt> <userinput>keystone service-create --name=ceilometer --type=metering \
<screen><prompt>$</prompt> <userinput>keystone service-create --name=ceilometer --type=metering \
--description="Telemetry"</userinput>
<prompt>#</prompt> <userinput>keystone endpoint-create \
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ metering / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:8777 \
--internalurl=http://<replaceable>controller</replaceable>:8777 \

14
doc/install-guide/section_cinder-controller.xml
View File

@ -58,7 +58,7 @@ connection = mysql://cinder:<replaceable>CINDER_DBPASS</replaceable>@<replaceabl
<step os="ubuntu">
<para>Use the password that you set to log in as root to create
a <literal>cinder</literal> database.</para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput>
<screen><prompt>$</prompt> <userinput>mysql -u root -p</userinput>
<prompt>mysql></prompt> <userinput>CREATE DATABASE cinder;</userinput>
<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'localhost' \
IDENTIFIED BY '<replaceable>CINDER_DBPASS</replaceable>';</userinput>
@ -75,8 +75,8 @@ IDENTIFIED BY '<replaceable>CINDER_DBPASS</replaceable>';</userinput></screen>
Service uses this user to authenticate with the Identity
Service. Use the <literal>service</literal> tenant and give
the user the <literal>admin</literal> role.</para>
<screen><prompt>#</prompt> <userinput>keystone user-create --name=cinder --pass=<replaceable>CINDER_PASS</replaceable> --email=<replaceable>cinder@example.com</replaceable></userinput>
<prompt>#</prompt> <userinput>keystone user-role-add --user=cinder --tenant=service --role=admin</userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-create --name=cinder --pass=<replaceable>CINDER_PASS</replaceable> --email=<replaceable>cinder@example.com</replaceable></userinput>
<prompt>$</prompt> <userinput>keystone user-role-add --user=cinder --tenant=service --role=admin</userinput></screen>
</step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu">
<para>Add the credentials to the file
@ -136,9 +136,9 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
Service so that other OpenStack services can locate it.
Register the service and specify the endpoint using the
<command>keystone</command> command.</para>
<screen><prompt>#</prompt> <userinput>keystone service-create --name=cinder --type=volume \
<screen><prompt>$</prompt> <userinput>keystone service-create --name=cinder --type=volume \
--description="OpenStack Block Storage"</userinput>
<prompt>#</prompt> <userinput>keystone endpoint-create \
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ volume / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
--internalurl=http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
@ -147,9 +147,9 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu">
<para>Also register a service and endpoint for version 2 of the
Block Storage Service API.</para>
<screen><prompt>#</prompt> <userinput>keystone service-create --name=cinderv2 --type=volumev2 \
<screen><prompt>$</prompt> <userinput>keystone service-create --name=cinderv2 --type=volumev2 \
--description="OpenStack Block Storage v2"</userinput>
<prompt>#</prompt> <userinput>keystone endpoint-create \
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ volumev2 / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s \
--internalurl=http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s \

10
doc/install-guide/section_glance-install.xml
View File

@ -85,7 +85,7 @@ connection = mysql://glance:GLANCE_DBPASS@<replaceable>controller</replaceable>/
<step os="ubuntu">
<para>Use the password you created to log in as root and create
a <literal>glance</literal> database user:</para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput>
<screen><prompt>$</prompt> <userinput>mysql -u root -p</userinput>
<prompt>mysql></prompt> <userinput>CREATE DATABASE glance;</userinput>
<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON glance.* TO 'glance'@'localhost' \
IDENTIFIED BY '<replaceable>GLANCE_DBPASS</replaceable>';</userinput>
@ -103,9 +103,9 @@ IDENTIFIED BY '<replaceable>GLANCE_DBPASS</replaceable>';</userinput></screen>
<literal>glance</literal> user. Use the
<literal>service</literal> tenant and give the user the
<literal>admin</literal> role.</para>
<screen><prompt>#</prompt> <userinput>keystone user-create --name=glance --pass=<replaceable>GLANCE_PASS</replaceable> \
<screen><prompt>$</prompt> <userinput>keystone user-create --name=glance --pass=<replaceable>GLANCE_PASS</replaceable> \
--email=<replaceable>glance@example.com</replaceable></userinput>
<prompt>#</prompt> <userinput>keystone user-role-add --user=glance --tenant=service --role=admin</userinput></screen>
<prompt>$</prompt> <userinput>keystone user-role-add --user=glance --tenant=service --role=admin</userinput></screen>
</step>
<step>
<para>Configure the Image Service to use the Identity
@ -170,9 +170,9 @@ flavor = keystone</programlisting>
<para>Register the Image Service with the Identity Service so
that other OpenStack services can locate it. Register the
service and create the endpoint:</para>
<screen><prompt>#</prompt> <userinput>keystone service-create --name=glance --type=image \
<screen><prompt>$</prompt> <userinput>keystone service-create --name=glance --type=image \
--description="OpenStack Image Service"</userinput>
<prompt>#</prompt> <userinput>keystone endpoint-create \
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ image / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:9292 \
--internalurl=http://<replaceable>controller</replaceable>:9292 \

14
doc/install-guide/section_heat-install.xml
View File

@ -55,7 +55,7 @@ connection = mysql://heat:<replaceable>HEAT_DBPASS</replaceable>@controller/heat
<step>
<para>Use the password that you set previously to log in as <literal>root</literal> and
create a <literal>heat</literal> database user:</para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput>
<screen><prompt>$</prompt> <userinput>mysql -u root -p</userinput>
<prompt>mysql></prompt> <userinput>CREATE DATABASE heat;</userinput>
<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'localhost' \
IDENTIFIED BY '<replaceable>HEAT_DBPASS</replaceable>';</userinput>
@ -100,9 +100,9 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
Orchestration service can use to authenticate with the
Identity Service. Use the <literal>service</literal> tenant
and give the user the <literal>admin</literal> role:</para>
<screen><prompt>#</prompt> <userinput>keystone user-create --name=heat --pass=<replaceable>HEAT_PASS</replaceable> \
<screen><prompt>$</prompt> <userinput>keystone user-create --name=heat --pass=<replaceable>HEAT_PASS</replaceable> \
--email=<replaceable>heat@example.com</replaceable></userinput>
<prompt>#</prompt> <userinput>keystone user-role-add --user=heat --tenant=service --role=admin</userinput></screen>
<prompt>$</prompt> <userinput>keystone user-role-add --user=heat --tenant=service --role=admin</userinput></screen>
</step>
<step>
<para>Edit the <filename>/etc/heat/heat.conf</filename> file to
@ -126,16 +126,16 @@ keystone_ec2_uri = http://<replaceable>controller</replaceable>:5000/v2.0/ec2tok
Identity Service so that other OpenStack services can locate
these APIs. Register the service and specify the
endpoint:</para>
<screen><prompt>#</prompt> <userinput>keystone service-create --name=heat --type=orchestration \
<screen><prompt>$</prompt> <userinput>keystone service-create --name=heat --type=orchestration \
--description="Orchestration"</userinput>
<prompt>#</prompt> <userinput>keystone endpoint-create \
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ orchestration / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:8004/v1/%\(tenant_id\)s \
--internalurl=http://<replaceable>controller</replaceable>:8004/v1/%\(tenant_id\)s \
--adminurl=http://<replaceable>controller</replaceable>:8004/v1/%\(tenant_id\)s</userinput>
<prompt>#</prompt> <userinput>keystone service-create --name=heat-cfn --type=cloudformation \
<prompt>$</prompt> <userinput>keystone service-create --name=heat-cfn --type=cloudformation \
--description="Orchestration CloudFormation"</userinput>
<prompt>#</prompt> <userinput>keystone endpoint-create \
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ cloudformation / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:8000/v1 \
--internalurl=http://<replaceable>controller</replaceable>:8000/v1 \

2
doc/install-guide/section_keystone-install.xml
View File

@ -59,7 +59,7 @@ connection = mysql://keystone:<replaceable>KEYSTONE_DBPASS</replaceable>@<replac
<para>Use the password that you set previously to log in as
root. Create a <literal>keystone</literal> database
user:</para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput>
<screen><prompt>$</prompt> <userinput>mysql -u root -p</userinput>
<prompt>mysql></prompt> <userinput>CREATE DATABASE keystone;</userinput>
<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON keystone.* TO 'keystone'@'localhost' \
IDENTIFIED BY '<replaceable>KEYSTONE_DBPASS</replaceable>';</userinput>

4
doc/install-guide/section_keystone-services.xml
View File

@ -23,7 +23,7 @@
<procedure>
<step>
<para>Create a service entry for the Identity Service:</para>
<screen><prompt>#</prompt> <userinput>keystone service-create --name=keystone --type=identity \
<screen><prompt>$</prompt> <userinput>keystone service-create --name=keystone --type=identity \
--description="OpenStack Identity Service"</userinput>
<computeroutput>+-------------+----------------------------------+
| Property | Value |
@ -42,7 +42,7 @@
the public API, internal API, and admin API. In this guide, the
<literal>controller</literal> host name is used. Note that the
Identity Service uses a different port for the admin API.</para>
<screen><prompt>#</prompt> <userinput>keystone endpoint-create \
<screen><prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ identity / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:5000/v2.0 \
--internalurl=http://<replaceable>controller</replaceable>:5000/v2.0 \

2
doc/install-guide/section_neutron-controller-node.xml
View File

@ -35,7 +35,7 @@
<para>Connect to the MySQL database as the root user, create the
<literal>neutron</literal> database, and grant the proper
access to it:</para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput>
<screen><prompt>$</prompt> <userinput>mysql -u root -p</userinput>
<prompt>mysql></prompt> <userinput>CREATE DATABASE neutron;</userinput>
<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON neutron.* TO 'neutron'@'localhost' \
IDENTIFIED BY '<replaceable>NEUTRON_DBPASS</replaceable>';</userinput>

6
doc/install-guide/section_nova-controller.xml
View File

@ -90,7 +90,7 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
<step os="ubuntu">
<para>Use the password you created previously to log in as root.
Create a <literal>nova</literal> database user:</para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput>
<screen><prompt>$</prompt> <userinput>mysql -u root -p</userinput>
<prompt>mysql></prompt> <userinput>CREATE DATABASE nova;</userinput>
<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON nova.* TO 'nova'@'localhost' \
IDENTIFIED BY '<replaceable>NOVA_DBPASS</replaceable>';</userinput>
@ -132,8 +132,8 @@ vncserver_proxyclient_address=192.168.0.10</programlisting>
authenticate with the Identity Service. Use the
<literal>service</literal> tenant and give the user the
<literal>admin</literal> role:</para>
<screen><prompt>#</prompt> <userinput>keystone user-create --name=nova --pass=<replaceable>NOVA_PASS</replaceable> --email=<replaceable>nova@example.com</replaceable></userinput>
<prompt>#</prompt> <userinput>keystone user-role-add --user=nova --tenant=service --role=admin</userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-create --name=nova --pass=<replaceable>NOVA_PASS</replaceable> --email=<replaceable>nova@example.com</replaceable></userinput>
<prompt>$</prompt> <userinput>keystone user-role-add --user=nova --tenant=service --role=admin</userinput></screen>
</step>
<step>
<para>Configure Compute to use these credentials with the Identity

26
doc/training-guides/lab001-control-node.xml
View File

@ -142,7 +142,7 @@ iface eth2 inet dhcp</programlisting>
<listitem>
<para>Create these databases:</para>
<para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput></screen>
<screen><prompt>$</prompt> <userinput>mysql -u root -p</userinput></screen>
<screen><prompt>mysql> </prompt><userinput>CREATE DATABASE keystone;</userinput></screen>
<screen><prompt>mysql> </prompt><userinput>GRANT ALL ON keystone.* TO 'keystoneUser'@'%' IDENTIFIED BY 'keystonePass';</userinput></screen>
<screen><prompt>mysql> </prompt><userinput>CREATE DATABASE glance;</userinput></screen>
@ -220,10 +220,10 @@ iface eth2 inet dhcp</programlisting>
<listitem>
<para>Run Scripts:</para>
<para>
<screen><prompt>#</prompt> <userinput>chmod +x keystone_basic.sh</userinput></screen>
<screen><prompt>#</prompt> <userinput>chmod +x keystone_endpoints_basic.sh</userinput></screen>
<screen><prompt>#</prompt> <userinput>./keystone_basic.sh</userinput></screen>
<screen><prompt>#</prompt> <userinput>./keystone_endpoints_basic.sh</userinput></screen>
<screen><prompt>$</prompt> <userinput>chmod +x keystone_basic.sh</userinput></screen>
<screen><prompt>$</prompt> <userinput>chmod +x keystone_endpoints_basic.sh</userinput></screen>
<screen><prompt>$</prompt> <userinput>./keystone_basic.sh</userinput></screen>
<screen><prompt>$</prompt> <userinput>./keystone_endpoints_basic.sh</userinput></screen>
</para>
</listitem>
<listitem>
@ -235,22 +235,22 @@ iface eth2 inet dhcp</programlisting>
<listitem>
<para>Paste the following:</para>
<para>
<screen><prompt>#</prompt> <userinput>export OS_TENANT_NAME=admin</userinput></screen>
<screen><prompt>#</prompt> <userinput>export OS_USERNAME=admin</userinput></screen>
<screen><prompt>#</prompt> <userinput>export OS_PASSWORD=admin_pass</userinput></screen>
<screen><prompt>#</prompt> <userinput>export OS_AUTH_URL="http://192.168.100.51:5000/v2.0/"</userinput></screen>
<screen><prompt>$</prompt> <userinput>export OS_TENANT_NAME=admin</userinput></screen>
<screen><prompt>$</prompt> <userinput>export OS_USERNAME=admin</userinput></screen>
<screen><prompt>$</prompt> <userinput>export OS_PASSWORD=admin_pass</userinput></screen>
<screen><prompt>$</prompt> <userinput>export OS_AUTH_URL="http://192.168.100.51:5000/v2.0/"</userinput></screen>
</para>
</listitem>
<listitem>
<para>Load the above credentials:</para>
<para>
<screen><prompt>#</prompt> <userinput>source Crediantials.sh</userinput></screen>
<screen><prompt>$</prompt> <userinput>source Crediantials.sh</userinput></screen>
</para>
</listitem>
<listitem>
<para>To test Keystone, we use a simple CLI command:</para>
<para>
<screen><prompt>#</prompt> <userinput>keystone user-list</userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-list</userinput></screen>
</para>
</listitem>
</itemizedlist>
@ -356,13 +356,13 @@ flavor = keystone</programlisting>
<listitem>
<para>To test Glance, upload the “cirros cloud image” directly from the internet:</para>
<para>
<screen><prompt>#</prompt> <userinput>glance image-create --name OS4Y_Cirros --is-public true --container-format bare --disk-format qcow2 --location https://launchpad.net/cirros/trunk/0.3.0/+download/cirros-0.3.0-x86_64-disk.img</userinput></screen>
<screen><prompt>$</prompt> <userinput>glance image-create --name OS4Y_Cirros --is-public true --container-format bare --disk-format qcow2 --location https://launchpad.net/cirros/trunk/0.3.0/+download/cirros-0.3.0-x86_64-disk.img</userinput></screen>
</para>
</listitem>
<listitem>
<para>Check if the image is successfully uploaded:</para>
<para>
<screen><prompt>#</prompt> <userinput>glance image-list</userinput></screen>
<screen><prompt>$</prompt> <userinput>glance image-list</userinput></screen>
</para>
</listitem>
</itemizedlist>