Repositories allow artifacts such as scripts and files which are stored on an external version control or repository management system to be synchronised and used in Blueprints within the Broker Composer.
The supported repository types include:
- Git
- SMB Share
This article describes the steps required to manage repositories. Refer to the article Using Repositories for details steps in browsing and using artifacts within an existing repository.
Adding a Repository
Refer to the relevant procedure steps for the the repository type:
Testing Repository Connectivity
Testing connectivity to the repository ensures that the entered credentials correctly allow the Broker to communicate with the repository provider.
This procedure describes the steps required to perform a test on a configured repository.
Prerequisites
- Administrative access to the Broker UI
Procedure Steps
- Login in the the Broker UI as an administrative user
- Navigate to Admin > Control Panel
- Select the Repositories tile
- Select the drop down menu next to the repository, click Test
- A status message will confirm the result of the test
- Script and file artifacts from the added repository are now ready for use in Broker blueprints
Performing Repository Synchronisation
After a repository has been configured and tested, a synchronisation can be performed to discover the repository items.
Once synchronisation has completed, the files within the repository are available for use (eg. as artifacts or library objects). Refer to the article Repository File Management for detailed steps.
This procedure describes the steps required to initiate a synchronisation of a configured repository.
Note: Repositories will automatically synchronise on a schedule once added (auto sync).
Prerequisites
- Administrative access to the Broker UI
Configuration Steps
- Login in the the Broker UI as an administrative user
- Navigate to Admin > Control Panel
- Select the Repositories tile
- Select the drop down menu next to the repository, click Synchronise
- A status message will confirm that the synchronisation task has been scheduled
- The status of the tasks can be monitored via the notifications bar - it may take a few minutes to complete depending on the number of resources
Removing a Repository
A repository can be removed from the Broker if it is no longer in use. When a repository is removed, all artifacts associated with the repository are also removed. Any blueprints using these are artifacts will display a validation error until the artifact node is re-linked to another artifact.
This procedure describes the steps required to remove a repository.
Prerequisites
- Administrative access to the Broker UI
Procedure Steps
- Login in the the Broker UI as an administrative user
- Navigate to Admin > Control Panel
- Select the Repositories tile
- Select the drop down menu next to the repository, click Remove
- Click Remove on the confirmation dialogue
- A status message will confirm that the repository has been removed