Skip to content

Core 1829- Docs Migration: Added New Clustering Docs #8

Merged
DavidCockerill merged 25 commits into
CORE-1824from
CORE-1829
Nov 29, 2022
Merged

Core 1829- Docs Migration: Added New Clustering Docs #8
DavidCockerill merged 25 commits into
CORE-1824from
CORE-1829

Conversation

@terraHDB

Copy link
Copy Markdown
Contributor

This PR includes a reworking of our cluster docs. Old clustering docs can be found here

@terraHDB
terraHDB changed the base branch from main to CORE-1824 November 15, 2022 19:15
@terraHDB terraHDB changed the title Core 1829- Added New Clustering Docs for Docs Migration Core 1829- Docs Migration: Added New Clustering Docs Nov 15, 2022
terraHDB and others added 3 commits November 15, 2022 15:20
* doc migration epic branch

* 3/4 progress of security

* finished configuration.md, began users and roles

* users and roles migrated; still needs updates

* updated user and roles operations

* corrections to security docs

* CORE-1825 Add/Update "install harpedb" subtopics (#1)

* added mac, added/updated windows, added/updated node version requirements, and added offline docs

* go requirements

* docs adjustments

* testing variable usage

* testing variable usage

* Update other.md

Update installation for other operating systems.

* added link to download

* node version

* exact replica download button

* functional download link

* deleted old link

* node version

Co-authored-by: Kris Zyp <kriszyp@gmail.com>

* Core 1826 add/update harperdb studio topic and subtopics (#2)

* added mac, added/updated windows, added/updated node version requirements, and added offline docs

* 1/3 through studio subtopics

* 2/3 through studio subtopics

* 3/3 through studio subtopics

* corrected harperdb operations api

* removed icon descriptions and fixed typos

* removed icon descriptions

* primary key vs hash_attribute change

* primary key vs hash attribute qualifier

* minor change to example function

Co-authored-by: Kris Zyp <kriszyp@gmail.com>
# Conflicts:
#	docs/harperdb-cloud/index.md
#	docs/harperdb-studio/index.md
Comment thread docs/clustering/index.md
@@ -1 +1,3 @@
# Clustering

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clustering introduction needs more than this. How much of the existing into do you think we could incorporate here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️

@@ -0,0 +1,64 @@
# Authentication

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How come all this security/studio stuff is in the clustering PR?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the security/studio pr was mistakenly merged to main, rather than the epic CORE-1824

Comment thread docs/clustering/how-to-cluster.md Outdated

To create a cluster you must have two or more nodes* (aka instances) of HarperDB running.

**A node is a single instance/installation of HarperDB constitutes a node. A node of HarperDB can operate independently with clustering on or off.*

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence sounds off.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed. ✔️

Comment thread docs/clustering/how-to-cluster.md Outdated

Subscriptions can be added, updated, or removed through the API.

_Note: The schema and tables in the subscription must exist on the local node (the node that is receiving the API request), but do not need to exist on the remote node. Any schema and tables that do not exist on the remote node will be automatically created._

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has changed. Now the schema and table must exist in at least one location - local or remote. If it doesnt exist on the"other" location it will be created

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️

@DavidCockerill
DavidCockerill merged commit 7785bd7 into CORE-1824 Nov 29, 2022
@Ethan-Arrowood
Ethan-Arrowood deleted the CORE-1829 branch August 12, 2025 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants