Repositories

Itential Platform supports the configuration of Repositories. This means that a user can provide configurations to fetch Pre-Built Automations from multiple repository locations as well as install and manage those Pre-builts in a single IP environment.

On this page, the minimum requirements to have a functioning repository in Itential Platform are defined. Instructions on how to create, manage, and delete these Pre-built Automation repository configurations are provided also.

Repository Configuration Properties

The configuration properties for the @itentialopensource Pre-built Automation repository are configured by default on startup of IP.

The following properties are required for a Pre-built Automation repository configuration.

Sample Repository Configuration

Below is a sample configuration for repoConfigs.

{
    ...
    "repoConfigs": {
        "@itentialopensource": {
            "enabled": true,
            "versionStatus": "current",
            "type": "gitlab",
            "hostname": "gitlab.com",
            "path": "itentialopensource/pre-built-automations",
            "credentials": {
                "token": "TOKEN STRING"
            }
        }
    }
    ...
}

Supported Repository Types

The type property of repoConfigs can only be set to the types supported within Itential Platform such as the following:

Managing Repository Configurations

The Repositories sidebar menu in Admin Essentials allows a user to manage their repository configurations. A user has the ability to create, edit, or delete a configuration. In addition to these options, a user can also select to View All which will allow the user to view all of the repository configurations currently on the system. Editing the repository configurations can be done from the Repository Config details page.

Figure 1: Admin Essentials Repositories

Figure 2: Manage Repository Configurations

Figure 3: Edit Repository Config

Adding a New Repository

A user can create a new repository configuration by going to the Repositories menu item of the Pre-built section of Admin Essentials and selecting the Create button in the upper left button bar. A dialog will appear, prompting the user to fill in the Configuration Properties.

A user can also create a new repository configuration without using the UI. An API request can be sent to POST /prebuilts-repository/configs with a request body of the following:

{
    "name": "test",
    "config": {
        "enabled": true,
        "versionStatus": "current",
        "type": "gitlab",
        "hostname": "gitlab.com",
        "path": "itentialopensource/pre-built-automations",
        "credentials": {}
    }
}

Editing a Repository

A user can edit an existing repository configuration by going to the Repositories menu item of the Pre-built section of Admin Essentials and selecting Edit repository details. A dialog will appear, prompting the user to modify each property that can be edited.

Connecting or Disconnecting a Repository

A user can connect or disconnect an existing repository configuration by going to the Repositories menu item of the Pre-built section of Admin Essentials and selecting the target configuration. A dialog will appear with all of the existing properties for the selected repository configuration. At the top of the dialog there is a toggle that can be switched on/off which represents the repository configuration being 'connected' or 'disconnected'.

Deleting a Repository

A user can delete an existing repository configuration by going to the Repositories menu item of the Pre-built section of Admin Essentials and selecting the target configuration. Then choose "Delete" in the more button at the upper right side. A dialog will appear, prompting the user to select a repository configuration to delete.

Viewing Installed Pre-Builts from Different Repositories

Installed pre-builts from different repositories will appear under the Pre-builts tab in Admin Essentials. Each repository config will be listed as a collapsible menu, with the pre-builts from that config listed under it. Pre-builts from connected repositories will have update icons if they are out of sync; pre-builts from disconnected repositories will not check the repository for updates. In addition, pre-builts from deleted repositories will not check for updates (as the repository is no longer accessible), and will also be moved under a local namespace in the sidebar.

The dropdown menu within the Pre-builts Catalog also allows the user to choose which repository to query when getting a list of pre-builts. This interface limits the query to only one repository at a time.