StyleBook configuration


StyleBooks simplify the task of managing complex NetScaler configurations for your applications. A StyleBook is a template that you can use to create and manage NetScaler configurations.

With a StyleBook, you can:

  • Configure a specific feature of NetScaler.
  • Create configurations for an enterprise application deployment such as Microsoft Exchange or Lync.

StyleBooks fit in well with the principles of Infrastructure-as-code that is practiced by DevOps teams, where configurations are declarative and version-controlled. The configurations are also repeated and are deployed as a whole. StyleBooks offer the following advantages:

  • Declarative: StyleBooks are written in a declarative rather than imperative syntax. StyleBooks allow you to focus on describing the outcome or the “desired state” of the configuration rather than the step-by-step instructions on how to achieve it on a particular NetScaler instance. NetScaler Console computes the diff between existing state on a NetScaler and the desired state you specified, and makes the necessary edits to the infrastructure. Because StyleBooks use a declarative syntax, written in YAML, components of a StyleBook can be specified in any order, and NetScaler Console determines the correct order based on their computed dependencies.
  • Atomic: When you use StyleBooks to deploy configurations, the full configuration is deployed or none of it is deployed and this ensures that the infrastructure is always left in a consistent state.
  • Versioned: A StyleBook has a name, namespace, and a version number that uniquely distinguishes it from any other StyleBook in the system. Any modification to a StyleBook requires an update to its version number (or to its name or namespace) to maintain this unique character. The version update also allows you to maintain multiple versions of the same StyleBook.
  • Composable: After a StyleBook is defined, the StyleBook can be used as a unit to build other StyleBooks. You can avoid repeating common patterns of configuration. It also allows you to establish standard building blocks in your organization. Because StyleBooks are versioned, changes to existing StyleBooks results in new StyleBooks, therefore ensuring that dependent StyleBooks are never unintentionally broken.
  • App-Centric: StyleBooks can be used to define the NetScaler configuration of a full application. The configuration of the application can be abstracted by using parameters. Therefore, users who create configurations from a StyleBook can interact with a simple interface consisting of filling a few parameters to create what can be a complex NetScaler configuration. Configurations that are created from StyleBooks are not tied to the infrastructure. A single configuration can thus be deployed on one or multiple NetScaler instances, and can also be moved among instances.
  • Auto-Generated UI: NetScaler Console auto-generates UI forms used to fill in the parameters of the StyleBook when configuration is done using the NetScaler Console GUI. StyleBook authors do not need to learn a new GUI language or separately create UI pages and forms.
  • API-driven: All configuration operations are supported by using the NetScaler Console GUI or through REST APIs. The APIs can be used in synchronous or asynchronous mode. In addition to the configuration tasks, the StyleBooks APIs also allow you to discover the schema (parameters description) of any StyleBook at runtime.

You can use one StyleBook to create multiple configurations. Each configuration is saved as a config pack. For example, consider that you have a StyleBook that defines a typical HTTP load balancing application configuration. You can create a configuration with values for the load balancing entities and run it on a NetScaler instance. This configuration is saved as a config pack. You can use the same StyleBook to create another configuration with different values and run it on the same or a different instance. A new config pack is created for this configuration. A config pack is saved both on NetScaler Console and on the NetScaler instance on which the configuration is run.

You can either use default StyleBooks, shipped with NetScaler Console, to create configurations for your deployment, or design your own StyleBooks and import them to NetScaler Console. You can use the StyleBooks to create configurations either by using the NetScaler Console GUI or by using APIs.

This document includes the following sections:


In this article