LogoLogo
Studio
4.4
4.4
  • Harper Docs
  • Getting Started
  • Developers
    • Applications
      • Caching
      • Defining Schemas
      • Defining Roles
      • Debugging Applications
      • Define Fastify Routes
      • Web Applications
      • Example Projects
    • Components
      • Managing
      • Reference
      • Built-In Components
    • REST
    • Operations API
      • Quick Start Examples
      • Databases and Tables
      • NoSQL Operations
      • Bulk Operations
      • Users and Roles
      • Clustering
        • Clustering with NATS
      • Custom Functions
      • Components
      • Registration
      • Jobs
      • Logs
      • Utilities
      • Token Authentication
      • SQL Operations
      • Advanced JSON SQL Examples
    • Real-Time
    • Replication/Clustering
      • Sharding
      • Legacy NATS Clustering
        • Requirements and Definitions
        • Creating A Cluster User
        • Naming A Node
        • Enabling Clustering
        • Establishing Routes
        • Subscription Overview
        • Managing Subscriptions
        • Things Worth Knowing
        • Certificate Management
    • Security
      • JWT Authentication
      • Basic Authentication
      • mTLS Authentication
      • Configuration
      • Users & Roles
      • Certificate Management
    • SQL Guide
      • SQL Features Matrix
      • SQL Date Functions
      • SQL Reserved Word
      • SQL Functions
      • SQL JSON Search
      • SQL Geospatial Functions
    • Miscellaneous
      • Google Data Studio
      • SDKs
      • Query Optimization
  • Administration
    • Best Practices and Recommendations
    • Logging
      • Standard Logging
      • Audit Logging
      • Transaction Logging
    • Clone Node
    • Compact
    • Jobs
    • Harper Studio
      • Create an Account
      • Log In & Password Reset
      • Organizations
      • Instances
      • Manage Databases / Browse Data
      • Manage Clustering
      • Manage Instance Users
      • Manage Instance Roles
      • Manage Applications
      • Instance Metrics
      • Instance Configuration
      • Enable Mixed Content
  • Deployments
    • Configuration File
    • Harper CLI
    • Install Harper
      • On Linux
    • Upgrade a Harper Instance
    • Harper Cloud
      • IOPS Impact on Performance
      • Instance Size Hardware Specs
      • Alarms
      • Verizon 5G Wavelength
  • Technical Details
    • Reference
      • Analytics
      • Architecture
      • Content Types
      • Data Types
      • Dynamic Schema
      • GraphQL
      • Harper Headers
      • Harper Limits
      • Globals
      • Resource Class
      • Transactions
      • Storage Algorithm
    • Release Notes
      • Harper Tucker (Version 4)
        • 4.4.24
        • 4.4.23
        • 4.4.22
        • 4.4.21
        • 4.4.20
        • 4.4.19
        • 4.4.18
        • 4.4.17
        • 4.4.16
        • 4.4.15
        • 4.4.14
        • 4.4.13
        • 4.4.12
        • 4.4.11
        • 4.4.10
        • 4.4.9
        • 4.4.8
        • 4.4.7
        • 4.4.6
        • 4.4.5
        • 4.4.4
        • 4.4.3
        • 4.4.2
        • 4.4.1
        • 4.4.0
        • 4.3.38
        • 4.3.37
        • 4.3.36
        • 4.3.35
        • 4.3.34
        • 4.3.33
        • 4.3.32
        • 4.3.31
        • 4.3.30
        • 4.3.29
        • 4.3.28
        • 4.3.27
        • 4.3.26
        • 4.3.25
        • 4.3.24
        • 4.3.23
        • 4.3.22
        • 4.3.21
        • 4.3.20
        • 4.3.19
        • 4.3.18
        • 4.3.17
        • 4.3.16
        • 4.3.15
        • 4.3.14
        • 4.3.13
        • 4.3.12
        • 4.3.11
        • 4.3.10
        • 4.3.9
        • 4.3.8
        • 4.3.7
        • 4.3.6
        • 4.3.5
        • 4.3.4
        • 4.3.3
        • 4.3.2
        • 4.3.1
        • 4.3.0
        • 4.2.8
        • 4.2.7
        • 4.2.6
        • 4.2.5
        • 4.2.4
        • 4.2.3
        • 4.2.2
        • 4.2.1
        • 4.2.0
        • 4.1.2
        • 4.1.1
        • 4.1.0
        • 4.0.7
        • 4.0.6
        • 4.0.5
        • 4.0.4
        • 4.0.3
        • 4.0.2
        • 4.0.1
        • 4.0.0
        • Tucker
      • HarperDB Monkey (Version 3)
        • 3.3.0
        • 3.2.1
        • 3.2.0
        • 3.1.5
        • 3.1.4
        • 3.1.3
        • 3.1.2
        • 3.1.1
        • 3.1.0
        • 3.0.0
      • HarperDB Penny (Version 2)
        • 2.3.1
        • 2.3.0
        • 2.2.3
        • 2.2.2
        • 2.2.0
        • 2.1.1
      • HarperDB Alby (Version 1)
        • 1.3.1
        • 1.3.0
        • 1.2.0
        • 1.1.0
  • More Help
    • Support
    • Slack
    • Contact Us
Powered by GitBook
On this page
  • Organization Instance List
  • Create a New Instance
  • Register Enterprise Instance
  • Delete an Instance
  • Upgrade an Instance
  • Instance Log In/Log Out
  1. Administration
  2. Harper Studio

Instances

PreviousOrganizationsNextManage Databases / Browse Data

Last updated 2 months ago

The Harper Studio allows you to administer all of your HarperDinstances in one place. Harper currently offers the following instance types:

  • Harper Cloud Instance Managed installations of Harper, what we call .

  • 5G Wavelength Instance Managed installations of Harper running on the Verizon network through AWS Wavelength, what we call . Note, these instances are only accessible via the Verizon network.

  • Enterprise Instance Any Harper installation that is managed by you. These include instances hosted within your cloud provider accounts (for example, from the AWS or Digital Ocean Marketplaces), privately hosted instances, or instances installed locally.

All interactions between the Studio and your instances take place directly from your browser. Harper stores metadata about your instances, which enables the Studio to display these instances when you log in. Beyond that, all traffic is routed from your browser to the Harper instances using the standard .

Organization Instance List

A summary view of all instances within an organization can be viewed by clicking on the appropriate organization from the page. Each instance gets their own card. Harper Cloud and Enterprise instances are listed together.

Create a New Instance

  1. Navigate to the page.

  2. Click the appropriate organization for the instance to be created under.

  3. Click the Create New Harper Cloud Instance + Register Enterprise Instance card.

  4. Select your desired Instance Type.

  5. For a Harper Cloud Instance or a Harper 5G Wavelength Instance, click Create Harper Cloud Instance.

    1. Fill out Instance Info.

      1. Enter Instance Name

        This will be used to build your instance URL. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https://c1-demo.harperdbcloud.com. The Instance URL will be previewed below.

      2. Enter Instance Username

        This is the username of the initial Harper instance super user.

      3. Enter Instance Password

        This is the password of the initial Harper instance super user.

    2. Click Instance Details to move to the next page.

    3. Select Instance Specs

      1. Select Instance RAM

        Harper Cloud Instances are billed based on Instance RAM, this will select the size of your provisioned instance. .

      2. Select Storage Size

        Each instance has a mounted storage volume where your Harper data will reside. Storage is provisioned based on space and IOPS. .

      3. Select Instance Region

        The geographic area where your instance will be provisioned.

    4. Click Confirm Instance Details to move to the next page.

    5. Review your Instance Details, if there is an error, use the back button to correct it.

    6. Review the and , if you agree, click the I agree radio button to confirm.

    7. Click Add Instance.

    8. Your Harper Cloud instance will be provisioned in the background. Provisioning typically takes 5-15 minutes. You will receive an email notification when your instance is ready.

Register Enterprise Instance

  1. Click the appropriate organization for the instance to be created under.

  2. Click the Create New Harper Cloud Instance + Register Enterprise Instance card.

  3. Select Register Enterprise Instance.

    1. Fill out Instance Info.

      1. Enter Instance Name

        This is used for descriptive purposes only.

      2. Enter Instance Username

        The username of a Harper super user that is already configured in your Harper installation.

      3. Enter Instance Password

        The password of a Harper super user that is already configured in your Harper installation.

      4. Enter Host

        The host to access the Harper instance. For example, harperdb.myhost.com or localhost.

      5. Enter Port

        The port to access the Harper instance. Harper defaults 9925 for HTTP and 31283 for HTTPS.

      6. Select SSL

        If your instance is running over SSL, select the SSL checkbox. If not, you will need to enable mixed content in your browser to allow the HTTPS Studio to access the HTTP instance. If there are issues connecting to the instance, the Studio will display a red error message.

    2. Click Instance Details to move to the next page.

    3. Select Instance Specs

      1. Select Instance RAM

        Harper instances are billed based on Instance RAM. Selecting additional RAM will enable the ability for faster and more complex queries.

    4. Click Confirm Instance Details to move to the next page.

    5. Review your Instance Details, if there is an error, use the back button to correct it.

    6. Click Add Instance.

    7. The Harper Studio will register your instance and restart it for the registration to take effect. Your instance will be immediately available after this is complete.

Delete an Instance

Instance deletion has two different behaviors depending on the instance type.

  • Harper Cloud Instance This instance will be permanently deleted, including all data. This process is irreversible and cannot be undone.

  • Enterprise Instance The instance will be removed from the Harper Studio only. This does not uninstall Harper from your system and your data will remain intact.

An instance can be deleted as follows:

  1. Click the appropriate organization that the instance belongs to.

  2. Identify the proper instance card and click the trash can icon.

  3. Enter the instance name into the text box.

    This is done for confirmation purposes to ensure you do not accidentally delete an instance.

  4. Click the Do It button.

Upgrade an Instance

Instance Log In/Log Out

The Studio enables users to log in and out of different database users from the instance control panel. To log out of an instance:

  1. Click the appropriate organization that the instance belongs to.

  2. Identify the proper instance card and click the lock icon.

  3. You will immediately be logged out of the instance.

To log in to an instance:

  1. Click the appropriate organization that the instance belongs to.

  2. Identify the proper instance card, it will have an unlocked icon and a status reading PLEASE LOG IN, and click the center of the card.

  3. Enter the database username.

    The username of a Harper user that is already configured in your Harper instance.

  4. Enter the database password.

    The password of a Harper user that is already configured in your Harper instance.

  5. Click Log In.

Navigate to the page.

Review the and , if you agree, click the I agree radio button to confirm.

Navigate to the page.

Harper instances can be resized on the page.

Navigate to the page.

Navigate to the page.

Harper Cloud
5G Wavelength Instances
Harper API
Harper Studio Organizations
Harper Studio Organizations
More on instance specs
More on IOPS Impact on Performance
Privacy Policy
Terms of Service
Harper Studio Organizations
Privacy Policy
Terms of Service
Harper Studio Organizations
Instance Configuration
Harper Studio Organizations
Harper Studio Organizations