目录

安装doryctl

Summary
  • 介绍doryctl的主要功能
  • 介绍doryctl的安装方式
  • 介绍doryctl的基础使用

安装doryctl

关于doryctl

doryctl安装的组件

  • 使用doryctl可以自动完成DORY以及相关组件的安装配置,安装的组件架构图如下:

/docs/images/dory-deployment-architecture.png

  • DORY核心服务:
    • dory-core: DORY社区版核心服务,支持多实例运行
    • dory-dashboard: DORY社区版WebUI管理界面,支持多实例运行
  • DORY依赖的基础组件:
    • MongoDB: DORY数据库服务
    • Redis: DORY缓存服务
    • OpenLDAP: DORY用户账号中心
    • Docker: DORY步骤执行器(executor),支持多实例运行
  • DORY管理的DevOps工具链组件:
    • Gitlab或者Gitea: 代码仓库
    • Nexus: 依赖与制品仓库
    • Harbor: 容器镜像仓库

doryctl支持的安装模式

  • doryctl支持两种安装模式:
  • 把DORY部署在kubernetes中,自动创建两个不同的namespace用于运行DORY相关服务以及harbor镜像仓库
  • DORY的执行器executor可以在kubernetes集群中的不同节点启动
  • 详细安装说明参见: kubernetes方式部署
  • 生产环境推荐安装方式
  • 使用docker-compose部署DORY,自动创建两个不同的docker-compose.yaml用于运行DORY相关服务以及harbor镜像仓库
  • DORY的所有执行器executor只能在同一个节点启动
  • 详细安装说明参见: docker-compose方式部署
  • 测试用途,不建议用于生产

使用doryctl在kubernetes上部署DORY演示视频

doryctl连接并管理DORY

  • [TODO] 使用doryctl可以连接DORY服务,通过命令行方式管理DORY。通过doryctl可以很容易与其他工具整合,主要包含以下功能:
    1. 查看各种流水线资源
    2. 配置项目流水线
    3. 运行流水线

二进制包方式安装doryctl

  • doryctl Releases下载相应的二进制安装包. 一旦下载后,二进制执行文件就可以在任何地方执行,你无需把执行文件放到全局目录,假如你没有主机的相关权限的话。

  • 更好的方式是把二进制执行文件放到PATH所在的目录,这样你在任何地方都可以调用doryctl,常见的路径为 /user/local/bin

源码方式安装doryctl

  • doryctl 需要golangv1.16.x以上版本编译。
1
2
3
4
5
6
7
# 克隆源代码
git clone https://github.com/dory-engine/dory-ctl.git

# 从源代码编译doryctl
cd dory-ctl
go mod tidy && go build -o doryctl
mv doryctl /usr/local/bin/

doryctl使用概览

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# 获取使用帮助
doryctl -h
doryctl is a command line toolkit to manage dory-core

Usage:
  doryctl is a command line toolkit
  doryctl [command]

Examples:
  # install dory-core
  doryctl install run -o readme-install -f install-config.yaml

Available Commands:
  completion  generate the autocompletion script for the specified shell
  help        Help about any command
  install     install dory-core with docker or kubernetes

Flags:
      --configFile string   doryctl.yaml config file (default is $HOME/.doryctl/doryctl.yaml)
  -h, --help                help for doryctl
  -i, --insecure            if true, the server certificate will not be checked for validity. This will make your HTTPS connections insecure
      --logFile string      log File path (if set, save logs in this path)
      --logLevel string     show log level, options: ERROR, WARN, INFO, DEBUG (default "INFO")
  -s, --serverURL string    DoryEngine server URL, example: http://dory.example.com:8080
      --timeout duration    DoryEngine server connection timeout settings, example: 2s, 1m (default 2s)

# 获取子命令帮助
doryctl install -h

###################################################
# doryctl自动识别terminal的语言设置,也可以强制切换语言
###################################################

# 强制切换说明文档语言为英文模式
LANG=en_US doryctl install check --mode kubernetes

# 强制切换说明文档语言为中文模式
LANG=zh_CN doryctl install check --mode kubernetes