{"id":28279033,"url":"https://github.com/krapie/yorkie-cluster","last_synced_at":"2025-10-23T02:27:02.624Z","repository":{"id":64563531,"uuid":"574537902","full_name":"krapie/yorkie-cluster","owner":"krapie","description":"Yorkie cluster design \u0026 container implementation","archived":false,"fork":false,"pushed_at":"2023-04-12T12:55:05.000Z","size":1552,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-18T20:45:05.145Z","etag":null,"topics":["cluster","docker","kubernetes","minikube","yorkie"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/krapie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-05T14:29:28.000Z","updated_at":"2023-03-04T14:30:26.000Z","dependencies_parsed_at":"2024-06-21T19:14:12.980Z","dependency_job_id":"174e5807-6f3f-487f-81ed-bd8ca8500915","html_url":"https://github.com/krapie/yorkie-cluster","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/krapie/yorkie-cluster","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krapie%2Fyorkie-cluster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krapie%2Fyorkie-cluster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krapie%2Fyorkie-cluster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krapie%2Fyorkie-cluster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/krapie","download_url":"https://codeload.github.com/krapie/yorkie-cluster/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krapie%2Fyorkie-cluster/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267399984,"owners_count":24081176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cluster","docker","kubernetes","minikube","yorkie"],"created_at":"2025-05-21T08:18:26.556Z","updated_at":"2025-10-23T02:27:02.535Z","avatar_url":"https://github.com/krapie.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# yorkie-cluster\n\nYorkie cluster design \u0026 Docker/Kubernetes implementation\n\n## Table of Contents\n\n- [yorkie-cluster](#yorkie-cluster)\n  - [Table of Contents](#table-of-contents)\n  - [Getting Started](#getting-started)\n    - [Prerequisites](#prerequisites)\n    - [Instructions](#instructions)\n  - [Development](#development)\n    - [Cluster Modes](#cluster-modes)\n    - [Project Structure](#project-structure)\n    - [About Yorkie](#about-yorkie)\n  - [Roadmap](#roadmap)\n\n## Getting Started\n\nIf you want to setup and test yorkie cluster,\njust clone this repository and follow instructions bellow.\n\n### Prerequisites\n\n- `docker` : Docker system for deploying yorkie cluster in local environment\n- `minikube` : Local k8s for deploying yorkie cluster in local environment\n- `kubectl` : K8s CLI for deploying \u0026 testing yorkie cluster\n- `istioctl` : Istio CLI for istio installation \u0026 service mesh\n- `helm` : Helm CLI for deploying yorkie cluster helm chart\n\n### Instructions\n\nThis instruction builds K8s \u0026 Istio based Yorkie lookup cluster mode.\n\n```bash\n# 1. clone repository\ngit clone https://github.com/krapie/yorkie-cluster.git\n\n# 2. change to project directory\ncd yorkie-cluster/helm\n\n# 3. start minikube cluster\nminikube start\n\n# 4. Install Istio with default profile\nistioctl install --set profile=default -y\n\n# 5. Install/Upgrade yorkie cluster helm chart\nhelm install yorkie-cluster ./yorkie-cluster\n\n# 6. start minikube tunneling for local connection\nminikube tunnel\n\n# 7. test yorkie api!\nconst client = new yorkie.Client('http://localhost');\n```\n\n## Development\n\n\u003e LookUp Cluster Mode PoC on K8s \u0026 Istio is now availiable. For more information, follow: [Yorkie LookUp Cluster Mode](./minikube/lookup-cluster-mode/README.md)\n\n### Cluster Modes\n\nThere are two cluster modes implemented by docker, kompose, and kubernetes:\n\n- **Broadcast Cluster Mode** : Yorkie cluster mode based on broadcasting \u0026 pub/sub \u0026 distributed lock.\n  For more information about the design, follow this page: [Yorkie Broadcast Cluster Mode](design/broadcast-cluster-mode.md)\n- **LookUp Cluster Mode** : Yorkie cluster mode based on routing \u0026 sharding. This cluster mode is in progress\n  For more information about the design, follow this page: [Yorkie Lookup Cluster Mode](https://github.com/yorkie-team/yorkie/issues/472)\n\n### Project Structure\n\nCurrent project structure look like this:\n\n- `docker` : Docker-compose manifests for simple deployment. This folder contains two cluster modes\n  - `broadcast-cluster-mode` : Yorkie broadcast cluster mode using docker-compose\n  - `lookup-cluster-mode` : Yorkie lookup cluster mode using docker-compose\n- `helm` : Helm chart for Yorkie cluster deployment\n  - `yorkie-cluster` : Yorkie cluster helm chart\n- `kompose` : K8s manifests converted from yorkie docker-compose files\n  - `broadcast-cluster-mode` : Yorkie broadcast cluster mode converted from docker-compose\n- `minikube` : K8s manifests for local k8s cluster (minikube)\n  - `broadcast-cluster-mode` : Yorkie broadcast cluster mode using K8s\n  - `lookup-cluster-mode` : Yorkie lookup cluster mode using K8s \u0026 Istio\n- `monitoring` : K8s manifest for monitoring tool (prometheus \u0026 grafana)\n\n### About Yorkie\n\nYorkie is an open source document store for building\ncollaborative editing applications.\nYorkie uses JSON-like documents(CRDT) with optional types.\n\nYorkie references\n\n- Yorkie Github: [https://github.com/yorkie-team/yorkie](https://github.com/yorkie-team/yorkie)\n- Yorkie Docs: [https://yorkie.dev/](https://yorkie.dev/)\n\n## Roadmap\n\n- [x] Yorkie Broadcast Cluster Mode on minikube (local, simple version)\n- [x] Yorkie LookUp Cluster Mode on docker (local, PoC)\n- [x] Yorkie LookUp Cluster Mode on minikube (istio \u0026 envoy sidecar, PoC)\n- [ ] Yorkie LookUp Cluster Mode on minikube (istio \u0026 envoy sidecar)\n- [ ] Yorkie LookUp Cluster Mode on AWS (cloud)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrapie%2Fyorkie-cluster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkrapie%2Fyorkie-cluster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrapie%2Fyorkie-cluster/lists"}