Customizing the IBM Cloud catalog for an enterprise
As the account owner or administrator, you can manage which products in the IBM Cloud® catalog are available for your enterprise. You can choose to include all products, a set of products, or only certain products. You can also specify what level of the enterprise hierarchy the filters apply to. And, you can further restrict which products are available for a specific account group or account.
Before you begin
- Set up your enterprise.
- Make sure that you have the administrator role on the catalog management service.
Managing products at the enterprise level
Centrally manage what's available in the catalog for your entire enterprise hierarchy by setting filters at the enterprise level. The filters automatically apply to all child account groups and accounts.
Let's say your organization is tasked with implementing a development and deployment model that's focused on improved speed, quality, and control. You might choose to restrict the catalog to IBM products only that are related to DevOps technologies for all members in your enterprise.
-
Go to Manage > Catalogs > Settings in the IBM Cloud console.
-
Select Exclude all products in the IBM Cloud catalog.
-
Select one or more filters to customize which products are available. In the case of our example, select the following filters:
- Category > Developer tools
- Provider > IBM
-
Review the Preview table to confirm your selections, and click Update.
-
Verify your updates in the catalog by going to Catalog > Services.
-
Expand the list of accounts in the console menu bar and select a child account to verify that the catalog includes only the products you selected.
Managing products for child account groups and accounts
To build on the example in the previous section, all account groups and accounts in your enterprise have access to Developer tools products provided by IBM. You can further restrict access to a subset of products for child account groups and accounts. For example, you might want to limit a specific account group, and its child accounts, to work with only the products that are Financial Services Validated.
- Go to Manage > Catalogs > Settings in the IBM Cloud console.
- Expand the enterprise hierarchy, and select the specific account group.
- Select Exclude all products in the IBM Cloud catalog.
- Select Compliance > Financial Services Validated.
- Review the Preview table to confirm your selections, and click Update.
- Switch to a child account in the account group by selecting it from the list of accounts in console menu bar.
- Verify your updates in the catalog by going to Catalog > Services.
Managing products at the enterprise level by using the CLI
This action can be done only in the console or through the API or SDKs. To see the steps, switch to the UI or API instructions.
Managing products for child account groups and accounts by using the CLI
You can restrict access to a subset of products for child account groups and accounts. For example, within your enterprise you might want to limit a specific account group, and its child accounts, to work with only the products that are Financial Services Validated.
-
Create a new filter.
ibmcloud catalog filter create [--catalog CATALOG] [--category CATEGORY] [--compliance COMPLIANCE] [--deployment-target TARGET] [--exclude-list LIST] [--include-all ALL] [--include-list LIST] [--offering-format FORMAT] [--pricing-plan PLAN] [--provider PROVIDER] [--release RELEASE] [--type TYPE]
If you don't specify the
--catalog CATALOG
command, the filter is created at the account level. -
Target an account group by specifying the command option
--account-group ACCOUNT GROUP
. -
Update the filter to include or exclude a particular product or products. See the Catalog management CLI guidance for command options or run the
ibmcloud catalog filter options
command to retrieve the filter options for each filter category.
Managing products at the enterprise level by using the API
Centrally manage what's available in the catalog for your entire enterprise hierarchy by setting filters at the enterprise level. The filters automatically apply to all child account groups and accounts.
String id = "{id}";
String revision = "{revision}";
String accountFilters = {accountFilters};
ReplaceCatalogOptions replaceOptions = new ReplaceEnterpriseOptions.Builder().enterpriseId(id).id(id).rev(revision).accountFilters(accountFilters).build();
Response<Catalog> response = service.replaceEnterprise(replaceOptions).execute();
System.out.println(response.getResult());
id = "{id}";
revision = "{revision}";
accountFilters = {accountFilters};
response = await service.replaceEnterprise({ 'enterpriseId': id, 'id': id, 'rev': revision, 'accountFilters': accountFilters, });
console.log(response);
id = "{id}"
revision = "{revision}"
accountFilters = "{accountFilters}"
response = self.service.replace_enterprise(enterprise_id=id, id=id, rev=revision, account_filters= accountFilters)
print(response)
id := "{id}"
revision := "{revision}"
accountFilters := {accountFilters}
replaceOptions := {replaceOptions}
replaceOptions := service.NewReplaceEnterpriseOptions(id)
replaceOptions.SetID(id)
replaceOptions.SetRev(revision)
replaceOptions.SetAccountFilters(accountFilters)
response, _ := service.ReplaceEnterprise(replaceOptions)
fmt.Println(response)
Managing products for child account groups and accounts by using the API
You can restrict access to a subset of products for child account groups and accounts. For example, within your enterprise you might want to limit a specific account group, and its child accounts, to work with only the products that are Financial Services Validated.
The following example request restricts the products for an account group and child accounts. When you call the API, replace the ID variables with the values that are specific to your target account group or account. The options for {account_filters}
are: inculde_all
, category_filters
, and id_filters
.
String id = "{id}";
Filters accountFilters = {accountFilters};
UpdateCatalogAccountOptions updateOptions = new UpdateCatalogAccountOptions.Builder().id(id).accountFilters(accountFilters).build();
Response<Void> response = service.updateCatalogAccount(updateOptions).execute();
System.out.println(response.getResult());
id = "{id}";
accountFilters = {accountFilters};
response = await service.updateCatalogAccount({ 'id': id, 'accountFilters': accountFilters });
console.log(response);
id="{id}"
accountFilters={accountFilters}
response = self.service.update_catalog_account(id=id, account_filters=accountFilters)
print(response)
id := "{id}"
accountFilters := {accountFilters}
updateOptions := service.NewUpdateCatalogAccountOptions()
updateOptions.SetID(id)
updateOptions.AccountFilters(accountFilters)
response, _ := service.UpdateCatalogAccount(updateOptions)
fmt.Println(response)