Skip to content

Commit 1178175

Browse files
zwwhdlszwwhdls
authored
juicefs docs: more explain in non-required config (#4519)
* juicefs docs: more explain in non-required config Signed-off-by: zwwhdls <zww@hdls.me> * fix typo Signed-off-by: zwwhdls <zww@hdls.me> --------- Signed-off-by: zwwhdls <zww@hdls.me>
1 parent be7eb0e commit 1178175

2 files changed

Lines changed: 35 additions & 35 deletions

File tree

‎docs/en/samples/juicefs_runtime.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ kubectl create secret generic jfs-secret \
4646
--from-literal=secret-key=<secretkey>
4747
```
4848

49-
- `metaurl`: Connection URL for metadata engine (e.g. Redis). Read [this document](https://juicefs.com/docs/community/databases_for_metadata/) for more information.
50-
- `access-key`: Access key of object storage.
51-
- `secret-key`: Secret key of object storage.
49+
- `metaurl`: Connection URL for metadata engine (e.g. Redis), it is required. Read [this document](https://juicefs.com/docs/community/databases_for_metadata/) for more information.
50+
- `access-key`: Access key of object storage, not required, if your filesystem is already formatted, can be empty.
51+
- `secret-key`: Secret key of object storage, not required, if your filesystem is already formatted, can be empty.
5252

5353
**Check `Dataset` to be created**
5454

@@ -61,22 +61,22 @@ metadata:
6161
spec:
6262
mounts:
6363
- name: minio
64-
mountPoint: "juicefs:///demo"
64+
mountPoint: "juicefs:///demo" # Refers to the subdirectory of JuiceFS, starts with `juicefs://`. Required.
6565
options:
66-
bucket: "<bucket>"
66+
bucket: "<bucket>" # Bucket URL. Not required, if your filesystem is already formatted, can be empty.
6767
storage: "minio"
6868
encryptOptions:
69-
- name: metaurl
69+
- name: metaurl # Connection URL for metadata engine. Required.
7070
valueFrom:
7171
secretKeyRef:
7272
name: jfs-secret
7373
key: metaurl
74-
- name: access-key
74+
- name: access-key # Access key of object storage. Not required, if your filesystem is already formatted, can be empty.
7575
valueFrom:
7676
secretKeyRef:
7777
name: jfs-secret
7878
key: access-key
79-
- name: secret-key
79+
- name: secret-key # Secret key of object storage. Not required, if your filesystem is already formatted, can be empty.
8080
valueFrom:
8181
secretKeyRef:
8282
name: jfs-secret
@@ -215,9 +215,9 @@ kubectl create secret generic jfs-secret \
215215
--from-literal=secret-key=<secretkey>
216216
```
217217

218-
- `token`: JuiceFS managed token. Read [this document](https://juicefs.com/docs/cloud/metadata/#token-management) for more details.
219-
- `access-key`: Access key of object storage.
220-
- `secret-key`: Secret key of object storage.
218+
- `token`: JuiceFS managed token. Not required, if JuiceFS connected to meta server via `initconfig`, can be empty. Read [this document](https://juicefs.com/docs/cloud/metadata/#token-management) for more details.
219+
- `access-key`: Access key of object storage, not required, if it has been configured in JuiceFS console, can be empty.
220+
- `secret-key`: Secret key of object storage, not required, if it has been configured in JuiceFS console, can be empty.
221221

222222
**Check `Dataset` to be created**
223223

@@ -230,21 +230,21 @@ metadata:
230230
spec:
231231
mounts:
232232
- name: minio
233-
mountPoint: "juicefs:///demo"
233+
mountPoint: "juicefs:///demo" # Refers to the subdirectory of JuiceFS, starts with `juicefs://`. Required.
234234
options:
235-
bucket: "<bucket>"
235+
bucket: "<bucket>" # Bucket URL. Not required, if no display of the specification is required, can be empty.
236236
encryptOptions:
237-
- name: token
237+
- name: token # JuiceFS managed token. Not required, if JuiceFS connected to meta server via `initconfig`, can be empty.
238238
valueFrom:
239239
secretKeyRef:
240240
name: jfs-secret
241241
key: token
242-
- name: access-key
242+
- name: access-key # Access key of object storage. Not required, if it has been configured in JuiceFS console, can be empty.
243243
valueFrom:
244244
secretKeyRef:
245245
name: jfs-secret
246246
key: access-key
247-
- name: secret-key
247+
- name: secret-key # Secret key of object storage. Not required, if it has been configured in JuiceFS console, can be empty.
248248
valueFrom:
249249
secretKeyRef:
250250
name: jfs-secret
@@ -256,7 +256,7 @@ EOF
256256
- `mountPoint`: Refers to the subdirectory of JuiceFS, which is the directory where users store data in the JuiceFS file system, starts with `juicefs://`. For example, `juicefs:///demo` is the `/demo` subdirectory of the JuiceFS file system.
257257
- `bucket`: Bucket URL. For example, using S3 as object storage, bucket is `https://myjuicefs.s3.us-east-2.amazonaws.com`. Read [this document](https://juicefs.com/docs/community/how_to_setup_object_storage/) to learn how to setup different object storage.
258258

259-
> **Attention**: `name` and `token` are required.
259+
> **Attention**: `name` is required.
260260
261261
Since JuiceFS uses local cache, the corresponding `Dataset` supports only one mount, and JuiceFS does not have UFS, you can specify subdirectory in `mountPoint` (`juicefs:///` represents root directory), and it will be mounted as the root directory into the container.
262262

‎docs/zh/samples/juicefs/juicefs_runtime.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ kubectl create secret generic jfs-secret \
4646

4747
其中：
4848

49-
- `metaurl`：元数据服务的访问 URL (比如 Redis)。更多信息参考[这篇文档](https://juicefs.com/docs/zh/community/databases_for_metadata/) 。
50-
- `access-key`：对象存储的 access key。
51-
- `secret-key`：对象存储的 secret key。
49+
- `metaurl`：元数据服务的访问 URL (比如 Redis)，必填。更多信息参考[这篇文档](https://juicefs.com/docs/zh/community/databases_for_metadata/) 。
50+
- `access-key`：对象存储的 access key，非必填，若 JuiceFS 已经格式化过，可以不填。
51+
- `secret-key`：对象存储的 secret key，非必填，若 JuiceFS 已经格式化过，可以不填。
5252

5353
**查看待创建的 `Dataset` 资源对象**
5454

@@ -61,22 +61,22 @@ metadata:
6161
spec:
6262
mounts:
6363
- name: minio
64-
mountPoint: "juicefs:///demo"
64+
mountPoint: "juicefs:///demo" # JuiceFS 的子目录，以 `juicefs://` 开头。必填
6565
options:
66-
bucket: "<bucket>"
67-
storage: "minio"
66+
bucket: "<bucket>" # Bucket URL。非必填，若 JuiceFS 已经格式化过，可以不填
67+
storage: "minio" # 对象存储类型。非必填，若 JuiceFS 已经格式化过，可以不填
6868
encryptOptions:
69-
- name: metaurl
69+
- name: metaurl # 元数据服务的访问 URL。必填
7070
valueFrom:
7171
secretKeyRef:
7272
name: jfs-secret
7373
key: metaurl
74-
- name: access-key
74+
- name: access-key # 对象存储的 access key。非必填，若 JuiceFS 已经格式化过，可以不填。
7575
valueFrom:
7676
secretKeyRef:
7777
name: jfs-secret
7878
key: access-key
79-
- name: secret-key
79+
- name: secret-key # 对象存储的 secret key。非必填，若 JuiceFS 已经格式化过，可以不填。
8080
valueFrom:
8181
secretKeyRef:
8282
name: jfs-secret
@@ -217,9 +217,9 @@ kubectl create secret generic jfs-secret \
217217

218218
其中：
219219

220-
- `token`：JuiceFS 管理 token。更多信息参考[这篇文档](https://juicefs.com/docs/zh/cloud/metadata/#%E4%BB%A4%E7%89%8C%E7%AE%A1%E7%90%86)。
221-
- `access-key`：对象存储的 access key。
222-
- `secret-key`：对象存储的 secret key。
220+
- `token`：JuiceFS 管理 token。非必填，若通过 `initconfig` 来连接元数据，可不填。更多信息参考[这篇文档](https://juicefs.com/docs/zh/cloud/metadata/#%E4%BB%A4%E7%89%8C%E7%AE%A1%E7%90%86)。
221+
- `access-key`：对象存储的 access key，非必填，若 ak/sk 设置在 JuiceFS 的控制台，可不填。
222+
- `secret-key`：对象存储的 secret key，非必填，若 ak/sk 设置在 JuiceFS 的控制台，可不填。
223223

224224
**查看待创建的 `Dataset` 资源对象**
225225

@@ -232,21 +232,21 @@ metadata:
232232
spec:
233233
mounts:
234234
- name: minio
235-
mountPoint: "juicefs:///demo"
235+
mountPoint: "juicefs:///demo" # JuiceFS 的子目录，以 `juicefs://` 开头。必填
236236
options:
237-
bucket: "<bucket>"
237+
bucket: "<bucket>" # Bucket URL。非必填，若不需要显示指定，可以不填
238238
encryptOptions:
239-
- name: token
239+
- name: token # JuiceFS 管理的 token。非必填，若通过 `initconfig` 来连接元数据，可不填。
240240
valueFrom:
241241
secretKeyRef:
242242
name: jfs-secret
243243
key: token
244-
- name: access-key
244+
- name: access-key # 对象存储的 access key，非必填，若 ak/sk 设置在 JuiceFS 的控制台，可不填。
245245
valueFrom:
246246
secretKeyRef:
247247
name: jfs-secret
248248
key: access-key
249-
- name: secret-key
249+
- name: secret-key # 对象存储的 secret key，非必填，若 ak/sk 设置在 JuiceFS 的控制台，可不填。
250250
valueFrom:
251251
secretKeyRef:
252252
name: jfs-secret
@@ -260,7 +260,7 @@ EOF
260260
- `mountPoint`：指的是 JuiceFS 的子目录，是用户在 JuiceFS 文件系统中存储数据的目录，以 `juicefs://` 开头；如 `juicefs:///demo` 为 JuiceFS 文件系统的 `/demo` 子目录。
261261
- `bucket`：Bucket URL。例如使用 S3 作为对象存储，bucket 为 `https://myjuicefs.s3.us-east-2.amazonaws.com`；更多信息参考[这篇文档](https://juicefs.com/docs/zh/community/how_to_setup_object_storage/) 。
262262

263-
> **注意**：其中 `name` 和 `token` 为必填项。
263+
> **注意**：其中 `name` 为必填项。
264264
265265
JuiceFS 对应的 `Dataset` 只支持一个 mount，且 JuiceFS 没有 UFS，`mountPoint` 中可以指定需要挂载的子目录（`juicefs:///` 为根路径），会作为根目录挂载到容器内。
266266

0 commit comments

Comments
 (0)