From 9c3ef35bcae7820ad61a4a5c6b76caacb47b1b13 Mon Sep 17 00:00:00 2001 From: qiaofeng1227 <76487013@qq.com> Date: Mon, 3 Jul 2023 10:36:36 +0800 Subject: [PATCH] change docs --- appmanage/api/v1/routers/health.py | 2 +- appmanage/docs/administrator.md | 12 +++-- cli/data/application.list | 2 +- docs/PRD.md | 4 +- docs/administrator.md | 4 +- docs/architecture.md | 2 +- docs/developer.md | 10 ++--- install/install.sh | 2 +- install/install_release.sh | 4 +- install/update.sh | 12 ++--- install/update_appstore.sh | 2 +- scripts/README.md | 12 ++--- scripts/containers_version.sh | 71 ------------------------------ scripts/install.sh | 6 +-- 14 files changed, 36 insertions(+), 109 deletions(-) delete mode 100644 scripts/containers_version.sh diff --git a/appmanage/api/v1/routers/health.py b/appmanage/api/v1/routers/health.py index 3de05d75..a015a99f 100644 --- a/appmanage/api/v1/routers/health.py +++ b/appmanage/api/v1/routers/health.py @@ -4,4 +4,4 @@ router = APIRouter() @router.get("/health") def health_check(): - return {"message": "StackHub API is alive"} + return {"message": "stackhub API is alive"} diff --git a/appmanage/docs/administrator.md b/appmanage/docs/administrator.md index f2424866..cdce5042 100644 --- a/appmanage/docs/administrator.md +++ b/appmanage/docs/administrator.md @@ -4,21 +4,19 @@ ### 安装组件 -1. python环境 -确保安装python3.6+ +1. python 环境 + 确保安装 python3.6+ -2. python的pip包fastapi,uvicorn[standard],gunicorn +2. python 的 pip 包 fastapi,uvicorn[standard],gunicorn ``` pip install -r requirements.txt ``` -3. 安装docker以及docker compose、创建docker 网络websoft9 +3. 安装 docker 以及 docker compose、创建 docker 网络 websoft9 ### 启动 ``` -git clone https://github.com/Websoft9/StackHub.git && cd StackHub/docker/appmanage && docker compose up -d +git clone https://github.com/Websoft9/stackhub.git && cd stackhub/docker/appmanage && docker compose up -d ``` - - diff --git a/cli/data/application.list b/cli/data/application.list index 9ea98e35..636b116b 100644 --- a/cli/data/application.list +++ b/cli/data/application.list @@ -3,7 +3,7 @@ Websoft9/role_docker Install Docker and some applications on Docker public 2021- Websoft9/ansible-superset Automatic installation for Apache Superset on Linux public 2021-09-26T03:19:56Z Websoft9/ansible-gitlab Automatic installation for GitLab on Linux public 2021-09-24T09:57:37Z Websoft9/docker-falcon Docker Compose to deploy Falcon-Plus in production public, fork 2021-09-24T02:58:00Z -Websoft9/StackHub CLI to install hot open source stacks public 2021-09-23T10:06:45Z +Websoft9/stackhub CLI to install hot open source stacks public 2021-09-23T10:06:45Z Websoft9/ansible-ansible This repository is only for developer who want to testing and learning Ansible public 2021-09-18T11:08:52Z Websoft9/ansible-jenkins Automatic installation for Jenkins on Linux public 2021-09-18T03:40:34Z Websoft9/docker-wordpress Docker Compose to deploy WordPress in production public, fork 2021-09-18T02:23:33Z diff --git a/docs/PRD.md b/docs/PRD.md index 6714cf9e..31532f9b 100644 --- a/docs/PRD.md +++ b/docs/PRD.md @@ -1,6 +1,6 @@ # 需求 -从两个主线理解 StackHub 的需求： +从两个主线理解 stackhub 的需求： - 应用生命周期管理：寻找、安装、发布、停止、卸载、升级等软件全生命周期。 - 基础设施运维管理：安全、存储、文件、容器、监控等系统管理 @@ -108,7 +108,7 @@ UI 自适应各种屏幕尺寸 一键自动化安装程序，类似： ``` -curl https://websoft9.github.io/StackHub/install/install.sh | bash +curl https://websoft9.github.io/stackhub/install/install.sh | bash ``` 主要步骤包括： diff --git a/docs/administrator.md b/docs/administrator.md index 33cfa716..5133d2fa 100644 --- a/docs/administrator.md +++ b/docs/administrator.md @@ -4,11 +4,11 @@ 1. 将 APP 的版本号、最小 CPU、内存、磁盘空间同步到 Contenful 数据表，通过自动化[Github Action](https://github.com/Websoft9/docker-library/blob/main/.github/workflows/requirement_to_contentful.yml)实现。 -2. 将 logo 图片同步到 Stackhub 项目的静态文件夹(/static/images)，通过自动化[Github Action](https://github.com/Websoft9/StackHub/blob/main/.github/workflows/logo.yml)实现。 +2. 将 logo 图片同步到 Stackhub 项目的静态文件夹(/static/images)，通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/logo.yml)实现。 ## AppManage 镜像生成 -发布镜像到 Dockhub 的 websoft9dev 组织下，通过自动化[Github Action](https://github.com/Websoft9/StackHub/blob/main/.github/workflows/appmanage_docker.yml)实现。 +发布镜像到 Dockhub 的 websoft9dev 组织下，通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/appmanage_docker.yml)实现。 ## 日志 diff --git a/docs/architecture.md b/docs/architecture.md index 5f01ce6f..4a88c4ef 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,6 +1,6 @@ ## 架构图 -![image](https://github.com/Websoft9/StackHub/assets/43192516/3b52f27a-8dff-477b-acea-cf971096540c) +![image](https://github.com/Websoft9/stackhub/assets/43192516/3b52f27a-8dff-477b-acea-cf971096540c) ## 详细 diff --git a/docs/developer.md b/docs/developer.md index 2f05a210..d10f2111 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -69,7 +69,7 @@ cancel_jobs = cancel.get_job_ids() ### API 文档 -[FastAPI 文档](https://github.com/Websoft9/StackHub/blob/main/appmanage/docs/developer.md) 使用 swagger 自动生成，访问地址：http://IP:PORT/docs。 +[FastAPI 文档](https://github.com/Websoft9/stackhub/blob/main/appmanage/docs/developer.md) 使用 swagger 自动生成，访问地址：http://IP:PORT/docs。 ## 版本管理 @@ -109,7 +109,7 @@ Websoft9 的 release 的版本号由项目主版本号和各微服务和插件 "Ubuntu": ["18.04","20.04","22.04"], "RedHat": ["7.9","8.6","9.2"] }, - "VERSION": "0.7.0" // StackHub项目版本号，上面所有组件的更新都会引起其版本更新 + "VERSION": "0.7.0" // stackhub项目版本号，上面所有组件的更新都会引起其版本更新 } ``` @@ -138,9 +138,9 @@ Dockerhub, Github packages, Azure artifacts, CODING 制品库 #### 制品库自动化 -* 插件制品管理：开发人员开发测试完成后，修改插件版本，触发 Action 构建 Github packages 制品 -* docker-libaray 库制品管理：开发人员测试完成后，修改 library 版本，触发 Action 构建 Github packages 制品 -* websoft9 制品管理：开发人员修改 appmanage 源码或微服务 docker-compose 测试完成后，修改 微服务 版本，触发 Action 构建 Dockerhub 镜像制品以及后台微服务 Github packages 制品 +- 插件制品管理：开发人员开发测试完成后，修改插件版本，触发 Action 构建 Github packages 制品 +- docker-libaray 库制品管理：开发人员测试完成后，修改 library 版本，触发 Action 构建 Github packages 制品 +- websoft9 制品管理：开发人员修改 appmanage 源码或微服务 docker-compose 测试完成后，修改 微服务 版本，触发 Action 构建 Dockerhub 镜像制品以及后台微服务 Github packages 制品 > Portainer,redis,nginxproxymanager 使用外部 dockerhub 镜像 diff --git a/install/install.sh b/install/install.sh index 8bbd9594..bd78c0c2 100644 --- a/install/install.sh +++ b/install/install.sh @@ -6,7 +6,7 @@ function error_exit { echo "$1" 1>&2 exit 1 } -trap 'error_exit "Please push issue to: https://github.com/Websoft9/StackHub/issues"' ERR +trap 'error_exit "Please push issue to: https://github.com/Websoft9/stackhub/issues"' ERR urls=( https://github.com diff --git a/install/install_release.sh b/install/install_release.sh index 0a29fac7..1f1e3475 100644 --- a/install/install_release.sh +++ b/install/install_release.sh @@ -6,7 +6,7 @@ function error_exit { echo "$1" 1>&2 exit 1 } -trap 'error_exit "Please push issue to: https://github.com/Websoft9/StackHub/issues"' ERR +trap 'error_exit "Please push issue to: https://github.com/Websoft9/stackhub/issues"' ERR urls=( https://ghproxy.com/https://github.com @@ -359,7 +359,7 @@ echo "fast url is: "$fasturl # download apps mkdir -p /data/apps clone_repo $fasturl/Websoft9/docker-library /data/library -clone_repo $fasturl/Websoft9/StackHub /data/apps/stackhub +clone_repo $fasturl/Websoft9/stackhub /data/apps/stackhub } StartAppMng(){ diff --git a/install/update.sh b/install/update.sh index b4e57aca..97ff490f 100644 --- a/install/update.sh +++ b/install/update.sh @@ -6,7 +6,7 @@ function error_exit { echo "$1" 1>&2 exit 1 } -trap 'error_exit "Please push issue to: https://github.com/Websoft9/StackHub/issues"' ERR +trap 'error_exit "Please push issue to: https://github.com/Websoft9/stackhub/issues"' ERR urls=( https://ghproxy.com/https://github.com @@ -125,7 +125,7 @@ fi } StackhubUpdate(){ echo "Update stackhub ..." -cd /tmp && rm -rf version.json && wget https://websoft9.github.io/StackHub/install/version.json +cd /tmp && rm -rf version.json && wget https://websoft9.github.io/stackhub/install/version.json if [ ! -f /data/apps/stackhub/install/version.json ]; then old_version="0.0.1" @@ -140,14 +140,14 @@ if [ "$old_version" \< "$release_version" ]; then echo "fasturl is: "$fasturl cd /tmp && rm -rf /tmp/stackhub if [[ $fasturl == *gitee.com* ]]; then - wget $fasturl/websoft9/StackHub/repository/archive/$release_version + wget $fasturl/websoft9/stackhub/repository/archive/$release_version unzip $release_version - mv StackHub* stackhub + mv stackhub* stackhub rm -f $release_version else - wget $fasturl/websoft9/StackHub/archive/refs/tags/$release_version.zip + wget $fasturl/websoft9/stackhub/archive/refs/tags/$release_version.zip unzip $release_version.zip - mv StackHub* stackhub + mv stackhub* stackhub rm -f $release_version.zip fi rm -rf /data/apps/stackhub diff --git a/install/update_appstore.sh b/install/update_appstore.sh index df90f823..fa5d4973 100644 --- a/install/update_appstore.sh +++ b/install/update_appstore.sh @@ -6,7 +6,7 @@ function error_exit { echo "$1" 1>&2 exit 1 } -trap 'error_exit "Please push issue to: https://github.com/Websoft9/StackHub/issues"' ERR +trap 'error_exit "Please push issue to: https://github.com/Websoft9/stackhub/issues"' ERR urls=( https://ghproxy.com/https://github.com diff --git a/scripts/README.md b/scripts/README.md index ccc924da..5a238b58 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -4,8 +4,8 @@ install.sh 安装 Stackhub 的自动化脚本，支持两个参数： -* -r 代表项目名称，例如：magento, lamp, lnmp, wordpress, joomla, gitlab 等 -* -i 代表是否用于镜像生产，支持 0（默认值，不用于镜像生产）和 1 两种参数 +- -r 代表项目名称，例如：magento, lamp, lnmp, wordpress, joomla, gitlab 等 +- -i 代表是否用于镜像生产，支持 0（默认值，不用于镜像生产）和 1 两种参数 主要有两种使用场景： @@ -15,7 +15,7 @@ install.sh 安装 Stackhub 的自动化脚本，支持两个参数： # 该场景下，脚本会删除服务器上的密钥对或运行云平台的某些恢复服务器出厂设置命令。 # 安装应用 -wget -N https://websoft9.github.io/StackHub/scripts/install.sh; bash install.sh -r magento -i 1 +wget -N https://websoft9.github.io/stackhub/scripts/install.sh; bash install.sh -r magento -i 1 # 中断后命令 cd /tmp/stackhub/apps && ansible-playbook -i hosts application.yml -c local -e init=1 -e appname=magento @@ -26,7 +26,7 @@ cd /tmp/stackhub/apps && ansible-playbook -i hosts application.yml -c local -e i # 此场景下，安装完成后，系统会强制重启 # 安装应用 -wget -N https://websoft9.github.io/StackHub/scripts/install.sh; bash install.sh -r magento -i 0 +wget -N https://websoft9.github.io/stackhub/scripts/install.sh; bash install.sh -r magento -i 0 # 中断后命令 cd /tmp/stackhub/apps && ansible-playbook -i hosts application.yml -c local -e init=0 -e appname=magento @@ -34,10 +34,10 @@ cd /tmp/stackhub/apps && ansible-playbook -i hosts application.yml -c local -e i ## reset_mysql_password.sh -该脚本 fork from [Mysql_ResetPasswd_Script](https://github.com/EwigeveMicca/Mysql_ResetPasswd_Script)，目前只适用于CentOS7 以上的系统和 MySQL5.6 版本； +该脚本 fork from [Mysql_ResetPasswd_Script](https://github.com/EwigeveMicca/Mysql_ResetPasswd_Script)，目前只适用于 CentOS7 以上的系统和 MySQL5.6 版本； 用法： - + ``` sudo git clone https://github.com/Websoft9/linuxscript.git; cd linuxscript/Mysql_ResetPasswd_Script;sudo sh reset_mysql_password.sh ``` diff --git a/scripts/containers_version.sh b/scripts/containers_version.sh deleted file mode 100644 index 18a96948..00000000 --- a/scripts/containers_version.sh +++ /dev/null @@ -1,71 +0,0 @@ -#!/bin/bash -export PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin - -# get applist -if [ -d StackHub ] ; then - echo "StackHub is exists" -else - git clone --depth=1 https://ghproxy.com/https://github.com/Websoft9/StackHub.git -fi -appnames=$(ls StackHub/apps/roles |grep -v Template |grep -v README.md |grep -v role) - -targetlist="" - -# get all of the running container's information( containername and imagename) -for appinfo in $(docker ps --format '{{.Names}}%{{.Image}}'); do - - containername=$(echo $appinfo |awk -F"%" '{print $1}') - imagename=$(echo $appinfo |awk -F"%" '{print $2}') - - for appname in $appnames; do - - if [[ $containername == $appname ]];then - if [[ $targetlist =~ $appname ]];then - continue - fi - echo "$containername容器名匹配成功app:$appname" - targetlist="$targetlist $appname" - cp /data/apps/library/apps/"$appname"/src/get_version.sh /tmp/"$appname"_get_version.sh - chmod +x /tmp/"$appname"_get_version.sh - bash /tmp/"$appname"_get_version.sh $containername - break - fi - done -done - -for appinfo in $(docker ps --format '{{.Names}}%{{.Image}}'); do - - containername=$(echo $appinfo |awk -F"%" '{print $1}') - imagename=$(echo $appinfo |awk -F"%" '{print $2}') - - for appname in $appnames; do - - if [[ $imagename =~ $appname ]];then - if [[ $targetlist =~ $appname ]];then - continue - fi - tmpvar="-" - if [[ $containername =~ $tmpvar ]];then - echo "$imagename=镜像名匹配成功app:$appname, and容器名是：$containername" - targetlist="$targetlist $appname" - cp /data/apps/library/apps/"$appname"/src/get_version.sh /tmp/"$appname"_get_version.sh - chmod +x /tmp/"$appname"_get_version.sh - bash /tmp/"$appname"_get_version.sh $containername - break - fi - else - realapp=echo $containername|awk -F"-" '{print $1}' - services=docker compose -p $realapp ps --services - for service in $services; do - if [[ $service == $appname ]];then - echo "$service服务名匹配成功app:$appname, and容器名是：$containername" - targetlist="$targetlist $appname" - cp /data/apps/library/apps/"$appname"/src/get_version.sh /tmp/"$appname"_get_version.sh - chmod +x /tmp/"$appname"_get_version.sh - bash /tmp/"$appname"_get_version.sh $containername - break - fi - done - fi - done -done diff --git a/scripts/install.sh b/scripts/install.sh index 9a77d90c..3b4129af 100644 --- a/scripts/install.sh +++ b/scripts/install.sh @@ -67,9 +67,9 @@ echo $repo_name echo $repo_init cd /tmp -rm -rf StackHub -wget -N https://websoft9.github.io/StackHub/scripts/githubclone.sh && bash githubclone.sh websoft9 StackHub -cd StackHub/apps +rm -rf stackhub +wget -N https://websoft9.github.io/stackhub/scripts/githubclone.sh && bash githubclone.sh websoft9 stackhub +cd stackhub/apps sudo echo "localhost" > hosts ansible-playbook -i hosts application.yml -c local -e init=$repo_init -e appname=$repo_name if [ $repo_init -ne 0 ]; then