You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
wscjxky 30f2a5265c fix postgres 'use' segment bug 8 months ago
configs 从DB读取镜像数据 9 months ago
database 数据库迁移:mySQL to postgreSQL 9 months ago
deployment 数据库迁移:mySQL to postgreSQL 9 months ago
docs rename saml root url 11 months ago
local_mysql update db conf 1 year ago
loggers add error handler 1 year ago
models fix postgres 'use' segment bug 8 months ago
routers 更新镜像字段 9 months ago
services rename var name 9 months ago
tools format data 1 year ago
utils 添加syscall调用 10 months ago
.gitignore fix swagger 1 year ago
Jenkinsfile modify jenkinsfile image name 8 months ago
README.md 更新部署README 1 year ago
build.sh bug fix 11 months ago
config.template.yaml 数据库迁移:mySQL to postgreSQL 9 months ago
go.mod merge from master 11 months ago
go.sum modify error code return strategy 11 months ago
main.go fix tar zh_name && clean tmp files 1 year ago

README.md

AIArtsBackend

Backend for AIArts.

开发说明

配置

  • 配置文件为config.yaml,在项目根目录
  • 配置结构体定义在configs/config.go,使用viper库读取配置
  • config.yaml已放入.gitignore,格式按照config.template.yaml编写

数据库

  • 使用mysql,配置写在config.yaml
  • 开发时自行启动mysql
  • 一个实例,定义在database/db.go,使用时需引入,无需再创建实例
  • orm使用gorm库,参考文档
  • 本地开mysql,可使用local_mysql下的docker-compose

日志

  • 日志配置写在了config.yaml
  • 如果设置writefile为true,会写入文件并输出到console
  • 如果设置writefile为false,日志只输出到console
  • 一个实例,定义在loggers/logger.go,使用时需引入,无需再创建实例
  • gin的日志已被loggers/gin_logger.go替换,保持与其他日志格式一致

路由

  • 路由使用gin框架,整体路由在routers/router.go
  • 各模块在单独的文件中实现
  • 成功返回,可使用routers/success_resp.go中的函数
  • 错误处理已经实现了部分函数routers/error_handlers.go
  • 错误码统一定义在routers/error_codes.go(待讨论)

API文档

  • 已集成swagger,生成文档时执行swag init即可
  • 写文档可参考每个router的sample

部署

  • 公用数据集存放路径/dlwsdata/storage/dataset/storage

  • 私有数据集存放路径/dlwsdata/work/user/storage

  • 更新并push至harbor

    sudo vim /etc/hosts

    增加 10.31.3.211 harbor.sigsus.cn

    sudo vim /etc/docker/daemon.json
    
    {
    "registry-mirrors": [],
    "insecure-registries": [
     "https://harbor.sigsus.cn:8443"
    ],
    "debug": true,
    "experimental": false
    }
    
  • 重启docker并登陆(需要进入 https://10.31.3.211:8443 注册)

    sudo systemctl  restart docker 
    sudo docker login harbor.sigsus.cn:8443
    
  • 开始推送到harbor

    cd deployment
    ./build2harbor.sh