Add an organization

To integrate a new Apigee Edge for Private Cloud organization with API Hub, follow these steps:

  1. Create a plugin instance on API Hub:

    Create a new Plugin Instance within API Hub specifically for your new organization. This registers the organization and provides the necessary connectivity details.

  2. Configure the Apigee API Hub for Private Cloud connector:

    Next, update the Apigee API Hub for Private Cloud connector's configuration to include the details for your new organization.

    • Edit the file /opt/apigee/customer/application/uapim-connector.properties.
    • Add a new entry for your new organization to the connectorConfig within the conf_uapim_connector.uapim.settings.json section. Ensure this new entry mirrors the structure of existing organization configurations.

      For example:

      conf_uapim_connector.uapim.settings.json={
                "connectorConfig" : {
                  "org1" : {
                    "runtimeDataPubsub" : "",
                    "metadataPubsub":"",
                    "serviceAccount": "mysa1@in.myfirstProject",
                    "pluginInstanceId":"projects//locations//plugins/system-edge-private-cloud/instances/"
                  },
                  "new_org" : {
                    "runtimeDataPubsub" : "",
                    "metadataPubsub":"",
                    "serviceAccount": "mysa2@in.mySecondProject",
                    "pluginInstanceId":"bbbbb"
                  }
                },
                "runtimeDataPath":"/the/nfs/mounted/path",
                "managementServer": "hostname"
              }
      
    • After making the changes, restart the connector by running:
      apigee-service edge-uapim-connector restart
  3. Configure the message processors:

    Finally, update the message processors to enable dual-write capability for your new organization and its environments. This configuration must be applied on each message processor (MP) node in your Apigee Edge for Private Cloud installation.

    • Edit the file /opt/apigee/customer/application/message-processor.properties on each MP node.
    • Find the property conf_message-processor-communication_uapim.enabled.environments and append your new organization and its desired environments using the organization~environment format, separated by commas. For example, if your new organization is new_org with dev and staging environments:

      This is a comma separated list of all the environments for which the UAPIM runtime data on-ramp has to be enabled. conf_message-processor-communication_uapim.enabled.environments=acme~prod,acme~dev,noncps~prod,new_org~dev,new_org~staging

      path to the NFS mount which conf_message-processor-communication_uapim.runtime.data.path=/the/nfs

    • After updating this file on all relevant MP nodes, perform a rolling restart of your message processors for the new configuration to take effect.