Application Delivery Management

创建和使用自定义 StyleBook

您可以为部署编写自己的 StyleBook,将其导入到 NetScaler® Application Delivery Management (ADM),并创建配置对象。您还可以使用 API 从 StyleBook 创建配置。

本文档包含以下信息:

开始之前

在开始创建 StyleBook 之前,请确保您了解以下内容:

StyleBook 文件使用 YAML 格式。有关 YAML 格式的信息,请参阅 YAML 语法

以下是创建 StyleBook 时必须注意的 YAML 准则列表:

  • YAML 区分大小写。
  • YAML 需要正确的缩进。
  • 使用 <spacebar> 键创建正确的缩进。请勿使用 <tab> 键。使用 <tab> 键会在将 StyleBook 导入到 MA Service 时导致编译错误。
  • 请勿在引号内使用字符串。仅当字符串包含标点符号(破折号、冒号等)时,才将字符串包含在引号内。如果要将数字解释为字符串,请将数字包含在引号内,或使用 StyleBook 的 str() 内置函数。
  • YES/Yes/yes/Y/y/NO/no/No/n/N、ON/On/on/OFF/Off/off 和 TRUE/true/truthy/FALSE/False/false/falsely 等字面量被视为布尔值,分别等同于 true 和 false。要将它们解释为字符串,请将它们包含在引号内。例如:

    • “YES”
    • “No”
    • “True”
    • “False” 等。

注意

在将 StyleBook 文件导入 NetScaler ADM 之前,建议您验证文件是否符合 YAML 格式。Citrix 建议您使用 StyleBook 中内置的 YAML 验证器来验证和导入 YAML 内容。

配置 StyleBook 时,您只能使用支持创建删除操作(POST 和 DELETE HTTP 方法)的 Nitro 配置资源。有关详细信息,请参阅 Nitro API 文档

StyleBook 剖析

编写 StyleBook 需要您了解 StyleBook 的语法、句法和结构。典型的 StyleBook 包含以下部分:

  • 标头:此部分允许您定义 StyleBook 的标识并描述其功能。这是一个强制性部分。
  • 导入 StyleBook:此部分允许您声明要从当前 StyleBook 引用哪些其他 StyleBook。编写 StyleBook 需要导入 NetScaler NITRO 配置 StyleBook 或其他 StyleBook。这是一个强制性部分。
  • 参数:此部分允许您定义 StyleBook 中创建配置所需的参数。它描述了 StyleBook 接受的输入。这是一个可选部分。
  • 组件:此部分允许您定义 StyleBook 为特定配置创建的实体(配置对象)。此部分被视为 StyleBook 的核心。组件通常使用参数部分中提供的输入来调整 StyleBook 生成的配置。这是一个可选部分。

    StyleBook 可以包含参数部分、组件部分或两者兼有。仅包含参数部分的 StyleBook 可用于定义可供其他 StyleBook 使用的参数列表。这有助于提高参数组在 StyleBook 集中的可重用性。仅包含组件部分的 StyleBook 可用于在 StyleBook 中指定属性值,而不是定义参数来获取用户输入。

  • 输出:参数部分定义 StyleBook 的输入,而此可选部分定义其输出。在此可选输出部分中,您可以指定要向从该 StyleBook 创建配置的用户以及导入该 StyleBook 的其他 StyleBook 公开的组件。用户和导入的 StyleBook 随后可以引用公开组件的属性。
  • 操作:StyleBook 可以包含一个可选部分,用于在 NetScaler ADM 中对作为 StyleBook 一部分的任何虚拟服务器启用 Analytics。

下图显示了 StyleBook 的简单概述。

StyleBook 概述图

以下示例可帮助您了解 StyleBook 的语法和结构,以及如何编写复杂性不断提高的 StyleBook。

创建和使用自定义 StyleBook