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

Gateway Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
23.1

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 the Git Import feature. You need only set permissions on the workflows.
Note: Importing of worklfows is also available as a REST API call. For more information, please refer to Import workflows HTTP API.

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 include the git-config.json file in your Git repository at the top level. This file specifies the folders where the new content should be stored. You can find examples of this configuration file in the http://github.com/bluecatlabs/gateway-workflows folder.

    The git-config.json file looks like the following:
    {
    	"workflows": ["Examples"],
    	"customizations": "customizations",
    	"snapshots": "snapshots"
    }

    Each line specifies the folder location. For example, "workflows" specifies the folder where workflows are stored and "customizations" specifies the folder where customizations are stored. If the "customizations" and "workflows" lines are blank, those 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.

Tip:

The Examples folder contains example workflows provided by BlueCat. These serve as templates of the kind of workflows that can be built and illustrate 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.