feat: improve to visualize the view-pages (namespace, topology)

README.md

@@ -13,7 +13,7 @@ Kore보드는 쿠버네티스 다중 클러스터 관리를 위한 웹 기반 UI
 ### Installation
 
 ```
-$ kubectl apply -f https://raw.githubusercontent.com/kore3lab/dashboard/master/scripts/install/kuberntes/recommended.yaml
+$ kubectl apply -f https://raw.githubusercontent.com/kore3lab/dashboard/master/scripts/install/kubernetes/recommended.yaml
 ```
 
 See [Installation Guide](./docs/user/installation.md) page for more information

docs/README.md

@@ -7,7 +7,6 @@
   * [API Specification](./developer/api-specification.md)
   * [Packaging Helm-chart](./developer/helm-chart.md)
   * [Web-Terminal Developer Guide](./developer/app-terminal.md)
-  * [Graph Developer Guide](./developer/app-graph.md)
 
 
 * [User Guide](./user/README.md)

docs/developer/README.md

@@ -5,4 +5,3 @@
 * [API Specification](./api-specification.md)
 * [Packaging Helm-chart](./helm-chart.md)
 * [Web-Terminal Developer Guide](./app-terminal.md)
-* [Graph Developer Guide](./app-graph.md)

docs/developer/api-specification.md

@@ -15,7 +15,7 @@
 
 ```
 $ curl -X GET http://localhost:3001/api/contexts
-$ curl -X GET http://localhost:3001/api/clusters/kubernetes@in-cluster/topology
+$ curl -X GET http://localhost:3001/api/clusters/kubernetes@in-cluster/graph/topology
 $ curl -X GET http://localhost:3001/api/clusters/kubernetes@in-cluster/dashboard
 ```
 

docs/developer/architecture.md

@@ -12,21 +12,89 @@ Terminal은 웹 UI에서 클러스터 및 파드 실행 터미널 서비스를 
 
 아래 그림은 프로젝트의 아키텍처를 간략하게 보여줍니다.
 
-![Architecture Overview](../images/architecture.png)
+![Architecture Overview](../images/architecture.v2.png)
 
+## Summary of function points.
 
+* Backend
+  * 인증 (로그인, 로그아웃) 및 세션키 발급 
+  * 멀티클러스터 Context 관리
+  * 클러스터별 Kubernetes API-Server 연동
+  * 클러스터별 Basic Core Resource 조회 및 생성,수정,삭제
+  * Custom Resource 조회 및 생성,수정,삭제
+  * Metrics-Scraper 연동을 통한 클러스터별, 노드별, 워크로드별 메트릭스 조회
+  * Workload 확장 조회
+  * 클러스터 이벤트 & 로그 조회
+* Metrics-Scraper
+  * 클러스터별 Metrics-Server 연동
+  * 클러스터별 Metrics 수집 및 저장
+  * 클러스터별, 노드별, 워크로드별 Metrics Summary API 제공
 * Frontend
-  * Vue, NuxtJS framework
-  * source code : src/app/frontend
+  * Backend, Metrics-Scraper, Terminal 컴포넌트 연동
+  * Basic & Core Resource 조회 화면
+  * Extention Resource 조회 화면
+  * Resource 등록, 수정, 삭제 화면
+  * Resource 검색 기능
+  * 노드 및  워크로드 Terminal 서비스 화면
+  * 워크로드 로그 조회 화면
+* Terminal
+  * 노드 및 워크로드에 대한 터미널 인스턴스
+  * 멀티클러스터 Context 연계
+  * 보안 인증 (Token) 처리
+  * 터미널 화면 연계를 위한 Socket 모듈
 
-* Backend
-  * Golang
-  * 소스코드 위치 src/app/backend 디렉토리
+## Summary of function points.
 
-* Metric-Scraper
-  * Golang
-  * source code : src/app/metric-server
+* Cluster
+  * Topology
+  * Namespaces
+  * Events
+* Workload
+  * Pods
+  * Deployments
+  * StatefulSets
+  * Cron Jobs
+  * Jobs
+  * Daemon Sets
+  * Replica Sets
+* Networking
+  * Services
+  * Ingress
+  * Endpoints
+  * Network Polices
+* Storage
+  * Persistent Volumn Claims
+  * Persistent Volumns
+  * Storage Classes
+* Configuration
+  * Config Maps
+  * Secrets
+  * Resource Quotas
+  * Limit Ranges
+  * Horizontal Pod Autoscalers
+  * Pod Disruption Budgets
+* Administrator
+  * Service Accounts
+  * Clsuter Roles
+  * Clsuter Roles Bindings
+  * Roles
+  * Role Bindings
+* Custom Resource
+  * Definitions
+  * CRD 
+* Commons
+  * Index(dashboard)
+  * Login
+  * Create
+  * Terminal
+  * Context Manager
+
+## Repository directires
+  * docs : documentations
+  * scripts : install & build scripts
+  * src : source codes root
+  * src/app/frontend :  source codes of frontend component
+  * src/app/backend : source codes of backend component
+  * src/app/metric-server : source codes of metric-server component
+  * src/app/terminal : source codes of terminal component
 
-* Terminal
-  * Golang
-  * source code : src/app/terminal

docs/developer/getting-started.md

@@ -20,14 +20,9 @@ $ git clone https://github.com/kore3lab/dashboard.git
 $ cd dashboard
 ```
 
-* Installation dependencies (frontend,graph)
+* Installation dependencies (frontend)
 
 ```
-# graph
-$ cd ../src/app/graph
-$ npm i
-
-$ cd ../../..
 $ npm i
 ```
 
@@ -56,7 +51,6 @@ $ curl http://localhost:3003/healthy
 ### Using ports
 * 3000 : front-end
 * 3001 : backend (restful-api)
-* 3002 : graph 개발
 * 3003 : terminal
 * 8000 : metrics scraper
 
@@ -71,14 +65,11 @@ $ npm run start:frontend        # frontend 실행
 $ npm run start:backend         # backend 실행
 $ npm run start:metrics-scraper # metrics scraper 실행
 $ npm run start:terminal        # container 에서 terminal 실행 
-$ npm run start:graph           # graph 실행
-$ npm run start:graph:backend   # 그래프 개발 실행 (backend + graph)
 ```
 
 * Build
 ```
 $ npm run build:frontend      # frontend 빌드 (using on docker build)
-$ npm run build:graph         # 그래프 빌드 frontend 에 변경된 최신 그래프 적용시 사용
 $ npm run run                 # frontend container 에서 nuxt 실행 (docker image entrypoint) 
 $ npm run build:terminal      # terminal 빌드 (using on docker build)
 ```

docs/developer/helm-chart.md

@@ -3,13 +3,13 @@
 * validation
 
 ```
-$ helm lint scripts/install/kuberntes/helm-chart
+$ helm lint scripts/install/kubernetes/helm-chart
 ```
 
 * output to yaml
 
 ```
-$ helm template -n kore kore-board scripts/install/kuberntes/helm-chart \
+$ helm template -n kore kore-board scripts/install/kubernetes/helm-chart \
   --set frontend.service.type=NodePort \
   --set frontend.service.nodePort=30080
 ```
@@ -18,7 +18,7 @@ $ helm template -n kore kore-board scripts/install/kuberntes/helm-chart \
 
 ```
 $ kubectl create ns kore
-$ helm template --debug -n kore kore-board scripts/install/kuberntes/helm-chart \
+$ helm template --debug -n kore kore-board scripts/install/kubernetes/helm-chart \
   --set frontend.service.type=NodePort \
   --set frontend.service.nodePort=30080 \
   | kubectl apply -n kore -f -
@@ -28,14 +28,14 @@ $ helm template --debug -n kore kore-board scripts/install/kuberntes/helm-chart
 * dry-run
 
 ```
-$ helm install --dry-run -n kore kore-board scripts/install/kuberntes/helm-chart \
+$ helm install --dry-run -n kore kore-board scripts/install/kubernetes/helm-chart \
   --set frontend.service.type=NodePort \
   --set frontend.service.nodePort=30080
 ```
 
 * packaging helm-chart
 
 ```
-$ helm package scripts/install/kuberntes/helm-chart  -d scripts/install/kuberntes   # packaging  (tgz file 생성)
-$ helm repo index scripts/install/kuberntes                                         # index.yaml 파일 생성/수정
+$ helm package scripts/install/kubernetes/helm-chart  -d scripts/install/kubernetes   # packaging  (tgz file 생성)
+$ helm repo index scripts/install/kubernetes                                         # index.yaml 파일 생성/수정
 ```

docs/user/installation.md

@@ -26,12 +26,12 @@ $ kubectl apply -f https://raw.githubusercontent.com/kore3lab/dashboard/master/s
 
 * Installation
 ```
-$ kubectl apply -f ./scripts/install/kuberntes/recommended.yaml
+$ kubectl apply -f ./scripts/install/kubernetes/recommended.yaml
 ```
 
 * clean-up
 ```
-$ kubectl delete -f ./scripts/install/kuberntes/recommended.yaml
+$ kubectl delete -f ./scripts/install/kubernetes/recommended.yaml
 ```
 
 ### Installation using Helm-chart
@@ -41,7 +41,7 @@ $ kubectl delete -f ./scripts/install/kuberntes/recommended.yaml
 
 ```
 $ kubectl create ns kore
-$ helm install -n kore kore-board ./scripts/install/kuberntes/helm-chart/ \
+$ helm install -n kore kore-board ./scripts/install/kubernetes/helm-chart/ \
   --set backend.service.type=NodePort \
   --set backend.service.nodePort=30081 \
   --set frontend.service.type=NodePort \