1. Using Oracle API Platform Cloud Service
  2. Manage Gateways
  3. Create a Logical Gateway

Create a Logical Gateway

Use the Management Portal or the createGateway action in the gateway installer to create a logical gateway.

This task describes how to create a logical gateway. See Understand Gateways and Gateway Nodes for a description of the relationship between logical gateways and gateway nodes. To install a gateway node, see Install a Gateway Node.

You can create a logical gateway from the Management Portal and from the command line installer. You can also create a logical gateway with the REST API for the Management Service in Oracle API Platform Cloud Service.

Option 1: Create a Logical Gateway in the Management Portal

Perform these steps in the Management Portal UI with a user with the Administrator or the Gateway manager role:

  1. Click Gateways Gateways in the navigation menu sidebar. If the navigation menu sidebar is hidden, click Show/Hide Navigation Menu Show/Hide Navigation Menu to show it. If the navigation menu is collapsed and you wish to view the text for the navigation items, click Expand Sidebar Expand Sidebar.

  2. From the Gateways list page, click Create.

  3. In the Gateway Name field, enter a name for the logical gateway.

  4. (Optional) In the Description field, describe the logical gateway you’re creating.

  5. Click Create.

    The logical gateway appears on the Gateway List page. The user who created the gateway is issued the Manage Gateway grant for it.

  6. Click the logical gateway you just created. The gateway’s Settings page, which displays the gateway’s ID and other details, appears.

  7. Provide the following details about your gateway, as applicable:

    • Load Balancer URL: If gateway nodes registered to this logical gateway are, or will be, placed behind a load balancer, provide HTTP and HTTPS URLs for the load balancer in the following format: http://<hostname or IP>:<port>/ for HTTP; https://<hostname or IP>:<port>/ for HTTPS.

    • Location: Describe the location of the nodes registered to this logical gateway.

    • Firewall: Configure firewall properties for nodes registered to this logical gateway.

      See Configure Gateway Firewall Properties.

Option 2: Create a Logical Gateway with the Gateway Node Installer

Perform these steps from a machine you’ve installed a gateway node to:

  1. Edit or add the following properties in the gateway-props.json file with details describing the gateway and the management tier:

    • nodeInstallDir

    • logicalGateway

    • gatewayNodeName

    • managementServiceUrl

    • idcsUrl

    • requestScope

      Note that you may also need to provide values for the managementServiceConnectionProxy property and other properties depending on your environment. See gateway-props.json File.

  2. Run the creategateway action.

    When you run this action, you are prompted for the following user credentials:

    • weblogic user: the WebLogic administrator user of the gateway node. These credentials are created when you run any of the install actions.

    • gateway manager user: the gateway manager user that is responsible for managing this gateway. You must provide the user’s name, password, client ID, and client secret. This user must already exist in the identity domain for your instance and must be assigned the Administrator or Gateway Manager role. This user is issued the Manage Gateway grant when the gateway is created. See Find Your Client ID and Client Secret.

    • gateway runtime user: the gateway runtime user that is used to download configuration from and upload statistics to the gateway. You must provide the user’s name, password, client ID, and client secret. This user must already exist in the identity domain for your instance and must be assigned the Gateway Runtime role. This user is issued the Node Service Account grant when the gateway is created. See Find Your Client ID and Client Secret.

    See creategateway.

The logical gateway is created on the Management Portal. The Gateway Manager user you specified is issued the Manage Gateway grant for the gateway and the Gateway Runtime user you specified is issued the Node Service Account for the gateway.