LogoLogo
4.1
4.1
  • Developer Documentation
  • Install HarperDB
    • On Linux
  • Getting Started
  • Full API Documentation
  • HarperDB Studio
    • Create an Account
    • Log In & Password Reset
    • Resources (Marketplace, Drivers, Tutorials, & Example Code)
    • Organizations
    • Instances
    • Query Instance Data
    • Manage Schemas / Browse Data
    • Manage Charts
    • Manage Clustering
    • Manage Instance Users
    • Manage Instance Roles
    • Manage Functions
    • Instance Metrics
    • Instance Configuration
    • Instance Example Code
    • Enable Mixed Content
  • HarperDB Cloud
    • IOPS Impact on Performance
    • Instance Size Hardware Specs
    • Alarms
    • Verizon 5G Wavelength
  • Security
    • JWT Authentication
    • Basic Authentication
    • Configuration
    • Users & Roles
  • Clustering
    • Requirements and Definitions
    • Creating A Cluster User
    • Naming A Node
    • Enabling Clustering
    • Establishing Routes
    • Subscription Overview
    • Managing Subscriptions
    • Things Worth Knowing
  • Custom Functions
    • Requirements and Definitions
    • Create a Project
    • Define Routes
    • Define Helpers
    • Host A Static Web UI
    • Using NPM and GIT
    • Custom Functions Operations
    • Restarting the Server
    • Debugging a Custom Function
    • Custom Functions Templates
    • Example Projects
  • Add-ons and SDKs
    • Google Data Studio
  • SQL Guide
    • SQL Features Matrix
    • Insert
    • Update
    • Delete
    • Select
    • Joins
    • SQL Date Functions
    • SQL Reserved Word
    • SQL Functions
    • SQL JSON Search
    • SQL Geospatial Functions
      • geoArea
      • geoLength
      • geoDifference
      • geoDistance
      • geoNear
      • geoContains
      • geoEqual
      • geoCrosses
      • geoConvert
  • HarperDB CLI
  • Configuration File
  • Logging
  • Transaction Logging
  • Audit Logging
  • Jobs
  • Upgrade a HarperDB Instance
  • Reference
    • Storage Algorithm
    • Dynamic Schema
    • Data Types
    • Content Types/Data Formats
    • HarperDB Headers
    • HarperDB Limits
  • Support
  • Release Notes
    • HarperDB Tucker (Version 4)
      • 4.1.0
      • 4.0.6
      • 4.0.5
      • 4.0.4
      • 4.0.3
      • 4.0.2
      • 4.0.1
      • 4.0.0
    • 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
Powered by GitBook

© HarperDB. All Rights Reserved

On this page
Export as PDF
  1. Clustering

Creating A Cluster User

Inter-node authentication takes place via HarperDB users. There is a special role type called cluster_user that exists by default and limits the user to only clustering functionality.

A cluster_user must be created and added to the harperdb-config.yaml file for clustering to be enabled.

All nodes that are intended to be clustered together need to share the same cluster_user credentials (i.e. username and password).

There are multiple ways a cluster_user can be created, they are:

  1. Through the operations API by calling add_user

{
    "operation": "add_user",
    "role": "cluster_user",
    "username": "cluster_account",
    "password": "letsCluster123!",
    "active": true
}

When using the API to create a cluster user the harperdb-config.yaml file must be updated with the username of the new cluster user.

This can be done through the API by calling set_configuration or by editing the harperdb-config.yaml file.

{
    "operation": "set_configuration",
    "clustering_user": "cluster_account"
}

In the harperdb-config.yaml file under the top-level clustering element there will be a user element. Set this to the name of the cluster user.

clustering:
  user: cluster_account

Note: When making any changes to the harperdb-config.yaml file, HarperDB must be restarted for the changes to take effect.

  1. Upon installation using command line variables. This will automatically set the user in the harperdb-config.yaml file.

Note: Using command line or environment variables for setting the cluster user only works on install.

harperdb install --CLUSTERING_USER cluster_account --CLUSTERING_PASSWORD letsCluster123!
  1. Upon installation using environment variables. This will automatically set the user in the harperdb-config.yaml file.

CLUSTERING_USER=cluster_account CLUSTERING_PASSWORD=letsCluster123
PreviousRequirements and DefinitionsNextNaming A Node

Last updated 1 year ago