package config gen

本命令用于根据输入的各选项生成配置文件。

选项	含义
-c,--cluster	生成的集群名称
-u,--username	主机ssh用户名
-p,--password	ssh登录密码
-N	ssh免密登录
--ip	部署的ip地址
--port	主机ssh连接端口
-i, --install-path	数据库安装路径（HOME目录）
--host	主机连接信息表达式
-t, --yas-type	数据库部署的架构类型： * DE：分布式，默认值 * SE：单机
-d, --deploy-mode	分布式部署的部署模式： * MINI：最小规模部署，按1MN 1CN 3DN规模部署在同一台主机 * NORMAL：常规部署，根据下述节点规模进行部署
--mn	分布式MN类型节点的部署规模，默认为1
--cn	分布式CN类型节点的部署规模，默认为1
--dn	分布式DN组及节点规模，例如1-3表示1一个组3个节点（组内一主两备）
--db	单机db组及节点部署的节点规模，默认为1
--listen-cidr	数据库的监听地址（默认与ip网段一致）
--din-cidr	分布式网络通信链路地址（默认与ip网段一致）
--replica-cidr	主备复制链路地址（默认与ip网段一致）
--begin-port	起始端口1688
--data-path	数据库实例的DATA目录
-f, --force	是否强制部署数据库，强制表示不会检查当前主机运行状态是否能够部署

示例1（未配置SSH免密）

$ yasboot package config gen --cluster yashandb -u yashan -p password \
--ip ip1,ip2,...,ipn --port 22 --install-path /var/database/yashan --begin-port 1688

上述命令等同于：

$ yasboot package config gen -c yashandb \
--host yashan:password@ip1,ip2,...,ipn:/var/database/yashan --begin-port 1688

示例2（已配置SSH免密）

$ yasboot package config gen -c yashandb \
--host root:@ip1,ip2,...,ipn:22:/var/database/yashan --begin-port 1688

package check gen

本命令用于生成主机检查的配置文件yascheck.toml。

选项	含义
--ip	此ip将作为网络测试的ip地址
-p, --path	配置文件生成的路径（默认当前目录）

示例

$ yasboot package check gen -p ./ --ip 192.168.x.x

package config join-demo

本命令用于生成托管命令使用的配置文件模板join_demo.toml。

选项	含义
-t, --type	托管集群的类型（SE/DE）
-d, --dir	配置文件生成的路径（默认当前目录）

示例

$ yasboot package config join-demo -t SE

package upload

本命令用于更新hosts.toml的信息，和上传新的YashanDB软件包。

选项	含义
-t, --toml	更新的toml文件
-i, --install-pkg	新的安装包路径

示例

$ yasboot package upload -t hosts.toml -i yashandb-22.2.0.9-linux-x86_64.tar.gz

package install

本命令用于对远程主机执行软件包安装（可通过toml文件配置对全部还是特定主机执行安装），软件包为tar.gz格式。

选项	含义
-i, --install-pkg	软件包文件本地路径
-f, --force	忽略错误并强制安装，默认为false
-t, --toml	要安装软件包的主机相关信息的配置文件
--disable	屏蔽任务进度条展示

示例

$ yasboot package install -i yashandb-22.2.0.9-linux-x86_64.tar.gz -t hosts.toml

package uninstall

本命令用于对远程主机上已安装的软件进行卸载（可通过toml文件配置选对全部还是对特定主机执行卸载）。

选项	含义
-c, --cluster	部署YashanDB的集群名
-t, --toml	以ssh方式卸载，需要主机配置文件如hosts.toml
-d, --child	展示任务以及子任务信息
-f, --force	强制卸载，默认false
--disable	屏蔽任务进度条展示

示例

--卸载整个集群
$ yasboot package uninstall -c yashandb

--按配置文件卸载
$ yasboot package uninstall -c yashandb -t hosts.toml

package upgrade

本命令用于对远程主机上已安装的软件（yasom，yasagent）进行升级。 必须在升级数据库完成后才能执行。

选项	含义
-c, --cluster	部署YashanDB的集群名
-t, --toml	需要主机配置文件如hosts.toml
-d, --child	展示任务以及子任务信息
--disable	屏蔽任务进度条展示

示例

$ yasboot package upgrade -c yashandb -t hosts.toml

package rollback

本命令用于对远程主机上已安装的软件（yasom，yasagent）进行回滚。

选项	含义
-c, --cluster	部署YashanDB的集群名
-t, --toml	需要主机配置文件如hosts.toml
--disable	屏蔽任务进度条展示

示例

$ yasboot package rollback -c yashandb -t hosts.toml