[README] update readme.md & folder structure

Author: krapie

README.md

@@ -4,45 +4,83 @@ Yorkie cluster on kubernetes
 
 ## Table of Contents
 
-- Getting Started
-  - Prerequisites
-  - Instructions
-- Development
-  - Project Requirements
-  - Project Structure
-  - About Yorkie
-- Roadmap
-- Uploads
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Instructions](#instructions)
+- [Development](#development)
+  - [Project Structure](#project-structure)
+  - [About Yorkie](#about-yorkie)
+- [Roadmap](#roadmap)
 
 ## Getting Started
 
-(WIP)
+If you want to setup and test yorkie cluster on k8s,
+just clone this repository and follow instructions bellow.
 
 ### Prerequisites
 
-- (WIP)
+- `minikube` : local k8s for deploying yorkie cluster in local environment
+- `kubectl` : k8s cli for deploying & testing yorkie cluster
 
 ### Instructions
 
 ```bash
-(WIP)
+# 1. clone repository
+git clone https://github.com/Krapi0314/yorkie-kubernetes.git
+
+# 2. change to project directory
+cd yorkie-kubernetes
+
+# 3. start minikube cluster
+minikube start
+
+# 4. enable minikube ingress addon
+minikube addons enable ingress
+
+# 5. start minikube tunneling for local connection
+minikube tunnel
+
+# 6. deploy all minikube manifests in minikube cluster
+kubectl apply -f minikube --recursive
+
+# 7. test yorkie api!
+const client = new yorkie.Client('http://localhost');
 ```
 
-## Development
+For play with more fun stuff,
 
-### Project Components
+```bash
+# 8. 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
 
-- (WIP)
+# 9. enter grafana web url in your browser
+curl http://localhost
 
-### Project Structure
+# 10. clone dashboard repository for admin dashboard!
+#     (change REACT_APP_ADMIN_ADDR to http://localhost)
+git clone https://github.com/yorkie-team/dashboard.git
 
-**Kubernetes**
+# 11. clone yorkie-tldraw repository for real-time collaboration whiteboard!
+#     (change REACT_APP_YORKIE_RPC_ADDR to http://localhost)
+git clone https://github.com/Krapi0314/yorkie-tldraw.git
+```
 
-(WIP)
+## Development
+
+### Project Structure
+
+- `kompose` : k8s manifests converted from yorkie docker-compose files
+- `minikube` : k8s manifests for local k8s cluster (minikube)
+  - **istio & envoy sidecar is not implemented to simplify**
+    **yorkie cluster architecture in local environment, and also instruction guide**
+- `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 is an open source document store for building
+collaborative editing applications.
+Yorkie uses JSON-like documents(CRDT) with optional types.
 
 Yorkie references
 
@@ -51,13 +89,7 @@ Yorkie references
 
 ## Roadmap
 
-### **Phase 1**
-
-- [x] (WIP)
-
-
-## Updates
-
-### **v0.0.1**
-
-- (WIP)
+- [x] yorkie broadcasting cluster mode on minikube (local)
+- [ ] yorkie broadcasting cluster mode on GKE (cloud)
+- [ ] yorkie cluster mode (other architectural approach) on minikube (local)
+- [ ] yorkie cluster mode (other architectural approach) on GKE (cloud)

minikube/config/envoy-configmap.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: ConfigMap
 metadata:
   name: envoy-configmap
+  namespace: default
   labels:
     app: envoy
 data:

minikube/deployment/envoy-deployment.yaml

@@ -2,6 +2,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: envoy-deployment
+  namespace: default
   labels:
     app: envoy
 spec:
@@ -21,6 +22,8 @@ spec:
             - containerPort: 8080
             - containerPort: 9090
             - containerPort: 9901
+          # resources will be configured in later updates
+          # (need to load test to configure resource capacity)
           resources: {}
           volumeMounts:
             - name: envoy-config

minikube/deployment/etcd-statefulset.yaml

@@ -2,6 +2,7 @@ apiVersion: apps/v1
 kind: StatefulSet
 metadata:
   name: etcd-statefulset
+  namespace: default
   labels:
     app: etcd
 spec:
@@ -33,6 +34,9 @@ spec:
               value: "revision"
             - name: ETCD_AUTO_COMPACTION_RETENTION
               value: "1000"
+          # resources will be configured in later updates
+          # (need to load test to configure resource capacity)
+          resources: {}
   volumeClaimTemplates:
     - metadata:
         name: etcd-persistent-storage

minikube/deployment/mongo-statefulset.yaml

@@ -2,6 +2,7 @@ apiVersion: apps/v1
 kind: StatefulSet
 metadata:
   name: mongo-statefulset
+  namespace: default
   labels:
     app: mongo
 spec:
@@ -25,6 +26,9 @@ spec:
           volumeMounts:
             - name: mongo-persistent-storage
               mountPath: /data/db
+          # resources will be configured in later updates
+          # (need to load test to configure resource capacity)
+          resources: {}
   volumeClaimTemplates:
     - metadata:
         name: mongo-persistent-storage

minikube/deployment/yorkie-server-deployment.yaml

@@ -2,10 +2,11 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: yorkie-server-deployment
+  namespace: default
   labels:
     app: yorkie-server
 spec:
-  replicas: 2
+  replicas: 3
   selector:
     matchLabels:
       app: yorkie-server
@@ -16,6 +17,8 @@ spec:
     spec:
       containers:
         - name: yorkie
+          # env will be configured in later updates
+          # (including secrets for certain variables)
           args:
             - server
             - --mongo-connection-uri
@@ -28,4 +31,6 @@ spec:
             - containerPort: 11101
             - containerPort: 11102
             - containerPort: 11103
+          # resources will be configured in later updates
+          # (need to load test to configure resource capacity)
           resources: {}

minikube/networking/ingress/yorkie-ingress.yaml

@@ -1,7 +1,9 @@
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
+  # using nginx ingress controller for minikube environment
   name: yorkie-ingress
+  namespace: default
 spec:
   rules:
     - http:
@@ -20,10 +22,11 @@ spec:
                 name: envoy-service
                 port:
                   number: 9090
-          - path: /
-            pathType: Prefix
-            backend:
-              service:
-                name: grafana-service
-                port:
-                  number: 3000
+          # uncomment this section if you deployed monitoring manifests
+          # - path: /
+          #   pathType: Prefix
+          #   backend:
+          #     service:
+          #       name: grafana-service
+          #       port:
+          #         number: 3000

minikube/service/envoy-service.yaml

@@ -2,10 +2,11 @@ apiVersion: v1
 kind: Service
 metadata:
   name: envoy-service
+  namespace: default
   labels:
     app: envoy
 spec:
-  type: NodePort
+  clusterIP: None
   selector:
     app: envoy
   ports:

minikube/service/etcd-service.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: etcd-service
+  namespace: default
   labels:
     app: etcd
 spec:

minikube/service/mongo-service.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: mongo-service
+  namespace: default
   labels:
     app: mongo
 spec:

minikube/service/yorkie-service.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: yorkie-service
+  namespace: default
   labels:
     app: yorkie-server
 spec:

minikube/config/prometheus-configmap.yaml monitoring/config/prometheus-configmap.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: ConfigMap
 metadata:
   name: prometheus-configmap
+  namespace: default
 data:
   prometheus.yml: |
     scrape_configs:

minikube/deployment/grafana-deployment.yaml monitoring/deployment/grafana-deployment.yaml

@@ -2,6 +2,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: grafana-deployment
+  namespace: default
   labels:
     app: grafana
 spec:
@@ -19,4 +20,6 @@ spec:
           image: grafana/grafana:latest
           ports:
             - containerPort: 3000
+          # resources will be configured in later updates
+          # (need to load test to configure resource capacity)
           resources: {}

minikube/deployment/prometheus-deployment.yaml monitoring/deployment/prometheus-deployment.yaml

@@ -2,6 +2,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: prometheus-deployment
+  namespace: default
   labels:
     app: prometheus
 spec:
@@ -27,6 +28,8 @@ spec:
               mountPath: /etc/prometheus/
             - name: prometheus-storage-volume
               mountPath: /prometheus/
+          # resources will be configured in later updates
+          # (need to load test to configure resource capacity)
           resources: {}
       volumes:
         - name: prometheus-config

minikube/service/grafana-service.yaml monitoring/service/grafana-service.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: grafana-service
+  namespace: default
   labels:
     app: grafana
 spec:

minikube/service/prometheus-service.yaml monitoring/service/prometheus-service.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: protetheus-service
+  namespace: default
   labels:
     app: protetheus
 spec: