Libraries represent a collection of logically grouped artifacts (scripts, files, and resources) from one or more configured repositories. Libraries are used within the blueprint canvas to reference the artifacts in a more intuitive manner than an unsorted list of artifacts.
By default, there are two system-managed libraries:
- Scripts; and
- Variable Sets
System-managed libraries cannot be managed and are automatically populated with scripts and variable sets added by Broker administrators.
In addition to system-managed libraries, libraries are provided by plugins. When such a plugin is enabled, its supported libraries can be viewed and managed.
Note: Libraries cannot be added manually.
This article describes the steps required to manage libraries.
Accessing Libraries
This section describes the steps required to access Libraries.
Prerequisites
- Administrative access to the Broker UI
Procedure Steps
- Login in the the Broker UI as an administrative user
- Navigate to Manage > Libraries
- Click the library name or the View button to view the library's contents
Library Content Operations
The following table lists the management operations available to artifacts within a library.
Operation | Description |
Edit | Modify the name or description of the artifact |
View Repository | View the details of the artifact's parent repository |
Preview |
View the contents of the artifact Note: Artifacts are read-only objects |
Remove | Remove the artifact from the library |
Adding Contents to Libraries
Library objects are added from configured repositories.
When a plugin is enabled, the plugin notifies the broker that it supports libraries, as well as the file type for the libraries which it supports. Repository items which have matching file types are available to be added to the supported libraries.
This section describes the steps required to add artifacts to a library.
Prerequisites
- Administrative access to the Broker UI
- Plugin enabled which supports libraries
- Repository added which contains supported library file types
Procedure Steps
In this example, the Azure service provider plugin supports a library for ARM Templates with the JSON file type. This procedure will add JSON files within a repository to the ARM Templates library.
- Login in the the Broker UI as an administrative user
- Navigate to Admin > Control Panel
- Select the Repositories tile
- Click the repository name or the View button to view the repository contents
- Select the Files tab and locate the ARM template JSON file to add to the library
- From the Add as Artifact drop-down menu, select Add to Library
- On the Add to Library screen, provide the following information:
- Choose a Library: Select the library to which the artifact should be added
- File: A read-only field which displays the artifact file name
- Label: A friendly name for the artifact
- Description: A description for the artifact
- Click OK
- A status message confirms that the artifact has been added to the library
- The library artifact can now be used in the blueprint canvas