安装指南

Pike 及后续版本

每个官方 OpenStack 项目应维护一个安装指南，其布局如 项目指南设置 中所述。当指南可用时，更新 openstack-manuals/www/project-data/latest.yaml 以包含有关该项目的信息，并确保将 has_install_guide 标志设置为 true，以确保该指南与来自其他项目的指南一起列出。

Newton 和 Ocata

仅针对 Newton 和 Ocata 版本，大型帐篷项目基于标准模板在其自己的仓库中创建了他们自己的安装指南。然后，这些指南被集中发布到 docs.openstack.org。

警告

以下说明已被 项目指南设置 取代。应使用规范中定义的布局创建新的安装指南，而不是以下说明。

设置项目特定的安装指南

1. 安装 cookiecutter

   # pip install cookiecutter
   

2. 在项目的仓库顶层目录中运行 Install Guide cookiecutter，以创建项目的安装指南框架

   $ cookiecutter https://opendev.org/openstack/installguide-cookiecutter.git
   

   系统将提示您回答以下问题以完成安装

   参数	说明	示例
   directory_name	安装指南目录在项目仓库中的名称。这应该是 install-guide。	install-guide
   服务	项目实现的服务名称。	计算、Telemetry Alarming 或 Root Cause Analysis
   codename	项目不同组件引用项目的名称	nova、aodh 或 vitrage，如 nova-conductor 或 vitrage-api

   将创建一个名为在 directory_name（通常为 install-guide）中定义的名称的目录，其中包含安装指南的框架。

3. 为 install-guide 在项目的仓库中创建一个 tox.ini 环境，使用此内容

   [testenv:install-guide]
   whitelist_externals = rm
   commands =
           rm -rf install-guide/build
           sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
   

4. 将 python 包 openstackdocstheme 添加到 test-requirements.txt 文件。从 全局文件 复制确切的依赖项行

   openstackdocstheme>=1.5.0  # Apache-2.0
   

5. 添加您的安装内容，并使用 tox 在本地测试构建

   $ tox -e install-guide
   

   本地构建将在 install-guide/build/html 目录中生成”。

6. 提交对项目仓库的更改以供审查。

在这些更改合并后，您可以设置构建作业。

1. 克隆 project-config 仓库

   $ git clone https://opendev.org/openstack/project-config
   

2. 在 jenkins/jobs/projects.yaml 中，将 install-guide-jobs 添加到项目的条目中

   - project:
       name: heat
   
       jobs:
       ...
        - install-guide-jobs:
            service: orchestration
   

   这里 service 是项目的服务名称，例如 heat 的 orchestration。

   这使用 JJB install-guide-jobs 作业模板定义作业。

3. 在 zuul/layout.yaml 中，找到项目的条目并添加 install-guide-jobs 模板

   - name: openstack/heat
     template:
       - name: install-guide-jobs
   

   这将安排安装指南作业。

4. 提交对 infra 仓库的更改以供审查。