项目结构

后端

  1. .
  2. ├── Dockerfile.amd64                                # 构建容器镜像使用的 dockerfile
  3. ├── Makefile                                        # 编译文件
  4. ├── LICENSE
  5. ├── README.md
  6. ├── ROADMAP.md
  7. ├── go.mod
  8. ├── pkg                                             # 主目录
  9. ├── locales                                         # 后端 i18n 翻译目录
  10. ├── docs                                            # REST Api 文档目录
  11. ├── migration                                       # 数据库变更文件目录

前端

  1. .
  2. ├── Dockerfile                                      # 构建容器镜像使用的 dockerfile             
  3. ├── LICENSE
  4. ├── README.md
  5. ├── package.json                                    # 包管理文件
  6. ├── src                                             # 主目录

配置开发环境

后端

!!! warning “”

  1. - KubeOperator 后端使用 iris 框架，并使用 Go mod 作为项目管理工具
  2. - 开发环境 Golang 版本 >= 1.14

初始化配置

数据库初始化

!!! warning “” KubeOperator 使用 MySQL 数据库，推荐使用 MySQL 5.7 版本。同时 KubeOperator 对数据库部分配置项有要求，请参考下附的数据库配置，修改开发环境中的数据库配置文件

  1. !!! warning ""
  3.     ```mysql
  4.     [mysqld]
  5.     datadir=/var/lib/mysql
  7.     default-storage-engine=INNODB
  8.     character_set_server=UTF8MB4
  9.     table_open_cache=128
  10.     max_connections=2000
  11.     max_connect_errors=6000
  12.     innodb_file_per_table=1
  13.     innodb_buffer_pool_size=1G
  14.     max_allowed_packet=64M
  15.     transaction_isolation=READ-COMMITTED
  16.     innodb_flush_method=O_DIRECT
  17.     innodb_lock_wait_timeout=1800
  18.     innodb_flush_log_at_trx_commit=0
  19.     sync_binlog=0
  20.     sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION
  21.     skip-name-resolve
  22.     user=mysql
  24.     [mysql]
  25.     default-character-set=utf8
  27.     [mysql.server]
  28.     default-character-set=utf8
  29.     ```
  31. 请参考文档中的建库语句创建 KubeOperator 使用的数据库，server 服务启动时会自动在配置的库中创建所需的表结构及初始化数据。
  33. !!! warning ""
  35.     ```mysql
  36.     CREATE DATABASE `ko` /*!40100 DEFAULT CHARACTER SET utf8mb4 */
  37.     ```
KubeOperator 配置文件

!!! warning “” KubeOperator 会默认加载该路径下的配置文件 /etc/ko/app.yaml，请参考下列配置创建对应目录及配置文件

  1. !!! warning ""
  3.     ```yaml
  4.     bind:
  5.       host: 0.0.0.0
  6.       port: 8080
  7.     logging:
  8.       level: info
  9.       out_put: fileAndStd
  10.       max_age: 2592000
  11.       rotation: 86400
  12.     # 数据库配置
  13.     db:
  14.       # mysql 服务地址，按需修改
  15.       host: mysql
  16.       port: 3306
  17.       user: root
  18.       # 明文密码：KubeOperator123@mysql
  19.       password: U08BAQEBAQHNm6g24wOpMgv34sNpwR5aBVdvFeSE9+6bydHO/WZLvZXlX9rxiY4V
  20.       name: ko
  21.       max_open_conns: 200
  22.       max_idle_conns: 10
  23.     jwt:
  24.       secret: iXDgDaEYBzIzustW
  25.       exp: 480
  26.     job:
  27.       timeout: 60
  28.     # kobe 组件配置
  29.     kobe:
  30.       # kobe 服务地址，按需修改
  31.       host: kobe
  32.       port: 8080
  33.     # kotf 组件配置
  34.     kotf:
  35.       # kotf 服务地址，按需修改
  36.       host: kotf
  37.       port: 8080
  38.     webkubectl:
  39.       host: webkubectl
  40.       port: 8080
  41.     kubepi:
  42.       host: kubepi
  43.       port: 80
  44.     cron:
  45.       enable: true
  46.     encrypt:
  47.       multilevel:
  48.         enable: true
  49.         secret: WjgBAQEBAQG1bkw4r7ZuaKD1klBxrT+zrRk8KWl+7LE0dli3h+a8gl6er0u8Ks1w
  50.         parts:
  51.           - dP3hT7dBQhygBCYW
  52.           - YIi2czL9wv4tQEZD
  53.     ```

运行后端服务

!!! warning “” 主目录运行

  1. ```
  2. go run main.go
  3. ```

前端

!!! warning “”

  1. - [neeko](https://github.com/KubeOperator/neeko) 前端使用了 Vue.js 作为前端框架，ElementUI 作为 UI 框架，并使用 npm 作为包管理工具
  2. - 开发者请先下载 Node.js 作为运行环境（推荐版本：v14.x）

运行步骤

!!! warning “” 部署运行好 KubeOperator API 服务器（前置条件）

  1. ```bash
  2. 1. 安装依赖
  3. $ npm install
  5. 2. 运行
  6. $ npm run serve
  7. ```

组件

!!! warning “” kobe 和 kotf 为 grpc 协议组件，使用 protobuf 生成

配置文件

kobe

!!! warning “” kobe 会默认加载该路径下的配置文件 /etc/kobe/app.yaml，请参考下列配置创建对应目录及配置文件

  1. ```yaml
  2. server:
  3.   host: 0.0.0.0
  4.   port: 8080
  5. app:
  6.   worker: 10
  7.   queue: 2000
  9. ansible:
  10.   timeout: 10
  11.   forks: 20
  12. ```
kotf

!!! warning “” kotf 会默认加载该路径下的配置文件 /etc/kotf/app.yaml，请参考下列配置创建对应目录及配置文件

  1. ```
  2. server:
  3.   host: 0.0.0.0
  4.   port: 8080
  5. ```

组件启动

!!! warning “”

  1. ```bash
  2. go run cmd/server/*.go 
  3. ```