Cloud Services

Enterprise Marketplace

Template management using the Bring Your Own Catalog Item tool
Published On Nov 06, 2024 - 7:20 AM

Template management using the Bring Your Own Catalog Item tool

Learn about the Bring Your Own Catalog Item tools UI in Kyndryl Modern Operations Applications.
The following tools are available for Bring Your Own Catalog Item in the Enterprise Marketplace user interface.

Importing templates using the UI

Importing templates can only be performed by the Catalog Admin role; to begin the process, complete the following steps:
  1. Click the
    Open menu
     icon in the upper left and select
    Enterprise Marketplace
     →
    Provider Management
    .
  2. On the
    Provider Management
     page, click
    Add Services
    .
  3. In the
    Choose an option to import service
     window, select from the following options:
    • Import through Provider Account:
       Allows you to select from provider accounts that you have previously set up. This action imports the services directly from the provider.
    • Import from File:
       Allows you to import a JSON file of catalogs that you previously exported. This process can be used to create catalogs on multiple instances.

Importing through provider accounts

The option allows you to import the templates directly from the provider. Before you can do this, you must set up a provider account.
If you want to import from provider accounts, begin the process using the steps in the previous section, then continue with the following steps:
  1. In the
    Choose an option to import service
     window, select
    Import through Provider Account
     and click
    OK
    .
  2. On the
    Catalog Discovery
     page, click the provider account that you want to import for. If multiple accounts are present, select one of them using the drop-down menu and click
    OK
    .
  3. A window is displayed telling you that the discovery process has started and that you will receive an email when it is complete. Click
    OK
    . All catalogs are imported in the Draft status.

Importing from file

This option allows you to import files that were previously exported from another environment. The file type must be
.zip
 and the maximum file size supported in 10 MB.
You can successfully export a .zip file that is larger than 10 MB, but the import of that file will fail.
If you want to import from a file, begin the process using the steps in the Importing templates using the UI section, then complete the following steps:
  1. In the
    Import from File
     window, select
    Upload File
     and click
    OK
    .
  2. Select the desired .zip file from the list and click
    Open
    .
  3. Click
    Import
    . All catalogs are imported in the Draft status.

Checking your import

The next step is to make sure that everything imported correctly by clicking the
History
 link under the associated provider in the navigation pane. A complete list of all discoveries is shown, including a count of the number of catalogs discovered and imported. If a failure occurred, click the
View Details
 link to see which catalogs failed.

Naming conventions

If there is only one JSON file in the source directory, the catalog name will be the name of the JSON file. If there are multiple directories in the source directory, the catalog name will be the name of the directory that the JSON file was found in, a hyphen, and the name of the JSON file.

Managing catalogs

After catalogs are imported, they are integrated into the system in Draft status. The
Provider Management
 page provides a list of all catalogs broken down into the following tabs:
  • Drafts:
     Catalogs that have been imported but not yet active in the system.
  • Published:
     Catalogs are shown in the catalog and are available for provisioning.
  • Retired:
     Catalogs that are no longer displayed in the catalog but are available to be reactivated.
You can also use the navigation pane on the left side to search by
Provider
 and
Groups
. You can also search by keywords in both the main page and the navigation pane.

Actions available

The following actions are available for each catalog:
  • View Details:
     Opens the details page for the catalog where you can view and edit the catalog. For more information, see Inventory management. This view can be used to edit the
    Category
     and
    Tags
    .
  • Export:
     Export the catalog so that it can be used in another environment.
  • Preview:
     Allows you to go through the configuration flow of the catalog, which are the steps the user will need to go through to provision the catalog. It is intended to test this process. This option is only available to the Service Designer role.
  • Publish
     or
    Retire:
     Either makes the catalog visible or no longer visible in the Catalog.

Editing catalogs

If you want to edit a catalog, complete the following steps:
  1. Click the
    Actions
     icon for the catalog and select
    View Details
    .
  2. On the
    Details
     page for the catalog, you can edit the following fields:
    • Select Category:
       You can select a category from a list of preset options.
    • Labels:
       Select a tag from a list of user-defined options.
    • Pricing:
       Select a pricing policy from a list of user-defined options.
  3. Click
    Save
    .

Selecting multiple catalogs

In addition to working on individual catalogs, you can select multiple catalogs by selecting the checkboxes for them. The following options will appear on the toolbar when you select multiple catalogs:
  • Publish
     or
    Retire:
     Either makes the catalogs visible or not visible in the catalog.
  • Export:
     Export the catalog so that it can be used in another environment.
There is a limit of 10 MB for exported .zip files. If your file is larger than this, it will export successfully, but will not be able to be imported.

Exporting catalogs

The Bring Your Own Catalog Item tool can also be used to import files in JSON format that have been exported from other environments. If you want to export catalogs so they can be used in other environments, complete the following steps.
The sourcePath can include multiple templates. However, each catalog must be in a separate folder named after the service ID of the contents. If multiple catalogs are included in a single folder, the system will only import one of them.
Microsoft Azure allows the use of simple templates that can contain multiple resources in the
/singleserv
 directory.
If you want to export templates, click the
Actions
 icon for the catalog and select
Export
.
The first time that you do this, you will be prompted to designate a location for the download.
Do you have two minutes for a quick survey?
Take Survey