StyleBook groups

There are two StyleBook groups in Citrix Application Delivery Management (ADM). They are the default StyleBooks and the custom StyleBooks. Whether it is a default or custom, a StyleBook is either a public or a private StyleBook. In Citrix ADM, you can view all the StyleBooks that are present in the system, regardless of their type or visibility status. You can also view a graphical display of how StyleBooks are connected with each other.  

This document explains the different types of StyleBooks. Also, it explains the following actions that you can perform on the StyleBooks from Citrix ADM:

  • Download a custom StyleBook and make modifications, or create a StyleBook based on an existing one.
  • Hide ADM default StyleBooks.
  • Delete a custom StyleBook from Citrix ADM.
  • Add labels to the StyleBooks.

Default and custom StyleBooks

  • Default StyleBooks are the StyleBooks shipped with Citrix ADM and they allow you to create configurations that you can deploy on your Citrix ADC instances. You cannot delete default StyleBooks, but you can hide them from the ADM GUI.
  • Custom StyleBooks are your own StyleBooks that you imported in to Citrix ADM.

Both default and custom StyleBooks can be either public or private.

Public and private StyleBooks

StyleBooks from which you can create configpacks can be categorized as public StyleBooks. That is, they are all available for your direct usage to create configurations from the Citrix ADM GUI and APIs.

But, some StyleBooks are used as building blocks for other StyleBooks. Such StyleBooks are marked as private. The private StyleBooks cannot be directly used to create configpacks from the Citrix ADM GUI. But, you can still display and view these StyleBooks on Citrix ADM. To mark any of your custom StyleBooks as private, set the private attribute in the StyleBook to true. You can still use private StyleBooks to create configpacks using the Citrix ADM APIs.

Example of a StyleBook marked as private

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

View StyleBooks

The number of StyleBooks - both default and private are increasing in Citrix ADM. You might want to search for the particular StyleBook that you want to access. You might also want to view both types of StyleBooks separately.

In Citrix ADM, when you navigate to Applications > StyleBooks, you can view a list of StyleBooks that are present in the system.

A default public StyleBook has the following icon on its panel:

localized image

Whereas a default private StyleBook has an icon that declares it as a private StyleBook:

localized image

While you can view the definition and dependencies of a private StyleBook, you cannot create a configpack from a private StyleBook using the GUI. The main purpose of a private StyleBook is to use it as a building block for another StyleBook. Using the building-blocks-StyleBooks encourages the reuse of common configuration patterns.

A custom public StyleBook has a different icon as shown in the following image:

localized image

While a custom private StyleBook appears with this icon:

localized image

At the top right-side of the page, you can see an option to select the type of StyleBooks to view. There are three options - all, public, or private StyleBooks. Click one of the options.

localized image

You can also search for a particular StyleBook by clicking the search icon. You can search by name, namespace, and version attributes or a combination of these options. The search operation is not case-sensitive.

localized image

Download custom StyleBooks

To download the custom Stylebooks from Citrix ADM, navigate to Applications > StyleBooks > Configurations. In the list of StyleBooks that are displayed on the right-side panel, check the option to download the custom-defined StyleBooks. Click Download. If the StyleBook has dependent custom StyleBooks, you can include these in the downloaded bundle.

Note

You can download custom StyleBooks that are marked as either public or private.

localized image

Note

You cannot download Citrix ADM default StyleBooks. You can, however, view their definitions and dependencies by clicking View Definition and View Dependencies links on the StyleBook panel.

Delete custom StyleBooks

You can also delete a custom StyleBook by clicking the Delete button. A pop-up window prompts you to confirm if you want to remove the StyleBook from Citrix ADM. If the StyleBook uses other custom StyleBooks, you can choose to remove those also by selecting the checkbox.

localized image

localized image

Note

You cannot delete a custom StyleBook that has other StyleBooks in Citrix ADM that depend on it, as this would break the existing StyleBooks.

View StyleBook dependencies

An important and powerful feature of StyleBooks is that they can be used as building blocks for other StyleBooks. You can import a StyleBook into another StyleBook. An imported Stylebook is declared as a type and is used by components or parameters of the second StyleBook. You can study the existing default StyleBooks in Citrix ADM to learn how one StyleBook can be built on top of another StyleBook.

Citrix ADM allows you to view a graphical display of how StyleBooks are connected with each other. This is especially useful for complex StyleBooks that are built using other StyleBooks as building blocks. By looking at the dependency graph, it is possible to see the relationships and dependencies among multiple StyleBooks.

A StyleBook used by other StyleBooks cannot be removed from the system, as this would break the existing StyleBooks. Using the dependency graph display, you can identify which StyleBooks are preventing the removal of a StyleBook.

To view StyleBook dependencies

In Citrix ADM, navigate to Applications > StyleBooks. The StyleBooks page displays all the StyleBooks available for your use in Citrix ADM. Scroll down and find your StyleBook. The StyleBook panel displays links to create a configuration, to view the StyleBook definition, and to view the StyleBook dependencies. Click View Dependencies.

Forward dependencies

The Forward Dependencies tab allows you to view the different default StyleBooks that your StyleBook is using. Follow the arrows to find the StyleBook that a StyleBook is using. When you point your mouse to one of the arrows, the arrow and the StyleBooks that are connected to one another are highlighted. You can also click the StyleBook names to view the definition of that StyleBook.

localized image

Reverse dependencies

The Reverse Dependencies tab allows you to graphically view the StyleBooks that are using your StyleBook. If you follow the arrows, you can see that all StyleBooks in the display point towards your StyleBook. Some StyleBooks might be directly using the StyleBook and some StyleBooks might be using the StyleBook through another StyleBook.

localized image

Create a label for the StyleBook

You can add labels to any StyleBook in Citrix ADM. Labels are key-value pairs that allow you to group StyleBooks using different criteria. You can use these labels while searching or filtering for StyleBooks in Citrix ADM.

To add a label to the StyleBook:

  1. Navigate to Applications > StyleBooks.

  2. Select Labels on the StyleBook for which you want to add labels.

    Labels for a StyleBook

    You can add labels to all types of StyleBooks.

  3. Specify the required Key and Value information that helps you filter the StyleBook.

    For example, Key=team and Value=bizdata

    Create a label for a StyleBook

    To add more labels, click +.

  4. Click Create.

To filter StyleBooks using labels, in the search bar, click Labels and select key and value from the list. The StyleBooks that are matching the specified label are displayed.

How to use labels

The following is an example search for the StyleBooks having a label where key=team and value=bizdata:

Example for a label