Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paypal/junodb

JunoDB is PayPal's home-grown secure, consistent and highly available key-value store providing low, single digit millisecond, latency at any scale.
https://github.com/paypal/junodb

Last synced: 1 day ago
JSON representation

JunoDB is PayPal's home-grown secure, consistent and highly available key-value store providing low, single digit millisecond, latency at any scale.

Awesome Lists containing this project

README 

        
# JunoDB - A secure, consistent and highly available key-value store



[![License](http://img.shields.io/:license-Apache%202-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)

[![Build](https://github.com/paypal/junoDB/actions/workflows/juno_server_bin_build.yml/badge.svg?branch=main)](https://github.com/paypal/junoDB/actions/workflows/juno_server_bin_build.yml)

[![Docker](https://github.com/paypal/junoDB/actions/workflows/juno_server_docker_build.yml/badge.svg?branch=main)](https://github.com/paypal/junoDB/actions/workflows/juno_server_docker_build.yml)



## What is JunoDB

JunoDB is PayPal's home-grown secure, consistent and highly available key-value store providing low, single digit millisecond, latency at any scale. 



  * [High Level Architecture](docs/junodb_arch_overview.md)

  * [Wire protocol](docs/wireprotocol.md)

  * [Contributing](docs/contributing.md)



## Getting Started with the JunoDB Server



### Clone the repository from [github](https://github.com/paypal/junodb)



```bash

git clone https://github.com/paypal/junodb.git

```



### Set BUILDTOP variable



```bash

export BUILDTOP=/junodb

cd $BUILDTOP

```



Continue building JunoDB server with 

1. [Docker build](#docker-build) or 

2. [Manual build](#manual-build) 





## Docker Build



* [Docker](#docker-build)    

    * [Install Dependencies](#docker_install_dependencies)

    * [Build JunoDB](#docker_build_junodb)

    * [Run JunoDB](#docker_run_junodb)

    * [Generate Secrets for Dev](#docker_secrets)

    * [Validate JunoDB](#docker_validate_junodb)



**Note** :

Docker build supported platforms

- Linux (Ubuntu)

- OS X (macOS)

### 
Install Dependencies


[Install Docker Engine version 20.10.0+](https://docs.docker.com/engine/install/ubuntu/)

Check for existing docker version

```bash

docker version

```



Install Docker if not installed or version is older than 20.10.0

```bash

docker/setup.sh

#If you are not added to the docker group, you will have to logout and login in the machine after running docker/setup.sh

```



If the user is not added to `docker` group, you may add manually. Logout and re-login after this step.

```bash

sudo usermod -a -G docker $USER

```



Verify that your username is added to docker group

```bash

groups



#or

cat /etc/group | grep docker

```



### 
Build JunoDB


```bash

#Login to docker hub account 

docker login



# Build junodb docker images

#etcd

#clustercfg

#storageserv

#proxy 

#junoclient



docker/build.sh 

```



### 
Run JunoDB


```bash

# Setup junodb network and start junodb services

#etcd

#clustercfg

#storageserv

#proxy 

#junoclient



# JunoDB proxy service listens on port 

# :5080 TLS and :8080 TCP

docker/start.sh 



```



### Shutdown JunoDB services

```bash

# This will shutdown junodb services

#etcd

#clustercfg

#storageserv

#proxy 

#junoclient



docker/shutdown.sh 



```



### Manually Run JunoDB services

```bash

#This can be done instead of ./start.sh to start up the docker services



cd $BUILDTOP/docker/manifest



# To run junodb services in --detach mode (recommended)

docker compose up -d



# Juno proxy service listens on port 

# :5080 TLS and :8080 TCP



#To view the running containers 

docker ps



# To stop junodb services

docker compose down

```

### 
Generate Secrets for Dev







> **_NOTE:_**  secrets for TLS and Encryption can be generated for dev/testing.

```bash 

sh $BUILDTOP/docker/manifest/config/secrets/gensecrets.sh



## generated secrets

# server.crt/server.pem - certificate/key for junodb proxy for TLS 

# ca.crt - CA cert

# keystore.toml - sample keystore file

```



### 
Validate JunoDB



Login to docker client and check connection with proxy

```bash 

docker exec -it junoclient bash -c 'nc -vz proxy 5080'

```







### You can also test the junodb server by running junocli and junoload





### JunoCLI


The following commands log in to the docker client and run the ./junocli command directly. The proxy ip is aliased as "proxy"



1. CREATE

```bash 

docker exec -it junoclient bash -c '/opt/juno/junocli create -s proxy:8080 -c config.toml -ns test_ns test_key test_value'

```



2. GET

```bash 

docker exec -it junoclient bash -c '/opt/juno/junocli get -s proxy:8080 -c config.toml -ns test_ns test_key'

```



3. UPDATE

```bash

docker exec -it junoclient bash -c '/opt/juno/junocli update -s proxy:8080 -c config.toml -ns test_ns test_key test_value_updated'

```



4. DESTROY

```bash

docker exec -it junoclient bash -c '/opt/juno/junocli destroy -s proxy:8080 -c config.toml -ns test_ns test_key'

```



More about junocli [here](docs/junocli.md) 







### Junoload



The following command logs in to the docker client and runs the ./junoload command directly. Junoload can be used for benchmarking juno server. 

The proxy ip is aliased as "proxy"



```bash 

docker exec -it junoclient bash -c '/opt/juno/junoload -s proxy:5080 -ssl -c config.toml -o 1'

```

More about junoload [here](docs/junoload.md) 











## Manual Build



**Note** : 

Manual build supported platforms

- Linux (Ubuntu 20.04)



The following sections explain the process for manually building the JunoDB server without Docker. These instructions are based on an Ubuntu 20.04.5 system

* [Manual](#manual-build)    

    * [Install Dependencies](#manual_install_dependencies)

    * [Build JunoDB](#manual_build_junodb)

    * [Run JunoDB](#manual_run_junodb)

    * [Validate](#manual_validate_junodb)

    * [Shutdown JunoDB](#manual_shutdown_junodb)



### 
Install Dependencies



Install [OpenSSL 1.0.2g+](https://www.openssl.org/source/)

```bash

sudo apt install openssl

```



Install [multilog](https://manpages.ubuntu.com/manpages/bionic/man8/multilog.8.html)



```bash

sudo apt install daemontools

```



Install dependencies for rocksdb



```bash

sudo apt-get install build-essential libgflags-dev libsnappy-dev zlib1g-dev libbz2-dev liblz4-dev libzstd-dev -y

```






Install Python 



```bash

#install python

sudo apt-get install python3.8

#set soft link

cd /usr/bin

sudo ln -s python3.8 python

```



### 
Build JunoDB


```bash

binary_build/build.sh

```





### 
Run JunoDB


```bash

export JUNO_BUILD_DIR=$BUILDTOP/release-binary/code-build

script/deploy.sh

```





### 
Validate JunoDB


```bash

#Validate if deploy was successful by checking if the proxy (junoserv), storage (junostorageserv), and etcd (junoclusterserv) processes are running

ps -eaf | grep juno

#There should be 41 processes running

#5 for junoclusterserv (3 logs, 1 etcdsvr.py, 1 etcdsvr_exe)

#20 for junostorageserv (6 logs, 1 manager, 12 workers, 1 monitor)

#16 for junoserv (6 logs, 1 manager, 8 workers, 1 monitor)

```





### Test out the server using junocli and junoload command

See instructions for junocli [here](docs/junocli.md) 


See instructions for junoload [here](docs/junoload.md) 



### Run functional tests

```bash

#Assuming user is in $BUILDTOP folder

test/functest/configsetup.sh

cd test/functest

$BUILDTOP/release-binary/tool/go/bin/go test -v -config=config.toml

```





### Run unit tests

```bash

#Assuming user is in $BUILDTOP folder

cd test/unittest

$BUILDTOP/release-binary/tool/go/bin/go test -v

```



### 
Shutdown JunoDB Services


```bash

#Assuming user is in $BUILDTOP folder

script/deploy.sh stop

```