样书配置

从 GitHub 存储库导入和同步样书

假设您使用 CI/CD 进程进行开发的场景。或者,您在 GitHub 中管理所有应用程序源代码和部署工件的场景。

在 GitHub 存储库中,您可能要维护几本用于部署 NetScaler 配置和管理这些样书的样书。您必须将这些样书上载到 NetScaler ADM。使用此功能,您可以直接将 GitHub 中存在的样书导入 NetScaler ADM。您无需手动从 GitHub 复制它们,然后将其上载到 NetScaler ADM 中。或者,手动同步 NetScaler ADM 和 GitHub 中的文件。此外,您可以从 GitHub 导入和同步配置包。

要导入样书和配置包,请在 NetScaler ADM 中定义一个代表 GitHub 存储库的存储库。提供 GitHub 存储库 URL 以及您在 GitHub 中创建的用户名和 API 令牌。这意味着,只有在 GitHub 中拥有有效帐户的授权用户才能导入和同步样本。

创建存储库后,您可以将NetScaler ADM与您的GitHub存储库同步。NetScaler ADM 连接到 GitHub 并导入在该存储库中找到的样书和配置包。然后,NetScaler ADM 会验证样书并将其添加到 NetScaler ADM 中的样书列表中。如果样本无法验证,则不会添加到 NetScaler ADM 中。您可以识别并更正样书中的错误。然后,将更新的版本提交到您的 GitHub 存储库中。稍后,您可以尝试将它们导入或将它们再次同步到 NetScaler ADM 中。

重要

  • 样书文件可以从 GitHub 存储库的任何分支导入和同步。

  • 您也可以导入和同步具有关联的依赖样书的样书。这些依赖样书可以在 Github 存储库中,也可以已经存在于 NetScaler ADM 中。

  • 必须从 NetScaler ADM GUI 或 API 手动启动来自 GitHub 存储库的样书的同步。也就是说,目前,样书的导入和同步不会根据您的 GitHub 提交活动自动进行。

  • 您要导入的配置包文件必须采用 JSON 格式。此外,配置文件内容必须遵循导出的配置格式。在您的 GitHub 存储库下,与配置包关联的文件必须位于configpacks文件夹中。

您可以从 GitHub 存储库中的任何文件夹将样书文件导入 NetScaler ADM。要导入配置包,请执行以下操作:

  1. 在根目录下创建一个名为configpacks的文件夹。确保与配置相关的所有文件都在此文件夹中。

  2. configpacks文件夹中,创建一个 JSON 文件,其中包含配置包的负载。此负载用于同步配置包。以下是有效负载示例:

    {"config_key":"unique-key-for-configpack","parameters":{"param-name1":"param-value1","param-name":"param-value2","param-namen":"param-valuen"},"stylebook":{"namespace":"some namespace","name":"somename","version":"spme-version"}}
    • config_key-用于在 NetScaler ADM 中标识配置包的唯一 ID 或名称。如果您未指定 config_key,NetScaler ADM 会在创建配置包时自动生成 ID。

      如果在 NetScaler ADM GUI 中找到指定的 ID,则同步操作会更新 NetScaler ADM GUI 中的配置包。否则,它会使用指定 ID 创建配置包。

    • parameters-它包含创建或更新配置包所需的所有参数。

    • stylebook-它是 JSON 文件中的必填属性。它包含要与配置包关联的命名空间、版本和样书名称。

  3. configpacks文件夹中,保留与配置包关联的所有文件,例如证书、签名文件和 XML 文件。

添加存储库

  1. 在 NetScaler ADM 中,转到应用程序 > 配置 > 存储库。单击添加

  2. 添加存储库窗口中,输入以下参数:

    • 名称-键入存储库的名称。此名称可以与 GitHub 中的存储库名称相同,也可以与其他名称相同。

    • 存储库 URL-键入 GitHub 仓库 URL。

      您可以指定 GitHub 企业 URL。它可以帮助您从 GitHub 企业帐户导入或同步样书和配置包。

    • 用户名-键入用于访问 GitHub 帐户或企业帐户的用户名。

    • API 令牌-此令牌用于访问 GitHub 仓库。有关如何为您的 GitHub 仓库创建 API 令牌的信息,请参阅有关创建个人访问令牌的 GitHub 文档。

    添加 GitHub 存储库

  3. 单击创建

    在 NetScaler ADM 中创建存储库。

存储库选项

以下是您的存储库的其他选项:

  • 编辑-您可以编辑存储库 URL、用户名和 API 令牌。

  • 删除-您可以删除存储库以及之前从该 GitHub 存储库导入的 NetScaler ADM 中存在的所有样书。

    注意

    如果存储库有任何与之关联的配置包的样书,则无法将其从 NetScaler ADM 中删除。首先,删除这些样书的所有配置包。稍后可以从 NetScaler ADM 中删除存储库以清理该存储库中的样书。

  • 重置-您可以删除 NetScaler ADM 中从该存储库同步的所有样书,而无需实际删除存储库条目。

  • 列出文件-您可以看到 NetScaler ADM 中存在的来自 GitHub 存储库的所有样书的列表。

GitHub 存储库列表

从 GitHub 导入样书和配置包的步骤

完成先决条件后,按照步骤从 GitHub 存储库导入样书和配置包:

  1. 可选,如果您尚未添加存储库,请添加存储库。
  2. 在“存储库”页面中选择存储库
  3. 单击“同步”。
从 GitHub 存储库导入和同步样书