14.4. 导入和导出模板

您可以使用 Satellite Web UI、Hammer CLI 或 Satellite API 来导入和导出模板。卫星 API 调用使用基于角色的访问控制系统，使任务能够以任何用户身份执行。您可以将模板与版本控制系统（如 Git 或本地目录）同步。

14.4.1. 导入模板

您可以从所选存储库导入模板。您可以使用不同的协议指向您的存储库，如 /tmp/dir、git://example.com、https://example.com 和 ssh://example.com。

注意

Satellite 提供的模板已锁定，您无法默认导入它们。要覆盖此行为，请将 TemplateSync 菜单中的 Force import 设置改为 yes，或将 force 参数 -d '{ "force": "true" }' 改为 import 命令。

先决条件

  • 每个模板都必须包含模板所属的位置和组织。这适用于所有模板类型。在导入模板前，请确保将以下部分添加到模板中： 

    <%#
kind: provision
name: My_Provisioning_Template
oses:
- My_first_OS
- My_second_OS
locations:
- My_first_Location
- My_second_Location
organizations:
- My_first_Organization
- My_second_Organization
%>

要使用 CLI 而不是 Satellite Web UI，请参阅 ]。要使用 API，请参阅 xref:api_Importing_Templates_managing-hosts[。

流程

  1. 在 Satellite Web UI 中，导航到 Hosts > Sync Templates。
  2. 点 Import。
  3. 每个字段填充在 Administer > Settings > TemplateSync 中配置的值。根据需要更改您要导入的模板的值。有关每个字段的更多信息，请参阅 第 14.2 节 “配置 TemplateSync 插件”。
  4. 点 Submit。

卫星 Web UI 显示导入的状态。状态不是持久性；如果您离开状态页面，则您无法返回该状态。

CLI 过程

  • 要从存储库中导入模板，请输入以下命令： 

    $ hammer import-templates \
--branch "My_Branch" \
--filter '.*Template Name$' \
--organization "My_Organization" \
--prefix "[Custom Index] " \
--repo "https://git.example.com/path/to/repository"

    为了更好地索引和管理模板，请使用 --prefix 为您的模板设置类别。要从大型仓库中选择特定的模板，请使用 --filter 来定义要导入的模板的标题。例如，-- filter '.*Ansible Default$' 导入各种 Ansible Default templates。

API 流程

  1. 将 POST 请求发送到 api/v2/templates/import ： 

    # curl -H "Accept:application/json" \
-H "Content-Type:application/json" \
-u login:password \
-k https://satellite.example.com/api/v2/templates/import \
-X POST

    如果导入成功，您会收到 {"message":"Success"}。

14.4.2. 导出模板

使用这个流程将模板导出到 git 存储库。

要使用 CLI 而不是 Satellite Web UI，请参阅 ]。要使用 API，请参阅 xref:api_Exporting_Templates_managing-hosts[。

流程

  1. 在 Satellite Web UI 中，导航到 Hosts > Sync Templates。
  2. 单击 Export。
  3. 每个字段填充在 Administer > Settings > TemplateSync 中配置的值。根据需要更改您要导出的模板的值。有关每个字段的更多信息，请参阅 第 14.2 节 “配置 TemplateSync 插件”。
  4. 点 Submit。

卫星 Web UI 显示导出的状态。状态不是持久性；如果您离开状态页面，则您无法返回该状态。

CLI 过程

  1. 要将模板导出到存储库，请输入以下命令： 

    hammer export-templates \
--organization "My_Organization" \
--repo "https://git.example.com/path/to/repository"
    注意

    此命令克隆存储库，在提交中进行更改，并推送回存储库。您可以使用 --branch "My_Branch" 选项，将模板导出到特定的分支。

API 流程

  1. 将 POST 请求发送到 api/v2/templates/export ： 

    # curl -H "Accept:application/json" \
-H "Content-Type:application/json" \
-u login:password \
-k https://satellite.example.com/api/v2/templates/export \
-X POST

    如果导出成功，您会收到 {"message":"Success"}。

注意

您可以使用 -d 参数在请求中指定默认 API 设置来覆盖它们。以下示例将模板导出到 git.example.com/templates 存储库： 

# curl -H "Accept:application/json" \
-H "Content-Type:application/json" \
-u login:password \
-k https://satellite.example.com/api/v2/templates/export \
-X POST \
-d "{\"repo\":\"git.example.com/templates\"}"