Crear y utilizar StyleBooks personalizados

Puede escribir su propio StyleBook para su implementación, importarlo a Citrix Application Delivery Management (ADM) y crear objetos de configuración. También puede usar API para crear configuraciones desde sus StyleBooks.

Este documento incluye la siguiente información:

Antes de empezar

Antes de empezar a crear StyleBooks, asegúrese de tener conocimiento de lo siguiente:

Los archivos StyleBook utilizan el formato YAML. Para obtener información sobre el formato YAML, consulte YAML Sintaxis.

La siguiente es una lista de pautas de YAML que debe tener en cuenta al crear StyleBooks:

  • YAML distingue entre mayúsculas y minúsculas.
  • YAML requiere una sangría adecuada
  • Use<spacebar> la clave para crear sangría adecuada. No utilice la<tab> tecla. El uso de<tab> la clave crea un error de compilación al importar su StyleBook a MA Service.
  • No utilice cadenas entre comillas. Incluya la cadena entre comillas solo si una cadena contiene signos de puntuación (guiones, dos puntos, etc.). Si quiere interpretar un número como una cadena, incluya el número entre comillas o utilice la función str() incorporada de StyleBooks.
  • Literales como YES/Yes/yes/Y/y/NO/no/No/n/N, ON/On/on/OFF/Off/off y TRUE/true/truthy/FALSE/False/false/falsely se consideran booleanos y equivalen a true y false respectivamente. Para interpretarlas como cadenas, inclúyelas entre comillas. Por ejemplo:

    • “YES”
    • “No”
    • “True”
    • “False” y así sucesivamente.

Nota

Antes de importar el archivo StyleBook a Citrix ADM, se recomienda validar si el archivo es compatible con el formato YAML. Citrix recomienda utilizar el validador YAML integrado en StyleBooks para validar e importar el contenido YAML.

Al configurar StyleBooks, solo puede usar recursos de configuración de Nitro que admitan las operaciones Create y Delete (métodos POST y DELETE HTTP). Para obtener más información, consulte la documentación de las API de Nitro.

Anatomía de un StyleBook

Escribir StyleBooks requiere que usted comprenda la gramática, la sintaxis y la estructura de StyleBooks. Un StyleBook típico tiene las siguientes secciones:

  • Encabezado: Esta sección le permite definir la identidad de un StyleBook y describir lo que hace. Esta es una sección obligatoria.
  • Importar StyleBooks: Esta sección le permite declarar a qué otro StyleBook quiere referirse de su StyleBook actual. Es necesario importar StyleBooks u otros StyleBooks de configuración Citrix ADC NITRO para escribir un StyleBook. Esta es una sección obligatoria.
  • Parámetros: Esta sección le permite definir los parámetros que necesita en su StyleBook para crear una configuración. Describe la entrada que toma tu StyleBook. Esta es una sección opcional.
  • Componentes: Esta sección le permite definir las entidades (objetos de configuración) que crea StyleBook para una configuración específica. Esta sección se considera como el núcleo de un StyleBook. Los componentes generalmente utilizan la entrada proporcionada en la sección de parámetros para adaptar la configuración generada por el StyleBook. Esta es una sección opcional.
    Un StyleBook puede tener una sección de parámetros, una sección de componentes, o ambos. Un StyleBook con solo la sección de parámetros es útil para definir una lista de parámetros que pueden ser utilizados por otros StyleBooks. Esto promueve la reutilización de grupos de parámetros en un conjunto de StyleBooks. Se puede usar un StyleBook con solo una sección de componentes cuando se quiere especificar los valores de los atributos en el StyleBook en lugar de definir parámetros para tomar la entrada del usuario.
  • Salidas: Mientras que la sección de parámetros define las entradas del StyleBook, esta sección opcional define sus salidas. En esta sección de salidas opcionales, puede especificar los componentes que quiere exponer a los usuarios que crean una configuración desde este StyleBook y a otros StyleBooks que importan este StyleBook. Los usuarios y la importación de StyleBooks pueden hacer referencia a las propiedades de los componentes expuestos.
  • Operaciones: Un StyleBook puede contener una sección opcional para habilitar Analytics en Citrix ADM en cualquier servidor virtual que forme parte del StyleBook.

La siguiente figura muestra un esquema simple de un StyleBook.

Imagen localizada

Los siguientes ejemplos le ayudan a aprender sobre la gramática y la estructura de un StyleBook y cómo escribir StyleBooks con niveles cada vez mayores de complejidad.

Crear y utilizar StyleBooks personalizados