Intended audience

Catalog Admins who create and maintain the catalogs
Service Designers who can preview the content created or updated by Catalog Admins

Overview

Import public cloud provider templates, including CloudFormation, YAML, ARM, Terraform, Jinja, ROS, and Google Python, from the local file system into Enterprise Marketplace
Fetch public cloud provider templates from a Git repository
Customize the imported templates as Enterprise Marketplace catalogs
Export the catalogs as a compressed (.zip) file
Import any catalogs (from the export step) into a different Enterprise Marketplace Instance

Supported features

Provider Management
page:
Add catalogs to Enterprise Marketplace:
Import from local file system
Fetch from GitHub repository
View and manage the life cycle of stacks (Edit, Export, Publish, View stacks, Retire, Delete)
Service details
page:
Edit catalog name, category, possible quantity, features, details, logo, group, labels, and provider site link
View/Select configuration attributes
Configuration Parameters
page:
Add configuration groups, attributes, sections, and section attributes
Edit configuration groups, attributes, sections, and section attributes
Reorder configuration attributes within or across configuration groups
Delete configuration groups, attributes, sections, and section attributes

Preview from
Provider Management
and
Service Details
pages

Prerequisites

Must have the Catalog Administrator role in Enterprise Marketplace Platform to access the
Provider Management
page to manage the catalog’s life cycle.
Must have the Service Designer role in Enterprise Marketplace to access the
Provider Management
page to be able to preview the catalogs.
Must have the Provider Account Admin role to access the Enterprise Marketplace User
Admin Page
and to add a Git provider asset account.
Knowledge of public cloud provider native and Terraform templates (Terraform/ARM/CloudFormation/Google Python/Jinja/ROS).

Lifecycle of a service

Draft:
Imported catalogs that have not been edited yet.
Work in Progress:
The catalog is not yet available for provisioning. Any content package that you have edited automatically enters the Work in Progress state.
Published:
The catalog is available for provisioning.
Retired:
The catalog has been removed but is still available to be reactivated.
Deleted:
The service has been completely removed from the system. Only catalogs that are not in the Published state and do not have any stacks associated with them can be deleted.

Navigating the Provider Management page

Drafts:
Catalogs that are in the design process and not yet available to the users.
Published:
Catalogs currently available for provisioning by the users.
Retired:
Published catalogs that have been removed from the list.

Providers:
Filters the results displayed on the
Catalog Status
tabs by the list of providers enabled in Enterprise Marketplace.
Groups:
By default each catalog gets linked to a unique Catalog Group, which is used for versioning in Enterprise Marketplace. Public cloud providers do not support this feature yet. You can filter the results displayed on the
Catalog Status
tabs by Catalog Group.

View Details:
View the
Service Details
page for the catalog.
Publish/Retire:
Depending on the status, make the catalog available for provisioning or remove it from the list.
Delete:
Remove a published catalog from the system.

Export:
Export the catalogs as a compressed JSON file so they can be imported into another system.
View stacks:
View all stacks that have been created from this catalog.

Importing catalogs from content packages

On the
Provider Management
page, click
Add Services
.
Select one of the following options in the pop-up window and then click
OK
:
Import through Provider Account:
Create a catalog using a previously created provider account. For more information, see Importing from a GitHub repository.
Import from File:
Import a previously created catalog that you exported as a .zip file. For more information about content packages, see Exporting content packages.

Importing from a local file system

Click
Upload File
.
Browse to and select the file.
Click
Open
.
Click
Import
.

Importing from a GitHub repository

Select
Enterprise Marketplace Content Factory
.
Select the Asset Account that you want to use and click
OK
.
The discovery process begins. You will be sent an email when the process is complete.

Preferred practices

Ensure that the
icb_catalog_metadata.json
name is intact and valid.
Validate that the directory structure is created as per the public cloud provider requirements.
Validate the template to be imported according to the native cloud provider expectations.
Limit the size of your content pack .zip file to 10 MB.

Setting up Enterprise Marketplace Content Factory

Click the
Master Accounts
tab if needed.
Click
New Master Account
.
Click
Enterprise Marketplace Content Factory
.
Provide the following account details for the account:
Name:
Provide a descriptive name for the account.
Description:
Provide any details for the account.
Status:
Select whether the account is
Active
or
Inactive
.

Click the
Asset Accounts
tab.
Click
New Asset Account
.
Click
Enterprise Marketplace Content Factory
.
Provide the following account details for the account:
Name:
Provide a descriptive name for the account.
Description:
Provide any details for the account.
Account Number:
Enter the account number for the account.
Endpoint URL:
Enter the Git organization endpoint that you want the account to connect to.
Select Existing Master Account:
Select the master account that you just created.
Status:
Select whether the account is
Active
or
Inactive
.

Exporting content packages

To export a single catalog, click the
Actions
icon for the catalog and click
Export
.
To export multiple catalogs at the same time, select the catalogs that you want to export and then click
Export
on the selected items bar.

Customizing imported catalogs

Details page for the catalog

Service Details:
The basic information about the offering.
Configuration Parameters:
This tab allows you to associate configuration groups, sections, and attributes with the catalog. Configuration groups create boxes that are displayed to the user on the
Additional Parameters
page when they are ordering the catalog. These boxes are further divided into discrete areas based on sections. Both configuration groups and sections can contain attributes, which are fields that the user must fill out during provisioning. The configuration groups, sections, and attributes are displayed in the order that they are listed on this tab. If you want to change this order, click
Reorder
in the upper right and move them around as desired. For more information about configuration groups, sections, and attributes, see the following sections:
Managing attributes
Managing sections
Managing configuration groups
Pricing:
This tab shows the name of the pricing file associated with the catalog. To change it, click
Upload
and then browse to and open the file. The pricing file must be in JSON format and be a maximum of 5 MB. For more information, see Pricing in Enterprise Marketplace.

Customizing the look and feel of your catalog

Catalog Name:
Enter the name for the catalog. This name is listed in the catalog. Currently, there is no restriction on the characters allowed. The minimum number of characters is 1 and the maximum number is 64.
Features:
Provide a description of the catalog’s features to help users understand what it is. Currently, there is no restriction on the characters allowed. The minimum number of characters is 1 and the maximum number is 5000. You can use standard HTML coding in this field to customize the output.
Details:
Provide a description of what the catalog is intended to do. Currently, there is no restriction on the characters allowed. The minimum number of characters is 1 and the maximum number is 5000. You can use any standard HTML coding in this field to customize the output.
Upload Image
or
Remove Image:
Allows you to upload an image to be displayed to represent the catalog in the list. There is no limit on file size, but the preferred pixel resolution is 32 x 32. Browse to and select the file, then click
Open
. If you already have selected an image, click
Remove Image
to remove it. You must remove the old image before you can upload a new one.
Category:
Select a category for the offering from a list of predefined options.
Provider Site:
Provide the URL for the website of the service provider.
Labels:
Add meaningful labels for the catalog. Labels can be used by the buyer to filter the catalogs on the
Catalog
page.
Select Configuration Attributes:
Select all the attributes that you want to appear on the
Additional Parameters
page when the user is provisioning the catalog.
Enable support for multi-quantity:
(optional) You can set a maximum number of this catalog that can be provisioned.
Max Quantity:
If you selected
Enable support for multi-quantity
, use the slider to set the maximum quantity.
Version:
The version number of the catalog. This number cannot be modified.
Status:
This can be
Work in Progress
or
Draft
for Draft catalogs. The catalog is in
Draft
after being imported and will change to
Work in Progress
when it is edited.
Group:
This is a label that you can set up to help you search for the catalog on the
Provider Management
page. Groups are used in the Provider Management associate catalogs with an incremental version because versioning is currently not supported by public cloud providers. By default, each catalog is associated with a unique group. Groups are not visible to Buyers. They are used by Catalog Administrators to logically group the unpublished catalogs to efficiently manage them collaboratively.

Customizing the configuration visible to the buyer when they order the service

Managing attributes
Managing sections
Managing configuration groups

Managing attributes

Creating attributes

Navigate to the
Configuration Parameters
tab.
Click the
Actions
icon for a configuration group or section and select
Add Attribute
.
On the
New Attribute
page, enter the following information for the attribute:
Configuration Group Name:
Enter the name of the config that you want displayed on the UI while configuring a service. If you create this attribute within a configuration group, this parameter will already be filled in and will not be editable.
Section Name:
The name of the section within the configuration group. If you create this attribute within a section, this parameter will already be filled in and will not be editable.
Configuration Name:
Enter the name that you want displayed for this attribute (the field name) in the UI while configuring a service.
Description:
Enter any information that you want to provide to the user about the configuration. This text is available to the user as a tool tip while ordering the service to help them understand the purpose of the attribute during provisioning.
Required:
Determines whether this field is mandatory when the user is configuring the service.
Selected:
Allows a radio button or checkbox to be preselected when the service is being configured.
Editable:
Determines whether the field continues to be configurable after the service is provisioned.
Configurable:
Determines whether the field is configurable while the service is being provisioned during edit of the catalog.
Data Type
and
Input Type:
Determines which type of data the configuration will accept, and what subtype of data within that type the configuration will accept. See the table for the combinations that are currently supported.
Required:
Set the attribute as required to prevent the user from ordering the service without inputting data into this field. The field will be marked with a red asterisk on the UI.

Validation:
Enter a validation expression in Regex format to ensure that the text entered meets your rules.
Error Message:
Enter a warning message to be shown to the user when what has been entered does not comply with the Regex expression provided in the
Validation
field.
Minimum Size:
For
freetext
, this is the minimum acceptable number of characters. For
numberinput
, it is the lowest acceptable value.
Maximum Size:
For
freetext
, this is the maximum acceptable number of characters. For
numberinput
, it is the highest acceptable value.
Step:
The acceptable interval between numbers. For example, if the minimum size is 1 and the step is 2, acceptable numbers are 1, 3, 5, 7, 9, and so on.
Default Value:
Sets a value to be entered if the user does not specify something for this attribute.
Values:
This section is used to create selections when the
Input Type
is
checkbox
,
radio
, and
selectOne
. You can provide values in three ways:
Static Value:
Use this method when you want to provide discrete, finite, and constant values. You need to provide the following values:
Label:
This value will be displayed to the user in the UI while configuring the service.
Value:
This value will be used internally by the template while provisioning the service. Click
Add Row
to add more value and label combinations.
Derived Value:
Use this method when the value for a config depends on another config and the value is discrete, finite, and constant. The input for this type is JSON body. Derived values are currently not supported for IBM Cloud, Azure, Alibaba, and Google.
In the following example, the value of config depends on the “region” config. When the user selects a
us-east-1
value for region, then the config will display
US East 1A
,
US East 1B
, and
US East 1C
values in the UI. When the region value is "us-west-1" then value is
US West 1A
and
US West 1B
will be displayed in the UI.
{
"configId": "region" // parent configId,
"valueMap": [{
    "parentValueId": "us-east-1" // parent value for config region,
    "dependentValues": [{
            "valueId": "us-east-1a",
            "label": "US East 1A"
        },
        {
            "valueId": "us-east-1b",
            "label": "US East 1B"
        },
        {
            "valueId": "us-east-1c",
            "label": "US East 1C"
        }
    ]
},
{
    "parentValueId": "us-west-1" // parent value for config region,
    "dependentValues": [{
            "valueId": "us-west-1a",
            "label": "US West 1A"
        },
        {
            "valueId": "us-west-1b",
            "label": "US West 1B"
        }
    ]
}]
}
Derived from External Source:
Use this option when the value is fetched dynamically from the provider. The input for this type is JSON body. If any value in the params depends on another config, then provide the dependent config in ${configId} format. If you need to fetch data from an external system that is not OOTB, see Dynamic data fetching from external systems.

Changing attribute visibility

Editing attributes

In the
Details
page for the service, click the
Actions
icon for the attribute that you want to manage and click
View Details
.
Click
Edit
at the bottom of the window.
In the
Details
page for the attribute, edit the fields as needed. See Creating attributes for details about how to fill out the fields.
Click
Save
at the top of the page.

Deleting attributes

Managing sections

Number of Disks: 5
Disk 1: Type: RAID0, Size 1 GB
Disk 2: Type RAID1, Size 2 GB
Disk 3: Type Non RAID, Size 800 GB

- ConfigurationGroup1
  - Add Disk Section
      - Disk Type Attribute
      - Disk Size Attribute

Max:
How many sections (collection of attributes) the user can add while performing service configuration.
Repeatable:
If this is set to false, the max value is set to 1 and the user cannot add any more sections.
Removable:
Sections can be removed when editing the stack.

Creating sections

On the
Details
page for the group, click the
Actions
icon for the configuration group and select
Add New Section
.
On the
Add New Section
page, enter the following information:
Section Name:
Enter a unique name for the section. The maximum number of characters is 256. You can use any special characters.
Repeatable:
This determines whether the user can open multiples of the same section to create, for example, multiple VMs in the same order. Select whether this is
True
or
False
. If it is
True
, you will need to select a
Maximum Size
.
Removable:
This selection determines whether a section that the user creates during the provisioning process can then be removed. Select whether this is
True
or
False
.
Click
Save
.

Navigate to the
Configuration Parameters
tab.
Expand any Configuration Group.
Click the
Actions
icon for the section that you want and click
Add Attribute
.
Create the attribute. For more information, see Creating attributes.

Editing sections

Navigate to the
Configuration Parameters
tab.
Expand the configuration group that contains the section.
Click the
Actions
icon for the section and select
View Details
.
In the
Details
window for the section, click
Edit
.
Alter the fields as needed and then click
Save
. For more information about the fields, see Creating sections.

Deleting sections

Navigate to the
Configuration Parameters
tab.
Expand the configuration group that contains the section.
Click the
Actions
icon for the section and select
Delete
.

Managing configuration groups

Creating configuration groups

On the
Details
page for the catalog, click the
Configuration Parameters
tab.
Click
Add Group
.
Enter the following information for the group:
Name:
Enter a meaningful name for the group that will be displayed as the name of the group in the UI. The Configuration GroupID is a unique identifier that is generated by the system for the group name and cannot be changed.
Call to Validate:
Select
True
if you want the system to check that all fields have been completed properly when the user clicks
Next
while provisioning the service. This feature has not yet been implemented.
Create any
Visibility Rules
. Visibility rules allow you to show and hide attributes and sections based on prior selections. For example, you might want to change the subregions that the user can select based on the region that that person selects. Click
Add Config Rule
to add rules for attributes, and
Add Section Rule
for sections. These selections are only visible if you have attributes and sections, respectively, in the configuration group. If you want to remove a rule, click the
Trash Can
icon next to it.
You will need the Configuration GroupID and values handy to create visibility rules.
Each rule requires you to fill out the following fields:
Configuration Name
or
Section Name:
Select the attribute or section in the configuration group that you want to affect.
Hide Expression:
Enter a Regex expression to determine when you hide the attribute. Use the Configuration GroupID and Value that you want to determine the attribute’s status. For example, in the expression
newattribute_11276=’value9’
, if the field with the Configuration GroupID
newattribute_11276
is set to
value9
, then the associated attribute is hidden. For more information, see Customizing visibility.
Click
Save
.

Editing configuration groups

On the
Details
page for the catalog, click the
Configuration Parameters
tab.
Click the
Actions
icon for one of the configuration groups and select
View Details
.
On the
Details
window for the configuration group, click
Edit
.
Alter the details as needed, and then click
Save
. For more information about the fields, see Creating configuration groups.

Deleting configuration groups

On the
Details
page for the catalog, click the
Configuration Parameters
tab.
Click the
Actions
icon for the configuration group and select
Delete
.

Customizing visibility

Show/Hide configuration attributes

ConfigA
value1
value2
ConfigB
value3
value4

Show/Hide sections

ConfigA
value1
value2
SectionA
ConfigB
value3
value4

Configuration Group A
Config Name: VPC Attribute, Config ID: vpc_attr_1 (with below values):
Label: Create New, Value: true
Label: Use Existing, Value: false
New VPC Name
Existing VPC Name

Click
Add Config Rule
and select the
New VPC Name
configuration. In the
Hide Expression
field, add the rule
vpc_attr_1=='true'
.
Click
Add Config Rule
and select the
Existing VPC Name
configuration. In the
Hide Expression
field, add the rule
vpc_attr_1=='false'
.

Managing visibility by context combination

Array:
Multiselect
String:
selectOne
searchList
radio

In the
Provider Management
window, click
Add Services
.
Click the
Actions
icon next to the catalog you want to change and select
View Details
.
Click the
Configuration Parameters
tab.
Click the
Actions
icon for the parameter you want to adjust and select
View Details
.
Click
Edit
.
In the
Values
section, click
Add Context Combination
.
In the
Add Context Combination
window, select any combination of context and team.
In the
Make Available to Parameter Values
section, select the values that you want available to that combination.
Click
Save
.

Reordering configuration groups, sections, and attributes

Navigate to the
Configuration Parameters
tab.
Click
Reorder
in the upper right.
Click and drag the items as desired.
Click
Save
in the upper right.

Previewing catalogs

Navigate to the
Provider Management
page. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
Click the
Actions
icon for a catalog in the Draft or Work in Progress state and select
Preview
.

Known limitations

General limitations
Amazon Web Services
Microsoft Azure
Google Cloud Provider
IBM Cloud
Alibaba Cloud

General limitations

The sequence is mismatched between the
Configuration Parameters
page and the
Preview
page. When an attribute is added after a section, that attribute is displayed above the section. However, during the preview it is displaying after the section (which is expected).
All newly added sections are displayed below as they are grouped together.
An empty section is not visible during the preview.
Users are not able to delete multiple services from the Draft section.
Multiple services cannot be retired simultaneously by selecting multiple check boxes (feature is not implemented yet).
User is not able to unretire multiple services (feature is not implemented yet).
User cannot delete multiple services from the Retired state (feature is not implemented yet).
A new import job will not start if a previous job is still in progress.
When
Import from File
is performed after
Import from Provider Account
, the history displays the name of the provider account for the service that was imported from the file.
If an exported file is imported multiple times, the import only gets passed the first time. All subsequent attempts fail. Versioning is not supported so it is considered as a duplicate entry.
If the user exports any service from a server/tenant and tries to import it again on the same tenant, it fails because the service ID must be unique for every service on a particular tenant. If you want to onboard the same exported content on the same tenant/server, the user must add a unique service ID in all the required places in the exported content.
Users are unable to re-import servicified content that has been deleted.
If some services have been selected in the
Draft
tab and the user navigates to another tab, services in the same index from the list get auto selected on all tabs.
After entering valid credentials (GitHub token) and selecting
TestConnection
, the user gets an "Invalid Credentials" error message.
If you try to import a zip that contains files from multiple providers (such as Azure and Alibaba), then discovery gets completed for the Alibaba files and fails for the Azure files.
While adding a new attribute, if the user adds a validation on an attribute, the default value is not validated against the same validation rule.
The UI does not display multiple error messages returned by the APIs. Only the first error message is shown on the UI.
The
Search
field on the
Configuration Parameters
page is not functional.
The
Static Value
,
Derived Value
, and
Derived from External Source
fields are not properly hidden for some
Data Type
and
Input Type
combinations.
Validations are not added for the
Required
,
Selected
,
Editable
, and
Configurable
fields.
The “Edit Success” message is displayed even if the user clicks
Edit
but saves without making any changes.
When editing service details, there is no placeholder to edit the heading for each feature or add multiple descriptions.
Adding fixed sections is not currently supported.
While creating a configuration group, the
Call to Validate
does not currently work.
The section sequence on Configuration Parameters is as follows:
Configurations within a configuration group are always displayed at the top of the group.
A section within a configuration group is always displayed at the bottom of the group.
Reorder is working only for Attributes and not for Groups/Sections.
Empty sections are not visible on the
Additional Parameters
page when the user previews the service.
When users import an empty .zip file, the catalog does not send valid zip content to integration and the job gets failed.
Users can add multiple hide expressions for the same config (all providers except for Amazon Web Service).
A section/attribute name created with special characters like @#!%&... cannot be deleted.
A user can disable the
Required
property for configs that are discovered after servicification while editing the configuration attribute.
While editing service details, there is no placeholder to edit the heading for each feature or add multiple descriptions to one feature.
While adding a section there is no placeholder on the UI for
fixedSectionItems
.
A service cannot be published with empty configuration groups or sections.
A removable property for Section is applicable only for the EDIT catalog flow.
For existing tenants, user will have to explicitly set the
discoverContent
and
manageSOEnabled
flags to
true
.
Even if the array
'icbCatalogRepository'
in the
icb_catalog_metadata.json
file will have multiple objects defined for a particular provider with different sourcepaths added in it, it will discover the content from only one sourcePath.
If there are a lot of configuration groups, sections, and attributes for the catalog and the scrollbar is enabled on the page, re-order is not possible from the top of the page to the bottom.
The user cannot add multiple hide expressions for same configuration feature at this moment. If a second hide expression is added, then it will either overwrite the previous one (GCP and Alibaba) or generate an error message (all other providers).

Amazon Web Services

Data Type: String-Download and Input Type: Downloadable are not provided by the UI.
There is no
Description
field in the
Service Details
page so users cannot add a description for an onboarded native template.
The "Configure Region" config group is displayed at second position on the
Configuration Parameter
page. Ideally it should be on top for all the services.
Parsing of an AWS native YAML template (with short syntax form intrinsic functions) is technically not possible in
nodejs
for
cb-aws-catalog-int
. The
library'cfn-flip'
is the only Python library that can support AWS native YAML template conversion that is already supported in CLI-based servicification.
Even if the array
'icbCatalogRepository'
in the
icb_catalog_metadata.json
file has multiple objects defined for the AWS provider with different sourcePaths, it will only discover the content from one sourcePath.
The catalog does not support a user-defined
sourcePath:"somezipfile.zip"
file, so integration does not receive valid zip content and the job fails. However, if users define
sourcePath:"/"
and place the .zip file containing native templates in this directory, then servicification is successful.
The
Import Failed Count
field in the job status email always shows the count as 0 even if failures occurred during the job.
If the user edits a configuration attribute by changing the
Values
option from
Derived Value
to
Static Value
without providing any values for the
Static Value
option, then any
Derived Value
metadata that was saved earlier will be retained.

Microsoft Azure

If the source path of exported content has multiple compressed files, only the first
.zip
file will be considered for import.

Google Cloud Provider

The
Derived value
feature is not yet supported.
Nested
.zip
file structures are not supported.
The UI allows exporting services in WIP format, but this format is not supported from the integrations side. Therefore, the user will get a success message after exporting the WIP service, but the service will not be available in the zip file.

IBM Cloud

Cancel discovery from the
Catalog Admin
page is not yet implemented for IBM Cloud.
A pricing error is displayed if a user reorders the template's default configs into a new section.
Users cannot add
Derived From External Source
metadata without specifying a parent configID.
The
Derived value
feature is not yet supported.
If there are multiple Terraform files for a service, all files should be in a folder. Importing a
.zip
file containing more than one Terraform file for same service (
main.tf
,
variables.tf
,
provider.tf
) at sourcePath without being in a folder will not work.

Alibaba Cloud

The
Derived Value
feature is not yet supported.
The
Import Failed Count
field in the job status email always shows the count as 0 even if failures occurred during the job.
If you provide an empty section in the template, then that empty section will not be visible during preview.