Newton 安装指南¶

基本安装指南的范围¶

基本安装指南的内容将涵盖每个云所需的基础设施和集中式项目。这包括定义为 starter-kit:compute 的 defcore 项目，以及其他一些项目

• 计算服务 (nova)：starter-kit:compute 的一部分。
• 镜像服务 (glance)：starter-kit:compute 的一部分。
• 身份验证服务 (keystone)：starter-kit:compute 的一部分。
• 网络服务 (neutron)：starter-kit:compute 的一部分。
• 块存储服务 (cinder)：当前安装指南的一部分，并且大多数用户期望它。
• 仪表板 (horizon)：当前安装指南的一部分，并且大多数用户期望它。

除非它们是运行基于 OpenStack 的云所必需的，或者现有项目需要它们，否则不会向指南中添加更多项目。

文档团队将为每个版本更新和测试基本安装指南。

安装指南将增强链接到额外的项目特定安装指南。为此，它将为每个官方项目单独设置一个章节，每个官方项目可以提供对其项目的简短介绍，以及指向其自身安装指南的链接。该章节还将解释所有这些项目都是 OpenStack 大本营的一流成员。

例如，编排可以将他们的安装指南存储在 heat 仓库中，并发布到 https://docs.openstack.org/project-install-guide/mitaka/orchestration/ 。

然后“附加项目”章节将包含一个介绍该服务并链接到它的一个小节

Orchestration service (heat)
============================

The Orchestration service ...

Installation is documented at
http://docs.openstack.org/project-install-guide/mitaka/orchestration
.

Docs.openstack.org 索引¶

项目特定的安装指南不仅会在安装指南中列出，而且也会在 docs.openstack.org 网页上找到。具体位置需要根据指南的数量来确定。

备选方案¶

• 打包的安装指南分离出来，没有单一来源的安装指南：每个发行版发布自己的安装指南。这些指南可以发布到 docs.openstack.org/install 或他们拥有的网络域，从他们自己的仓库中获取和审查，并由他们的团队进行管理。这些团队可以设置自己的发布计划。这种替代方案不能解决项目团队的需求，但可以减轻集中式文档团队的资源压力。

• 停止编写基于软件包的安装指南到 OpenStack git 命名空间中。相反，让一个中央团队编写基于 starter-kit 的指南，描述多种可用的部署选项，并发布到 docs.openstack.org。当读者浏览 distro 市场时，此解决方案可能已经可用：https://openstack.org/marketplace/distros/。

• 每个项目团队可以编写一个“从源代码安装”安装指南，其中包含所有基本项目基础设施的设置。

• 更改安装指南的范围，根据本规范中提出的建议添加更多或更少的项目。但是，这并不能解决上述与软件包单一来源问题。

• 现状：一个由文档团队维护的中央安装指南，对于不属于中央指南的那些项目，没有项目特定的指南。除非我们获得每个项目在安装指南中的资源承诺，否则这种方法无法扩展。

• 一个由文档团队审查的中央指南 - 就像今天一样 - 只有当项目团队承诺编写、测试和更新章节时，项目才会被记录。

  这无法扩展，因为审查仍然由文档团队完成。过去的经验表明，项目团队需要被提醒他们的承诺，因此最终文档团队将为如此庞大的指南扮演大量的协调和引导角色 - 而不是遵循本提案寻求的赋能角色。

负责人¶

• Lana Brindley (loquacities) - 文档 PTL
• Andreas Jaeger (AJaeger) - 基础设施
• 安装指南专业团队

工作项¶

• 更新标题（更新为？），以反映它是用于培训而不是生产的，并添加序言以解释该目的。
• 从软件包记录文档，以充分利用现有内容，但继续随着时间的推移重新审视这个问题，因为关于用户更喜欢哪种安装方法会涌现更多数据。
• 编辑现有内容，使其仅使用手动配置。
• 创建可以运行和自动测试的脚本，并将这些脚本的片段逐字包含在指南中。这将加速指南的测试。
• 创建一个“cookie cutter”模板，可用于所有服务 (AJaeger)：https://review.openstack.org/#/c/314229/
• 记录在新的治理下添加大本营项目流程，包括所需的测试和依赖项。
• 将共享文件系统 (Manila)、对象存储 (Swift)、编排 (Heat)、遥测 (Ceilometer)、数据库 (Trove) 移动到项目仓库，并在“附加项目”章节中链接它们。