Your Docusaurus site did not load properly.

A very common reason is a wrong site baseUrl configuration.

Current configured baseUrl = /docs/

We suggest trying baseUrl =

CloudQuery 安装手册#

版本说明#

标准版:CloudQuery 标准版提供数据库模块、数据操作、权限管控、组织架构管理、应用管理、个人信息管理等基础功能。满足中小企业日常的开发以及权限管控需求。

完整版:完整版包括目前平台所有功能,可以理解为标准版+所有插件,但对服务器性能要求较高。

审计插件:审计插件作为 CloudQuery 平台首个可插拔模块,为平台提供独立的审计明细以及审计分析功能,支持单独安装、独立部署。

服务器环境#

完整版部署服务器配置建议 8 核 16G 及以上。

标准版部署服务器配置建议 4 核 8G 及以上。

审计插件建议独立部署,服务器配置 4 核 8G 及以上。

操作系统建议使用 CentOS 7。

在线安装#

完整版#

1、解压在线安装包#

unzip cloud-query-all-online-latest.zip

如未安装 unzip,可通过 yum install -y unzip 或者点击下载 unzip rpm 包,通过 rpm -ivh unzip 包名 进行安装。

2、执行安装脚本#

解压完成后,进入解压目录,给安装脚本增加执行权限

chmod +x cloudquery-community.sh

权限添加完成后通过给脚本传 install 参数进行安装

./cloudquery-community.sh install

执行后就会显示进度条,开始安装应用。

3、安装过程#

安装过程无需人工参与,分为环境和应用安装两步

环境安装:安装应用运行所需的环境,有进度条显示安装进度,安装完成会有提示。

应用安装:依次下载云端的应用 docker 镜像文件,每个镜像都有下载进度显示,如不能下载,请检查网络以及配置镜像源

4、应用启动#

应用安装完成后会自动启动,同时有个运行检监脚本,正常运行会提示 cloudquery 启动成功。

启动成功后,可用浏览器访问 http://机器 IP:9898,使用应用。

后续可用服务的方式管理应用启动或停止。

systemctl start cloudquery
systemctl stop cloudquery

标准版#

1、解压在线安装包#

unzip cloud-query-std-online-latest.zip

如未安装 unzip,可通过 yum install -y unzip 或者点击下载 unzip rpm 包,通过 rpm -ivh unzip 包名 进行安装。

2、执行安装脚本#

解压完成后,进入解压目录,给安装脚本增加执行权限

chmod +x cloudquery-standard.sh

权限添加完成后通过给脚本传 install 参数进行安装

./cloudquery-standard.sh install

执行后就会显示进度条,开始安装应用。

3、安装过程#

安装过程无需人工参与,分为环境和应用安装两步

环境安装:安装应用运行所需的环境,有进度条显示安装进度,安装完成会有提示。

应用安装:依次下载云端的应用 docker 镜像文件,每个镜像都有下载进度显示,如不能下载,请检查网络以及配置镜像源

4、应用启动#

应用安装完成后会自动启动,同时有个运行检监脚本,正常运行会提示 cloudquery 启动成功。

启动成功后,可用浏览器访问 http://机器 IP:9898,使用应用。

后续可用服务的方式管理应用启动或停止。

systemctl start cloudquery
systemctl stop cloudquery

审计插件#

1、解压在线安装包#

unzip cloud-query-audit-online-latest.zip

如未安装 unzip,可通过 yum install -y unzip 或者点击下载 unzip rpm 包,通过 rpm -ivh unzip 包名 进行安装。

2、执行安装脚本#

解压完成后,进入解压目录,给安装脚本增加执行权限

chmod +x cloudquery-audit.sh

权限添加完成后通过给脚本传 install 参数进行安装

./cloudquery-audit.sh install

执行后就会显示进度条,开始安装应用。

3、安装配置#

安装过程无需人工参与,分为环境和应用安装两步

环境安装:安装应用运行所需的环境,有进度条显示安装进度,安装完成会有提示。

应用安装:依次下载云端的应用 docker 镜像文件,每个镜像都有下载进度显示,如不能下载,请检查网络以及配置镜像源

应用安装完成需修改以下配置

(1).修改/opt/cloudquery/audit/cloudquery-resources-flinkd.yml

services:
kafka:
image: cloudquery.tencentcloudcr.com/cloudquery/community_kafka:2.12-2.5.0
restart: always
container_name: cloudquery-kafka
ports:
- '9094:9094'
environment:
KAFKA_ADVERTISED_LISTENERS: INSIDE://cloudquery-kafka:9092,OUTSIDE://localhost:9094
# !!! localhost 修改为本机 IP
KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT
KAFKA_LISTENERS: INSIDE://:9092,OUTSIDE://:9094
KAFKA_ZOOKEEPER_CONNECT: 10.0.2.123:2181
KAFKA_INTER_BROKER_LISTENER_NAME: INSIDE
TZ: Asia/Shanghai
networks:
cloudquerynet:
ipv4_address: 10.0.2.120
note

localhost 修改为本机 IP

(2).修改/opt/cloudquery/audit/deploy.sh

JOB_CLASS_NAME="cn.bintools.cloudquery.audit.AnalysisApplication"
JM_CONTAINER=$(docker ps --filter name=jobmanager --format={{.ID}})
docker cp ./target/analysis.jar "${JM_CONTAINER}":/opt/analysis.jar
docker exec -i "${JM_CONTAINER}" flink run -d -c ${JOB_CLASS_NAME} /opt/analysis.jar \
--bootstrap.servers cloudquery-kafka:9092 \
--url jdbc:postgresql://10.0.2.103:5432/postgres # 10.0.2.103 修改为标准版服务器 IP
note

10.0.2.103 修改为标准版服务器 IP

4、应用启动#

./cloudquery-audit.sh start

离线安装#

完整版#

1、解压离线安装包#

unzip cloud-query-all-offline-latest.zip

2、执行安装脚本#

解压完成后,进入解压目录,给安装脚本增加执行权限

chmod +x cloudquery-community.sh

权限添加完成后通过给脚本传 install 参数进行安装

./cloudquery-community.sh install

执行后就会显示进度条,开始安装应用。

3、安装过程#

安装过程无需人工参与,分为环境和应用安装两步

环境安装:安装应用运行所需的环境,有进度条显示安装进度,安装完成会有提示。

应用安装:依次导入应用的 docker 镜像。

4、应用启动#

应用安装完成后会自动启动,同时有个运行检监脚本,正常运行会提示 cloudquery 启动成功。

启动成功后,可用浏览器访问 http://机器 IP:9898,使用应用。

后续可用服务的方式管理应用启动或停止。

systemctl start cloudquery
systemctl stop cloudquery

标准版#

1、解压离线安装包#

unzip cloud-query-std-offline-latest.zip

2、执行安装脚本#

解压完成后,进入解压目录,给安装脚本增加执行权限

chmod +x cloudquery-standard.sh

权限添加完成后通过给脚本传 install 参数进行安装

./cloudquery-standard.sh install

执行后就会显示进度条,开始安装应用。

3、安装过程#

安装过程无需人工参与,分为环境和应用安装两步

环境安装:安装应用运行所需的环境,有进度条显示安装进度,安装完成会有提示。

应用安装:依次导入应用的 docker 镜像。

4、应用启动#

应用安装完成后会自动启动,同时有个运行检监脚本,正常运行会提示 cloudquery 启动成功。

启动成功后,可用浏览器访问 http://机器 IP:9898,使用应用。

后续可用服务的方式管理应用启动或停止。

systemctl start cloudquery
systemctl stop cloudquery

审计插件#

1、解压离线安装包#

unzip cloud-query-audit-offline-latest.zip

2、执行安装脚本#

解压完成后,进入解压目录,给安装脚本增加执行权限

chmod +x cloudquery-audit.sh

权限添加完成后通过给脚本传 install 参数进行安装

./cloudquery-audit.sh install

执行后就会显示进度条,开始安装应用。

3、安装过程#

安装过程无需人工参与,分为环境和应用安装两步

环境安装:安装应用运行所需的环境,有进度条显示安装进度,安装完成会有提示。

应用安装:依次导入应用的 docker 镜像。

应用安装完成需修改以下配置

(1).修改/opt/cloudquery/audit/cloudquery-resources-flinkd.yml

services:
kafka:
image: cloudquery.tencentcloudcr.com/cloudquery/community_kafka:2.12-2.5.0
restart: always
container_name: cloudquery-kafka
ports:
- '9094:9094'
environment:
KAFKA_ADVERTISED_LISTENERS: INSIDE://cloudquery-kafka:9092,OUTSIDE://localhost:9094
# !!! localhost 修改为本机 IP
KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT
KAFKA_LISTENERS: INSIDE://:9092,OUTSIDE://:9094
KAFKA_ZOOKEEPER_CONNECT: 10.0.2.123:2181
KAFKA_INTER_BROKER_LISTENER_NAME: INSIDE
TZ: Asia/Shanghai
networks:
cloudquerynet:
ipv4_address: 10.0.2.120
note

localhost 修改为本机 IP

(2).修改/opt/cloudquery/audit/deploy.sh

JOB_CLASS_NAME="cn.bintools.cloudquery.audit.AnalysisApplication"
JM_CONTAINER=$(docker ps --filter name=jobmanager --format={{.ID}})
docker cp ./target/analysis.jar "${JM_CONTAINER}":/opt/analysis.jar
docker exec -i "${JM_CONTAINER}" flink run -d -c ${JOB_CLASS_NAME} /opt/analysis.jar \
--bootstrap.servers cloudquery-kafka:9092 \
--url jdbc:postgresql://10.0.2.103:5432/postgres
note

10.0.2.103 修改为标准版服务器 IP

4、应用启动#

./cloudquery-audit.sh start

版本更新#

离线更新#

1、下载 离线更新包#

2、上传离线更新包#

scp cloudquery.tar.gz root@yourserverhost:/tmp

3、解压到指定目录#

# 如果下面目录不存在则先创建
mkdir /opt/updateagent/work/decompress
# 解压
tar -zxvf /tmp/cloudquery.tar.gz -C /opt/updateagent/work/decompress/

4、在网页界面上点击检查更新#

在线更新#

直接在网页上点击检查更新,等待 5-20 分钟即可(时间视网速情况而定)#

更新失败解决方法#

1、界面上显示「版本检查失败,请重试」#

  • 使用命令 ps -ef | grep agent 检查 agent 程序是否在运行
  • 如果上一步中 agent 未运行,使用命令 cd /opt/updateagent && ./agent & 运行
  • 如果使用离线更新,确保更新包 cloudquery.tar.gz 解压至 /opt/updateagent/work/decompress 目录下
  • 如果使用在线更新,确保服务器可以访问外部网络(使用 https://cloudquery.club/version.json 测试)

2、界面上显示更新失败#

  • 确保所有容器正常运行,可以使用 docker ps 查看
  • 删除 /opt/updateagent/work/decompress 文件夹,删除 /opt/updateagent/work/backup 文件夹
  • 清空 /opt/updateagent/work/tmp 和 /opt/updateagent/work/packet 目录下的文件
  • 按照离线更新或在线更新方式,重试一次

应用探针#

参见 应用探针安装部署

使用#

启动资源服务后,可以通过 telnet 命令检查服务是否启动正常,是否能对外通信

访问 ip:9898 端口,进入 CloudQuery 登录页面

初始内置用户与密码:

用户名密码权限
admin001password最高
adminpassword
Testpassword普通用户

登陆成功后这里就是您的舞台了

Enjoy yourself.#

其他#

Docker-compose 命令集#

以启动数据持久服务为例:

启动

docker-compose -f cloudquery-resources.yml up -d

停止

docker-compose -f cloudquery-resources.yml stop

停止并删除容器

docker-compose -f cloudquery-resources.yml down

下载 PDF#

CloudQuery 安装手册 PDF