Crear y utilizar StyleBooks personalizados
Puede escribir su propio StyleBook para la implementación, importarlo a NetScaler Application Delivery Management (ADM) y crear objetos de configuración. También puede usar la API para crear configuraciones desde sus StyleBooks.
Este documento incluye la siguiente información:
Antes de comenzar
Antes de empezar a crear StyleBooks, asegúrese de tener conocimiento de lo siguiente:
- API de NITRO. Para obtener más información, consulte la documentación de la APIde
- YAML
Los archivos StyleBook utilizan el formato YAML. Para obtener información sobre el formato YAML, consulte Sintaxis YAML.
La siguiente es una lista de pautas de YAML que debe tener en cuenta al crear StyleBooks:
- YAML distingue mayúsculas de minúsculas
- YAML requiere una indentación adecuada
- Utilice la tecla
<spacebar>para crear una indentación adecuada. No utilice la tecla<tab>. El uso de la tecla<tab>crea un error de compilación al importar su StyleBook a MA Service. - No utilice cadenas entre comillas. Incluya la cadena entre comillas únicamente si la cadena contiene signos de puntuación (guiones, dos puntos, etc.). Si quiere interpretar un número como una cadena, inclúyalo entre comillas o utilice la función integrada str () de StyleBooks.
-
Los literales como sí/sí/sí/y/no/no/no/n/n, encendido/encendido/apagado/apagado/apagado y verdadero/verdadero/falso/falso/falso/falso se consideran booleanos y equivalen a verdadero y falso, respectivamente. Para interpretarlas como cadenas, inclúyalas entre comillas. Por ejemplo:
- “SÍ”
- “No”
- “Cierto”
- “Falso” y así sucesivamente.
Nota
Antes de importar el archivo de StyleBook a NetScaler ADM, se recomienda que valide 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 API de Nitro.
Anatomía de un StyleBook
Escribir StyleBooks requiere que comprenda la gramática, la sintaxis y la estructura de los StyleBooks. Un StyleBook típico tiene las siguientes secciones:
- Encabezado: esta sección permite definir la identidad de un StyleBook y describir su función. Se trata de una sección obligatoria.
- Importar StyleBooks: esta sección le permite declarar a qué otros StyleBook quiere hacer referencia desde su StyleBook actual. Es necesario importar la configuración de NetScaler NITRO, StyleBooks u otros StyleBooks para escribir un StyleBook. Se trata de 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 su StyleBook. Se trata de una sección opcional.
-
Componentes: esta sección le permite definir las entidades (objetos de configuración) que crea el StyleBook para una configuración específica. Esta sección se considera el núcleo de un StyleBook. Los componentes suelen utilizar la entrada proporcionada en la sección de parámetros para adaptar la configuración generada por el StyleBook. Se trata de una sección opcional.
Un StyleBook puede tener una sección de parámetros, una sección de componentes o ambas. Un StyleBook con solo la sección de parámetros es útil para definir una lista de parámetros que pueden usar otros StyleBooks. Esto promueve la reutilización de los grupos de parámetros en un conjunto de StyleBooks. Se puede usar un StyleBook con solo una sección de componentes cuando quiera especificar los valores de los atributos en el StyleBook en lugar de definir parámetros para tomar las entradas 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 creen una configuración a partir de este StyleBook y a otros StyleBooks que lo importen. Los usuarios que importen StyleBooks podrán entonces hacer referencia a las propiedades de los componentes expuestos.
- Operaciones: un StyleBook puede contener una sección opcional para habilitar los análisis en NetScaler ADM en cualquier servidor virtual que forme parte del StyleBook.
La siguiente ilustración muestra un esquema simple de un StyleBook.
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.