Skip to content

Commit

Permalink
Docs: fix object storage type of GCS
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaogaozi committed Nov 27, 2023
1 parent 9a40759 commit 91a7f55
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 84 deletions.
2 changes: 1 addition & 1 deletion cmd/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ func storageFlags() []cli.Flag {
return addCategories("DATA STORAGE", []cli.Flag{
&cli.StringFlag{
Name: "storage",
Usage: "customized storage type (e.g. s3, gcs, oss, cos) to access object store",
Usage: "customized storage type (e.g. s3, gs, oss, cos) to access object store",
},
&cli.StringFlag{
Name: "bucket",
Expand Down
2 changes: 1 addition & 1 deletion cmd/format.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func formatStorageFlags() []cli.Flag {
&cli.StringFlag{
Name: "storage",
Value: "file",
Usage: "object storage type (e.g. s3, gcs, oss, cos)",
Usage: "object storage type (e.g. s3, gs, oss, cos)",
},
&cli.StringFlag{
Name: "bucket",
Expand Down
2 changes: 1 addition & 1 deletion cmd/objbench.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Details: https://juicefs.com/docs/community/performance_evaluation_guide#juicefs
&cli.StringFlag{
Name: "storage",
Value: "file",
Usage: "object storage type (e.g. s3, gcs, oss, cos)",
Usage: "object storage type (e.g. s3, gs, oss, cos)",
},
&cli.StringFlag{
Name: "access-key",
Expand Down
8 changes: 4 additions & 4 deletions docs/en/reference/command_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ juicefs format sqlite3://myjfs.db myjfs --trash-days=0

|Items|Description|
|-|-|
|`--storage=file`|Object storage type (e.g. `s3`, `gcs`, `oss`, `cos`) (default: `file`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types)|
|`--storage=file`|Object storage type (e.g. `s3`, `gs`, `oss`, `cos`) (default: `file`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types)|
|`--bucket=/var/jfs`|A bucket URL to store data (default: `$HOME/.juicefs/local` or `/var/jfs`)|
|`--access-key=value`|Access Key for object storage (can also be set via the environment variable `ACCESS_KEY`), see [How to Set Up Object Storage](../reference/how_to_set_up_object_storage.md#aksk) for more.|
|`--secret-key value`|Secret Key for object storage (can also be set via the environment variable `SECRET_KEY`), see [How to Set Up Object Storage](../reference/how_to_set_up_object_storage.md#aksk) for more.|
Expand Down Expand Up @@ -215,7 +215,7 @@ juicefs config redis://localhost --min-client-version 1.0.0 --max-client-version

|Items|Description|
|-|-|
|`--storage=file` <VersionAdd>1.1</VersionAdd> |Object storage type (e.g. `s3`, `gcs`, `oss`, `cos`) (default: `"file"`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types).|
|`--storage=file` <VersionAdd>1.1</VersionAdd> |Object storage type (e.g. `s3`, `gs`, `oss`, `cos`) (default: `"file"`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types).|
|`--bucket=/var/jfs`|A bucket URL to store data (default: `$HOME/.juicefs/local` or `/var/jfs`)|
|`--access-key=value`|Access Key for object storage (can also be set via the environment variable `ACCESS_KEY`), see [How to Set Up Object Storage](../reference/how_to_set_up_object_storage.md#aksk) for more.|
|`--secret-key value`|Secret Key for object storage (can also be set via the environment variable `SECRET_KEY`), see [How to Set Up Object Storage](../reference/how_to_set_up_object_storage.md#aksk) for more.|
Expand Down Expand Up @@ -650,7 +650,7 @@ For metadata cache description and usage, refer to [Kernel metadata cache](../gu

|Items|Description|
|-|-|
|`--storage=file`|Object storage type (e.g. `s3`, `gcs`, `oss`, `cos`) (default: `"file"`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types).|
|`--storage=file`|Object storage type (e.g. `s3`, `gs`, `oss`, `cos`) (default: `"file"`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types).|
|`--storage-class value` <VersionAdd>1.1</VersionAdd> |the storage class for data written by current client|
|`--bucket=value`|customized endpoint to access object storage|
|`--get-timeout=60`|the max number of seconds to download an object (default: 60)|
Expand Down Expand Up @@ -805,7 +805,7 @@ ACCESS_KEY=myAccessKey SECRET_KEY=mySecretKey juicefs objbench --storage=s3 http

|Items|Description|
|-|-|
|`--storage=file`|Object storage type (e.g. `s3`, `gcs`, `oss`, `cos`) (default: `file`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types)|
|`--storage=file`|Object storage type (e.g. `s3`, `gs`, `oss`, `cos`) (default: `file`, refer to [documentation](../reference/how_to_set_up_object_storage.md#supported-object-storage) for all supported object storage types)|
|`--access-key=value`|Access Key for object storage (can also be set via the environment variable `ACCESS_KEY`), see [How to Set Up Object Storage](../reference/how_to_set_up_object_storage.md#aksk) for more.|
|`--secret-key value`|Secret Key for object storage (can also be set via the environment variable `SECRET_KEY`), see [How to Set Up Object Storage](../reference/how_to_set_up_object_storage.md#aksk) for more.|
|`--block-size=4096`|size of each IO block in KiB (default: 4096)|
Expand Down
8 changes: 4 additions & 4 deletions docs/zh_cn/reference/command_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ juicefs format sqlite3://myjfs.db myjfs --trash-days=0

|| 说明|
|-|-|
|`--storage=file`|对象存储类型,例如 `s3``gcs``oss``cos`。默认为 `file`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型。|
|`--storage=file`|对象存储类型,例如 `s3``gs``oss``cos`。默认为 `file`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型。|
|`--bucket=path`|存储数据的桶路径(默认:`$HOME/.juicefs/local``/var/jfs`)。|
|`--access-key=value`|对象存储的 Access Key,也可通过环境变量 `ACCESS_KEY` 设置。查看[如何设置对象存储](../reference/how_to_set_up_object_storage.md#aksk)以了解更多。|
|`--secret-key=value`|对象存储的 Secret Key,也可通过环境变量 `SECRET_KEY` 设置。查看[如何设置对象存储](../reference/how_to_set_up_object_storage.md#aksk)以了解更多。|
Expand Down Expand Up @@ -215,7 +215,7 @@ juicefs config redis://localhost --min-client-version 1.0.0 --max-client-version

|| 说明|
|-|-|
|`--storage=file` <VersionAdd>1.1</VersionAdd>|对象存储类型,例如 `s3``gcs``oss``cos`。默认为 `file`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型。|
|`--storage=file` <VersionAdd>1.1</VersionAdd>|对象存储类型,例如 `s3``gs``oss``cos`。默认为 `file`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型。|
|`--bucket=path`|存储数据的桶路径(默认:`$HOME/.juicefs/local``/var/jfs`)。|
|`--access-key=value`|对象存储的 Access Key,也可通过环境变量 `ACCESS_KEY` 设置。查看[如何设置对象存储](../reference/how_to_set_up_object_storage.md#aksk)以了解更多。|
|`--secret-key=value`|对象存储的 Secret Key,也可通过环境变量 `SECRET_KEY` 设置。查看[如何设置对象存储](../reference/how_to_set_up_object_storage.md#aksk)以了解更多。|
Expand Down Expand Up @@ -650,7 +650,7 @@ juicefs mount redis://localhost /mnt/jfs --backup-meta 0

|| 说明|
|-|-|
|`--storage=file`|对象存储类型 (例如 `s3``gcs``oss``cos`) (默认:`"file"`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型)|
|`--storage=file`|对象存储类型 (例如 `s3``gs``oss``cos`) (默认:`"file"`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型)|
|`--bucket=value`|为当前挂载点指定访问对象存储的 Endpoint。|
|`--storage-class value` <VersionAdd>1.1</VersionAdd>|当前客户端写入数据的存储类型|
|`--get-timeout=60`|下载一个对象的超时时间;单位为秒 (默认:60)|
Expand Down Expand Up @@ -804,7 +804,7 @@ ACCESS_KEY=myAccessKey SECRET_KEY=mySecretKey juicefs objbench --storage=s3 http

|| 说明|
|-|-|
|`--storage=file`|对象存储类型 (例如 `s3``gcs``oss``cos`) (默认:`file`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型)|
|`--storage=file`|对象存储类型 (例如 `s3``gs``oss``cos`) (默认:`file`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型)|
|`--access-key=value`|对象存储的 Access Key,也可通过环境变量 `ACCESS_KEY` 设置。查看[如何设置对象存储](../reference/how_to_set_up_object_storage.md#aksk)以了解更多。|
|`--secret-key=value`|对象存储的 Secret Key,也可通过环境变量 `SECRET_KEY` 设置。查看[如何设置对象存储](../reference/how_to_set_up_object_storage.md#aksk)以了解更多。|
|`--block-size=4096`|每个 IO 块的大小(以 KiB 为单位)(默认值:4096)|
Expand Down
73 changes: 0 additions & 73 deletions pkg/object/README.md

This file was deleted.

0 comments on commit 91a7f55

Please sign in to comment.