Example: Usage Scenarios of Connecting Non-containerized API Gateway to API Control Plane using Properties

Edit online

This use case outlines the procedure to connect IBM webMethods API Gateway deployed in non-containerized environment (Installer) with API Control Plane using properties.

To establish the connection, configure API Control Plane agent through a set of properties.

  1. Configure API Control Plane agent.
    Add the following properties under Java Additional Parameters in the custom_wrapper.conf file located at Install_dir\profiles\IS_default\configuration and save the file:
    
wrapper.java.additional.306=-Dapigw_cp_agentConfig_enabled=true
wrapper.java.additional.307=-Dapigw_cp_agentConfig_runtimeConfig_runtimeName=demo-props
wrapper.java.additional.308=-Dapigw_cp_agentConfig_controlPlaneConfig_controlPlaneURL=http://localhost:81/
wrapper.java.additional.309=-Dapigw_cp_agentConfig_controlPlaneConfig_username=<username>
wrapper.java.additional.310=-Dapigw_cp_agentConfig_controlPlaneConfig_password=<password>
wrapper.java.additional.311=-Dapigw_cp_agentConfig_runtimeConfig_description="My test description"
    Note: API Control Plane URL must be specified with http protocol.
  2. Start webMethods API Gateway instance.
  3. Access API Control Plane with the following url,
    • https://localhost:8080 if API Control Plane is deployed using Docker with the default configurations specified in the GIT Hub repository.
    • https://my-control-plane/ if API Control Plane is deployed using Helm with the default configurations specified in the GIT Hub repository.
  4. Verify if the connection is established between webMethods API Gateway and API Control Plane. If webMethods API Gateway is successfully connected with API Control Plane, the name and status of webMethods API Gateway gets auto populated on the dashboard and Runtimes screen in the API Control Plane application.