Skip to content

Commit

Permalink
Deployed c3d49c7 to v1.20.x-lts with MkDocs 1.5.3 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@shenkaibo
shenkaibo committed Oct 31, 2023
1 parent ffde5ef commit c3dd8cd
Show file tree
Hide file tree
Showing 5 changed files with 138 additions and 91 deletions.
224 changes: 135 additions & 89 deletions v1.20.x-lts/installation/online_installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -861,17 +861,17 @@ <h5 style="color: #000000">软件测试</h5>

<li class="md-nav__item">
<a href="#2" class="md-nav__link">
2 一键安装（采用默认安装参数）
2 一键安装
</a>

</li>

<li class="md-nav__item">
<a href="#3" class="md-nav__link">
3 手动安装（可配置安装参数）
3 手动安装
</a>

<nav class="md-nav" aria-label="3 手动安装（可配置安装参数）">
<nav class="md-nav" aria-label="3 手动安装">
<ul class="md-nav__list">

<li class="md-nav__item">
Expand Down Expand Up @@ -3241,17 +3241,17 @@ <h5 style="color: #000000">软件测试</h5>

<li class="md-nav__item">
<a href="#2" class="md-nav__link">
2 一键安装（采用默认安装参数）
2 一键安装
</a>

</li>

<li class="md-nav__item">
<a href="#3" class="md-nav__link">
3 手动安装（可配置安装参数）
3 手动安装
</a>

<nav class="md-nav" aria-label="3 手动安装（可配置安装参数）">
<nav class="md-nav" aria-label="3 手动安装">
<ul class="md-nav__list">

<li class="md-nav__item">
Expand Down Expand Up @@ -3308,178 +3308,224 @@ <h5 style="color: #000000">软件测试</h5>
<h1>在线安装</h1>

<h2 id="1">1 环境要求<a class="headerlink" href="#1" title="Permanent link">&para;</a></h2>
<div class="admonition info">
<div class="admonition ms-abstract">
<p class="admonition-title">部署服务器要求</p>
<ul>
<li>操作系统: CentOS 7.x / Redhat 7.x</li>
<li>CPU/内存: 最低要求 4C8G，推荐 8C16G</li>
<li>CPU/内存: 最低要求 4C8G，推荐 8C16G (2.3.0版本及其之后的版本，最低配置 8C16G)</li>
<li>磁盘空间: 50G</li>
<li>网络要求：可访问互联网</li>
<li>注：如用于生产环境，推荐使用 <a href="https://community.fit2cloud.com/#/products/metersphere/downloads">离线安装包</a> 进行部署</li>
</ul>
</div>
<h2 id="2">2 一键安装（采用默认安装参数）<a class="headerlink" href="#2" title="Permanent link">&para;</a></h2>
<p>在服务器上以 <code>root</code> 用户执行如下命令一键安装 MeterSphere。
<h2 id="2">2 一键安装<a class="headerlink" href="#2" title="Permanent link">&para;</a></h2>
<div class="admonition ms-abstract">
<p>在服务器上以 <code>root</code> 用户执行如下命令一键安装 MeterSphere。<br>
<div class="highlight"><pre><span></span><code>curl -sSL https://resource.fit2cloud.com/metersphere/metersphere/releases/latest/download/quick_start.sh | bash
</code></pre></div></p>
<p>安装成功后，通过浏览器访问如下页面登录 MeterSphere。</p>
<p>安装成功后，通过浏览器访问如下页面登录 MeterSphere。<br>
<div class="highlight"><pre><span></span><code>地址: http://目标服务器IP地址:8081
用户名: admin
密码: metersphere
</code></pre></div>
</code></pre></div></p>
<p>安装脚本默认使用 /opt/metersphere 目录作为安装目录，MeterSphere 的配置文件、数据及日志等均存放在该安装目录。</p>
<div class="admonition info">
</div>
<div class="admonition ms-abstract">
<p class="admonition-title">安装目录目录结构说明</p>
<div class="highlight"><pre><span></span><code>/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 -&gt; /opt/metersphere/.env #-- MeterSphere 的配置文件 /opt/metersphere/.env 的软链接
├── logs #-- MeterSphere 各组件的日志文件持久化目录
└── version #-- 安装包对应的 MeterSphere 版本信息
</code></pre></div>
</div>
<h2 id="3">3 手动安装（可配置安装参数）<a class="headerlink" href="#3" title="Permanent link">&para;</a></h2>
<h2 id="3">3 手动安装<a class="headerlink" href="#3" title="Permanent link">&para;</a></h2>
<h3 id="31">3.1 手动安装<a class="headerlink" href="#31" title="Permanent link">&para;</a></h3>
<p>到 GitHub release 页面下载在线安装包，链接为: <a href="https://github.com/metersphere/metersphere/releases">https://github.com/metersphere/metersphere/releases</a></p>
<div class="highlight"><pre><span></span><code><span class="c1"># 下载在线安装包</span>
wget<span class="w"> </span>https://github.com/metersphere/metersphere/releases/download/v1.x.y/metersphere-online-installer-v1.20.x-lts.tar.gz
<div class="admonition ms-abstract">
<p>MeterSphere 安装包下载链接: <a href="https://github.com/metersphere/metersphere/releases">https://github.com/metersphere/metersphere/releases</a>
<div class="highlight"><pre><span></span><code># 下载在线安装包
wget https://github.com/metersphere/metersphere/releases/download/v2.x.y/metersphere-online-installer-v2.x.y.tar.gz

<span class="c1"># 解压在线安装包</span>
tar<span class="w"> </span>-zxvf<span class="w"> </span>metersphere-online-installer-v1.20.x-lts.tar.gz
# 解压在线安装包
tar -zxvf metersphere-online-installer-v2.x.y.tar.gz

<span class="c1"># 进入解压目录</span>
<span class="nb">cd</span><span class="w"> </span>metersphere-online-installer-v1.20.x-lts
# 进入解压目录
cd metersphere-online-installer-v2.x.y

<span class="c1"># 配置安装参数，参数说明见下文</span>
<span class="c1"># vi install.conf</span>
# 配置安装参数，参数说明见下文
# vi install.conf

<span class="c1"># 执行install.sh安装脚本</span>
/bin/bash<span class="w"> </span>install.sh
</code></pre></div>
<p>安装成功后，通过浏览器访问如下页面登录 MeterSphere。</p>
<div class="highlight"><pre><span></span><code>地址: http://目标服务器IP地址:8081
用户名: admin
密码: metersphere
</code></pre></div>
# 执行install.sh安装脚本
/bin/bash install.sh
</code></pre></div></p>
<p>执行完安装脚本后，会在线拉取镜像，等提示安装完成后，使用 msctl status 查看服务各个组件状态</p>
</div>
<p><a class="glightbox" href="../img/installation/ms-status.png" data-type="image" data-width="100%" data-height="auto" data-desc-position="bottom"><img alt="服务状态" src="../img/installation/ms-status.png" width="900px" /></a></p>
<div class="admonition ms-abstract">
<p>等待几分钟后，使用命令 <code>msctl status</code> 检查服务运行情况，若各个组件都是 healthy 状态，通过浏览器访问如下页面登录 MeterSphere。
<div class="highlight"><pre><span></span><code> 请通过以下方式访问:

URL: http://服务器IP:8081
用户名: admin
初始密码: metersphere
</code></pre></div></p>
</div>
<h3 id="32">3.2 安装配置文件说明<a class="headerlink" href="#32" title="Permanent link">&para;</a></h3>
<div class="admonition info">
<p class="admonition-title">安装配置文件说明, 如果无特殊需求可以不进行修改采用默认参数安装（首次安装可修改配置 install.conf 文件中相关配置，修改完后执行 /bin/bash install.sh 命令进行安装，已安装成功如需再修改配置参数，可以直接到 ${MS_BASE}/metersphere/.env 里修改，修改完后执行 msctl reload 即可重新加载配置文件）</p>
<div class="admonition ms-abstract">
<p class="admonition-title">安装配置文件说明</p>
<p>如果无特殊需求可以不进行修改采用默认参数安装（首次安装可修改配置 install.conf 文件中相关配置，修改完后执行 <code>/bin/bash install.sh</code> 命令进行安装，已安装成功如需再修改配置参数，需要到 ${MS_BASE}/metersphere/.env 里修改，修改完后执行 <code>msctl reload</code> 即可重新加载配置文件）。
<div class="highlight"><pre><span></span><code># 基础配置
## 安装路径<span class="p">,</span> MeterSphere 配置及数据文件默认将安装在 ${MS_BASE}/metersphere 目录下
MS_BASE<span class="p">=</span>/<span class="k">opt</span>
## 安装路径， MeterSphere 配置及数据文件默认将安装在 ${MS_BASE}/metersphere 目录下
MS_BASE=/opt
## MeterSphere 使用的 docker 网络网段信息
MS_DOCKER_SUBNET<span class="p">=</span><span class="m">172</span>.<span class="m">30</span>.<span class="m">10</span>.<span class="m">0</span>/<span class="m">24</span>
## 镜像前缀<span class="p">,</span> MeterSphere 相关组件使用的 Docker 镜像前缀<span class="p">,</span> 例如 registry.<span class="k">cn</span><span class="p">-</span>qingdao.aliyuncs.<span class="k">com</span>/metersphere
MS_IMAGE_PREFIX<span class="p">=</span>registry.<span class="k">cn</span><span class="p">-</span>qingdao.aliyuncs.<span class="k">com</span>/metersphere
## 镜像标签<span class="p">,</span> MeterSphere 相关组件使用的 Docker 镜像标签
MS_IMAGE_TAG<span class="p">=</span>v1.<span class="m">19</span>.<span class="m">1</span>
MS_DOCKER_SUBNET=172.30.10.0/24
## 镜像前缀， MeterSphere 相关组件使用的 Docker 镜像前缀， 例如 registry.cn-qingdao.aliyuncs.com/metersphere
MS_IMAGE_PREFIX=registry.cn-qingdao.aliyuncs.com/metersphere
## 镜像标签， MeterSphere 相关组件使用的 Docker 镜像标签
MS_IMAGE_TAG=v2.3.0
## 性能测试使用的 JMeter 镜像
MS_JMETER_IMAGE<span class="p">=</span>${MS_IMAGE_PREFIX}/jmeter<span class="p">-</span>master:<span class="m">5</span>.<span class="m">4</span>.<span class="m">3</span><span class="p">-</span>ms4<span class="p">-</span>jdk8
## 安装模式
MS_INSTALL_MODE<span class="p">=</span>allinone
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<span class="p">=</span><span class="m">8081</span>
## MeterSphere Node<span class="p">-</span>Controller 组件的 HTTP 服务监听端口
MS_NODE_CONTROLLER_PORT<span class="p">=</span><span class="m">8082</span>
MS_NODEEXPORTER_PORT<span class="p">=</span><span class="m">9100</span>
MS_SERVER_PORT=8081
## MeterSphere Node-Controller 组件的 HTTP 服务监听端口
MS_NODE_CONTROLLER_PORT=8082
MS_NODEEXPORTER_PORT=9100

# 数据库配置
## 是否使用外部数据库
MS_EXTERNAL_MYSQL<span class="p">=</span>false
MS_EXTERNAL_MYSQL=false
## 数据库地址
MS_MYSQL_HOST<span class="p">=</span>mysql
MS_MYSQL_HOST=mysql
## 数据库端口
MS_MYSQL_PORT<span class="p">=</span><span class="m">3306</span>
MS_MYSQL_PORT=3306
## 数据库库名
MS_MYSQL_DB<span class="p">=</span>metersphere
MS_MYSQL_DB=metersphere
## 数据库用户名
MS_MYSQL_USER<span class="p">=</span>root
MS_MYSQL_USER=root
## 数据库密码
MS_MYSQL_PASSWORD<span class="p">=</span>Password123@mysql
MS_MYSQL_PASSWORD=Password123@mysql

# Prometheus 配置
## 是否使用外部Prometheus
MS_EXTERNAL_PROM<span class="p">=</span>false
MS_PROMETHEUS_PORT<span class="p">=</span><span class="m">9090</span>
MS_EXTERNAL_PROM=false
MS_PROMETHEUS_PORT=9090

# Redis 配置
## 是否使用外部Redis
MS_EXTERNAL_REDIS<span class="p">=</span>false
MS_EXTERNAL_REDIS=false
## Redis 端口
MS_REDIS_PORT<span class="p">=</span><span class="m">6379</span>
MS_REDIS_PORT=6379
## Redis 密码
MS_REDIS_PASSWORD<span class="p">=</span>Password123@redis
MS_REDIS_PASSWORD=Password123@redis
## Redis地址
MS_REDIS_HOST<span class="p">=</span>$<span class="p">(</span>hostname <span class="p">-</span>I<span class="p">|</span>cut <span class="p">-</span><span class="k">d</span><span class="s2">&quot; &quot;</span> <span class="p">-</span><span class="k">f</span> <span class="m">1</span><span class="p">)</span>
MS_REDIS_HOST=$(hostname -I|cut -d&quot; &quot; -f 1)

# Kafka 配置
## 是否使用外部 Kafka
MS_EXTERNAL_KAFKA<span class="p">=</span>false
MS_EXTERNAL_KAFKA=false
## Kafka 地址
MS_KAFKA_HOST<span class="p">=</span><span class="m">10</span>.<span class="m">1</span>.*.*
MS_KAFKA_HOST=10.1.*.*
## Kafka 端口
MS_KAFKA_PORT<span class="p">=</span><span class="m">9092</span>
MS_KAFKA_PORT=9092
## 性能测试结果数据使用的 Kafka Topic
MS_KAFKA_TOPIC<span class="p">=</span>JMETER_METRICS
MS_KAFKA_TOPIC=JMETER_METRICS
## 性能测试日志数据使用的 Kafka Topic
MS_KAFKA_LOG_TOPIC<span class="p">=</span>JMETER_LOGS
MS_KAFKA_LOG_TOPIC=JMETER_LOGS
## 性能测试定时任务通知使用的 Kafka Topic
MS_KAFKA_TEST_TOPIC<span class="p">=</span>LOAD_TESTS
MS_KAFKA_TEST_TOPIC=LOAD_TESTS
## 重构后性能测试结果数据使用的 Kafka Topic
MS_KAFKA_REPORT_TOPIC<span class="p">=</span>JMETER_REPORTS

# TCP MOCK 端口范围
MS_TCP_MOCK_PORT<span class="p">=</span><span class="m">10000-10010</span>

# Chrome 容器配置
## 是否启动Chrome容器
MS_CHROME_ENABLED<span class="p">=</span>false
</code></pre></div>
MS_KAFKA_REPORT_TOPIC=JMETER_REPORTS

# 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）
</code></pre></div></p>
</div>
<h3 id="33">3.3 数据库配置文件说明<a class="headerlink" href="#33" title="Permanent link">&para;</a></h3>
<div class="admonition info">
<div class="admonition ms-abstract">
<p class="admonition-title">注意</p>
<p>MeterSphere 使⽤ MySQL 5.7 对系统数据进⾏存储。同时 MeterSphere 对数据库部分配置项有要求，请参考下附的数据库配置，修改环境中的数据库配置文件。</p>
<p>MeterSphere 使⽤ MySQL 8.0 对系统数据进⾏存储。同时 MeterSphere 对数据库部分配置项有要求，请参考下附的数据库配置，修改环境中的数据库配置文件。</p>
<div class="highlight"><pre><span></span><code>[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=&#39;SET default_collation_for_utf8mb4=utf8mb4_general_ci&#39;

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
</code></pre></div>
<p>请参考文档中的建库语句创建 MeterSphere 使用的数据库，metersphere-server 服务启动时会自动在配置的库中创建所需的表结构及初始化数据。
<div class="highlight"><pre><span></span><code><span class="k">CREATE</span><span class="w"> </span><span class="k">DATABASE</span><span class="w"> </span><span class="n n-Quoted">`metersphere`</span><span class="w"> </span><span class="cm">/*!40100 DEFAULT CHARACTER SET utf8mb4 */</span>
<div class="highlight"><pre><span></span><code>CREATE DATABASE `metersphere` /*!40100 DEFAULT CHARACTER SET utf8mb4 */
</code></pre></div></p>
</div>
<h2 id="4">4 配置反向代理<a class="headerlink" href="#4" title="Permanent link">&para;</a></h2>
<div class="admonition warning">
<p class="admonition-title">注意</p>
<p>如果需要使用 Nginx、Haproxy 等反向代理，需要配置反向代理对 websocket 的支持。以 Nginx 为例，参考的配置内容如下。
<div class="admonition ms-abstract">
<p>如果使用了 Nginx、HAProxy 进行反向代理配置，需要增加对 websocket 的支持。以 Nginx 为例，参考配置如下:
<div class="highlight"><pre><span></span><code>server {
listen 80;
server_name demo.metersphere.com;
Expand Down Expand Up @@ -3508,7 +3554,7 @@ <h2 id="4">4 配置反向代理<a class="headerlink" href="#4" title="Permanent
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 &quot;upgrade&quot;;
Expand Down
1 change: 1 addition & 0 deletions v1.20.x-lts/quick_start/quick_start/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3304,6 +3304,7 @@ <h2 id="1">1 部署服务器要求<a class="headerlink" href="#1" title="Permane
<li>CPU内存要求：最低要求 4C8G，推荐 8C16G</li>
<li>部署目录空间（默认/opt目录）要求： 50G</li>
<li>网络要求：可访问互联网</li>
<li>注：如用于生产环境，推荐使用 <a href="https://community.fit2cloud.com/#/products/metersphere/downloads">离线安装包</a> 进行部署</li>
</ul>
</div>
<h2 id="2">2 网络端口要求<a class="headerlink" href="#2" title="Permanent link">&para;</a></h2>
Expand Down
2 changes: 1 addition & 1 deletion v1.20.x-lts/search/search_index.json
View file

Large diffs are not rendered by default.

Binary file modified v1.20.x-lts/sitemap.xml.gz
View file
Binary file not shown.
Loading

0 comments on commit c3dd8cd

Please sign in to comment.