Skip to content

Commit

Permalink
doc: fix lint
Browse files Browse the repository at this point in the history
Signed-off-by: jiefenghuang <[email protected]>
  • Loading branch information
jiefenghuang committed Mar 18, 2024
1 parent 8d403c6 commit be34544
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 13 deletions.
25 changes: 21 additions & 4 deletions docs/en/security/posix_acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,50 @@ sidebar_position: 1
---

# POSIX ACL

Version 1.2 supports POSIX ACL. For detailed rules, please refer to:

- [POSIX Access Control Lists on Linux](https://www.usenix.org/legacy/publications/library/proceedings/usenix03/tech/freenix03/full_papers/gruenbacher/gruenbacher_html/main.html#:~:text=Access%20Check%20Algorithm&text=The%20ACL%20entries%20are%20looked,matching%20entry%20contains%20sufficient%20permissions.)
- [setfacl](https://linux.die.net/man/1/setfacl)

## Usage
Currently, once ACL is enabled, it cannot be disabled. Therefore, the --enable-acl flag is associated with the volume.

<!-- markdownlint-disable MD044 enhanced-proper-names -->

Currently, once ACL is enabled, it cannot be disabled.
Therefore, the --enable-acl flag is associated with the volume.

- Create a new volume

```shell
juicefs format sqlite3://myjfs.db myjfs --enable-acl
```

- Modify the configuration of an existing volume
```

```shell
juicefs config sqlite3://myjfs.db --enable-acl
```

<!-- markdownlint-enable MD044 enhanced-proper-names -->

## Compatibility

- New client versions are compatible with old volume versions.
- Old client versions are compatible with new volume versions (without ACL enabled).

:::caution Note
If ACL is enabled, it is recommended that all clients upgrade. If an old client mounts a new volume (without ACL enabled) and ACL is subsequently enabled on the volume, operations by the old client may impact the correctness of ACL.
If ACL is enabled, it is recommended that all clients to be upgraded.
If an old client mounts a new volume (without ACL enabled),
and ACL is subsequently enabled on the volume,
operations by the old client may impact the correctness of ACL.
:::

## Others

- Enabling ACL increases the minimum client version requirement to v1.2.
- Enabling ACL may have additional performance implications. For scenarios with infrequent ACL changes, the impact is minimal with memory cache optimization.
- Enabling ACL may have additional performance implications.
For scenarios with infrequent ACL changes,
the impact is minimal with memory cache optimization.
- Enabling ACL will activate extended attributes (xattr) functionality.
- Enabling ACL is recommended for using ["Sync Accounts between Multiple Hosts"](administration/sync_accounts_between_multiple_hosts.md)
2 changes: 1 addition & 1 deletion docs/zh_cn/reference/command_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ juicefs config redis://localhost --min-client-version 1.0.0 --max-client-version
|`--min-client-version value` <VersionAdd>1.1</VersionAdd>|允许连接的最小客户端版本|
|`--max-client-version value` <VersionAdd>1.1</VersionAdd>|允许连接的最大客户端版本|
|`--dir-stats` <VersionAdd>1.1</VersionAdd>|开启目录统计,这是快速汇总和目录配额所必需的 (默认值:false)|
|`--enable-acl` <VersionAdd>1.2</VersionAdd>|开启POSIX ACL(不支持关闭), 同时允许连接的最小客户端版本会提升到v1.2|
|`--enable-acl` <VersionAdd>1.2</VersionAdd>|开启 POSIX ACL(不支持关闭), 同时允许连接的最小客户端版本会提升到 v1.2|

### `juicefs quota` <VersionAdd>1.1</VersionAdd> {#quota}

Expand Down
26 changes: 18 additions & 8 deletions docs/zh_cn/security/posix_acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,42 @@ sidebar_position: 3
---
# POSIX ACL

1.2版本支持POSIX ACL, 详细规则参考
1.2 版本支持 POSIX ACL, 详细规则参考

- [POSIX Access Control Lists on Linux](https://www.usenix.org/legacy/publications/library/proceedings/usenix03/tech/freenix03/full_papers/gruenbacher/gruenbacher_html/main.html#:~:text=Access%20Check%20Algorithm&text=The%20ACL%20entries%20are%20looked,matching%20entry%20contains%20sufficient%20permissions.)
- [setfacl](https://linux.die.net/man/1/setfacl)

## 使用
目前ACL开启后暂不支持取消, 所以--enable-acl flag与卷关联.

<!-- markdownlint-disable MD044 enhanced-proper-names -->

目前 ACL 开启后暂不支持取消,所以--enable-acl flag 与卷关联。

- 创建新卷

```shell
juicefs format sqlite3://myjfs.db myjfs --enable-acl
```

- 修改已有卷配置

```shell
juicefs config sqlite3://myjfs.db --enable-acl
```

<!-- markdownlint-enable MD044 enhanced-proper-names -->

## 兼容

- 新版本客户端兼容老版本卷
- 老版本客户端兼容(不开启acl的)新版本卷
- 老版本客户端兼容 (不开启 ACL 的) 新版本卷
:::caution 提示
如果启用acl功能, 建议所有客户端都升级. 老版本客户端挂载了新卷(没有开启acl), 后续如果卷开启了acl, 老版本客户端的操作会影响ACL的正确性
如果启用 ACL 功能,建议所有客户端都升级。老版本客户端挂载了新卷 (没有开启 ACL), 后续如果卷开启 ACL, 老版本客户端的操作会影响 ACL 的正确性
:::

## 其他
- 开启ACL后, 客户端版本要求会提升到v1.2
- 开启ACL会有额外的性能影响, 对于ACL变动不频繁的场景, 有内存cache优化影响不大
- 开启ACL会启用扩展属性 (xattr) 功能
- 开启ACL建议使用[「多主机间同步账户」](../administration/sync_accounts_between_multiple_hosts.md)

- 开启 ACL 后,客户端版本要求会提升到 v1.2
- 开启 ACL 会有额外的性能影响,对于 ACL 变动不频繁的场景,有内存 cache 优化影响不大
- 开启 ACL 会启用扩展属性 (xattr) 功能
- 开启 ACL 建议使用[「多主机间同步账户」](../administration/sync_accounts_between_multiple_hosts.md)

0 comments on commit be34544

Please sign in to comment.