-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: crd list page, select table columns, web terminal separation
- Loading branch information
Showing
829 changed files
with
87,050 additions
and
198,885 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,16 @@ | ||
# Kore-board Documentation | ||
|
||
* [User Guide](./user/README.md) | ||
* [Developer Guide](./developer/README.md) | ||
|
||
* [Getting started](./developer/getting-started.md) | ||
* [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) | ||
* [Installation](./user/installation.md) | ||
* [Sign-in configuration](./user/config-sign-in.md) | ||
* [Kubeconfig configuration](./user/config-kubeconfigs.md) | ||
* [Configure startup parameters](./user/config-startup-parameters.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,175 +1,8 @@ | ||
# Developer guide | ||
|
||
## Preparation | ||
* [Getting started](./getting-started.md) | ||
* [API Specification](./api-specification.md) | ||
* [Packaging Helm-chart](./helm-chart.md) | ||
* [Web-Terminal Developer Guide](./app-terminal.md) | ||
* [Graph Developer Guide](./app-graph.md) | ||
|
||
아래 소프트웨어 설치 및 $PATH 변수에 추가 필요 | ||
|
||
* Curl 7+ | ||
* Git 2.13.2+ | ||
* Docker 1.13.1+ ([installation manual](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/)) | ||
* Golang 1.13.9+ ([installation manual](https://golang.org/dl/)) | ||
* Node.js 12+ and npm 6+ ([installation with nvm](https://github.com/creationix/nvm#usage)) | ||
* Gulp.js 4+ ([installation manual](https://github.com/gulpjs/gulp/blob/master/docs/getting-started/1-quick-start.md)) | ||
|
||
## Getting started | ||
|
||
* clone | ||
|
||
``` | ||
$ git clone https://github.com/acornsoftlab/dashboard.git | ||
$ cd dashboard | ||
``` | ||
|
||
* `subtree`로 구성된 소스 중 사용되지 않는 파일을 제외하도록 지정하고 소스 트리를 업데이트합니다. | ||
|
||
``` | ||
# sparse checkout 옵션 지정 | ||
$ git config core.sparsecheckout true | ||
# 대상 파일 지정 | ||
$ cat <<EOF> .git/info/sparse-checkout | ||
/* | ||
!/src/app/metrics-scraper | ||
/src/app/metrics-scraper/hack/build.sh | ||
/src/app/metrics-scraper/pkg | ||
/src/app/metrics-scraper/vendor | ||
/src/app/metrics-scraper/Dockerfile | ||
/src/app/metrics-scraper/go.* | ||
/src/app/metrics-scraper/*.go | ||
!/src/app/metrics-scraper/**/*_test.go | ||
EOF | ||
# 트리 업데이트 | ||
$ git read-tree HEAD -m -u | ||
``` | ||
|
||
|
||
* Installation dependencies (frontend,graph) | ||
|
||
``` | ||
# graph | ||
$ cd ../src/app/graph | ||
$ npm i | ||
$ cd ../../.. | ||
$ npm i | ||
``` | ||
|
||
* Run | ||
|
||
``` | ||
$ npm run start | ||
``` | ||
|
||
* Verified running | ||
|
||
``` | ||
# frontend | ||
$ curl http://localhost:3000/ | ||
# backend | ||
$ curl http://localhost:3001/healthy | ||
# metrics scraper | ||
$ curl http://localhost:8000/api/v1 | ||
``` | ||
|
||
### Using ports | ||
* 3000 : front-end | ||
* 3001 : backend (restful-api) | ||
* 3002 : graph 개발 | ||
* 8000 : metrics scraper | ||
|
||
|
||
## Build & Run | ||
|
||
|
||
* Develop | ||
``` | ||
$ npm run start # 실행 (backend, frontend, metrics-scraper) | ||
$ npm run start:frontend # frontend 실행 | ||
$ npm run start:backend # backend 실행 | ||
$ npm run start:metrics-scraper # metrics scraper 실행 | ||
$ 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) | ||
``` | ||
|
||
* Containerization | ||
* default tag : "latest" (.npmrc 파일 참조) | ||
* `--kore-board:docker_image_tag=<value>` 옵션으로 latest 대신 tag 지정 가능 | ||
|
||
``` | ||
# docker build | ||
$ npm run docker:build:frontend | ||
$ npm run docker:build:backend | ||
$ npm run docker:build:metrics-scraper | ||
# docker push | ||
$ npm run docker:push:frontend | ||
$ npm run docker:push:backend | ||
$ npm run docker:push:metrics-scraper | ||
# docker build & push | ||
$ npm run docker:build:push:frontend | ||
$ npm run docker:build:push:backend | ||
$ npm run docker:build:push:metrics-scraper | ||
# all (frontend, backend) | ||
$ npm run docker:build # build | ||
$ npm run docker:build:push # build & push | ||
# tag 를 옵션으로 지정하는 예 | ||
$ npm run docker:build:backend --kore-board:docker_image_tag=v0.2.0 | ||
``` | ||
|
||
## Build helm-chart | ||
|
||
See [Helm-chart development guide](./helm-chart.md) page. | ||
|
||
|
||
## Debugging for "in-cluster" environment | ||
|
||
``` | ||
# 이전 token & ca 파일 삭제 | ||
$ sudo rm /var/run/secrets/kubernetes.io/serviceaccount/token /var/run/secrets/kubernetes.io/serviceaccount/ca.crt | ||
$ sudo mkdir -p /var/run/secrets/kubernetes.io/serviceaccount/ | ||
# namespace & serviceaccount 이름 지정 | ||
$ export NAMESPACE="kore" | ||
$ export SERVICE_ACCOUNT="kore-board" | ||
# token & ca 파일 생성 | ||
$ echo -n "$(kubectl get secret -n ${NAMESPACE} $(kubectl get sa ${SERVICE_ACCOUNT} -n ${NAMESPACE} -o jsonpath={.secrets..name} | cut -f1 -d ' ') -o jsonpath='{$.data.token}' | base64 --decode)" | sudo tee /var/run/secrets/kubernetes.io/serviceaccount/token | ||
$ echo -n "$(kubectl config view --raw=true -o jsonpath='{.clusters[0].cluster.certificate-authority-data}' | base64 --decode)" | sudo tee /var/run/secrets/kubernetes.io/serviceaccount/ca.crt | ||
# set api-server endpoint | ||
$ export KUBERNETES_SERVICE_HOST=$(kubectl config view --raw=true -o jsonpath='{.clusters[0].cluster.server}' | awk -F/ '{print $3}' | awk -F: '{print $1}') | ||
$ export KUBERNETES_SERVICE_PORT=$(kubectl config view --raw=true -o jsonpath='{.clusters[0].cluster.server}' | awk -F/ '{print $3}' | awk -F: '{print $2}') | ||
# create a empty kubeconfig file | ||
$ rm "$(pwd)/.tmp/config" | ||
$ export KUBECONFIG="$(pwd)/.tmp/config" | ||
``` | ||
|
||
## Modules | ||
|
||
* [backend](../../src/app/backend/README.md) | ||
* [frontend](../../src/app/frontend/README.md) | ||
* [metrics-scraper](../../src/app/metrics-scraper/README.md) | ||
* [graph](../../src/app/graph/README.md) | ||
|
||
|
||
## Link | ||
* https://github.com/kubernetes/client-go | ||
* https://github.com/gin-gonic/gin | ||
* https://bootstrap-vue.org/docs/components | ||
* https://adminlte.io/ | ||
* https://nuxtjs.org/ | ||
* [Noto Emoji Animals Nature Icons by Google](https://github.com/googlefonts/noto-emoji) - favico, Apache 2.0 |
Oops, something went wrong.