Manage gateway

NineData's gateway is a database connection service that supports remote access to private network databases. By deploying a gateway, user can securely and inexpensively access a third-party cloud or local database to NineData without applying for an external network address, and access data securely through a private network address. This article describes how to configure and manage the gateway.

Prerequisite

• Created or joined an organization. For more information, please refer to Manage Organization.
• The NineData console is in organization mode. To switch from personal mode to organization mode, please see Switching to Organization.

Restrictions

The host to which the gateway is deployed must be able to access the public network. If the host cannot access the public network and is in a LAN, the gateway can be deployed through a proxy gateway. See Using Proxy Gateways for more information.

Create gateway

1. Log in to NineData console.

2. In the left navigation bar, click Datasource > Gateway.

3. Click Create Gateway in the upper right corner of the page.

4. Configure the parameters according to the table below.

   Parameter	Description
   Name	The name of the gateway can be manually specified for the convenience of search and management.
   Environment	Select the operating system of the host where the gateway needs to be deployed, and the corresponding gateway installation method is displayed. The following operating systems are supported: Windows(x86_64) Linux(x86_64) macOS
   	Select the region closest to the location of the host in relation to the deployed gateway to achieve relatively fast access speed.
   Advanced	Use Proxy: Deploy through a Proxy Gateway. See Using Proxy Gateways for more information.

5. According to the installation guide shown below, install and configure the gateway on the deployment host. After the configuration is completed, the Gateway Connection Diagram on the right side of the page will change 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 list to view the list of gateways that have been created.

View and manage gateways

User can view the current status of the gateway in the console and perform management operations on the gateway.

1. Log in to NineData console.

2. In the left navigation bar, click Datasource > Gateway.

3. On the Gateways page, one can view all gateways under the current user (personal mode) or organization (organizational mode), and the following operation:

   Operation	Description
   View gateway details	Click the Gateway ID, or click > Details in the Action column to the right of the gateway. The Details page contains the following: Basic information : The basic information of the gateway, including gateway ID , gateway name , status , number of data sources , IP , installation path , creator , creation time , etc. Monitor : Graphs of CPU and memory utilization of the hosts on which the gateway is deployed. Log : Gateway logs.
   Disaster Recovery Management	Click on the button on the page 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 the gateway whose status is Normal , and click > Create Datasource in the Action column on the right to create the data source. For more information, see Manage datasources.
   Stop gateway	Find the gateway whose status is Normal , click Terminate in the Action column on the right, and click Stop in the pop-up confirmation window. Note : After a gateway is stopped, the gateway process on the host where the gateway is deployed will automatically end within a few minutes.
   Start gateway	Find the gateway whose status is Stopped , click Launch in the Action column on the right, and in the Launch window that pops up, restart the gateway according to the installation guide on the page.
   Delete gateway	If no longer need a gateway, find the gaway whose status is Stopped, click > Delete on the right side of the gateway, and click Delete Gateway in the confirmation window that pops up. Note : After the gateway is deleted, it cannot be recovered, please operate with caution.

Enable Gateway Disaster Recovery

NineData Gateway supports disaster recovery functionality, which automatically starts a new gateway process in case of abnormal exit or server failure, ensuring high availability of services.

tip

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

Prerequisites

The operating system of the gateway server should be Linux or MacOS.

Steps

1. Log in to the NineData Console.

2. In the left navigation pane, click on Data Source Management > Gateway.

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

4. On the Details page, click on , locate , and toggle the switch to enable it.

   tip

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

Configure Gateway Alerts

User can configure alerts for the target gateway to be notified by SMS, phone, email, and Webhook when the gateway operates unexpectedly.

Prerequisite

• Gateway created.
• Gateway alert is not configured.

Steps

1. Log in to the NineData console.

2. In the left navigation pane, click Datasource > Gateway.

3. In the list of gateways, click the ID of the gateway for which an alert needs to be configured or click > Details in the Action column on the right side of the gateway.

4. On the Details page, click Configure Alert in the upper right corner , or click Show Details and click Configure on the right of Alert Policy.

   tip

   If the Configure Alert button cannot be found, user may have already configured the alert function for the gateway. At this point user can do the following:

   • Click Show Details , click View on the right of Alert Policy , and click Add Policy in the upper right corner to add an alert policy.
   • Click Show Details , click View to the right of Alert Policy , and then click theicon to the right of Existing Alert policys to delete the current alert policy and recreate it.

5. In the displayed dialog box, user can directly click Save to enable the default alert policy, or click the Custom tab, configure a custom alert policy according to the table below, and then click Save.

   tip

   The default alert policy will send SMS alerts to the creator of the gateway and the user who enabled the alert when the gateway is abnormal.

   Parameter	Description
   Methods	Create Policy : Create a new alert policy on the current page. Choose Policy : Use the created alert policy. For more information, see Configuring Alert policy.
   Name	Enter the name of the policy. For the convenience of subsequent search and management, please try to use a meaningful name. Up to 24 characters are supported.
   Alert Rules	Select the gateway alert rule. The alert rule contains the conditions that trigger the alert and the push method of the alert. NineData provides a default gateway alert rule, when the status of the gateway is abnormal, it will be pushed by SMS. If user need to customize alert rule , click Create Now below the Alert Rules list.
   Alert Reception	Select the destination for the alert to push. The following options are supported: User : A user who has registed with NineData. Receiver Group : the created group to receive notices. All members in the receiving group will receive the alert. If haven't created one yet, click Create Now below the receiving group list. For more information, see Configuring Alert Reception.

Appendix: Using a Proxy Gateway

In the case the host cannot access the public network directly, a proxy gateway within the LAN environment can be used for indirect access. Two hosts within the same LAN, and able to 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 in host A, which acts as a proxy through which host B can connect to the NineData server.

Steps

1. Log in to host A and create a gateway. For more information, see Create Gateway.

2. Log in to NineData Console.

3. On the left navigation bar, click Datasource>Gateway.

4. Click Create Gateway on the upper right corner of the page.

5. In Environment, select the operating system on which the gateway host needs to be deployed. The following operating systems are supported:

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

6. Click Advanced, select Use Proxy, and click the drop-down box under Proxy, and select the gateway created in host A in the drop-down menu.

   tip

   At this time, the gateway process will automatically open a port on host A for access to host B. When the page prompts xxx has enabled the proxy function, port number xxx, it indicates the proxy gateway opened, and please continue to the next step.

7. Click the icon on the right side of Install Command Line to copy the installation command, log in to host B, and execute the command in the terminal.

8. Wait for the Gateway Connection Diagram on the right side of the Create Gateway page to change from Waiting for the local gateway to launch... to The local gateway is connected successfully.