跳转到： 导航, 搜索

文档/指南规范

OpenStack 文档
文档规范
Warning icon.svg 警告

此页面已弃用。此处保留供参考。

以下列出了编写特定指南时使用的约定。通常，我们希望在指南之间保持一致性，尤其因为某些指南包含相同的文件。

通用

  • 提及 Bug。如果存在导致某些解决方法或限制需要记录的 Bug，应包含 Bug 报告的链接。这使得维护和更新此类注释更容易。

安装指南

  • 使用 controller 代替控制器节点管理接口 IP 地址 10.0.0.11。使用可替换标记代替它，例如 <replaceable>controller</replaceable>。
  • 使用 computeX 代替计算节点管理接口 IP 地址，用于计算节点。将 X 替换为从 1 开始的数字。第一个计算节点的管理接口 IP 地址为 10.0.0.31，第二个为 10.0.0.32，依此类推。
  • 使用 blockX 代替块存储节点管理接口 IP 地址，用于块存储节点。将 X 替换为从 1 开始的数字。第一个块存储节点的管理接口 IP 地址为 10.0.0.41，第二个为 10.0.0.42，依此类推。
  • 使用 objectX 代替对象存储节点管理接口 IP 地址，用于对象存储节点。将 X 替换为从 1 开始的数字。第一个对象存储节点的管理接口 IP 地址为 10.0.0.51，第二个为 10.0.0.52，依此类推。
  • 对于 Fedora/RHEL/CentOS 的 Juno 及更高版本，由于升级到版本 7，请使用 systemctl 而不是 service restart 或 chkconfig <service> on。
  • 尝试引用架构章节中描述的网络接口名称。例如，说“将管理接口 IP 地址配置为 10.0.0.51”，而不是“将 eth0 配置为 10.0.0.51”。
  • 示例 IP 寻址结构最多允许 10 个控制器节点、网络节点、计算节点、块存储节点和对象存储节点。
  • 数据库密码写为 SERVICE_DBPASS，例如 NOVA_DBPASS
  • Keystone 密码写为 USERNAME_PASS，例如 GLANCE_PASS
  • rabbit_userid 是 guest
  • 网络服务
    • 在章节/小节标题和首次出现时使用“OpenStack Networking (neutron)”。在后续出现时使用“OpenStack Networking”或“Networking”。
    • 在章节/小节标题和首次出现时使用“legacy networking (nova-network)”。在后续出现时使用“legacy networking”。
  • 涉及命令的步骤结构
1) Run the following command to install the components:
    a) apt-get install package1 package2
  • 涉及配置的步骤结构
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
    • 编辑 /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>

操作指南

在某些情况下，操作指南遵循 O'Reilly 风格指南。

官方书籍标题和标题缩写

标题用于 HTML 和 PDF 输出。标题缩写仅用于 PDF 输出。

安装指南

受众：云操作员

标题 标题缩写
OpenStack Debian 7.0 安装指南 Debian 安装指南
OpenStack openSUSE 和 SUSE Linux Enterprise Server 安装指南 openSUSE 和 SUSE Linux Enterprise 安装指南
OpenStack Red Hat Enterprise Linux、CentOS 和 Fedora 安装指南 Red Hat 安装指南
OpenStack Ubuntu 12.04 (LTS) 安装指南 Ubuntu 安装指南

管理指南

受众：云操作员

标题 标题缩写
OpenStack 架构设计指南 架构设计指南
OpenStack 云管理员指南 云管理员指南
OpenStack 配置参考 配置参考
OpenStack 高可用性指南 高可用性指南
OpenStack 操作指南 操作指南
OpenStack 安全指南 安全指南
OpenStack 虚拟机镜像指南 虚拟机镜像指南

应用程序开发者和用户指南

受众

  • 在云中运行应用程序的开发者
  • 管理云中资源和服务的用户

注意

pom.xml 文件中的产品定义会影响 PDF 封面页上的标题显示方式。

标题

标题 标题缩写 产品
API 快速入门 不适用
OpenStack API 完整参考（网页） 不适用 OpenStack
OpenStack 块存储服务 API v2 参考 块存储服务 API 参考 OpenStack 块存储服务
OpenStack 计算 API v2 和扩展参考 计算 API 和扩展参考 OpenStack 计算
OpenStack Identity Service API v2.0 参考 Identity Service API 参考 OpenStack Identity Service
OpenStack Image Service API v2 参考 Image Service API 参考 OpenStack Image Service
OpenStack Networking API v2.0 参考 Networking API 参考 OpenStack Networking
OpenStack Image Service API v1 参考 Image Service API 参考 OpenStack Image Service
对象存储 API v1 参考 对象存储 API 参考 OpenStack 对象存储
OpenStack 终端用户指南 终端用户指南 OpenStack
OpenStack 管理员用户指南 管理员用户指南 OpenStack
OpenStack 命令行界面参考 CLI 参考 OpenStack
从 "https://wiki.openstack.org/w/index.php?title=Documentation/Guide_conventions&oldid=160514" 检索