Skip to content

Commit

Permalink
docs: update quick_start.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@shenkaibo
shenkaibo committed Oct 31, 2023
1 parent 3e6d8b8 commit c3d49c7
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 74 deletions.
186 changes: 112 additions & 74 deletions docs/installation/online_installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,96 +3,109 @@ description: MeterSphere 一站式开源持续测试平台官方文档。MeterSp
---

## 1 环境要求

!!! info "部署服务器要求"
!!! ms-abstract "部署服务器要求"
* 操作系统: CentOS 7.x / Redhat 7.x
* CPU/内存: 最低要求 4C8G，推荐 8C16G
* CPU/内存: 最低要求 4C8G，推荐 8C16G (2.3.0版本及其之后的版本，最低配置 8C16G)
* 磁盘空间: 50G
* 网络要求：可访问互联网
* 注：如用于生产环境，推荐使用 [离线安装包](https://community.fit2cloud.com/#/products/metersphere/downloads) 进行部署

## 2 一键安装
!!! ms-abstract ""
在服务器上以 `root` 用户执行如下命令一键安装 MeterSphere。<br>
```
curl -sSL https://resource.fit2cloud.com/metersphere/metersphere/releases/latest/download/quick_start.sh | bash
```

## 2 一键安装（采用默认安装参数）

在服务器上以 `root` 用户执行如下命令一键安装 MeterSphere。
```
curl -sSL https://resource.fit2cloud.com/metersphere/metersphere/releases/latest/download/quick_start.sh | bash
```

安装成功后，通过浏览器访问如下页面登录 MeterSphere。

```
地址: http://目标服务器IP地址:8081
用户名: admin
密码: metersphere
```
安装成功后，通过浏览器访问如下页面登录 MeterSphere。<br>
```
地址: http://目标服务器IP地址:8081
用户名: admin
密码: metersphere
```

安装脚本默认使用 /opt/metersphere 目录作为安装目录，MeterSphere 的配置文件、数据及日志等均存放在该安装目录。
安装脚本默认使用 /opt/metersphere 目录作为安装目录，MeterSphere 的配置文件、数据及日志等均存放在该安装目录。

!!! info "安装目录目录结构说明"
!!! ms-abstract "安装目录目录结构说明"
```
/opt/metersphere/
├── bin #-- 安装过程中需要加载到容器中的脚本
├── compose_files #-- 根据不同的安装模式，保存需要使用到的 compose 文件信息
├── conf #-- MeterSphere 各组件及数据库等中间件的配置文件
├── data #-- MeterSphere 各组件及数据库等中间件的数据持久化目录
├── docker-compose-gateway.yml #-- MeterSphere 的 API 网关
├── docker-compose-eureka.yml #-- MeterSphere 的服务注册中心
├── docker-compose-base.yml #-- MeterSphere 基础 Docker Compose 文件，定义了网络等基础信息
├── docker-compose-workstation.yml #-- MeterSphere 工作台模块的 Docker Compose 文件
├── docker-compose-test-track.yml #-- MeterSphere 测试跟踪模块的 Docker Compose 文件
├── docker-compose-api-test.yml #-- MeterSphere 接口测试模块的 Docker Compose 文件
├── docker-compose-ui-test.yml #-- MeterSphere UI 测试模块的 Docker Compose 文件
├── docker-compose-performance-test.yml #-- MeterSphere 性能测试模块的 Docker Compose 文件
├── docker-compose-report-stat.yml #-- MeterSphere 报表统计模块的 Docker Compose 文件
├── docker-compose-project-management.yml #-- MeterSphere 项目管理模块的 Docker Compose 文件
├── docker-compose-system-setting.yml #-- MeterSphere 系统设置模块的 Docker Compose 文件
├── docker-compose-kafka.yml #-- MeterSphere 自带的 Kafka 所需的 Docker Compose 文件
├── docker-compose-mysql.yml #-- MeterSphere 自带的 MySQL 所需的 Docker Compose 文件
├── docker-compose-node-controller.yml #-- MeterSphere Node-Controller 组件所需的 Docker Compose文件
├── docker-compose-server.yml #-- MeterSphere Server 及 Data-Streaming 所需的 Docker Compose文件
├── docker-compose-redis.yml #-- MeterSphere Redis 组件所需的 Docker Compose文件
├── docker-compose-minio.yml #-- MeterSphere 自带的分布式对象存储服务
├── docker-compose-prometheus.yml #-- MeterSphere Prometheus 组件所需的Docker Compose 文件
├── install.conf -> /opt/metersphere/.env #-- MeterSphere 的配置文件 /opt/metersphere/.env 的软链接
├── logs #-- MeterSphere 各组件的日志文件持久化目录
└── version #-- 安装包对应的 MeterSphere 版本信息
```

## 3 手动安装（可配置安装参数）
## 3 手动安装
### 3.1 手动安装
到 GitHub release 页面下载在线安装包，链接为: https://github.com/metersphere/metersphere/releases

```sh
# 下载在线安装包
wget https://github.com/metersphere/metersphere/releases/download/v1.x.y/metersphere-online-installer-v1.20.x-lts.tar.gz

# 解压在线安装包
tar -zxvf metersphere-online-installer-v1.20.x-lts.tar.gz

# 进入解压目录
cd metersphere-online-installer-v1.20.x-lts
!!! ms-abstract ""
MeterSphere 安装包下载链接: https://github.com/metersphere/metersphere/releases
```
# 下载在线安装包
wget https://github.com/metersphere/metersphere/releases/download/v2.x.y/metersphere-online-installer-v2.x.y.tar.gz

# 解压在线安装包
tar -zxvf metersphere-online-installer-v2.x.y.tar.gz

# 进入解压目录
cd metersphere-online-installer-v2.x.y

# 配置安装参数，参数说明见下文
# vi install.conf

# 执行install.sh安装脚本
/bin/bash install.sh
```

# 配置安装参数，参数说明见下文
# vi install.conf
执行完安装脚本后，会在线拉取镜像，等提示安装完成后，使用 msctl status 查看服务各个组件状态
![服务状态](../img/installation/ms-status.png){ width="900px" }

# 执行install.sh安装脚本
/bin/bash install.sh
```
!!! ms-abstract ""
等待几分钟后，使用命令 `msctl status` 检查服务运行情况，若各个组件都是 healthy 状态，通过浏览器访问如下页面登录 MeterSphere。
```
请通过以下方式访问:

安装成功后，通过浏览器访问如下页面登录 MeterSphere。
URL: http://服务器IP:8081
用户名: admin
初始密码: metersphere

```
地址: http://目标服务器IP地址:8081
用户名: admin
密码: metersphere
```
```

### 3.2 安装配置文件说明

!!! info "安装配置文件说明, 如果无特殊需求可以不进行修改采用默认参数安装（首次安装可修改配置 install.conf 文件中相关配置，修改完后执行 /bin/bash install.sh 命令进行安装，已安装成功如需再修改配置参数，可以直接到 ${MS_BASE}/metersphere/.env 里修改，修改完后执行 msctl reload 即可重新加载配置文件）"
```vim
!!! ms-abstract "安装配置文件说明"
如果无特殊需求可以不进行修改采用默认参数安装（首次安装可修改配置 install.conf 文件中相关配置，修改完后执行 `/bin/bash install.sh` 命令进行安装，已安装成功如需再修改配置参数，需要到 ${MS_BASE}/metersphere/.env 里修改，修改完后执行 `msctl reload` 即可重新加载配置文件）。
```
# 基础配置
## 安装路径, MeterSphere 配置及数据文件默认将安装在 ${MS_BASE}/metersphere 目录下
## 安装路径， MeterSphere 配置及数据文件默认将安装在 ${MS_BASE}/metersphere 目录下
MS_BASE=/opt
## MeterSphere 使用的 docker 网络网段信息
MS_DOCKER_SUBNET=172.30.10.0/24
## 镜像前缀, MeterSphere 相关组件使用的 Docker 镜像前缀, 例如 registry.cn-qingdao.aliyuncs.com/metersphere
## 镜像前缀， MeterSphere 相关组件使用的 Docker 镜像前缀， 例如 registry.cn-qingdao.aliyuncs.com/metersphere
MS_IMAGE_PREFIX=registry.cn-qingdao.aliyuncs.com/metersphere
## 镜像标签, MeterSphere 相关组件使用的 Docker 镜像标签
MS_IMAGE_TAG=v1.19.1
## 镜像标签， MeterSphere 相关组件使用的 Docker 镜像标签
MS_IMAGE_TAG=v2.3.0
## 性能测试使用的 JMeter 镜像
MS_JMETER_IMAGE=${MS_IMAGE_PREFIX}/jmeter-master:5.4.3-ms4-jdk8
## 安装模式
MS_JMETER_IMAGE=${MS_IMAGE_PREFIX}/jmeter-master:5.5-ms2-jdk11
## 安装模式 allinone | server | node-controller | selenium-hub， 其中 selenium-hub 和 node-controller 可以单独在服务器上部署作为执行机使用
MS_INSTALL_MODE=allinone
## MeterSphere 主程序的 HTTP 服务监听端口
MS_SERVER_PORT=8081
Expand Down Expand Up @@ -145,52 +158,77 @@ cd metersphere-online-installer-v1.20.x-lts
## 重构后性能测试结果数据使用的 Kafka Topic
MS_KAFKA_REPORT_TOPIC=JMETER_REPORTS

# TCP MOCK 端口范围
MS_TCP_MOCK_PORT=10000-10010

# Chrome 容器配置
## 是否启动Chrome容器
MS_CHROME_ENABLED=false
# UI容器配置
## 是否启动UI模块
MS_UI_ENABLED=false
## 是否启动工作台容器
MS_WORKSTATION_ENABLED=false

# minio 配置
## 是否使用外部minio
MS_EXTERNAL_MINIO=false
## minio 地址
MS_MINIO_ENDPOINT=http://minio:9000
## minio access
MS_MINIO_ACCESS_KEY=admin
## minio 密码
MS_MINIO_SECRET_KEY=Password123@minio

# 修改组件最大内存限制（v2.7以上可以在 /opt/metersphere/.env 里修改某容器服务的最大内存限制，在/opt/metersphere/ 目录下的docker-compose分别定义各自服务的最大属性值，如 api-test 的属性在 docker-compose-api-test.yml 中定义，为 MS_API_MEM_LIMIT）
MS_API_MEM_LIMIT=1073741824（默认为 1g）
```

### 3.3 数据库配置文件说明

!!! info "注意"
MeterSphere 使⽤ MySQL 5.7 对系统数据进⾏存储。同时 MeterSphere 对数据库部分配置项有要求，请参考下附的数据库配置，修改环境中的数据库配置文件。
!!! ms-abstract "注意"
MeterSphere 使⽤ MySQL 8.0 对系统数据进⾏存储。同时 MeterSphere 对数据库部分配置项有要求，请参考下附的数据库配置，修改环境中的数据库配置文件。

```
[mysqld]
datadir=/var/lib/mysql

default-storage-engine=INNODB
character_set_server=utf8mb4
lower_case_table_names=1
performance_schema=off
table_open_cache=128
max_connections=2000
transaction_isolation=READ-COMMITTED
max_connections=1000
max_connect_errors=6000
innodb_file_per_table=1
innodb_buffer_pool_size=1G
max_allowed_packet=64M
transaction_isolation=READ-COMMITTED
innodb_file_per_table=1
innodb_buffer_pool_size=512M
innodb_flush_method=O_DIRECT
innodb_lock_wait_timeout=1800
innodb_flush_log_at_trx_commit=0
sync_binlog=0


server-id=1
log-bin=mysql-bin
expire_logs_days = 2
binlog_format=mixed

sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION

character-set-client-handshake = FALSE
character-set-server=utf8mb4
collation-server=utf8mb4_general_ci
init_connect='SET default_collation_for_utf8mb4=utf8mb4_general_ci'

sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION

skip-name-resolve

[mysql]
default-character-set=utf8mb4

[mysql.server]
default-character-set=utf8mb4
```

请参考文档中的建库语句创建 MeterSphere 使用的数据库，metersphere-server 服务启动时会自动在配置的库中创建所需的表结构及初始化数据。
```mysql
```
CREATE DATABASE `metersphere` /*!40100 DEFAULT CHARACTER SET utf8mb4 */
```

## 4 配置反向代理
!!! warning "注意"
如果需要使用 Nginx、Haproxy 等反向代理，需要配置反向代理对 websocket 的支持。以 Nginx 为例，参考的配置内容如下。
!!! ms-abstract ""
如果使用了 Nginx、HAProxy 进行反向代理配置，需要增加对 websocket 的支持。以 Nginx 为例，参考配置如下:
```
server {
listen 80;
Expand Down Expand Up @@ -220,7 +258,7 @@ cd metersphere-online-installer-v1.20.x-lts
client_max_body_size 1000m;
#access_log off;

# 配置 websocket 支持
#配置 websocket 支持
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
Expand Down
1 change: 1 addition & 0 deletions docs/quick_start/quick_start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ description: MeterSphere 一站式开源持续测试平台官方文档。MeterSp
* CPU内存要求：最低要求 4C8G，推荐 8C16G
* 部署目录空间（默认/opt目录）要求： 50G
* 网络要求：可访问互联网
* 注：如用于生产环境，推荐使用 [离线安装包](https://community.fit2cloud.com/#/products/metersphere/downloads) 进行部署

## 2 网络端口要求

Expand Down

0 comments on commit c3d49c7

Please sign in to comment.