Skip to content

Commit

Permalink
Docs: a series of updates to the documentation (#4805)
Browse files Browse the repository at this point in the history
  • Loading branch information
yuhr123 authored May 6, 2024
1 parent 55ab091 commit 3207f90
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 166 deletions.
6 changes: 4 additions & 2 deletions docs/en/deployment/production_deployment_recommendations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ description: This article is intended as a reference for users who are about to

# Production Deployment Recommendations

This article aims to give some recommendations when deploying JuiceFS to a production environment, so please read the following in advance and carefully.
This document provides deployment recommendations for JuiceFS community edition in production environments, focusing on monitoring metric collection, automatic metadata backup, trash configuration, background tasks of clients, client log rolling, and command-line auto-completion, to ensure the stability and reliability of the file system.

## Metrics Collection and Visualization

Be sure to collect and visualize the monitoring metrics for your JuiceFS client through Grafana, as described in this [documentation](../administration/monitoring.md).
It is necessary to collect monitoring metrics from JuiceFS clients and visualize them using Grafana, allowing for real-time monitoring of file system performance and health status, as described in this [documentation](../administration/monitoring.md).

## Automatic Metadata Backup

Expand Down Expand Up @@ -47,6 +47,8 @@ Please refer to this [documentation](../security/trash.md) for more information

## Client Background Tasks

The JuiceFS file system maintains background tasks through clients, which can automatically execute cleaning tasks such as deleting pending files and objects, purging expired files and fragments from the trash, and terminating long-stalled client sessions, etc.

All clients of the same JuiceFS volume share a set of background tasks during runtime. Each task is executed at regular intervals, and which client will be chosen is random. The background tasks include

1. cleaning up files and objects to be deleted
Expand Down
20 changes: 3 additions & 17 deletions docs/en/tutorials/aliyun.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,27 +83,13 @@ Alibaba Cloud OSS needs to be accessed through API, you need to prepare the acce
## Installation

We currently using Ubuntu Server 20.04 64-bit, so you can download the latest version of the client by running the following commands. You can also choose another version by visiting the [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) page.
We currently using Ubuntu Server 20.04 64-bit, so you can download the latest version of the client by running the following command

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
curl -sSL https://d.juicefs.com/install | sh -
```

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

After downloading, unzip the program into the `juice` folder.

```shell
mkdir juice && tar -zxvf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" -C juice
```

Install the JuiceFS client to `/usr/local/bin` :

```shell
sudo install juice/juicefs /usr/local/bin
```
You can also choose another version by visiting the [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) page.

Execute the command and see the help message `juicefs` returned, which means the client installation is successful.

Expand Down
24 changes: 2 additions & 22 deletions docs/en/tutorials/digitalocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,30 +60,10 @@ The access address of the Redis can be found in the `Connection Details` of the

### 1. Install JuiceFS client

We currently using Ubuntu Server 20.04, execute the following commands in sequence to install the latest version of the client.

Check current system and set temporary environment variable:

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
```

Download the latest version of the client software package adapted to the current system:

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

Unzip the installation package:

```shell
mkdir juice && tar -zxvf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" -C juice
```

Install the client to `/usr/local/bin`:
We currently using Ubuntu Server 20.04, execute the following command to install the latest version of the client.

```shell
sudo install juice/juicefs /usr/local/bin
curl -sSL https://d.juicefs.com/install | sh -
```

Execute the command and see the command help information returned to `juicefs`, which means that the client is installed successfully.
Expand Down
5 changes: 2 additions & 3 deletions docs/en/tutorials/juicefs_on_colab.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,7 @@ Note that the follow commands are run in Colab environment so there is a `!` mar
1. Download `juicefs` to Colab runtime instance

```shell
! curl -L -o juicefs.tar.gz https://github.com/juicedata/juicefs/releases/download/v1.0.0-beta2/juicefs-1.0.0-beta2-linux-amd64.tar.gz
! tar -xf juicefs.tar.gz
! curl -sSL https://d.juicefs.com/install | sh -
```

2. Set up Google Cloud credentials
Expand All @@ -127,7 +126,7 @@ Note that the follow commands are run in Colab environment so there is a `!` mar
4. Mount JuiceFS file system `myvolumn` onto folder `mnt`

```shell
! GOOGLE_APPLICATION_CREDENTIALS=/content/.config/application_default_credentials.json nohup ./juicefs mount "postgres://postgres:mushroom1@localhost:5432/juicefs?sslmode=disable" mnt > juicefs.log &
! GOOGLE_APPLICATION_CREDENTIALS=/content/.config/application_default_credentials.json nohup juicefs mount "postgres://postgres:mushroom1@localhost:5432/juicefs?sslmode=disable" mnt > juicefs.log &
```

Now you should be able to use the folder `mnt` as if it is a local file system folder to write and read folders and files
Expand Down
24 changes: 2 additions & 22 deletions docs/en/tutorials/juicefs_on_wsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,30 +54,10 @@ Using JuiceFS in WSL means using JuiceFS on a Linux system, and here is an examp

### Install the client

Install the JuiceFS client on the Linux subsystem by executing the following command in sequence.

1. Get the latest version number

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
```

2. Download the client to the current directory

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

3. Unzip the installation package

```shell
tar -zxf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

4. Install
Install the JuiceFS client on the Linux subsystem by executing the following command.

```shell
sudo install juicefs /usr/local/bin
curl -sSL https://d.juicefs.com/install | sh -
```

### Creating a file system
Expand Down
20 changes: 3 additions & 17 deletions docs/en/tutorials/qcloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,27 +77,13 @@ Tencent Cloud COS needs to be accessed through API, you need to prepare the acce
## Installation

Here we are using Ubuntu Server 20.04 64-bit system, and the latest version of the client can be downloaded by running the following commands. You can also choose another version by visiting the [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) page.
Here we are using Ubuntu Server 20.04 64-bit system, and the latest version of the client can be installed by running the following command.

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
curl -sSL https://d.juicefs.com/install | sh -
```

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

After downloading, unzip the program into the `juice` folder.

```shell
mkdir juice && tar -zxvf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" -C juice
```

Install the JuiceFS client to `/usr/local/bin` :

```shell
sudo install juice/juicefs /usr/local/bin
```
You can also choose another version by visiting the [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) page.

Execute the command and see the help message `juicefs` returned, which means the client installation is successful.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ description: 本文面向即将把 JuiceFS 部署到生产环境的用户参考

# 生产环境部署建议

生产环境的注意事项在这里罗列介绍
本文档提供在生产环境中部署 JuiceFS 社区版的建议,主要涉及监控指标收集、元数据自动备份、回收站配置、客户端后台任务、客户端日志滚动和命令行自动补全等方面,以确保文件系统的稳定性和可靠性

## 监控指标收集与可视化

请务必收集 JuiceFS 客户端的监控指标并通过 Grafana 可视化,具体请参考[文档](../administration/monitoring.md)
务必收集 JuiceFS 客户端的监控指标,并通过 Grafana 可视化,以便实时监控文件系统的性能和健康状态。具体请参考[文档](../administration/monitoring.md)

## 元数据自动备份

Expand Down Expand Up @@ -47,6 +47,8 @@ description: 本文面向即将把 JuiceFS 部署到生产环境的用户参考

## 客户端后台任务

JuiceFS 文件系统通过客户端维护后台任务,可以自动执行清理待删除文件和对象、清理回收站中的过期文件和碎片、清理长时间未响应的客户端会话等任务等。

同一个 JuiceFS 文件系统的所有客户端在运行过程中共享一个后台任务集,每个任务定时执行,且具体执行的客户端随机选择。具体的后台任务包括:

1. 清理待删除的文件和对象
Expand Down
20 changes: 3 additions & 17 deletions docs/zh_cn/tutorials/aliyun.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,27 +81,13 @@ JuiceFS 会将所有的数据都存储到对象存储中,它支持几乎所有
## 安装

我们当前使用的是 Ubuntu Server 20.04 64 位系统,依次执行以下命令可以下载最新版本客户端。你也可以访问 [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) 页面选择其他版本
当前使用的是 Ubuntu Server 20.04 64 位系统,依次执行以下命令可以安装最新版本客户端

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
curl -sSL https://d.juicefs.com/install | sh -
```

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

下载完成以后,解压程序到 `juice` 文件夹:

```shell
mkdir juice && tar -zxvf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" -C juice
```

将 JuiceFS 客户端安装到 `/usr/local/bin`

```shell
sudo install juice/juicefs /usr/local/bin
```
你也可以访问 [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) 页面选择其他版本。

执行命令,看到返回 `juicefs` 的命令帮助信息,代表客户端安装成功。

Expand Down
24 changes: 2 additions & 22 deletions docs/zh_cn/tutorials/digitalocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,30 +60,10 @@ Redis 的访问地址可以从控制台的 `Connection Details` 中找到,如

### 1. 安装 JuiceFS 客户端

我们当前使用的是 Ubuntu Server 20.04,依次执行以下命令即可安装最新版本客户端。

检测当前系统信息并设置临时的环境变量:

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
```

下载适配当前系统的最新版客户端软件包:

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

解压安装包:

```shell
mkdir juice && tar -zxvf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" -C juice
```

将客户端安装到 `/usr/local/bin`
我们当前使用的是 Ubuntu Server 20.04,执行以下命令即可安装最新版本客户端。

```shell
sudo install juice/juicefs /usr/local/bin
curl -sSL https://d.juicefs.com/install | sh -
```

执行命令,看到返回 `juicefs` 的命令帮助信息,代表客户端安装成功。
Expand Down
5 changes: 2 additions & 3 deletions docs/zh_cn/tutorials/juicefs_on_colab.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,7 @@ juicefs format \
1. 下载 `JuiceFS`到 Colab 实例上

```shell
! curl -L -o juicefs.tar.gz https://github.com/juicedata/juicefs/releases/download/v1.0.0-beta2/juicefs-1.0.0-beta2-linux-amd64.tar.gz
! tar -xf juicefs.tar.gz
! curl -sSL https://d.juicefs.com/install | sh -
```

2. 设置 Google Cloud 凭证
Expand All @@ -91,7 +90,7 @@ juicefs format \
4. 挂载 JuiceFS file system `myvolumn``mnt` 目录上。

```shell
! GOOGLE_APPLICATION_CREDENTIALS=/content/.config/application_default_credentials.json nohup ./juicefs mount "postgres://postgres:mushroom1@localhost:5432/juicefs?sslmode=disable" mnt > juicefs.log &
! GOOGLE_APPLICATION_CREDENTIALS=/content/.config/application_default_credentials.json nohup juicefs mount "postgres://postgres:mushroom1@localhost:5432/juicefs?sslmode=disable" mnt > juicefs.log &
```

现在你应该可以像使用本地文件系统一样使用 `mnt` 目录了。
Expand Down
24 changes: 2 additions & 22 deletions docs/zh_cn/tutorials/juicefs_on_wsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,30 +54,10 @@ WSL 安装完成以后,即可在开始菜单找到新安装的 Linux 发行版

### 安装客户端

依次执行命令,在 Linux 子系统中安装 JuiceFS 客户端:

1. 获取最新的版本号

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
```

2. 下载客户端到当前目录

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

3. 解压安装包

```shell
tar -zxf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

4. 安装客户端
执行命令,在 Linux 子系统中安装 JuiceFS 客户端:

```shell
sudo install juicefs /usr/local/bin
curl -sSL https://d.juicefs.com/install | sh -
```

### 创建文件系统
Expand Down
20 changes: 3 additions & 17 deletions docs/zh_cn/tutorials/qcloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,27 +87,13 @@ JuiceFS 会将所有的数据都存储到对象存储中,它支持几乎所有
## 安装

我当前使用的是 Ubuntu Server 20.04 64 位系统,依次执行以下命令可以下载最新版本客户端。你也可以访问 [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) 页面选择其他版本
我当前使用的是 Ubuntu Server 20.04 64 位系统,执行以下命令可以安装最新版本客户端

```shell
JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v')
curl -sSL https://d.juicefs.com/install | sh -
```

```shell
wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz"
```

下载完成以后,解压程序到 `juice` 文件夹:

```shell
mkdir juice && tar -zxvf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" -C juice
```

将 JuiceFS 客户端安装到 `/usr/local/bin`

```shell
sudo install juice/juicefs /usr/local/bin
```
你也可以访问 [JuiceFS GitHub Releases](https://github.com/juicedata/juicefs/releases) 页面选择其他版本。

执行命令,看到返回 `juicefs` 的命令帮助信息,代表客户端安装成功。

Expand Down

0 comments on commit 3207f90

Please sign in to comment.