Instance Configuration

HarperDB instance configuration can be viewed and managed directly through the HarperDB Studio. HarperDB Cloud instances can be resized in two different ways via this page, either by modifying machine RAM or by increasing drive storage. User-installed instances can have their licenses modified by modifying licensed RAM.

 

All instance configuration is handled through the config page of the HarperDB Studio, accessed with the following instructions:

  1. Navigate to the HarperDB Studio Organizations page.
  2. Click the appropriate organization that the instance belongs to.
  3. Select your desired instance.
  4. Click config in the instance control bar.

Note, the config page will only be available to super users and certain items are restricted to Studio organization owners.

Instance Overview

The instance overview panel displays the following instance specifications:

  • Instance URL
  • Instance Node Name (for clustering)
  • Instance API Auth Header (this user)
    The Basic authentication header used for the logged in HarperDB database user
  • Created Date (HarperDB Cloud only)
  • Region (HarperDB Cloud only)
    The geographic region where the instance is hosted.
  • Total Price
  • RAM
  • Storage (HarperDB Cloud only)
  • Disk IOPS (HarperDB Cloud only)

Update Instance RAM

HarperDB Cloud instance size and user-installed instance licenses can be modified with the following instructions. This option is only available to Studio organization owners.

 

Note: For HarperDB Cloud instances, upgrading RAM may add additional CPUs to your instance as well. Click here to see how many CPUs are provisioned for each instance size.

  1. In the update ram panel at the bottom left:
    • Select the new instance size.
    • If you do not have a credit card associated with your account, an Add Credit Card To Account button will appear. Click that to be taken to the billing screen where you can enter your credit card information before returning to the config tab to proceed with the upgrade.
    • If you do have a credit card associated, you will be presented with the updated billing information.
    • Click Upgrade.
  2. The instance will shutdown and begin reprovisioning/relicensing itself. The instance will not be available during this time. You will be returned to the instance dashboard and the instance status will show UPDATING INSTANCE.
  3. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.

Note, if HarperDB Cloud instance reprovisioning takes longer than 20 minutes, please submit a support ticket here: https://harperdbhelp.zendesk.com/hc/en-us/requests/new.

Update Instance Storage

The HarperDB Cloud instance storage size can be increased with the following instructions. This option is only available to Studio organization owners.

 

Note: Instance storage can only be upgraded once every 6 hours.

  1. In the update storage panel at the bottom left:
    • Select the new instance storage size.
    • If you do not have a credit card associated with your account, an Add Credit Card To Account button will appear. Click that to be taken to the billing screen where you can enter your credit card information before returning to the config tab to proceed with the upgrade.
    • If you do have a credit card associated, you will be presented with the updated billing information.
    • Click Upgrade.
  2. The instance will shut down and begin reprovisioning itself. The instance will not be available during this time. You will be returned to the instance dashboard and the instance status will show UPDATING INSTANCE.
  3. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.

Note, if this process takes longer than 20 minutes, please submit a support ticket here: https://harperdbhelp.zendesk.com/hc/en-us/requests/new.

Remove Instance

The HarperDB instance can be deleted/removed from the Studio with the following instructions. Once this operation is started it cannot be undone. This option is only available to Studio organization owners.

  1. In the remove instance panel at the bottom left:
    • Enter the instance name in the text box.
    • The Studio will present you with a warning.
    • Click Remove.
  2. The instance will begin deleting immediately.

Restart Instance

The HarperDB Cloud instance can be restarted with the following instructions.

  1. In the restart instance panel at the bottom left:
    • Enter the instance name in the text box.
    • The Studio will present you with a warning.
    • Click Restart.
  2. The instance will begin restarting immediately.