Importing workflows from a Git repository - Platform - BlueCat Gateway - 22.4.1

Gateway Administration Guide

Product name
BlueCat Gateway

You can import workflows into BlueCat Gateway either from the BlueCat Labs public GitHub repository or a private Git repository.

Note: When importing workflows from the BlueCat Labs public Git repository, you do not need to restart the Gateway container when using Git Import; you only have to set permissions on the workflows.
Note: The import workflow feature is also available as a REST API call. For more information, please refer to Import workspaces.
When using Git import, the following limitations apply:
  • You must have Internet access to perform this operation.
  • To set which workflow directories, customization directories, or snapshots to import, you must have the git-config.json file in your Git repository at the top level. Refer to the folder as an example. The git-config.json file contains the following code:
    	"workflows": ["Examples"],
    	"customizations": "customizations",
    	"snapshots": "snapshots"
    Each line specifies the folder location. For example, "workflows" specifies the folder where the workflows exist and "customizations" specifies the folder where the customizations exist.
    Note: If the "customizations" and "workflows" lines are blank, the fields are ignored.
  • The import operation stores old workflows in a backup-storage folder in the bluecat_portal directory.
  • If an existing workflow or an endpoint with the same name already exists, you can delete the existing workflow or endpoint by selecting the Clear Existing Workflows in Custom Workspace option.
  • The system always gets the workflows from the branch you specified in the GitHub URL or in the GitLab Project Branch field. Ensure you are using the latest BlueCat Gateway version before downloading.
  • Permissions set on existing workflows will be inherited by the newly imported workflows from Git. If necessary, BlueCat recommends that Gateway administrators review permissions for the Example workflows after they have been imported.

The workflows reside in the following folder:

  • Examples—contains the example workflows provided by BlueCat. These example workflows serve as templates of the kind of workflow that can be built, and are also examples of BlueCat best practices for UI components and API usage. Each BlueCat Gateway release has a corresponding tag that can be used to download the version that is guaranteed to be compatible with that release.