Import custom StyleBooks 编辑

After you have built your StyleBook, you have to import it to Citrix Application Delivery Management (ADM) to use it. Citrix ADM allows you to import a single StyleBook in YAML form or multiple StyleBook YAML files as a bundle in a .zip, .tgz, or .gz form. The Citrix ADM system validates your StyleBooks on import. The StyleBook is now ready to be used for creating configurations.

Citrix ADM also has a built-in YAML editor that you can use to compose the StyleBook YAML contents. The YAML editor allows you to validate your YAML constructs from the Citrix ADM GUI itself. You do not need to use a separate tool for these validation checks. The content is validated against YAML standards and any deviation is highlighted. You can then correct the content and attempt to import the StyleBook into Citrix ADM. The built-in YAML editor provides two advantages while writing your own StyleBook.

• Color coded. The editor displays the StyleBook content parsed as per YAML guidelines, and the color coding helps you to differentiate easily between the keys and the values defined in the YAML content.
• YAML validation. The content is validated for any YAML errors as you type in and any deviation is immediately highlighted. This validation allows you to write text that conforms to YAML guidelines even before you import the StyleBook in the ADM.

Note

Currently, the editor validates the content according to YAML guidelines. It does not validate for code correctness and typographical errors.

To import your StyleBook

1. In Citrix ADM, navigate to Applications > Configuration > StyleBooks, and then click Import New StyleBook.

2. Click one of the following options to import a StyleBook.

   • File - select the required file or the bundle of files from your local storage.

     Note

     In this example, import the lb-vserver.yml StyleBook that you had created in StyleBook to Create a Load Balancing Virtual Server.

     

   • Bundle - Citrix ADM allows you to import multiple StyleBooks in YAML format. You can import more than one YAML StyleBook files that are compressed in a zip (.zip) format or tarball (.tgz, .gz) format.

     

     You can now include icons to each StyleBook in the bundle. Ensure to have the resources folder that contains icons in the PNG, GIF, or JPEG formats. If the icon file name matches the StyleBook name, the icons are automatically mapped to the StyleBooks. Otherwise, do the following:

     1. Add the icon_mapping.json file in the resources folder.

     2. Map StyleBooks and icons in the icon_mapping.json file as follows:

        <StyleBook file name> : <icon file name>
        <!--NeedCopy-->