Cloud Services

Cost & Asset Management

Registering a custom provider
Published On Oct 18, 2024 - 1:26 PM

Registering a custom provider

Enable custom providers, on-prem vRA and private cloud asset collector.
This feature is available for Cost and Asset Management Premium edition only. See your delivery representative for details.
Custom provider deployments can be on-prem or off-prem on IBM® Cloud. With
Cost & Asset Management (CAM)
, the user can enable its own custom providers. It can also enable the on-prem vRA, Private cloud asset collector, to pull in both asset and usage information from vSphere.
First, register a custom provider and then upload the Generic Provider Data (GPD) file. If the user does not have access to a properly formatted GPD file, can create a GPD file.
To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
To register a custom provider, make the following two API calls on the
Tenant
instance: one to add the provider metadata and one to add the vault adapter ID.
To access these APIs, click the
User
 icon located at the beginning of the landing screen and select
Developer Console
. For the application, select
Core
, and for the service, select
cb-credential-service
.
To add the provider metadata, make the following API call:
  • API endpoint - /cb-credential-service/api/v2.0/metadata/serviceProviders
    • Request Type - POST
    • Request headers - username, apikey, Content-Type
    • Request body - (as shown below)
 {
    "providerType": "test_private_cloud",
    "displayName": "test_private_cloud",
    "iconImage": "path of icon for this provider",
    "canSupportSubAccounts": true,
    "canDiscoverSubAccounts": false,
    "canDetachSubAccounts": false,
    "canDoTestConnection": true,
    "version": 1,
    "accountMetadata": {
    },
    "credentialMetadata": {
        "costIngestion": {
            "accessKey": {
                "type": "password",
                "canUpdate": true,
                "minLength": 5,
                "maxLength": 200,
                "isRequired": true,
                "displayLabel": "Access Key ID",
                "helpText": "Enter Access Key ID"
            },
            "secretKey": {
                "type": "password",
                "canUpdate": true,
                "minLength": 5,
                "maxLength": 200,
                "isRequired": true,
                "displayLabel": "Secret Access Key",
                "helpText": "Enter Secret Access Key"
            }
        },
        "provisioning": {
            "accessKey": {
                "type": "password",
                "canUpdate": true,
                "minLength": 8,
                "maxLength": 200,
                "isRequired": true,
                "displayLabel": "AccessKey ID",
                "helpText": "Add Access Key ID"
            },
            "secretKey": {
                "type": "password",
                "canUpdate": true,
                "minLength": 8,
                "maxLength": 200,
                "isRequired": true,
                "displayLabel": "Secret Access Key",
                "helpText": "Add Secret Access Key"
            }
        },
        "assetIngestion": {
            "accessKey": {
                "type": "password",
                "canUpdate": true,
                "minLength": 8,
                "maxLength": 200,
                "isRequired": true,
                "displayLabel": "AccessKey ID",
                "helpText": "Add Access Key ID"
            },
            "secretKey": {
                "type": "password",
                "canUpdate": true,
                "minLength": 8,
                "maxLength": 200,
                "isRequired": true,
                "displayLabel": "Secret Access Key",
                "helpText": "Add Secret Access Key"
            }
        }
    }
}
Response: 200 400 500 Internal server error
To add the vault adapter ID, make the following API call:
  • API endpoint - /cb-credential-service/api/v2.0/serviceProviders
    • Request Type - POST
    • Request headers - username, apikey, Content-Type
    • Request body - (as shown below)
 {
    "vaultAdaptorId": "2d8ff61d-a316-4b35-b27c-d2ee72fefa79",
    "serviceProviderName": "test_private_cloud",
    "serviceProviderType": "test_private_cloud",
    "serviceProviderCode": "test_private_cloud"
}
For more information about how to upload the GPD file, see Uploading files manually.
Do you have two minutes for a quick survey?
Take Survey