样书配置

创建和编辑配置包

在 NetScaler 控制台中,您可以从样书中创建配置包。配置包与创建它的样书相关联。对配置包的任何更新都是通过与之关联的样书进行的。

创建配置包

要从样书创建配置包,请执行以下操作:

  1. 导航到 应用程序 > 配置 > 配置包

  2. 单击添加

  3. 选择样书中,选择要从中创建配置包的所需样书。

    此页面将样书分为默认样书、企业样书和自定义样书。选择相应的选项卡以查找所需的样书。

  4. 可选,为您的 配置包指定一个唯一的配置密钥 。此密钥 显示为此配置包的显示密钥

    • 如果您指定了存在的 配置密钥 ,则 NetScaler 控制台无法创建配置包。

    • 如果您未指定 配置密钥,NetScaler 制台会自动分配配置包 ID。但是,此值不显示为 显示键

    • 如果您未指定 配置密钥 且任何样书参数已设置 key 属性,则该参数值将显示为 显示密钥。有关更多信息,请参阅 参数

  5. 指定所需的详细信息,例如应用程序名称、IP 地址、端口或协议类型。

    图形用户界面字段因样书而异于另一个样书。

  6. 目标实例中,选择要运行配置的实例或实例组。

    注意:

    您可以根据需要指定任意数量的目标实例,在多个 NetScaler 上部署配置。

  7. 单击试运行

    对象页面显示从 NetScaler 实例中创建、修改或删除的对象。

  8. 单击创建

    配置包将显示在 样书 > 配置 页面中。

如果要编辑现有的配置包,请选择配置包并单击“编辑”。

更改配置包的样书

有时,您需要更新样书以添加功能或修复问题。如果您已经使用旧的样书创建了配置包,则可能需要更新它们以使用新更新的样书。要使用新的样书,请更改配置包的现有样书。

以在 NetScaler 实例上部署基本负载平衡器配置的样书 example-lb 为例。而且,您可以从此样书中创建配置包 CP1。

要使用基本的负载平衡器配置来配置监视器,您需要一个新的样书。为此,请创建一个 example-lb-mon 样书,其中包含配置监视器的功能以及基本的负载平衡器配置。

创建样书后,更新现有配置包 CP1 以添加监视器。要更新配置包,请执行以下操作:

  1. 导航到 应用程序 > 配置 > 配置包

  2. 选择要更改样书的配置包。

    在此示例中,从列表中选择 CP1。

  3. 单击“更改样书”。

  4. 从列表中选择所需的样书。然后,单击“保存选择”。

  5. 单击 Change(更改)。

    在此示例中,从列表中选择 例子-lb-mon

    更改配置包的样书时,新样书中的参数可能具有与现有样书不同的结构。如果参数结构与之前的样书类似,则参数的值将自动保留在各自的字段中。否则,只有两个样书之间具有相同结构的参数才会被传输。例如,相同的参数名称、类型、参数父级等。

    注意:

    样书兼容性页面显示参数的差异。此页面可帮助您决定是更改样书还是继续使用现有样书。如果要更改样书,请查看更改,然后单击“下一步”。

    如果在新样书中添加了新参数,则在更改样书后,必须手动为此类参数指定值。

    在此示例中,示 例 lb 样书的配置页面上显示的参数如下:

    负载平衡配置包示例

    新示 例-lb-mon 样书的配置页面上显示的参数如下:

    配置包迁移后的示例参数

    在这种情况下,样书会保留基本负载平衡器配置的旧值,因为新样书未更改现有参数。而且,它只添加了新的参数。对于监视器参数,请手动指定所需的值。

  6. 目标实例中,查看选定的实例并根据需要更新列表。

  7. 单击试运行

    对象页面显示从 NetScaler 实例中创建、修改或删除的对象。

  8. 单击确定

    样书 > 配置 页面中, 样书名称 列显示所选配置包的新样书名称。在这种情况下,它会显示示 例-lb-mon

更改有多个配置包的样书

当您想更改具有多个配置包的现有样书时,请执行以下操作:

  1. 将新样书导入 NetScaler 控制台。

    通常,新样书的名称和命名空间相同,版本高于现有样书。但是,如果名称、命名空间或版本不同,则可以跳过此步骤。

  2. 更改与现有样书关联的配置包的样书。

    仅当选定的配置包与同一样书关联时,您才能选择“更改样书”。

    对于选定的配置包,当满足以下条件时,NetScaler 控制台会成功更改样书:

    • 所选样书中必须包含现有样书的所有配置参数。

    • 选定样书中的新参数是可选的。

    要查看所选配置包的进度,请在“配置”页面中选择“正在进行/失败的配置”

  3. 将所有配置包绑定到新样书后,将旧样书从 NetScaler 控制台中移除。

导出或导入配置包

您可以像样书一样导出或导入配置包。使用此功能,您可以轻松地将样书配置共享到另一台 NetScaler 控制台服务器。导出配置包时,tgzzip 捆绑包下载到本地计算机。此捆绑包包含一个 JSON 文件,其中包含配置包中定义的所有参数。

导出配置

执行以下操作以导出配置包:

  1. 导航到 应用程序 > 配置 > 配置包

  2. 选择要导出的配置包。

  3. 选择操作中,选择 导出配置

    导出配置选项

  4. 在“导出配置”窗格中,指定以下内容:

    • 部署配置的目标实例信息:选择此选项可在导出捆绑包中包含目标实例的信息。

    • 与配置关联的样书:选择此选项可将样书包含在导出包中。

    • 用于保护导出配置数据的密码:指定用于加密导出包的密码短语。此密码短语可保护配置包的敏感数据。

    • 压缩文件类型:选择 ZIPTGZ 文件类型。

    导出配置包

  5. 单击导出

    将导出包保存在本地计算机上。

导入配置

您可以将配置包从本地电脑导入到另一台 NetScaler 控制台服务器。要导入配置包,请执行以下操作:

  1. 导航到 应用程序 > 配置 > 配置包

  2. 选择 导入配置

  3. 从计算机中选择导入文件包。

  4. 使用您在导出期间指定的密码。

  5. 可选,在“高级选项”中,选择“仅在 NetScaler 上已存在所有配置对象时才允许创建新配置”。

    此选项不会更改已在 NetScaler 实例上创建的对象。

    假设您在两台 NetScaler 控制台服务器中添加了相同的 NetScaler 实例。而且,您想将配置包从一台 NetScaler 控制台服务器迁移到另一台服务器。使用此选项可在不更改 NetScaler 实例上的配置对象的情况下导入配置包。

    重要:

    要使用此选项,请确保指定的配置包包含目标实例信息。请参阅“导出配置”

    只有当目标实例上都存在所有对象时,此选项才迁移配置。

  6. 单击导入

导入配置

当您导入配置包时,NetScaler 控制台会验证以下内容:

  • 关联样书:如果关联的样书不在 NetScaler 控制台中,则它会将样书与配置包一起导入。

  • 目标实例:检查目标实例并在指定的目标实例上部署配置。如果 NetScaler 控制台中不存在上述的 NetScaler 实例,则导入配置包时不带目标实例。

  • 来源 NetScaler控制台:如果您要在同一台 NetScaler 控制台服务器上导入配置包,则所选包会更新现有配置包。

将配置包另存为草稿

配置包中的“另存为草稿”选项允许您将配置更改保存为草稿。此功能无需立即将更改部署到 NetScaler 实例即可保存更改。

要将配置包另存为草稿,请执行以下步骤:

  1. 导航到 应用程序 > 配置 > 配置包
  2. 在“配置”页面上,单击“添加”。
  3. 选择所需的样本,然后单击“选择”。
  4. 在“创建配置”页面上,单击“另存为草稿”。

另存为草稿

将配置包保存为草稿后,您的配置更改不会直接部署到 NetScaler 实例。相反,配置包以草稿形式存储在“待定配置”下的“草稿配置”选项卡中。

在“草稿配置”选项卡中,选择配置包以执行以下操作:

  • 编辑草稿的配置。
  • 将配置部署到 NetScaler 实例。
  • 删除草稿。

草稿配置

您还可以安排何时部署已保存的草稿。

有关更多信息,请参阅为配置包创建时间表

为配置包创建时间表

创建配置包时,默认情况下,配置包会自动部署到 NetScaler 实例。使用此功能,您可以安排配置包的部署。

要为配置包创建时间表,请执行以下步骤:

  1. 导航到 应用程序 > 配置 > 配置包
  2. 在“配置”页面上,单击“添加”。
  3. 选择样本,然后单击选择
  4. 在“创建配置”页面的“执行”下,从“执行模式”列表中选择“稍后”。
  5. 选择所需的日程安排时间和日期,然后单击“提交”。

执行模式

所有计划配置都存储在“待定配置”下的“计划配置”选项卡中。您可以选择创建的时间表来编辑配置参数、部署或取消计划。

注意:

部署计划配置包会取消计划并立即执行配置。

预定配置

对于已部署的配置包

您还可以创建计划来编辑和删除已部署的配置包。

为配置包安排编辑操作

要创建编辑已部署配置包的时间表,请执行以下步骤:

  1. 导航到 应用程序 > 配置 > 配置包
  2. 在“配置”页面上,选择一本样书,然后单击“编辑”。
  3. 在“编辑配置”页面上,编辑配置包。
  4. 在“执行模式”列表中,选择“稍后”。
  5. 选择所需的日程安排时间和日期,然后单击“提交”。

为配置包安排删除操作

要创建删除已部署配置包的时间表,请执行以下步骤:

  1. 导航到 应用程序 > 配置 > 配置包
  2. 在“配置”页面上,选择一本样书,然后单击“删除”。
  3. 在“执行模式”列表中,选择“稍后”。
  4. 选择所需的日程安排时间和日期,然后单击“确定”。

删除配置包时间表

从配置包中分离目标实例

要从配置包中分离目标实例,请执行以下操作:

  1. 导航到 应用程序 > 配置 > 配置包

  2. 选择包含要删除的目标实例的配置包。

  3. 在“选择操作”中,选择“分离目标”。

  4. 在“分离目标”窗格中,选择要从配置包中移除的目标实例。

    分离目标

  5. 单击确定

将显示一条消息,确认已创建重复的配置包,目标实例现已删除。

构建您的样书

例磅 样书的完整内容如下供您参考:

name: example-lb
namespace: examples.stylebooks
version: "1.0"
display-name: Basic Load Balancer App
description: This is an example StyleBook that creates a load balancer application
schema-version: "1.0"
import-stylebooks:
  -
    namespace: com.citrix.adc.stylebooks
    prefix: stlb
    version: "1.0"
parameters-default-sources:
  - stlb::lb
components:
  -
    name: lb-comp
    type: stlb::lb
    description: Uses the default lb StyleBook to build the typical lb configuration objects
    properties-default-sources:
      - $parameters
<!--NeedCopy-->

例-lb-mon 样书的完整内容如下供参考:

name: example-lb-mon
namespace: examples.stylebooks
version: "1.0"
description: This is an example StyleBook that creates a load balancer application with monitors
display-name: Basic Load Balancer App with Monitors
schema-version: "1.0"
import-stylebooks:
  -
    namespace: netscaler.nitro.config
    prefix: ns
    version: "10.5"
  -
    namespace: com.citrix.adc.stylebooks
    prefix: stlb
    version: "1.0"
  -
    namespace: com.citrix.adc.commontypes
    prefix: cmtypes
    version: "1.0"
parameters-default-sources:
  - stlb::lb
parameters:
  -
    name: monitors
    label: "List of Monitors"
    description: "List of Monitors to monitor Application Servers"
    type: cmtypes::monitor[]
substitutions:
  mon-name(appname, monname): $appname + "-mon-" + $monname
components:
  -
    name: lb-comp
    type: stlb::lb
    description: Uses the default lb StyleBook to build the typical lb configuration objects
    properties-default-sources:
      - $parameters
  -
    name: monitors-comp
    type: cmtypes::monitor
    condition: $parameters.monitors
    repeat: $parameters.monitors
    repeat-item: mon
    repeat-index: ndx
    description: Builds a list of NetScaler monitor objects and binds them to the servicegroup of this LB config
    properties-default-sources:
      - $mon
    properties:
        monitorname: $substitutions.mon-name($parameters.lb-appname, $mon.monitorname)
    components:
      -
        name: monitor-svcg-binding-comp
        condition:  $parameters.svc-servers
        type: ns::servicegroup_lbmonitor_binding
        properties:
          servicegroupname: $components.lb-comp.outputs.servicegroup.properties.servicegroupname
          monitor_name: $parent.properties.monitorname
<!--NeedCopy-->
创建和编辑配置包