样书配置

样书类别

在 NetScaler 控制台中,有两个样书类别:默认和自定义,可以是公共的,也可以是私有的。NetScaler 控制台允许您查看系统中存在的所有样书以及它们之间的连接方式。

本文档说明了不同类型的样书以及您可以在 NetScaler 控制台上对样书执行的以下操作:

  • 下载自定义样书并进行修改,或者基于现有样书创建样书。
  • 隐藏 NetScaler 控制台的默认样书。
  • 从 NetScaler 控制台中删除一本定制样书。
  • 将标签添加到样书中。

默认和自定义样书

  • 默认样书是 NetScaler 控制台附带的样书,它们允许您创建可以在 NetScaler 实例上部署的配置。您无法删除默认样书,但可以在 NetScaler 控制台 GUI 中将其隐藏。
  • 定制样书 是您自己导入到 NetScaler 控制台中的样书。

默认样书和自定义样书都可以是公开的也可以是私有的。

公共和私人样书

您可以从中创建配置包的样书可以归类为公共样书。也就是说,它们都可供您直接使用,从 NetScaler 控制台 GUI 和 API 中创建配置。

但是,有些样书被用作其他样书的基石。此类样书被标记为 有。私有样书不能直接用于从 NetScaler 控制台 GUI 创建配置包。但是,您仍然可以在 NetScaler 控制台上显示和查看这些样书。要将任何自定义样书标记为 有,请将样书中的私有属性设置为 true。您仍然可以使用私有样书使用 NetScaler 控制台 API 创建配置包。

标记为私有样书的示例

name: basic-lb-config
namespace: com.example.stylebooks
version: "0.1"
display-name: Load Balancing Configuration
description: |
    This StyleBook defines a simple load balancing configuration and is a building block to build other load balancing configurations.
schema-version: "1.0"
private: true
<!--NeedCopy-->

查看样书

NetScaler 控制台中的样书(包括默认样书和私有样书)的数量都在增加。您可能需要搜索要访问的特定样书。您可能还想分别查看这两种类型的样书。

在 NetScaler 控制台中,当您导航 到“应用程序”>“配置”“样书”时,可以查看系统中存在的样书列表。

默认公用样书面板上有以下图标:

默认公共样书

而默认的私有样书有一个将其声明为私有样书的图标:

私人图标

虽然您可以查看专用样书的定义和依赖关系,但不能使用 GUI 从专用样书创建配置包。私有样书的主要目的是将其用作另一个样书的构建块。使用 Building-Blocks-样书 鼓励重复使用常见的配置模式。

自定义公用样书具有不同的图标,如下图所示:

默认公共图标

虽然自定义私有样书显示以下图标:

默认私人图标

在页面右上角,您可以看到选择要查看的样书类型的选项。共有三个选项——全部、公共或私有样书。单击其中一个选项。

按公共和私人筛选样书

您也可以通过单击搜索图标来搜索特定样书。您可以按名称、命名空间和版本属性或这些选项的组合进行搜索。搜索操作不区分大小写。

搜索样书

下载自定义样书

要从 NetScaler 控制台下载定制样书,请导航 到应用程序 > 配置 配置包。在右侧面板上显示的样书列表中,选中下载自定义样书的选项。单击下载。如果样书具有相关的自定义样书,则可以在下载的捆绑包中包含相关样书。

注意

您可以下载标记为公共或私有的自定义样书。

下载样书

注意

您无法下载 NetScaler 控制台的默认样书。您可以查看它们的定义和依赖关系。为此,请单击样书面板上的查看定义查看依赖关系链接。

更新自定义样书

您可以从 NetScaler 控制台 GUI 本身更新定制样书定义。因此,您可以在不更改版本的情况下更改样书。您也可以更新从样书包中导入的定义。

重要

在从 NetScaler 控制台 GUI 更新样书定义之前,请确保样书定义中没有相关样书。

您可以更新包含配置包的样书定义。确保样书的定义向后兼容。因此,所有参数都保存在更新后的样书中,新添加的参数显示为可选参数。

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

  2. 选择 自定义样书 选项卡。

  3. 在要 更新的样书上选择更新定义

  4. 根据需要更新定义,然后单击 更新

    更新自定义样书

  5. 刷新页面以查看最新更改。

删除自定义样书

您也可以通过单击“删除”按钮来 删除 自定义样书。弹出窗口提示您确认是否要从 NetScaler 控制台中删除样书。如果样书使用其他自定义样书,则可以通过选中该复选框来选择删除此类样式书。

删除样书

注意:

如果定制样书在 NetScaler 控制台中有依赖样书,则不要将其删除。此操作可能会破坏现有的样书。

查看样书依赖关系

样书一个重要的强大功能是它们可以用作其他样书的构建块。

您可以:

  • 将一个样书导入到另一个样书中 - 导入的样书被声明为一种类型,并由第二个样书的组件或参数使用。在 NetScaler 控制台中查看现有默认样书,了解如何在另一本样书的基础上构建样书。

  • 查看样书如何相互连接的图形显示 - 这种表示法对于使用其他样书作为构件构建的复杂样书非常有用。依赖关系图允许您查看样书之间的关系和依赖关系。

注意:

您无法删除其他样书使用的样书,因为此操作可能会破坏现有样书。使用依赖关系图显示屏来识别哪些样书阻止了样书的删除。

查看样书依赖关系

在 NetScaler 控制台中,导航到应用程序 > 配置 > 样书。样书页面显示了所有可供您在 NetScaler 控制台中使用的样书。向下滚动并找到您的样书。单击“查看依赖关系”以查看依赖样书。

转发依赖关系

转发依赖关系”选项卡允许您查看样书正在使用的不同默认样书。按照箭头查找样书正在使用的样书。当您将鼠标指向其中一个箭头时,该箭头和相互连接的样书将突出显示。您也可以单击样书来查看该样书的定义。

转发依赖关系

反向依赖关系

反向依赖关系”选项卡允许您以图形方式查看使用样书的样书。如果按照箭头进行操作,您可以看到显示屏中的所有样书都指向您的样书。有些样书可能直接使用样书,有些样书可能正在通过其他样书使用样书。

反向依赖关系

根据配置包审核 NetScaler 配置

您可以将样书配置包所做的更改与当前的 NetScaler 配置进行比较。通过此比较,您可以执行以下操作:

  • 检测样书配置包和 NetScaler 配置之间的配置偏差。

  • 识别 NetScaler 上任何未显示配置包所做更改的修改和删除的对象。

要将配置包更改与 NetScaler 实例配置进行比较,请执行以下操作:

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

  2. 单击“配置审核”。

    “配置审核”页显示创建和审核的对象。

    根据配置包审核 NetScaler 配置

注意:

更新部署在 NetScaler 实例上的样书配置包时,它可能与其部署状态有所不同。而且,它无法更新配置包。样书引擎会自动协调这些差异并更新配置包。

下载配置包的支持包

配置包的支持包可帮助 Citrix 技术支持团队查看、分析和解决配置包问题。要下载支持包,请执行以下步骤:

  1. 转到 应用程序 > 配置 > 配置包

  2. 选择要将支持包下载到的配置包。

  3. 在“选择操作”中,单击“支持包”。

    您可以以 Zip 或 TGZ 文件格式压缩包。

  4. 可选,指定密码来加密捆绑文件。

  5. 单击下载

支持包

为样书创建标签

您可以在 NetScaler 控制台中为任何样书添加标签。标签是键值对,允许您使用不同的条件对样书进行分组。您可以在 NetScaler 控制台中搜索或筛选样书时使用这些标签。

要向样书添加标签,请执行以下操作:

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

  2. 在要为其添加 标签 的样书上选择标签。

    样书的标签

    您可以向所有类型的样书添加标签。

  3. 指定有助于筛选样书的所需 信息。

    例如,键 = 团队和值 = Bizdata

    为样书创建标签

    要添加更多标签,请单击 +

  4. 单击创建

要使用标签筛选样书,请单击搜索栏中的 标签 ,然后从列表中选择一个键和一个值。将显示与指定标签相匹配的样书。

如何使用标签

以下是搜索带有标签的样书的示例,其中包括 key=teamvalue=bizdata

标签示例

您可以将样书标签关联到它的配置包。因此,您可以使用样书标签本身搜索配置包。

创建配置包时,请使用 标签关联 部分中的以下选项之一:

  • 将所有现在和将来的样书标签与配置关联 - 此选项将所有样书标签关联到配置包。它还可以确保将来可能添加到样书中的新标签关联起来。

  • 择标签 — 此选项显示所选样书的标签。您可以选择所需的样书标签并与配置包关联。

将样书标签与其配置包相关联

克隆一本样书

作为管理员,您可以创建样书的副本以及他们的依赖样书。然后,您可以使用此包进行自定义,例如更新 parameterscomponents 部分。

要克隆样书,请执行以下操作:

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

  2. 在要复制的默认或自定义样书上选择“克隆”。

    克隆样书

  3. 在“克隆样书”页面中,输入样书和相关样书的命名空间和版本。您也可以选择建议的命名空间和版本。

    克隆样书

    注意:

    克隆的样书及其依赖样书必须具有不同的命名空间和版本,以将其与现有样书区分开来。您不能为克隆的样书使用任何保留的 NetScaler 控制台命名空间。

  4. 单击“克隆”。克隆的样书包将导入到 NetScaler 控制台并显示在样书页面中。