自动化运维平台Spug介绍

#Docker安装
$ yum install -y yum-utils
$ yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
$ yum install docker-ce docker-ce-cli containerd.io
$ systemctl start docker

#拉取/下载阿里云项目镜像，阿里云的镜像与 Docker hub 同步更新，国内用户建议使用阿里云的镜像。官方镜像内置了 Mysql 数据库，也可以使用外部数据库（Mysql 5.6+）
$ docker pull registry.aliyuncs.com/openspug/spug

#启动容器
# 第一种：持久化存储启动容器
# 其中，/spug 指的是映射宿主机本地的磁盘路径，/data是容器内代码和数据初始化存储的路径，使用-v /spug:/data制定映射到容器外，进行持久化
$ docker run -d --restart=always --name=spug -p 80:80 -v /spug:/data registry.aliyuncs.com/openspug/spug
# 如果需要在spug内使用docker命令则需要添加额外的参数
$ docker run -d --restart=always --name=spug -p 80:80 -v /spug/:/data -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker registry.aliyuncs.com/openspug/spug

#进入容器，完成项目初始化；该过程会创建一个用户名为 admin 密码为 spug.dev 的管理员账户，可自行替换管理员账户。
$ docker exec spug init_spug admin spug.dev  #如果提示连接数据失败，再次执行尝试
# 执行完毕后需要重启容器
$ docker restart spug

##使用外部 Mysql

$ docker exec -it spug bash  #进入容器

#修改配置文件使----->访问外部数据库
$ vi /data/spug/spug_api/spug/overrides.py  #如下所示：

DATABASES = { 
   
    'default': { 
   
        'ATOMIC_REQUESTS': True,
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'spug',
        'USER': 'spug',  # 修改为外部数据库的用户
        'PASSWORD': 'spug.dev',  # 修改为外部数据的用户密码
        'HOST': 'localhost',    # 修改为外部数据的ip
        'OPTIONS': { 
   
            'unix_socket': '/var/lib/mysql/mysql.sock',   # ！！！删除该行
            'charset': 'utf8mb4',
            'sql_mode': 'STRICT_TRANS_TABLES',
        }
    }
}

#停止容器内的数据库服务
$ vi /etc/supervisord.d/spug.ini
# 找到如下行并删除
[program:mariadb]
command = /usr/libexec/mysqld --user=mysql
autostart = true

#退出并重启容器
$ exit
$ docker restart spug

## 默认更新到最新版本；spug 是容器名称，也可以替换为自己的容器ID

$ docker exec -i spug python3 /data/spug/spug_api/manage.py update 

# 更新完成后重启容器
$ docker restart spug

$ curl https://spug.dev/installer/spug-installer | bash

#拉取项目
$ git clone https://github.com/openspug/spug /data/spug
或git clone https://gitee.com/openspug/spug
$ cd /data/spug
$ git checkout x.x.x   # x.x.x 为指定的发行版本，例如：git checkout v2.2.2 

#将下载好的前端压缩包解压到指定目录，假设web_x.y.z.tar.gz
$ tar xf web_x.y.z.tar.gz -C /data/spug/spug_web/

#创建运行环境
# 安装依赖，如需要使用常规发布功能，则需要安装 git v2.17.0+
$ yum install mariadb-devel python3-devel gcc openldap-devel redis nginx supervisor
# 创建虚拟环境
$ cd /data/spug/spug_api
$ python3 -m venv venv
$ source venv/bin/activate
# 安装python包
$ pip install -U pip -i https://pypi.tuna.tsinghua.edu.cn/simple/
$ pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
$ pip install gunicorn mysqlclient -i https://pypi.tuna.tsinghua.edu.cn/simple/

#修改后端配置；后端默认使用的 Sqlite 数据库，通过修改配置使用 MYSQL 作为后端数据库；
#在 spug_api/spug/ 目录下创建 overrides.py 文件，启动后端服务后会自动覆盖默认的配置，避免直接修改 settings.py 以便于后期获取新版本
$ vi spug_api/spug/overrides.py

DEBUG = False

DATABASES = { 
   
    'default': { 
   
        'ATOMIC_REQUESTS': True,
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'spug',             # 替换为自己的数据库名，请预先创建好编码为utf8mb4的数据库
        'USER': 'spug_user',        # 数据库用户名
        'PASSWORD': 'spug_passwd',  # 数据库密码
        'HOST': '127.0.0.1',        # 数据库地址
        'OPTIONS': { 
   
            'charset': 'utf8mb4',
            'sql_mode': 'STRICT_TRANS_TABLES',
            #'unix_socket': '/opt/mysql/mysql.sock' # 如果是本机数据库,且不是默认安装的Mysql,需要指定Mysql的socket文件路径
        }
    }
}

#初始化数据库
$ cd /data/spug/spug_api
$ python manage.py updatedb

#创建默认管理员账户
$ python manage.py user add -u admin -p spug.dev -s -n 管理员  #-s 超级管理员，-n 用户昵称

# 创建启动服务脚本
$ vi /etc/supervisord.d/spug.ini

[program:spug-api]
command = bash /data/spug/spug_api/tools/start-api.sh
autostart = true
stdout_logfile = /data/spug/spug_api/logs/api.log
redirect_stderr = true

[program:spug-ws]
command = bash /data/spug/spug_api/tools/start-ws.sh
autostart = true
stdout_logfile = /data/spug/spug_api/logs/ws.log
redirect_stderr = true

[program:spug-worker]
command = bash /data/spug/spug_api/tools/start-worker.sh
autostart = true
stdout_logfile = /data/spug/spug_api/logs/worker.log
redirect_stderr = true

[program:spug-monitor]
command = bash /data/spug/spug_api/tools/start-monitor.sh
autostart = true
stdout_logfile = /data/spug/spug_api/logs/monitor.log
redirect_stderr = true

[program:spug-scheduler]
command = bash /data/spug/spug_api/tools/start-scheduler.sh
autostart = true
stdout_logfile = /data/spug/spug_api/logs/scheduler.log
redirect_stderr = true

#创建前端nginx配置文件；、如果没有在 spug.conf 中指定 server_name 则需要把 /etc/nginx/nginx.conf 中默认的 server 块注释或删除后才能正常访问， 否则会打开 Nginx 默认页面
$ vi /etc/nginx/conf.d/spug.conf

server { 
   
        listen 80;
        server_name _;     # 修改为自定义的访问域名
        root /data/spug/spug_web/build/;
        client_max_body_size 20m;   # 该值会影响文件管理器可上传文件的大小限制，请合理调整

        gzip  on;
        gzip_min_length  1k;
        gzip_buffers     4 16k;
        gzip_http_version 1.1;
        gzip_comp_level 7;
        gzip_types       text/plain text/css text/javascript application/javascript application/json;
        gzip_vary on;

        location ^~ /api/ { 
   
                rewrite ^/api(.*) $1 break;
                proxy_pass http://127.0.0.1:9001;
                proxy_read_timeout 180s;
                proxy_redirect off;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        }

        location ^~ /api/ws/ { 
   
                rewrite ^/api(.*) $1 break;
                proxy_pass http://127.0.0.1:9002;
                proxy_http_version 1.1;
                proxy_set_header Upgrade $http_upgrade;
                proxy_set_header Connection "Upgrade";
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        }

        location / { 
   
                try_files $uri /index.html;
        }
}

#启动服务
# 设置开机启动
$ systemctl enable nginx
$ systemctl enable redis
$ systemctl enable supervisord
$ systemctl restart nginx
$ systemctl restart redis  #请确保Redis仅监听在 127.0.0.1
$ systemctl restart supervisord

## 默认更新到最新版本
$ cd spug_api
$ source venv/bin/activate
$ python manage.py update
# 重启服务
$ supervisorctl restart all