Product Documentation

Importing and synchronizing StyleBooks from GitHub repository

Consider that you are using CI/CD processes for your development, or you are managing all the deployment objects in GitHub. You might have created several StyleBooks for deploying your Citrix ADC configurations, and you are managing the StyleBooks in GitHub repositories. Now, you can directly import these StyleBooks into Citrix Applications and Delivery Management (ADM.) You don’t need to manually copy them out of GitHub and upload them into Citrix ADM.

You can now define a repository in Citrix ADM that represents a GitHub repository by providing the GitHub repository URL. You must provide your user name and password (or API token) created in GitHub. That means only authorized users who have a valid account in GitHub can import and sync StyleBooks.

After creating the repository, you can sync Citrix ADM with your GitHub repository. Citrix ADM imports StyleBooks found in that repository then validates them and adds them to the list of StyleBooks in Citrix ADM. StyleBooks are not added to Citrix ADM if they fail validation. You must correct the errors and commit updated versions into your GitHub repository. Later you can try importing them or syncing them again into Citrix ADM.

Note:

  • Currently, you can only import and sync StyleBooks that do not have dependent StyleBooks associated with them. That is, the StyleBook must have all the configurations it needs to be defined in one file.
  • The Sync from a GitHub repository needs to be initiated manually from the Citrix ADM GUI or API. That is, currently, importing of StyleBooks does not happen automatically based on GitHub commit activity.

You can currently import StyleBooks files from the master branch only.

Prerequisites

  • You must have a valid account in GitHub.

  • StyleBook files must exist at the root folder of the master branch in the GitHub repository.

Adding a repository and importing StyleBooks from GitHub

  1. In Citrix ADM, navigate to Applications > Configurations > Repositories.

  2. Click Add. In the Add Repository window, enter the following parameters:

    • Name. Type the name of the repository. This name can be the same as the repository name in GitHub or a different one.

    • Repository URL. Type the GitHub repository URL.

    • User name and password. Type the user name and password with which you access the GitHub account.

    Note: You can also provide the API token in place of a password. API tokens can be used instead of a password for GitHub over HTTPS. You can also use them to authenticate to the API over Basic Authentication.

  3. Click Create.

    localized image

    The repository is created in Citrix ADM.

  4. To import or sync StyleBooks, select the repository in the Repositories page, and click Sync.

The other actions that you can use here are:

  • Edit. You can edit the repository URL, user name, and password (or API token).

  • Delete. You can delete the repository along with all StyleBooks present in Citrix ADM that were imported previously from that GitHub repository.

    Note: you cannot delete a repository from Citrix ADM if it has any StyleBooks that have ConfigPacks associated with them.

  • Reset. You can remove all StyleBooks in Citrix ADM synced from that repository without actually deleting the repository entry from Citrix ADM.

  • List files. You can see a list of all StyleBooks present in Citrix ADM that originate from the GitHub repository.

localized image

Importing and synchronizing StyleBooks from GitHub repository