1 Star 1 Fork 98

Shwan / neatlogic-itom-all

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
QUICK_START.md 5.73 KB
一键复制 编辑 原始数据 按行查看 历史
lvzk 提交于 2023-04-23 12:34 . update QUICK_START.md.

项目部署教程

Docker环境检查

检查docker版本(返回版本信息,说明docker已安装)

docker --version
docker-compose --version

注意:请确保docker已安装,才能进行后续步骤

安装

先下载 docker-compose.yml,该配置文件是docker compose的核心,用于定义服务、网络和数据卷。

如果不做修改,直接执行启动命令

  docker-compose -f docker-compose.yml up -d  #-f 表示执行指定yml, -d 表示后台执行并返回

默认会安装一下容器服务:

容器服务名 默认宿主机端口 启动容器服务依赖 访问地址 容器内服务启停命令 描述
neatlogic-db 3306 - - 启: /app/databases/neatlogicdb/scripts/neatlogicdb start
停: /app/databases/neatlogicdb/scripts/neatlogicdb stop
mysql数据库
neatlogic-collectdb 27017 - - 启:/app/databases/collectdb/bin/mongod --config /app/databases/collectdb/conf/mongodb.conf
停:
mongo 127.0.0.1:27017/admin -uadmin -p u1OPgeInMhxsNkNl << EOF
db.shutdownServer();
exit;
EOF
mongodb,如果使用cmdb自动采集、自动化、巡检、发布则需要该服务
neatlogic-runner 8084、8888 - - 启:deployadmin -s autoexec-runner -a startall
停:deployadmin -s autoexec-runner -a stopall
执行器,如果使用发布、巡检、自动化、tagent则需要该服务
neatlogic-app 8282 neatlogic-db
neatlogic-collectdb
neatlogic-runner
neatlogic-nacos
- 启:deployadmin -s neatlogic -a startall
停:deployadmin -s neatlogic -a stopall
后端服务
neatlogic-web 8090、8080、9099 neatlogic-app 宿主机IP:8090/租户名 #前端页面
宿主机IP:9099 #租户管理页面 登录帐号:admin 密码:123456
启:/app/systems/nginx/sbin/nginx
重启:/app/systems/nginx/sbin/nginx -s reload
停:kill xx
前端服务
neatlogic-nacos 8848 neatlogic-db 启: /app/systems/nacos/bin/startup.sh -m standalone nacos 后端服务 config

验证

因为docker容器服务启动是异步的,所以以上提到的启动命令执行完也不代表服务都正常启动完了.
仍需要等待几分钟时间后访问前端服务:http://宿主机ip:8090/ 如果出现登录页面,恭喜你服务部署成功.登录帐号:admin 密码:neatlogic@901
如果提示租户不存在,则需要查看下日志,可能是服务还在等待启动中

docker-compose -f docker-compose.yml logs -f neatlogic-app

如果日志中出现error,则将最后的截图联系我们Neatlogic in Slack

按需修改配置 docker-compose.yml

一般常见需要修改的场景:

1、数据持久化 默认是没有配置持久化的,如果需要则参考以下配置修改即可:

neatlogic-db

  volumes:
    - /app/logs/neatlogicdb/:/app/logs/neatlogicdb/
    - type: volume
      source: db_data
      target: /app/databases/neatlogicdb/ #宿主机路径

neatlogic-collectdb

  volumes:
      - /app/logs/collectdb/:/app/logs/collectdb/
      - type: volume
        source: collectdb_data
        target: /app/databases/collectdb/ #宿主机路径

neatlogic-runner

  volumes:
      - /app/logs/neatlogic-runner/:/app/logs/autoexec-runner/
      - type: volume
        source: autoexec_data
        target: /app/autoexec/data/ #宿主机路径

2、宿主机端口冲突

修改 ports 字段即可,例如neatlogic-web的8080端口冲突,则需要将左侧的宿主机端口改成非占用端口即可,如我要改成8081:

  ports:
    - "8090:8090"
    - "8081:8080"
    - "9099:9099"

3、不使用自带的容器服务

如无需某容器服务则只需要删除对应容器服务配置,且修改对应被依赖的容器服务的environment属性
如无需neatlogic-db,因neatlogic-db被neatlogic-app和neatlogic-nacos依赖,所以neatlogic-app和neatlogic-nacos都需要修改environment的MYSQL_SERVICE_HOST、MYSQL_SERVICE_PORT、MYSQL_SERVICE_USER、MYSQL_SERVICE_PASSWORD,如:
自定义使用外部mysqldb 192.168.1.33:3306,帐号/密码:app/123456

  environment:
    #连接的mysql配置
    MYSQL_SERVICE_HOST: "192.168.1.33"
    MYSQL_SERVICE_PORT: 3306
    ...
    MYSQL_SERVICE_USER: app
    MYSQL_SERVICE_PASSWORD: "123456"

常用COMMAND

启动

根据yml创建容器并启动所有容器服务

  docker-compose -f docker-compose.yml up -d  #-f 表示执行指定yml, -d 表示后台执行并返回

如果只需要处理某个容器服务,只需要在命令后补充容器服务名即可,如:

  docker-compose -f docker-compose.yml up -d neatlogic-app #单独重新创建并启动neatlogic-app服务

查看日志

查看所有容器服务的日志

  docker-compose -f docker-compose.yml logs

如果只需要查看某个容器服务的日志,只需要在命令后补充容器服务名即可,如:

  docker-compose -f docker-compose.yml logs neatlogic-app

实时查看日志

  docker-compose -f docker-compose.yml logs -f

查看启动成功的容器

  docker-compose -f docker-compose.yml ps

启停容器

启容器

  docker-compose -f docker-compose.yml start

停容器

  docker-compose -f docker-compose.yml stop 

如果只需要启某个容器,只需要在命令后补充容器服务名即可,如:

  docker-compose -f docker-compose.yml start neatlogic-app

进入容器服务

非必要用户无需进入容器服务,如进去neatlogic-app容器服务:

  docker-compose -f docker-compose.yml exec neatlogic-app sh

停止并移除容器,网络,镜像和卷

  docker-compose -f docker-compose.yml down 
1
https://gitee.com/permtbo/neatlogic-itom-all.git
git@gitee.com:permtbo/neatlogic-itom-all.git
permtbo
neatlogic-itom-all
neatlogic-itom-all
develop3.0.0

搜索帮助