Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konsalex/boltnet
(Unofficial) Cluster Management for Neo4j with NodeJS
https://github.com/konsalex/boltnet
docker neo4j nodejs
Last synced: 3 months ago
JSON representation
(Unofficial) Cluster Management for Neo4j with NodeJS
- Host: GitHub
- URL: https://github.com/konsalex/boltnet
- Owner: konsalex
- Created: 2021-06-23T15:36:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-17T12:52:01.000Z (about 3 years ago)
- Last Synced: 2024-10-15T02:53:35.283Z (3 months ago)
- Topics: docker, neo4j, nodejs
- Language: TypeScript
- Homepage:
- Size: 540 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/konsalex/boltnet/actions/workflows/semantic-release.yml)
---
- [🗒 Description](#-description)
- [🚀 Installing](#-installing)
- [🔨 Usage](#-usage)
- [📣 Feedback](#-feedback)
# 🗒 Description
This is a unofficial NodeJS CLI for managing Neo4j Cluster with Docker. Behind the curtains [Dockerode](https://github.com/apocas/dockerode) is used to orchestrate all the necessary operations.
If you want to know more about Neo4j Clusters, please check [here](https://neo4j.com/docs/operations-manual/current/clustering/).
**Boltnet** is not intended for production usage, rather than for automated testing 🤖
# 🚀 Installing
To install this as a global package use the below command
```bash
# NPM
npm install -g boltnet
# Yarn
yarn global add boltnet
```
# 🔨 Usage
- [🔘 Create Cluster](#create-cluster)
- [⚛️ Create Single Instance](#create-single-instance)
- [✂️ Prune Networks](#prune-networks)
- [🏺 Detete Boltnet Containers](#detete-boltnet-containers)
The best way to start using **boltnet** is to execute `boltnet --help`.
```
Usage: boltnet [options]
Options:
--version Show version number [boolean]
--prune [boolean] [default: false]
-x, --remove Removes all boltnet created container [boolean]
-c, --cluster Creates a neo4j cluster with a default of 3 Core members
[number] [default: 3]
-r, --read-replica Sets read replicas to the initial cluster
[number] [default: 0]
-u, --user-name Set username for the authentication
[string] [default: "neo4j"]
-p, --user-password Set password for the authentication
[string] [default: "newpassword"]
-i, --image [string] [default: "4.3-enterprise"]
-h, --help Show help [boolean]
```
Main functionalities include:
## Create Cluster
```bash
# Create a cluster with default settings
# 3 Core members, 0 Read replicas, Username/Password: neo4j/newpassword , Neo4j Image: 4.3-enterprise
boltnet -c
# Create a cluster with custom settings
# 4 Core members, 2 Read replicas, Username/Password: random/randompass , Neo4j Image: 4.0.1-enterprise
boltnet -c 4 -r 2 -u random -p randompass -i 4.0.1-enterprise
```
## Create Single Instance
```bash
# Create a single instance with default settings
# Username/Password: neo4j/newpassword , Neo4j Image: 4.3-enterprise
boltnet -s
# Create a single instance with custom settings
# 4Username/Password: random/randompass , Neo4j Image: 4.0.1-enterprise
boltnet -s -u random -p randompass -i 4.0.1-enterprise
```
## Prune Networks
Every time a cluster is created, there is also a bridge network created for the cluster members to communicate with each other.
You can prune unused networks:
```bash
boltnet --prune
```
## Detete Boltnet Containers
To delete all running/created **boltnet** containers run:
```bash
boltnet --x
```
# 📣 Feedback
If you have any suggestions or want a more advanced feature on **boltnet**, feel free to open an issue.