Citrix Application Delivery Management service

Create and edit a configuration pack

In Citrix Application Delivery Management (ADM), you can create a configuration pack from a StyleBook. And, the configuration pack is tied to the StyleBook from which it is created. The updates to the configuration pack are made through the StyleBook to which it is tied.

Create a configuration pack

Perform the following to create a configuration pack from a StyleBook:

  1. Navigate to Applications > StyleBooks > Configurations.

  2. Click Add.

  3. In Choose StyleBooks, select the required StyleBooks from which you want to create a configuration pack.

    This page categorizes StyleBooks into default and custom StyleBooks. Select the respective tabs to find the required StyleBooks.

  4. Specify the required details such as application name, IP address, port, or protocol type.

    The GUI fields differ from one StyleBook to another StyleBook.

  5. In Target Instances, select instances or instance groups where you want to run the configuration.

    Note

    You can deploy the configuration on more than one Citrix ADC, by specifying as many target instances as needed.

  6. Click Dry Run.

    The Objects page displays the objects that get created, modified, or removed from the Citrix ADC instances.

  7. Click Create

    The configuration pack appears in the StyleBook > Configurations page.

If you want to edit the existing configuration packs, select the configuration pack and click Edit.

Change the StyleBook of a configuration pack

Sometimes, you need to update the StyleBook to add functionality or fix an issue. If you already have created configuration packs using the old StyleBook, you might want to update them to use the new updated StyleBook. To use a new StyleBook, change the existing StyleBook of the configuration pack.

Consider an example StyleBook example-lb that deploys a basic load balancer configuration on an ADC instance. And, you create a configuration pack CP1 from this StyleBook.

When you want to configure monitors with the basic load balancer configuration, you need a new StyleBook. Therefore, create example-lb-mon StyleBook that includes the ability to configure monitors along with the basic load balancer configuration.

After you create a StyleBook, update the existing configuration pack CP1 to add some monitors. To do so, perform the following:

  1. Navigate to Applications > StyleBooks > Configurations.

  2. Select the configuration pack for which you want to change the StyleBook.

    In this example, select CP1 from the list.

  3. Click Edit.

  4. In Update Configuration, under StyleBook Details, click the Change StyleBook link.

  5. In the Choose StyleBook pane, select the required StyleBook from the list. Then, click Change Selection.

    In this example, select example-lb-mon from the list.

    When you change the StyleBook of a configuration pack, the parameters in the new StyleBook might have a different structure than the existing StyleBook. If the parameter structure is similar to the previous StyleBook, the parameters’ values are automatically retained in their respective fields. Otherwise, only parameters that have the same structure between the two StyleBooks are transferred. For example, the same parameter name, type, parameter parent, and more.

    Change the StyleBook of a configuration pack

    If new required parameters are added in the new StyleBook, after changing the StyleBook, you have to manually specify the values for such parameters.

    In this example, the parameters that appear on the configuration page for the example-lb StyleBook are as follows:

    Example load balancing configuration pack

    The parameters that appear on the configuration page for the new example-lb-mon StyleBook are as follows:

    Example parameters after configuration pack migration

    In this case, the StyleBooks retain the older values for the basic load balancer configuration because the new StyleBook hasn’t changed existing parameters. And, it adds only the new parameters. For monitor parameters, manually specify the required values.

  6. In Target Instances, review the selected instances and update the list if necessary.

  7. Click Dry Run.

    The Objects page displays the objects that get created, modified, or removed from the Citrix ADC instances.

  8. Click Create to update the configuration pack.

    The configuration pack appears in the StyleBook > Configurations page. The StyleBook Name column displays the new StyleBook name. In this case, it displays example-lb-mon.

Workflow to update an existing StyleBook that has configuration packs

When you update an existing StyleBook that has configuration packs, perform the following:

  1. Import a new StyleBook to ADM.

    Typically, the new StyleBook has the same name and namespace with a higher version than the existing StyleBook. However, you can skip this step if the name, namespace, or version are different.

  2. Change the StyleBook for the configuration packs that are tied to the existing StyleBook.

  3. Remove the old StyleBook from ADM once all configuration packs are tied to the new StyleBook.

Export or import configuration packs

You can export or import a configuration pack like StyleBooks. With this feature, you can readily share the StyleBook configuration to another ADM server. When you export a configuration pack, a tgz or zip bundle downloads to your local computer. This bundle includes a JSON file with all the parameters defined in a configuration pack. Do the following to export a configuration pack:

  1. Navigate to Applications > StyleBooks > Configurations.

  2. Select a configuration pack that you want to export.

  3. In Select Action, select Export Configuration.

    Export configuration option

  4. In the Export Configuration pane, specify the following:

    • Target instance(s) information on which the configuration is deployed: Select this option to include target instances’ information with the export bundle.

    • StyleBook associated with Configuration: Select this option to include the StyleBook in the export bundle.

    • Passphrase for protecting the export configuration data: Specify a passphrase to encrypt the export bundle. This passphrase secures the sensitive data of a configuration pack.

    • Compress file type: Select either ZIP or TGZ file type.

    Export configuration pack

  5. Click Export.

    Save the export bundle on your local computer.

You can import a configuration pack from your local computer to a different ADM server. To import a configuration pack, do the following:

  1. Navigate to Applications > StyleBooks > Configurations.

  2. Select Import Configuration.

    Import configuration option

  3. Choose the import file bundle from your computer.

  4. Use the passphrase that you have specified during export.

  5. Click Import.

Import configuration

When you import a configuration pack, the ADM verifies the following:

  • Associated StyleBook: If the associated StyleBook is not in the ADM, it imports the StyleBook along with the configuration pack.

  • Target instances: Check for target instances and deploys the configuration on the specified target instances. If the mentioned ADC instances are absent in the ADM, the configuration pack is imported without target instances.

  • Source ADM: If you are importing a configuration pack on the same ADM server, the selected bundle updates the existing configuration pack.

Build your StyleBooks

The full content of example-lb StyleBook is provided for your reference as follows:

name: example-lb
namespace: examples.stylebooks
version: "1.0"
display-name: Basic Load Balancer App
description: This is an example StyleBook that creates a load balancer application
schema-version: "1.0"
import-stylebooks:
  -
    namespace: com.citrix.adc.stylebooks
    prefix: stlb
    version: "1.0"
parameters-default-sources:
  - stlb::lb
components:
  -
    name: lb-comp
    type: stlb::lb
    description: Uses the default lb StyleBook to build the typical lb configuration objects
    properties-default-sources:
      - $parameters

The full content of example-lb-mon StyleBook is provided for your reference as follows:

name: example-lb-mon
namespace: examples.stylebooks
version: "1.0"
description: This is an example StyleBook that creates a load balancer application with monitors
display-name: Basic Load Balancer App with Monitors
schema-version: "1.0"
import-stylebooks:
  -
    namespace: netscaler.nitro.config
    prefix: ns
    version: "10.5"
  -
    namespace: com.citrix.adc.stylebooks
    prefix: stlb
    version: "1.0"
  -
    namespace: com.citrix.adc.commontypes
    prefix: cmtypes
    version: "1.0"
parameters-default-sources:
  - stlb::lb
parameters:
  -
    name: monitors
    label: "List of Monitors"
    description: "List of Monitors to monitor Application Servers"
    type: cmtypes::monitor[]
substitutions:
  mon-name(appname, monname): $appname + "-mon-" + $monname
components:
  -
    name: lb-comp
    type: stlb::lb
    description: Uses the default lb StyleBook to build the typical lb configuration objects
    properties-default-sources:
      - $parameters
  -
    name: monitors-comp
    type: cmtypes::monitor
    condition: $parameters.monitors
    repeat: $parameters.monitors
    repeat-item: mon
    repeat-index: ndx
    description: Builds a list of Citrix ADC monitor objects and binds them to the servicegroup of this LB config
    properties-default-sources:
      - $mon
    properties:
        monitorname: $substitutions.mon-name($parameters.lb-appname, $mon.monitorname)
    components:
      -
        name: monitor-svcg-binding-comp
        condition:  $parameters.svc-servers
        type: ns::servicegroup_lbmonitor_binding
        properties:
          servicegroupname: $components.lb-comp.outputs.servicegroup.properties.servicegroupname
          monitor_name: $parent.properties.monitorname

Create and edit a configuration pack