Import and synchronize StyleBooks from GitHub repository
Consider a scenario where you are using CI/CD processes for your development. Or, a scenario where you are managing all the application source code and deployment objects in GitHub.
In the GitHub repository, you might have created several StyleBooks for deploying the NetScaler configurations and managing these StyleBooks. These StyleBooks are also required in NetScaler Console. Now, you can directly import these StyleBooks into NetScaler Console. You don’t need to manually copy them from GitHub and then upload them into NetScaler Console or manually synchronize the files in both NetScaler Console and GitHub.
You can now define a repository in NetScaler Console that represents a GitHub repository. Provide the GitHub repository URL and 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 NetScaler Console with your GitHub repository. NetScaler Console connects to GitHub and imports StyleBooks found in that repository. NetScaler Console then validates the StyleBooks and adds them to the list of StyleBooks in NetScaler Console. StyleBooks are not added to NetScaler Console if they fail validation. Correct the errors and commit updated versions into your GitHub repository. Later you can try importing them or syncing them again into NetScaler Console.
Note
StyleBooks files can be imported and synchronized from any branch of a GitHub repository.
You can import and synchronize StyleBooks that have dependent StyleBooks associated with them too.
The synchronization of StyleBooks from a GitHub repository must be initiated manually from the NetScaler Console GUI or API. That is, currently, importing and syncing of StyleBooks does not happen automatically based on GitHub commit activity.
Add a repository and import StyleBooks from GitHub repository
Before you begin, ensure you have a valid account in GitHub.
You can import StyleBook files to NetScaler Console from any folder in the GitHub repository.
-
In NetScaler Console, navigate to Applications > StyleBooks > Repositories.
-
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. For information on how to create API tokens for your GitHub repository, see the GitHub documentation for creating personal access tokens.
-
-
Click Create.
The repository is created in NetScaler Console.
-
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 NetScaler Console that were imported previously from that GitHub repository.
Note
You cannot delete a repository from NetScaler Console if it has any StyleBooks that have ConfigPacks associated with them. First, delete all the config packs of these StyleBooks. You can later remove the repository from NetScaler Console to clean up the StyleBooks from that repository.
-
Reset. You can remove all StyleBooks in NetScaler Console synced from that repository without actually deleting the repository entry from NetScaler Console.
-
List files. You can see a list of all StyleBooks present in NetScaler Console that originates from the GitHub repository.