样书配置

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

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

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

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

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

重要

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

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

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

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

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

  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"
        }
    }
    <!--NeedCopy-->
    
    • config_key -用于在 NetScaler 控制台中标识配置包的唯一 ID 或名称。如果您未指定 config_key,NetScaler 控制台会在创建配置包时自动生成 ID。

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

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

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

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

添加存储库

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

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

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

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

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

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

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

    添加 GitHub 存储库

  3. 单击创建

    该仓库是在 NetScaler 控制台中创建的。

存储库选项

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

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

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

    注意

    如果仓库中有任何与配置包关联的样书,则无法从 NetScaler 控制台中删除该仓库。首先,删除这些样书的所有配置包。稍后,您可以从 NetScaler 控制台中移除该仓库,以清理该仓库中的样书。

  • 重置-您可以移除 NetScaler 控制台中从该仓库同步的所有样书,而无需实际删除仓库条目。

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

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

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

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