Galaxy内容导入器
项目描述
Ansible需求
galaxy-importer
需要以下其他Ansible项目
如果您从源代码安装,请参阅仓库中的setup.cfg
以获取匹配的需求。
安装
从pypi
pip安装 galaxy-importer
从源代码
克隆仓库并进入项目目录
将本地setup.py及其开发依赖项安装到环境中
pip install -e .[dev]
运行导入器
单独运行解析/验证以查看日志输出和导入结果
python -m galaxy_importer.main [collection_artifact_file]
支持旧版角色(注意:必须在旧版角色的父目录中)
python -m galaxy_importer.main --legacy-role [legacy_role_directory] --namespace [namespace]
支持将Markdown转换为HTML
python -m galaxy_importer.main --markdown [readme_md_directory]
在终端中查看日志输出,并在写入的文件 importer_result.json
中查看导入结果
输出结构
metadata
(来自 MANIFEST.json 的所有数据,由 CollectionLoader._load_collection_manifest() 设置)docs_blob
(由 CollectionLoader._build_docs_blob() 设置)collection_readme
documentation_files
contents
contents
requires_ansible
配置
支持可选的 ini 配置文件,按照以下顺序检查以下位置
/etc/galaxy-importer/galaxy-importer.cfg
<code_source>/galaxy_importer/galaxy-importer.cfg
您可以通过设置环境中的 GALAXY_IMPORTER_CONFIG
来覆盖上述路径。例如
$ export GALAXY_IMPORTER_CONFIG=~/galaxy-importer.cfg
配置选项及其默认值定义在 DEFAULTS
中,位置在 galaxy_importer/config.py
包含部分配置选项的示例配置文件
[galaxy-importer]
LOG_LEVEL_MAIN = INFO
RUN_ANSIBLE_TEST = False
ANSIBLE_LOCAL_TMP = '~/.ansible/tmp'
-
ANSIBLE_LOCAL_TMP
- 设置为任何所需的本地 Ansible 临时目录。默认为~/.ansible/tmp
。 -
ANSIBLE_TEST_LOCAL_IMAGE
- 设置为True
以在容器镜像中运行沙盒化的ansible-test
。运行容器需要安装 Podman 或 Docker。默认为False
。 -
CHECK_CHANGELOG
- 设置为False
以跳过在集合根目录或docs/
目录下检查CHANGELOG.rst
或CHANGELOG.md
文件,或检查changelogs/changelog.(yml/yaml)
文件。默认为True
。 -
CHECK_REQUIRED_TAGS
- 设置为True
以检查 Ansible 集合认证所需的一组标签。默认为False
。 -
LOCAL_IMAGE_DOCKER
- 设置为True
以通过 Docker 运行ansible-test
容器镜像;否则,将使用 Podman。默认为False
。 -
LOG_LEVEL_MAIN
- 设置为所需的日志级别。默认为INFO
。 -
OFFLINE_ANSIBLE_LINT
- 设置为False
如果您希望ansible-lint
检查新版本。默认为True
。 -
REQUIRE_V1_OR_LATER
- 设置为True
以要求版本号1.0.0
或更高版本。默认为False
。 -
RUN_ANSIBLE_DOC
- 设置为False
以跳过ansible-doc
。默认为True
。 -
RUN_ANSIBLE_LINT
- 设置为False
以跳过在整个集合上运行ansible-lint --profile production
。默认为True
。 -
RUN_ANSIBLE_TEST
- 设置为True
以在集合导入期间运行ansible-test
。默认为False
。 -
RUN_FLAKE8
- 设置为True
以运行 flake8。默认为False
。
问题和流程
要提交问题,请访问 Automation Hub Jira 项目
galaxy-importer
的流程细节: PROCESS.md
附加说明
将 .md
文件放置在 docs/
目录中,以便在 Galaxy 或 Automation Hub 的导入集合的“文档”选项卡中显示。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源分发
构建分发
galaxy_importer-0.4.25.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 6923a51a795779c6d12f6c270a17d735119f183bcb35b296de14aab431faaff1 |
|
MD5 | 2fa67eab90cf03780f5444520d50d296 |
|
BLAKE2b-256 | 4a03fb5fd44ee6d24f748224a09a74052024b5a7fb956e323adea3ce0256a4d3 |