diff --git a/cmd/flags.go b/cmd/flags.go index 7a5c8d6876f0..cd227fb86d59 100644 --- a/cmd/flags.go +++ b/cmd/flags.go @@ -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", diff --git a/cmd/format.go b/cmd/format.go index 976f12908198..0ec3cd6632f9 100644 --- a/cmd/format.go +++ b/cmd/format.go @@ -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", diff --git a/cmd/objbench.go b/cmd/objbench.go index 2e0e9db414aa..39913f9cd543 100644 --- a/cmd/objbench.go +++ b/cmd/objbench.go @@ -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", diff --git a/docs/en/reference/command_reference.md b/docs/en/reference/command_reference.md index b42a63ef5393..dc5645e86c48 100644 --- a/docs/en/reference/command_reference.md +++ b/docs/en/reference/command_reference.md @@ -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.| @@ -215,7 +215,7 @@ juicefs config redis://localhost --min-client-version 1.0.0 --max-client-version |Items|Description| |-|-| -|`--storage=file` 1.1 |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` 1.1 |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.| @@ -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` 1.1 |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)| @@ -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)| diff --git a/docs/zh_cn/reference/command_reference.md b/docs/zh_cn/reference/command_reference.md index 97aa499cdc01..53696826ba0b 100644 --- a/docs/zh_cn/reference/command_reference.md +++ b/docs/zh_cn/reference/command_reference.md @@ -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)以了解更多。| @@ -215,7 +215,7 @@ juicefs config redis://localhost --min-client-version 1.0.0 --max-client-version |项 | 说明| |-|-| -|`--storage=file` 1.1|对象存储类型,例如 `s3`、`gcs`、`oss`、`cos`。默认为 `file`,参考[文档](../reference/how_to_set_up_object_storage.md#supported-object-storage)查看所有支持的对象存储类型。| +|`--storage=file` 1.1|对象存储类型,例如 `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)以了解更多。| @@ -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` 1.1|当前客户端写入数据的存储类型| |`--get-timeout=60`|下载一个对象的超时时间;单位为秒 (默认:60)| @@ -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)| diff --git a/pkg/object/README.md b/pkg/object/README.md deleted file mode 100644 index ce9824cf13a3..000000000000 --- a/pkg/object/README.md +++ /dev/null @@ -1,73 +0,0 @@ - -The following object store are supported: - -- file: local files -- sftp: FTP via SSH -- s3: Amazon S3 -- hdfs: Hadoop File System (HDFS) -- gcs: Google Cloud Storage -- wasb: Windows Azure Blob Storage -- oss: Aliyun OSS -- cos: Tencent Cloud COS -- ks3: KSYun KS3 -- ufile: UCloud UFile -- qingstor: Qingcloud QingStor -- bos: Baidu Cloud Object Storage -- jss: JCloud Object Storage -- qiniu: Qiniu -- b2: Backblaze B2 -- space: Digital Ocean Space -- obs: Huawei Object Storage Service -- oos: CTYun OOS -- scw: Scaleway Object Storage -- minio: MinIO -- scs: Sina Cloud Storage -- eos: ECloud (China Mobile Cloud) Object Storage - -they should be specified in the following format: - -[NAME://][ACCESS_KEY:SECRET_KEY@]BUCKET[.ENDPOINT][/PREFIX] - -Some examples: - -- local/path -- user@host:port:path -- file:///Users/me/code/ -- hdfs://hdfs@namenode1:9000,namenode2:9000/user/ -- s3://my-bucket/ -- s3://access-key:secret-key-id@my-bucket/prefix -- wasb://account-name:account-key@my-container/prefix -- gcs://my-bucket.us-west1.googleapi.com/ -- oss://test -- cos://test-1234 -- obs://my-bucket -- bos://my-bucket -- minio://myip:9000/bucket -- scs://access-key:secret-key-id@my-bucket.sinacloud.net/prefix - -Note: - -- It's recommended to run it in the target region to have better performance. -- Auto discover endpoint for bucket of S3, OSS, COS, OBS, BOS, `SRC` and `DST` can use format `NAME://[ACCESS_KEY:SECRET_KEY@]BUCKET[/PREFIX]` . `ACCESS_KEY` and `SECRET_KEY` can be provided by corresponding environment variables (see below). -- S3: - * The access key and secret key for S3 could be provided by `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, or *IAM* role. -- Wasb(Windows Azure Storage Blob) - * The account name and account key can be provided as [connection string](https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#configure-a-connection-string-for-an-azure-storage-account) by `AZURE_STORAGE_CONNECTION_STRING`. -- GCS: The machine should be authorized to access Google Cloud Storage. -- OSS: - * The credential can be provided by environment variable `ALICLOUD_ACCESS_KEY_ID` and `ALICLOUD_ACCESS_KEY_SECRET` , RAM role, [EMR MetaService](https://help.aliyun.com/document_detail/43966.html). -- COS: - * The AppID should be part of the bucket name. - * The credential can be provided by environment variable `COS_SECRETID` and `COS_SECRETKEY`. -- OBS: - * The credential can be provided by environment variable `HWCLOUD_ACCESS_KEY` and `HWCLOUD_SECRET_KEY` . -- BOS: - * The credential can be provided by environment variable `BDCLOUD_ACCESS_KEY` and `BDCLOUD_SECRET_KEY` . -- Qiniu: - The S3 endpoint should be used for Qiniu, for example, abc.cn-north-1-s3.qiniu.com. - If there are keys starting with "/", the domain should be provided as `QINIU_DOMAIN`. -- sftp: if your target machine uses SSH certificates instead of password, you should pass the path to your private key file to the environment variable `SSH_PRIVATE_KEY_PATH`, like ` SSH_PRIVATE_KEY_PATH=/home/someuser/.ssh/id_rsa juicefs sync [src] [dst]`. -- Scaleway: - * The credential can be provided by environment variable `SCW_ACCESS_KEY` and `SCW_SECRET_KEY` . -- MinIO: - * The credential can be provided by environment variable `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` .