开发快速入门

此页面描述了如何在 Ubuntu 上设置和使用一个可用的 Python 开发环境，用于开发 masakari。 这些说明假定您已经熟悉 git。

按照这些说明，您可以构建文档并运行 masakari 单元测试。

注意

有关如何为 Masakari 贡献代码，请参考：https://docs.openstack.org/infra/manual/developers.html

Masakari 使用 Gerrit 代码审查系统，请参考：https://docs.openstack.org/infra/manual/developers.html#development-workflow

设置

有两种方法可以创建开发环境：使用 DevStack，或显式安装和克隆您需要的内容。

使用 DevStack

要在 DevStack 中启用 Masakari，请执行以下步骤

下载 DevStack

export DEVSTACK_DIR=~/devstack
git clone https://opendev.org/openstack/devstack.git $DEVSTACK_DIR

启用 Masakari 插件

通过将以下部分添加到 $DEVSTACK_DIR/local.conf 来启用插件

[[local|localrc]]
enable_plugin masakari https://opendev.org/openstack/masakari

可选地，可以按如下方式提供 git refspec（分支、标签或提交）

[[local|localrc]]
enable_plugin masakari https://opendev.org/openstack/masakari <refspec>

运行 DevStack 实用程序

cd $DEVSTACK_DIR
./stack.sh

显式安装/克隆

DevStack 安装一个完整的 OpenStack 环境。 或者，要显式克隆和安装 Masakari，请参考：在 Ubuntu 上安装和配置

构建文档

要进行完整的文档构建，请从 masakari 目录发出以下命令

tox -e docs

这将创建一个 Python 虚拟环境，在该环境中安装所需的 Python 先决条件，并在该环境中构建所有文档。

运行单元测试

请参阅 运行 Python 单元测试