yorkie-cluster

README

yorkie-cluster

Yorkie cluster design & Docker/Kubernetes implementation

Table of Contents

• Getting Started
  • Prerequisites
  • Instructions
• Development
  • Cluster Modes
  • Project Structure
  • Kubernetes Structure
  • About Yorkie
• Roadmap

Getting Started

If you want to setup and test yorkie cluster, just clone this repository and follow instructions bellow.

Prerequisites

• docker : Docker system for deploying yorkie cluster in local environment
• minikube : Local k8s for deploying yorkie cluster in local environment
• kubectl : K8s CLI for deploying & testing yorkie cluster
• istioctl : Istio CLI for istio installation & service mesh

Instructions

This instruction builds K8s & Istio based Yorkie lookup cluster mode.

# 1. clone repository
git clone https://github.com/krapie/yorkie-cluster.git

# 2. change to project directory
cd yorkie-cluster

# 3. start minikube cluster
minikube start

# 4. Install Istioctl and set PATH
curl -L https://istio.io/downloadIstio | sh -

cd istio-1.17.1

export PATH=$PWD/bin:$PATH

# 5. Install Istio with demo profile
istioctl install --set profile=demo -y

# 6. create yorkie namespace and switch context (optional)
kubectl create namespace yorkie
# kubectl config set-context --current --namespace yorkie

# 7. Set auto envoy sidecar injetion in namespace
kubectl label namespace yorkie istio-injection=enabled

# 5. deploy all minikube manifests in minikube cluster
kubectl apply -f minikube/lookup-cluster-mode --recursive

# 6. start minikube tunneling for local connection
minikube tunnel

# 7. test yorkie api!
const client = new yorkie.Client('http://localhost');

For play with more fun stuff,

# 9. deploy monitoring tools if you want to see metrics
#    (ignore json error, it's grafana json file, not k8s manifest file)
kubectl apply -f monitoring --recursive

# 10. enter grafana web url in your browser
curl http://localhost

# 11. clone dashboard repository for admin dashboard!
#     (change REACT_APP_ADMIN_ADDR to http://localhost)
git clone https://github.com/yorkie-team/dashboard.git

# 12. clone yorkie-tldraw repository for real-time collaboration whiteboard!
#     (change REACT_APP_YORKIE_RPC_ADDR to http://localhost)
git clone https://github.com/krapie/yorkie-tldraw.git

Development

LookUp Cluster Mode PoC on K8s & Istio is now availiable. For more information, follow: Yorkie LookUp Cluster Mode

Cluster Modes

There are two cluster modes implemented by docker, kompose, and kubernetes:

• Broadcast Cluster Mode : Yorkie cluster mode based on broadcasting & pub/sub & distributed lock. For more information about the design, follow this page: Yorkie Broadcast Cluster Mode
• LookUp Cluster Mode : Yorkie cluster mode based on routing & sharding. This cluster mode is in progress For more information about the design, follow this page: Yorkie Lookup Cluster Mode

Project Structure

Current project structure look like this:

• docker : Docker-compose manifests for simple deployment. This folder contains two cluster modes
  • broadcast-cluster-mode : Yorkie broadcast cluster mode using docker-compose
  • lookup-cluster-mode : Yorkie lookup cluster mode using docker-compose
• kompose : K8s manifests converted from yorkie docker-compose files
  • broadcast-cluster-mode : Yorkie broadcast cluster mode converted from docker-compose
• minikube : K8s manifests for local k8s cluster (minikube)
  • broadcast-cluster-mode : Yorkie broadcast cluster mode using K8s
  • lookup-cluster-mode : Yorkie lookup cluster mode using K8s & Istio
• monitoring : K8s manifest for monitoring tool (prometheus & grafana)

About Yorkie

Yorkie is an open source document store for building collaborative editing applications. Yorkie uses JSON-like documents(CRDT) with optional types.

Yorkie references

• Yorkie Github: https://github.com/yorkie-team/yorkie
• Yorkie Docs: https://yorkie.dev/

Roadmap

• Yorkie Broadcast Cluster Mode on minikube (local, simple version)
• Yorkie LookUp Cluster Mode on docker (local, PoC)
• Yorkie LookUp Cluster Mode on minikube (istio & envoy sidecar, PoC)
• Yorkie LookUp Cluster Mode on minikube (istio & envoy sidecar)
• Yorkie LookUp Cluster Mode on AWS (cloud)