- 분리된 네트워크를 위한 비동기 분산 인프라 관리 콘솔 및 에이전트.
- 지원:
- 온-프레미스 데이터센터의 베어메탈 서버
- 회사/인트라넷의 PC/워크스테이션
- 노트북
- 퍼블릭 클라우드
-
docker-compose 명령어
git clone https://github.com/klevry/klevr.git sudo docker-compose -f klevr/docker-compose.yml up -d -
http://localhost:8091의 console을 방문 할 수 있음
-
Lending page (default ID/PW = admin/admin)
-
Main page
- 이미지를 클릭 시 유튜브로 이동:
- Agent
- 프로비저닝: Docker, Kubernetes, Micro K8s(on Linux laptop) with Vagrant & VirtualBox, Prometheus
- 다운로드 및 실행: Hypervisor(via libvirt container), Terraform, Prometheus, Beacon
- 메트릭 데이터 집계 및 전달
- Manager
- Web console
- 호스트 풀 관리
- 리소스 관리
- 프라이머리 호스트 관리
- 작업 관리
- 서비스 카탈로그 관리
- 개발/스테이징/프로덕션에 서비스 전달
- 도커 이미지
- Agent(user's infrastructure management agent): klevry/agent:latest
- Manager(management console): klevry/manager:latest
- Console(web console): klevry/console:latest
- AGENT_GROUPS: Agent들이 속해 있는 Zone(Group)의 정보. Zone(Group)을 기준으로 Task들이 Agent에 분배될 수 있습니다.
- AGENTS: Manager에 접근이 허가된 Agents들의 상태 및 해당 Agent가 속해 있는 Zone의 정보등을 관리
- API_AUTHENTICATIONS: Manager에서 제공하는 기능에 액세스 할 수 있도록 인증 과정을 거치기 위한 API key 관리
- TASK_LOCK: Manager가 Lock을 선점하여 작업의 기능을 제공할 수 있음을 알림
- Manager로 부터 Task 제공이 가능함을 알리는 Lock을 선점해서 확인
- TASKS: Task의 전반적인 사항과 상태 관리
- TASK_DETAIL: 각 Task의 세부 설정 내용
- TASK_STEPS: Task의 실제 작업을 수행하는 Step을 관리
- TASK_LOGS: Task의 로그
- Klevr는 React로 구현된 Web 기반의 관리 도구(console)을 갖고 있습니다.
- Console의 사용자 메뉴얼은 여기에서 볼 수 있습니다.
- 사용자(admin) 인증을 제공하고 있으며, Task, Credential, Zone, Agent 그리고 API Key를 관리 할 수 있습니다.
- ".env" 파일에서 "REACT_APP_API_URL"를 설정함으로써 Console에서 연결되고자 하는 Manager를 지정할 수 있습니다.
- Klevr는 Manager, Agent 그리고 DB로 구성되어 있습니다
- Manager에서 Task와 Agent를 관리하기 위한 백그라운드 작업들
- Lock: Lock 상태를 주기별로 확인
- EventHandler: WebHook으로 Task의 변경 상태에 대해서 알림
- AgentStatus: Agent의 현재 상태를 지속적으로 확인 변경
- ScheduledTask: Task 상태가 Scheduled 이고 예약 시간보다 이전인 Task들의 상태를 waitPolling 상태로 변경
- TaskHandOverUpdater: 상태가 HandOver인 Task들의 DB 상태 변경
- Lock: Lock 상태를 주기별로 확인
- Manager에서 Task 및 Agent 관리
- Task 실행
- Task 상태 변환
- Primary Agent 관리
- 최초에Manager에게 HandShake를 요청한 Agent가 Primary로 선정
- 이 후 HandShake 요청하는 Agent들은 Secondary로 선정
- Secondary Agent들은 Primary Agent의 상태를 감시합니다. Primary Agent의 이상을 감지한 최초의 Secondary Agent가 Manager에게 Primary Agent의 상태를 보고 후 Primary Agent로 선정됩니다.
- Task 실행
- Docker/Docker-compose/Docker-registry
-
Beacon - Libvirt
- Task manage to ProvBee
-
- Terraform of container by ProvBee
- KVM(libvirt)
-
Micro K8sK3s - Prometheus
- Grafana
- Helm
- Vault(maybe)
-
Packer(maybe) -
Vagrant -
Consul
.
├── CNAME
├── Dockerfiles // Docker image build를 위한 기반 디렉토리
│ ├── README.md
│ ├── agent
│ ├── console
│ ├── libvirt
│ └── manager
├── LICENSE
├── README.md // 지금 보고있는 화면입니다 :)
├── assets
│ ├── [Images & Contents]
├── build.sh
├── cmd // 실제 아티팩트, Klevr 에이전트 및 관리자 (웹 서버)
│ ├── klevr-agent
│ │ ├── Makefile
│ │ ├── README.md
│ │ ├── agent_installer.sh // Manager가 생성한 스크립트로 curl 명령을 통한 원격 설치 프로그램
│ │ └── main.go // 에이전트의 main 소스 코드
│ └── klevr-manager
│ ├── Dockerfiles // Docker 빌드를 위해 바이너리 아티팩트를 이 디렉토리로 전송
│ ├── Makefile
│ ├── README.md
│ └── main.go // 매니저의 main 소스 코드
├── conf
│ ├── klevr-manager-compose.yml // Manager 실행을 위한 환경 설정 파일
│ ├── klevr-manager-db.sql.create // Manager 초기화 및 실행을 위한 데이터베이스
│ ├── klevr-manager-db.sql.modify
│ └── klevr-manager-local.yml
├── console // Klevr WebConsole
│ ├── Makefile
│ ├── README.md
│ ├── jsconfig.json
│ ├── package-lock.json
│ ├── package.json
│ ├── public
│ ├── src
│ │ ├── components
│ │ │ ├── common
│ │ │ ├── credentials
│ │ │ ├── overview
│ │ │ ├── settings
│ │ │ ├── store
│ │ │ ├── task
│ │ │ └── zones
│ │ ├── pages
│ │ ├── theme
│ │ └── utils
│ └── yarn.lock
├── docker-compose-agent.yml
├── docker-compose-console.yml
├── docker-compose-demo.yml
├── go.mod
├── go.sum
├── pkg
│ ├── agent // agent 패키지 디렉토리
│ │ ├── agent.go // agent 패키지의 진입점 (agent 스케줄러 실행)
│ │ ├── common.go // 공통 사용을 위한 유틸성 함수 및 상수
│ │ ├── handshake.go // manager에게 handshake 요청
│ │ ├── primary_status_report.go // Primary 상태 이상 보고
│ │ ├── protobuf // agent간 gRPC 통신 프로토콜 디렉토리
│ │ ├── scheduler.go // Primary와 Secondary 에이전트 작업
│ │ ├── scheduler_primary.go // Primary 에이전트의 작업
│ │ ├── scheduler_secondary.go // Secondary 에이전트의 작업
│ │ └── send_server.go // gRPC 프로토콜 인터페이스 구현체
│ ├── common // common 패키지 디렉토리
│ │ ├── api_agent_model.go // api로 제공되는 모델들
│ │ ├── commander.go // 예약된 커맨드(Task)를 관리
│ │ ├── commands.go // 예약된 커맨드
│ │ ├── const.go
│ │ ├── context.go // klevr에서 사용될 컨텍스트들을 관리
│ │ ├── credential_model.go // Credential 관리 API를 위한 모델
│ │ ├── encrypt.go // 암복호화 함수들
│ │ ├── error.go // 에러 및 예외처리
│ │ ├── http.go // http 통신용 request/response 관리
│ │ ├── json_time.go // json 전용 time 관리
│ │ ├── jwt.go // jwt 관리
│ │ ├── log.go // log에 장식을 추가 하기 위한 설정
│ │ ├── md5.go // hash 변환
│ │ ├── orm.go // xorm 관리
│ │ ├── queue.go // event 관리를 위한 큐
│ │ ├── security.go // 암호화 키
│ │ ├── task_executor.go // Task 실행 관리
│ │ └── task_model.go // Task 관리 모델
│ ├── communicator // http communicator 패키지 디렉토리
│ │ ├── README.md
│ │ └── communicator.go
│ ├── manager // manager 패키지 디렉토리
│ │ ├── api.go // http API 핸들러 등록 및 설정
│ │ ├── api_agent.go // agent API 핸들러
│ │ ├── api_console.go // console API 핸들러
│ │ ├── api_inner.go // inner API 핸들러
│ │ ├── api_inner_model.go // inner API 모델
│ │ ├── api_install.go // install API
│ │ ├── cache.go // 캐쉬 관리
│ │ ├── context_constants.go // context에서 사용할 상수
│ │ ├── handler.go // http 패키지에서 사용할 미들웨어
│ │ ├── persist_model.go // 데이터베이스 관리 모델
│ │ ├── repository.go // orm을 이용한 데이터베이스 관리
│ │ ├── server.go // Manager 패키지의 진입점
│ │ ├── server_test.go
│ │ └── storage.go // 캐쉬와 데이터베이스 관리
│ └── rabbitmq // rabbitmq 패키지 디렉토리
│ └── rabbitmq.go
├── scripts
│ ├── baremetal
│ └── linux_laptop
├── swag.sh
├── test
│ ├── common
│ │ └── task_executor_test.go
│ └── repository_test.go
└── version.properties
- API 대시보드 URL : http://localhost:8090/swagger/index.html
- 등록
- [POST] /inner/groups
- 조회
- [GET] /inner/groups/{groupID}
- 삭제
- [DELETE] /inner/groups/{groupID}
- 등록
- [POST] /inner/groups/{groupID}/apikey
- 조회
- [GET] /inner/groups/{groupID}/apikey
- 수정
- [PUT] /inner/groups/{groupID}/apikey
- 등록
- [POST] /inner/tasks
- 리스트
- [GET] /inner/tasks
- 조회
- [GET] /inner/tasks/{taskID}
- 취소
- [DELETE] /inner/tasks/{taskID}
- 예약어 커맨드 정보
- [GET] /inner/commands