Configuring Noname collector for API discovery

Using the Noname collector, you can discover APIs from the Noname environment. This document provides step-by-step instructions to add a Noname data source collector to your API discovery capability.

1. Create a service account in the Noname environment by completing the following steps:
   1. Log in to the Noname security host.
   2. From the Menu bar, click Settings.
   3. From the side navigation panel, click User Management.
   4. Select the Service Accounts tab and then click Create Service Account.
      Tip: Using the service account, you can retrieve a Client ID and a Client Secret.
2. In the Helm directory, open the values.yaml file.
3. Update the following parameters based on your API Connect provider organization and authentication.

   • noname.host_name

     The hostname of the Noname securities.

   • noname.client_id

     Client ID configuration.

   • noname.client_secret

     Client secret configuration.

     The Client Secret is added to a Kubernetes secret as part of the deployment and then mounted on the collector deployment pod.

   • discovery.datasource_name

     The data source name for all APIs discovered by the Noname collector.

     If data source name is empty, the collected API namespace is used.

   • discovery.platform_api_prefix

     The Platform API prefix has a default value of platform-api, the same as the prefix value for API Connect on Cloud. You can change it to match your system setup when it is different from the default.

   • discovery.apic_host_domain

     Domain name of the API Connect instance where the discovered APIs are sent. For example, us-east-a.apiconnect.automation.ibm.com.

   • discovery.provider_org

     The provider organization name of the API Connect manager.

   • discovery.api_key

     You can obtain an API key from the API Manager for a user who has permission to post the API.

     For more information about obtaining the API key, see Managing platform REST API keys.

     The API key is added to the Kubernetes Secret during deployment and then mounted on the collector pod.

   • discovery.namespace

     The namespace where the Noname collector is deployed in your cluster.

   • logging.log_level

     Default log_level is debug.

   • images.api_discovery_noname_collector

     Update this property to upgrade the Noname collector deployment.

     Note: Update the collectors periodically to maintain compatibility with the Discovery service.

   The following example depicts sample parameters of values.yaml file:

   
   host_name: noname_domain
   client_id: xxxxxx
   client_secret: xxxxxx
   discovery:
   datasource_name: ibmsec-data-source
   platform_api_prefix: platform-api
   apic_host_domain: us-east-a.apiconnect.automation.ibm.com
   provider_org: myOrgName
   api_key: xxxxxx
   namespace: default
   logging:
   log_level: debug
   images:
   api_discovery_noname_collector: ghcr.io/ibm-apiconnect/api-discovery-noname-collector:7-2025-04-16-18-39-15

4. Save the values.yaml file.
5. Run the following command to deploy the collector.

   helm template . | kubectl apply -f -

   The output indicates that the required Kubernetes resources are deployed for the Noname collector.

   secret/noname-client-secret created
   secret/noname-porg-secret created
   service/management-api-discovery-noname-collector created
   deployment.apps/management-api-discovery-noname-collector created

   After the collector is deployed, any APIs that are discovered are sent to the API Connect Discovery service.

   When the collector sends the first OpenAPI documents to your provider organization, you can view the collector that is listed in the Sources tab in the Discover section in API Manager. You can review the discovered APIs by selecting the APIs tab under the Discover section of API Manager. For more information, see Reviewing your discovered APIs.

   Tip: You can uninstall the collector from Helm by running the following command.

   helm template . | kubectl delete -f -

6. To view the collector, and any traffic being received, log in to your provider organization by using API Manager.
7. In the navigation panel, click the Discover icon , then click the Sources tab to view your Noname collector.
   Sources have the following status:

   Enabled

   The source is enabled, and synchronizes with the collector according to its configuration.

   Disabled

   The source is disabled, and API Connect won't accept any files from the collector. This status is set by the discovery service if a discovery operation fails.

   Unhealthy

   The source collector is unavailable.

   Paused

   The source is paused, and API Connect won't accept any files from the collector.

8. Optional: To change the source status, click the Options icon next to the source.
   • Pause collector - To pause the source.
   • Delete collector - To delete the source from API Manager. The external source files are not deleted.
   • Resume collector - To restart a paused or disabled source.