Manage Gateway Nodes in the API Platform Cloud Service Management Portal

Manage registration, polling intervals, and proxies for each of your gateway nodes in the Oracle API Platform Cloud Service - Classic Management Portal.

Topics

• Understand Gateway Node Details

• Register a Node to a Logical Gateway

• Approve a Gateway Node Registration

• Changing the Node Polling Interval

• Configuring a Proxy for a Gateway Node

• Unregister a Gateway Node

Understand Gateway Node Details

The Nodes page displays details for all nodes known to a gateway.

The Active tab displays all active gateway nodes. The name, description, and host is shown for each gateway.

The Requesting Registration tab displays gateway nodes that are requesting registration but have not yet been approved. The name, description, and host is shown for each node. The name of the user requesting the registration and the time the request was made are also displayed.

The Rejected tab displays gateway nodes that have requested registration, but have been rejected.

Tip:

Click Dismiss to clear a gateway node from the Rejected tab.

Register a Node to a Logical Gateway

Use the join node installer action to register a node to an existing logical gateway on the Management Portal. If you want to create a new logical gateway and register a node to it, use the create-join action instead.

Tip:

You can also register a node to a logical gateway with the REST API for the Management Service in Oracle API Platform Cloud Service.

To register a node to a logical gateway:

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

   • logicalGateway

   • managementServerHost

   • managementServerPort

   • (Required for create-join actions only): publishAddress

   See gateway-props.json File.

2. Run the join action to register a node to an existing logical gateway, or run the join action to create a new logical gateway and register a node to it

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

   • weblogic user: the WebLogic administrator user of the gateway node.

   • gateway manager: the Gateway Manager user that is responsible for managing this gateway. This user is issued the Manage Gateway grant when the gateway is created.

   • gateway runtime user: the Gateway Runtime user that is used to download configuration from and upload statistics to the API Platform Cloud Service Management Portal. This user is issued the Node Service Account grant when the gateway is created.

   See join and create-join.

3. Sign in to the Management Portal with the Gateway Manager user specified in the previous step and approve the node registration.

The node is registered to the logical gateway 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.

Approve a Gateway Node Registration

A gateway manager or administrator issued the Manage Gateway grant must approve node registrations before APIs can be deployed to the gateway. Approve a gateway registration in the Management Portal. Gateway Managers must be issued the Manage Gateway grant for a gateway to approve node registrations to it.

To approve a gateway registration:

1. From the Gateways List page, click the gateway for which you want to approve node registrations
2. Click the (Nodes) tab.
3. Click the Requesting tab.
4. Hover over the gateway node registration you want to approve, and then click Approve. Click Reject to reject the registration instead. You can see rejected requests on the Rejected tab.

The registration is approved. You can now manage the gateway node in the Management Portal.

Changing the Node Polling Interval

Configure how regularly a gateway node polls the management tier for the logical gateway definition.

When a node polls the management tier and the definition for the gateway it is registered to differs from its current shape, the node updates itself to match the definition from the management tier. See Understanding Gateways and Gateway Nodes for an explanation of gateways and gateway nodes.

Gateway Managers must be issued the Manage Gateway grant for a gateway to change the polling interval of a node registered to it.

Note:

Different nodes belonging to a gateway can have different polling intervals. Nodes registered to the same gateway may not have the same endpoints or API iterations deployed, depending on the delay between polls from each node.

1. From the Gateways page, click the gateway the node is registered to.
2. Click the (Nodes) tab.
3. Click [Enter Polling Interval], or the interval itself, if one was already configured, and then enter polling interval as a positive integer, and then press Enter.

   Note:

   Entering 0 stops polling on this node.

   
   
   Description of the illustration enter-polling-interval.png
   
4. Click Seconds, or other time period if one was already configured, and then click again to expand the time period list. Select the time period (Seconds, Minutes, Hours, or Days) you want the node to use to poll for updates.
   
   
   Description of the illustration polling-interval-time.png
   

   For example, if you entered 5 as the polling interval and Minutes as the time period, the node polls for changes to the logical gateway definition every five minutes. If the deployed endpoints or API implementations differ, the node is updated to match the definition of the gateway from the Management Portal.

5. Click Save.
   

The polling interval is configured. The node will poll the management tier for the gateway the next time the previous interval elapses, and then the new polling interval takes effect.

Note:

If the previous polling interval was 0, you must manually initiate a poll to synchronize the node with the latest logical gateway definition. The poll will not happen automatically.

Configuring a Proxy for a Gateway Node

Configure proxies for each node registered to gateways you manage. This allows for different proxy configurations for development and production gateways or different proxies for nodes located in separate data centers. When configured, the node passes requests to your backend services through the proxies you specify.

Gateway Managers must be issued the Manage Gateway grant for a gateway to configure proxies for nodes registered to it.

To configure a proxy for a gateway node:

1. In the Management Portal, click the Gateways tab.
2. Click the gateway the node is registered to.
3. Click the (Nodes) tab.
4. In the Proxies column, enter the host and port of the HTTP and HTTPS proxies you want to pass requests through. For example, enter www.proxy.example.com:80 in the HTTP and HTTPS rows.
   
   
   Description of the illustration node-proxy-urls.png
   
5. Click Save.
   

The gateway node proxy is configured. You don’t need to restart the node for this change to take effect.

Unregister a Gateway Node

Unregister a node from a gateway to stop managing it with the Oracle API Platform Cloud Service - Classic management tier.

Unregistering a node does not shut it down; it continues to run normally until you manually shut it down using the stop node installer action.

When you unregister a gateway, the node stops polling the management server for updated logical gateway definitions. As a result, new APIs or more recent API iterations deployed to the gateway will not be deployed to the unregistered node; however, APIs that were deployed to the node when it was unregistered are still deployed. Requests sent to these APIs are handled normally.

Tip:

You can also unregister a node using the REST API for the Management Service in Oracle API Platform Cloud Service or the unregister node installer action.

Gateway Managers must be issued the Manage Gateway grant for a gateway to unregister nodes from it.

To unregister a gateway node from the Management Portal:

1. From the Gateways list page, click the gateway the node is registered to.
2. Click the Nodes tab.
3. Hover over the node you want to unregister, and then click Unregister when it appears.
   
   
   Description of the illustration unregister-node.png
   

   Tip:

   Instead of hovering, you can also click anywhere inside of or use the keyboard to navigate to the node panel to make the Unregister button appear.

4. Click Yes to confirm.

The gateway node is unregistered.

Run the stop node installer action to stop the running node server. Run the destroyNode node installer action to stop the running server and uninstall the node from the machine.

To reregister a node to a gateway, use the REST API for the Management Service in Oracle API Platform Cloud Service or the join gateway installer action.