Skip to content

Manage the data plane and databases

This topic introduces how to manage a BYOC data plane and its databases in NebulaGraph Cloud. Keep the AWS IAM roles in place while the platform operates or cleans up resources.

Required role: Organization Owner or Project Admin. Select the BYOC organization and open its sole project before following the procedures below.

Inspect data plane status

Open Data Plane. For a deployed or deploying record, open its name to inspect details, Deployment Timeline, and SYSTEM LOGS.

Status Meaning and next action
Pending Record created; authorization/deployment still required. Click Deploy to continue.
Deploying Deployment is in progress. Follow the timeline and logs; management actions are unavailable.
Running Data plane is ready for database creation.
Failed Inspect the failure, fix its cause, then use Retry Deployment when available.
Deleting Deletion is in progress. Wait and retain authorization until cleanup is verified.

If progress or log updates are interrupted, reconnect or retry loading them, then check the data plane status to determine the deployment outcome. See Troubleshooting.

Rename the data plane

  1. On Data Plane, open the card's … menu and select Rename.
  2. Enter Data Plane Name and click Confirm.
  3. Verify the new name on the card.

Renaming changes the display name. Continue to use the original External ID in the IAM template; do not rename roles or replace the ID with the new display name.

Change database capacity

Use Databases → … for the database, or its Overview → … menu. Available actions depend on tier, database state, and license information. Start with a Running database and a valid license. Check Query and Storage quota before resizing or scaling.

Warning

Resizing and scaling can make the database temporarily unavailable. Arrange a suitable maintenance window and review the confirmation before submitting.

Resize node specifications

Standard uses one node specification. Professional and Enterprise allow separate Query and Storage specifications.

  1. Open the database's … menu and select Resize.
  2. Review Current for Standard, or Current Configuration for Professional and Enterprise. Select the new node specification; for Professional and Enterprise, select the Query and Storage specifications you want to change. The new Standard or Storage node specification must support the existing storage size.
  3. Review the selected configuration and the availability notice, then click Resize.
  4. Wait until the database status is Running. Open its Overview and verify the updated node specifications.

Scale node counts

Scaling is available for Professional and Enterprise databases.

  1. Open the database's … menu and select Scale to open Scale Database.
  2. Review the current Graph Nodes (query nodes) and Storage Nodes counts.
  3. Select the new counts from the available options. Check that any increase fits the corresponding remaining license quota.
  4. Review the selected counts and the availability notice, then click Scale.
  5. Wait until the database status is Running. Open its Overview and verify the updated node counts.

Increase storage size

Warning

Storage size cannot be reduced after an increase. AWS EBS also limits subsequent volume changes; follow the constraints displayed in the dialog.

  1. Open the database's … menu and select Increase Storage Size when available.
  2. Select a size greater than the existing size and within the displayed range. For Professional and Enterprise, this size applies to each storage node.
  3. Review the new size and, for Professional and Enterprise, the total storage size across all storage nodes. Click Increase Storage Size to submit the change.
  4. Open the database's Overview and verify the updated storage size after the change completes.

BYOC does not require the fully managed trial-to-paid upgrade or capacity-bundle purchase workflow. Check AWS bills and your license agreement for costs.

Suspend and resume a database

  1. In Databases, open the database's … menu, select Suspend, and confirm. Wait for Suspended. Applications cannot read or write while it is suspended.
  2. To resume, click Resume on the database card and confirm. Wait for Running before reconnecting.

After suspension, check the AWS costs of retained resources and the license fees in your BYOC agreement. If license information prevents the action, restore that information or contact support; do not remove AWS resources directly as a workaround.

Delete the data plane

All project databases must be deleted first. If you also plan to delete the project, remove the data plane before deleting the project.

Warning

Deleting databases can permanently remove data. Preserve required data before deletion. Keep both IAM roles until infrastructure cleanup is complete.

  1. In Databases, open … → Delete for each database, review the confirmation, and confirm only after preserving required data. Wait until the project has no database records.
  2. Open Data Plane → … → Delete Data Plane.

  3. Read the deletion description for the current state:

    • Running: deletion starts infrastructure cleanup in your AWS account.
    • Other states, including Failed: deletion removes only the control-plane record. If deployment failed, work with support to check and clean residual AWS resources before removing the record or authorization.

  4. Enter the exact data plane name and click Delete. Actions are unavailable during Deploying or Deleting.

  5. After the data plane is removed from the platform, have your AWS administrator verify that its AWS resources are cleaned up and check the associated AWS costs.
  6. Only after cleanup is verified, have the AWS administrator remove the IAM authorization using the retained Terraform directory and a reviewed destroy plan. The IAM template removes only the roles and policies it created.

If a deletion is blocked by remaining databases, licensing, unavailable resource checks, or an error, see Troubleshooting. Do not delete IAM roles first.