Jump to: navigation, search

Difference between revisions of "Documentation/Guide conventions"

Line 2: Line 2:
 
{{OpenStack_Conventions_Navbar}}
 
{{OpenStack_Conventions_Navbar}}
  
= Guide conventions =
+
The following lists conventions used for writing specific guides. In general we want to be consistent between guides, especially since some guides include the same files.
  
The following lists conventions used for writing specific guides. In general we want to be consistent between guides, especially since some guides include the same files.
+
__TOC__
  
 
== General ==
 
== General ==

Revision as of 08:21, 27 July 2014

The following lists conventions used for writing specific guides. In general we want to be consistent between guides, especially since some guides include the same files.

General

  • Mentioning Bugs. If there is a bug that causes some workaround or limitation to be documented, the link to the bug report should be included. This makes it easier to maintain and update such notes.

Install Guide

  • Use controller instead of the controller node management interface IP address 10.0.0.11. Use replaceable for it like <replaceable>controller</replaceable>.
  • Use computeX instead of the compute node management interface IP address for compute nodes. Replace X with a number starting from 1. The management interface IP address of the first compute node is 10.0.0.31, the second is 10.0.0.32, etc.
  • Use blockX instead of the block storage node management interface IP address for block storage nodes. Replace X with a number starting from 1. The management interface IP address of the first block storage node is 10.0.0.41, the second 10.0.0.42, etc.
  • Use objectX instead of the object storage node management interface IP address for object storage nodes. Replace X with a number starting from 1. The management interface IP address of the first object storage node is 10.0.0.51, the second 10.0.0.52, etc.
  • Try to reference the name of a network interface as described in the architecture chapter. For example, say "configure the management interface IP address as 10.0.0.51" rather than "configure eth0 as 10.0.0.51".
  • The example IP addressing structure allows up to 10 controller nodes, network nodes, compute nodes, block storage nodes, and object storage nodes.
  • Database passwords are written as SERVICE_DBPASS, e.g. NOVA_DBPASS
  • Keystone passwords are written as USERNAME_PASS, e.g. GLANCE_PASS
  • rabbit_userid is guest
  • Networking services
    • Use "OpenStack Networking (neutron)" for chapter/section titles and first instance. Use "OpenStack Networking" or "Networking" for additional instances.
    • Use "legacy networking (nova-network)" for chapter/section titles and first instance. Use "legacy networking" for additional instances.
  • Structure for steps that involve commands:
1) Run the following command to install the components:
    a) apt-get install package1 package2
  • Structure for steps that involve configuration:
1) Edit the /etc/abc/abc.conf file:
    a) Configure database access in the [database] section:
        [database]
        ...
        connection = mysql://
    b) Configure RabbitMQ message broker access in the [DEFAULT] section:
        [DEFAULT]
        ...
        rabbit_host = controller
    c) Configure Identity service access in the [keystone_authtoken] section:
        [keystone_authtoken]
        ...
        auth_host = controller
    • Example code snippet for editing /etc/heat/heat.conf:
<procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
  <title>To configure the Orchestration components</title>
  <para>Edit the <filename>/etc/heat/heat.conf</filename> file and perform
    the following tasks:</para>
  <step>
    <para>Configure database access in the <literal>[database]</literal>
      section.</para>
    <para>Replace <replaceable>HEAT_DBPASS</replaceable> with the password
      you chose for the Orchestration database.</para>
    <programlisting language="ini">[database]
...
connection = mysql://heat:<replaceable>HEAT_DBPASS</replaceable>@<replaceable>controller</replaceable>/heat</programlisting>
  </step>
  <step os="ubuntu;sles;opensuse">
    <para>Configure <application>RabbitMQ</application> message broker
      access in the <literal>[DEFAULT]</literal> section:</para>
    <para>Replace <replaceable>RABBIT_PASS</replaceable> with the password
      you chose for the <literal>guest</literal> account in
      <application>RabbitMQ</application>.</para>
    <programlisting language="ini">[DEFAULT]
...
rpc_backend = heat.openstack.common.rpc.impl_kombu
rabbit_host = <replaceable>controller</replaceable>
rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
  </step>
</procedure>

Operations Guide

The Operations Guide follows for some cases the O'Reilly style guide.