安装

Kayobe 可以通过 PyPI 上发布的 Python 包,或者从源代码安装。从 PyPI 安装可以确保使用经过充分使用和测试的软件,而从源代码安装则允许使用未发布或已修补的代码。从 Python 包安装从 Kayobe 5.0.0 开始支持。

先决条件

目前 Kayobe 支持 Ansible 控制主机上的以下操作系统:

  • CentOS Stream 10(自 Flamingo 19.0.0 版本起)

  • Rocky Linux 10(自 Flamingo 19.0.0 版本起)

  • Ubuntu Noble 24.04(自 Dalmatian 17.0.0 版本起)

有关其他主机支持的操作系统详情,请参阅 支持矩阵

为了避免与系统包管理器安装的 Python 包冲突,建议在虚拟环境中安装 Kayobe。确保 Ansible 控制主机上可用 virtualenv Python 模块。为了构建 Kayobe 的一些 Python 依赖项的扩展,有必要安装 GCC 编译器链。

在 CentOS/Rocky 上

$ dnf install -y python3-devel gcc libffi-devel

在 Ubuntu 上

$ apt install -y python3-dev gcc libffi-dev python3-venv

如果从源代码安装 Kayobe,则需要 Git 来克隆和使用源代码仓库。

在 CentOS/Rocky 上

$ dnf install -y git

在 Ubuntu 上

$ apt install -y git

在 Ubuntu 上,确保 /usr/bin/python 指向 Python 3 解释器

$ apt install -y python-is-python3

本地目录结构

Kayobe Ansible 控制主机环境的目录结构是可配置的,但建议如下,其中 <base_path> 是顶级目录的路径

<base_path>/
    src/
        kayobe/
        kayobe-config/
        kolla-ansible/
    venvs/
        kayobe/
        kolla-ansible/

这种模式确保了特定环境的所有依赖项都安装在一个顶级路径下,并且没有安装到共享位置。这允许在同一控制主机上使用多个 Kayobe 环境。

创建 kayobe-config 源代码仓库将在 配置指南 中介绍。Kolla Ansible 源代码检出和 Python 虚拟环境将由 kayobe 自动创建。

并非所有这些目录都会在所有场景中使用 - 如果 Kayobe 或 Kolla Ansible 是从 Python 包安装的,则不需要源代码仓库。

从 PyPI 安装

本节介绍如何在虚拟环境中从 Python 包安装 Kayobe。这从 Kayobe 5.0.0 开始支持。

首先,切换到顶级目录,并创建源代码仓库和 Python 虚拟环境的目录

$ cd <base_path>
$ mkdir -p src venvs

为 Kayobe 创建一个虚拟环境

$ python3 -m venv <base_path>/venvs/kayobe

激活虚拟环境并更新 pip

$ source <base_path>/venvs/kayobe/bin/activate
(kayobe) $ pip install -U pip

如果使用 Kayobe 的最新版本

(kayobe) $ pip install kayobe

或者,要安装 Kayobe 的特定版本

(kayobe) $ pip install kayobe==5.0.0

最后,停用虚拟环境

(kayobe) $ deactivate

从源代码安装

本节介绍如何在虚拟环境中从源代码安装 Kayobe。

首先,切换到顶级目录,并创建源代码仓库和 Python 虚拟环境的目录

$ cd <base_path>
$ mkdir -p src venvs

接下来,获取 Kayobe 源代码。例如

$ cd <base_path>/src
$ git clone https://opendev.org/openstack/kayobe.git -b stable/2025.2

为 Kayobe 创建一个虚拟环境

$ python3 -m venv <base_path>/venvs/kayobe

激活虚拟环境并更新 pip

$ source <base_path>/venvs/kayobe/bin/activate
(kayobe) $ pip install -U pip

使用源代码检出安装 Kayobe 及其依赖项

(kayobe) $ cd <base_path>/src/kayobe
(kayobe) $ pip install .

最后,停用虚拟环境

(kayobe) $ deactivate

可编辑的源代码安装

从 Kayobe 5.0.0 开始,可以创建 Kayobe 的 可编辑安装。在可编辑安装中,对 Kayobe 源代码树的任何更改都会立即在运行任何 Kayobe 命令时可见。要创建可编辑安装,请添加 -e 标志

(kayobe) $ cd <base_path>/src/kayobe
(kayobe) $ pip install -e .

这对于开发安装 Kayobe 特别有用。