Skip to content

Commit 2ee821b

Browse files
committed
[Readme] update reamde.md with argocd screenshot
1 parent 9674564 commit 2ee821b

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Yorkie cluster on kubernetes
99
- [Instructions](#instructions)
1010
- [Development](#development)
1111
- [Project Structure](#project-structure)
12+
- [Minikube Structure](#minikube-structure)
1213
- [About Yorkie](#about-yorkie)
1314
- [Roadmap](#roadmap)
1415

@@ -72,10 +73,23 @@ git clone https://github.com/Krapi0314/yorkie-tldraw.git
7273

7374
- `kompose` : k8s manifests converted from yorkie docker-compose files
7475
- `minikube` : k8s manifests for local k8s cluster (minikube)
75-
- **istio & envoy sidecar is not implemented to simplify**
76+
- **istio & envoy sidecar will be implemented in later updates.**
77+
- **for now, istio is not implemented to simplify**
7678
**yorkie cluster architecture in local environment, and also instruction guide**
7779
- `monitoring` : k8s manifest for monitoring tool (prometheus & grafana)
7880

81+
### Minikube Structure
82+
83+
![argocd screenshot](./screenshot/argocd.PNG)
84+
85+
In minikube yorie cluster, there are:
86+
87+
- `yorkie-ingress` : ingress (lb, gw) for routing yorkie related services
88+
- `envoy-service` -> `envoy pod` : envoy proxy for web connection & routing api, 1 replica exists
89+
- `yorkie-service` -> `yorkie pods` : yorkie api server, 3 replica exists
90+
- `etcd-service` -> `etcd stateful pod` : etcd for cluster mode, 1 replica exists
91+
- `mongo-service` -> `mongo stateful pod` : mongodb for nosql db, 1 replica exists
92+
7993
### About Yorkie
8094

8195
Yorkie is an open source document store for building
@@ -89,7 +103,8 @@ Yorkie references
89103

90104
## Roadmap
91105

92-
- [x] yorkie broadcasting cluster mode on minikube (local)
106+
- [x] yorkie broadcasting cluster mode on minikube (local, simple version)
107+
- [ ] yorkie broadcasting cluster mode on minikube (istio & envoy sidecar)
93108
- [ ] yorkie broadcasting cluster mode on GKE (cloud)
94109
- [ ] yorkie cluster mode (other architectural approach) on minikube (local)
95110
- [ ] yorkie cluster mode (other architectural approach) on GKE (cloud)

screenshot/argocd.PNG

53.2 KB
Loading

0 commit comments

Comments
 (0)