Skip to content

Create a database instance

Before getting started, you need to create a NebulaGraph Cloud account, create a database, and then connect to it. This topic covers how to create a database instance.

Prerequisites

An AWS account is prepared.

Step 1. Sign up and log in to NebulaGraph Cloud

  1. Open this URL in your browser.

  2. Click Sign Up Now to create a NebulaGraph Cloud account using your email, Github or Google account.

    If using your email to sign up, you will receive an email containing a Verify button after registration. Click the button to verify your email address and set your password.

Step 2. Create a database

  1. On the Database page that appears by default, click Create Database.

  2. On the Create database page, specify the following information:

    • Basic

      • Database Name: Customize a name for the database.
      • Cloud Provider: AWS is selected by default.
      • Region: Choose the region based on your business requirements. For more information about the available regions for your business, see AWS Regions.
        • us-east-2: US East (Ohio)
        • us-west-2: US West (Oregon)

    • Capacity: Select a combination of node, storage size, and price based on your requirements.

      New users can enjoy a 14-day free trial per NebulaGraph Cloud account, which comes with one database instance of 2 vCPUs, 4 GB of RAM, and 10 GB of storage, without requiring any payment information. For more information, see Try NebulaGraph Cloud for free.

    • Payment Method: Click Add a payment method to bind your AWS account as the payment method. You are prompted to log in to your AWS account and purchase NebulaGraph Cloud on the AWS Marketplace.

    Note

    After you complete the binding, it may take a few minutes for the payment method to be displayed on the NebulaGraph Cloud Web UI. You can refresh the page to check the status.

  3. Review the summary on the right, then click Create.

(Optional) Step 3. Connect to your database using SDKs

If you want to use SDKs to connect to your database, complete this step to configure network access. Otherwise, skip this step.

  1. On the Database page, click the name of the database that you created to view the database details.

  2. On the left-side navigation pane, click Network access under Security. NebulaGraph Cloud allows you to access the database through public network or private network. Follow either of the following steps based on your requirements:

    • Access the database through public network:

      1. On the IP Allow List tab, click the toggle switch to enable accessing the database through public network.
      2. Click + Add IP Addresses to add custom IP addresses to the allow list.

    • Access the database through private network:

      1. Click the Private Endpoint tab.

      2. On the Create Private Link Service pane, click Create to enable the private link service.

      3. On the Create Private Link Endpoint pane, specify your VPC ID and subnet ID, and run the automatically generated command in your AWS CLI to create the private link endpoint.

  3. On the left-side navigation pane, click Overview under Basic.

  4. In the upper-right corner of the Overview page, click Connect.

  5. In the Connect to your database dialog box, specify the following items and click Confirm:

    • Choose a connection type: Select Public (Connect via public network) or Private (Connect via private endpoint).
    • Install the client: Select NebulaGraph Java, NebulaGraph Go, or NebulaGraph Python, and click Download installation package for installation.
    • Connect: Click Generate and take note of the following connection information: Host, Port, Username, and Password. If you need to refresh the password, click Regenerate.

  6. Set up the SDKs with the connection information. For more information, see Java SDK guide, Go SDK guide, and Python SDK guide.

What's next