Manage gateways

NineData Gateway is a database connection service for private-network databases. Deploy a gateway to connect NineData to third-party cloud or on-premises databases through private network addresses without exposing those databases to the public Internet.

Before you begin

• You have created or joined an organization. For details, see Manage organizations.
• The NineData console is in organization mode. To switch from personal mode to organization mode, see Switch to organization.

Limitations

The host where the gateway is deployed must be able to access the public network. If the host is in a LAN and cannot access the public network directly, deploy the gateway through a proxy gateway. For details, see Use a proxy gateway.

Create gateway

1. Sign in to the NineData Console.

2. Open Datasource > Gateway.

3. Click Create Gateway.

4. Configure the parameters in the table.

   Parameter	Description
   Name	Enter a meaningful gateway name so it is easy to search for and manage later.
   Environment	Select the operating system of the host where the gateway will be deployed. NineData displays the corresponding installation method. Supported operating systems include: Windows(x86_64) Linux(x86_64) macOS
   Access Region	Select the region closest to the gateway host for faster access.
   Advanced	Use Proxy: Deploy through a Proxy Gateway. For details, see Use a proxy gateway.

5. Follow the installation guide in the console to install and configure the gateway on the deployment host. After the gateway is configured, the Gateway Connection Diagram changes from Waiting for the local gateway to launch... to The local gateway is connected successfully.

6. Click Complete and back to List to return to the gateway list.

View and manage gateways

View gateway status and manage gateways in the console.

1. Sign in to the NineData Console.

2. Open Datasource > Gateway.

3. On the Gateways page, view all gateways under the current user in personal mode or organization in organization mode. Available operations include:

   Operation	Description
   View gateway details	Click the Gateway ID, or click > Details in the Action column. The Details page includes: Basic information: Gateway ID, gateway name, status, number of data sources, IP address, installation path, creator, creation time, and other basic information. Monitor: CPU and memory utilization charts for the host where the gateway is deployed. Log: Gateway logs.
   Disaster Recovery Management	Click Disaster Recovery to enable or disable disaster recovery for this gateway. By default, gateways created on Linux systems have disaster recovery enabled, while gateways on macOS systems have it disabled.
   Create a data source	Find a gateway whose status is Normal, and click > Create Datasource in the Action column to create a data source. For details, see Add data sources.
   Stop gateway	Find a gateway whose status is Normal, click Terminate in the Action column, and click Stop in the confirmation dialog. Note: After a gateway is stopped, the gateway process on the deployment host ends within a few minutes.
   Start gateway	Find a gateway whose status is Stopped, click Launch in the Action column, and follow the installation guide in the Launch dialog to restart the gateway.
   Delete gateway	If you no longer need a gateway, find a gateway whose status is Stopped, click > Delete, and click Delete Gateway in the confirmation dialog. Note: After a gateway is deleted, it cannot be recovered. Proceed with caution.

Enable gateway disaster recovery

Gateway disaster recovery starts a new gateway process if the existing process exits abnormally or the server fails.

tip

Gateways on Linux systems have disaster recovery enabled by default when created, while gateways on macOS systems have it disabled by default.

Before you begin

The gateway server runs Linux or macOS.

Procedure

1. Sign in to the NineData Console.

2. Open Data Source Management > Gateway.

3. In the gateway list, click the target gateway ID, or click the icon in the Action column and select Details.

4. On the Details page, click More, locate Disaster Recovery, and toggle the switch to enable it.

   tip

   macOS systems may request disk access permission for the terminal. If this permission is not enabled, follow the on-screen prompts to enable it.

Configure gateway alerts

Configure gateway alerts so receivers are notified by SMS, phone, email, or Webhook when the gateway status becomes abnormal.

Before you begin

• The gateway has been created.
• No gateway alert has been configured for the gateway.

Procedure

1. Sign in to the NineData Console.

2. Open Datasource > Gateway.

3. In the gateway list, click the ID of the gateway that needs an alert, or click > Details in the Action column.

4. On the Details page, click Configure Alert, or click Show Details and then click Configure next to Alert Policy.

   tip

   If the Configure Alert button is not displayed, the gateway may already have an alert policy. In this case, use one of these options:

   • Click Show Details, click View next to Alert Policy, and click Add Policy to add an alert policy.
   • Click Show Details, click View next to Alert Policy, and then click the icon next to an existing alert policy to delete and recreate it.

5. In the dialog, click Save to enable the default alert policy, or click the Custom tab, configure a custom alert policy using the table, and then click Save.

   tip

   The default alert policy sends SMS alerts to the gateway creator and the user who enabled the alert when the gateway status becomes abnormal.

   Parameter	Description
   Methods	Create Policy: Create a new alert policy on the current page. Choose Policy: Use an existing alert policy. For details, see Configure alert rules.
   Name	Enter a meaningful policy name. Up to 24 characters are supported.
   Alert Rules	Select the gateway alert rule. The alert rule contains the alert trigger conditions and notification method. NineData provides a default gateway alert rule that sends an SMS notification when the gateway status becomes abnormal. To customize an alert rule, click Create Now below the Alert Rules list.
   Alert Reception	Select where to send the alert. Supported options include: User: A registered NineData user. Receiver Group: A receiver group whose members receive the alert. If you have not created one yet, click Create Now below the receiver group list. For details, see Configure alert receivers.

Appendix: Use a proxy gateway

If the target host cannot access the public network directly, use a proxy gateway in the same LAN for indirect access. Prepare two hosts in the same LAN that can access each other:

• Host A: A host that can access the public network.
• Host B: The host that needs to connect to the NineData server.

Create a gateway on host A. Host A acts as a proxy so host B can connect to the NineData server.

Procedure

1. Sign in to host A and create a gateway. For details, see Create gateway.

2. Sign in to the NineData Console.

3. Open Datasource > Gateway.

4. Click Create Gateway.

5. In Environment, select the operating system of the gateway host. The following operating systems are supported:

   • Windows(x86_64)
   • Linux(x86_64)
   • macOS

6. Click Advanced, select Use Proxy, and then select the gateway created on host A from the Proxy dropdown list.

   tip

   The gateway process opens a port on host A for host B. When the page displays <gateway_name> has enabled the proxy function, port <port>, the proxy gateway is ready. Continue to the next step.

7. Click the icon next to Install Command Line to copy the installation command, connect to host B, and run the command in the terminal.

8. Wait until the Gateway Connection Diagram on the Create Gateway page changes from Waiting for the local gateway to launch... to The local gateway is connected successfully.

Result

The gateway is created or updated in the gateway list. Use a gateway in normal status when creating data sources that require private-network access.