Skip to content

Docs: fix juicefs docs #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 8, 2024
Merged

Docs: fix juicefs docs #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a20bfbc
Docs: fix juicefs docs
xingcan-hu Jul 5, 2024
a9c6129
fix juicefs markdown render issue
xingcan-hu Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions catalog/juicefs/apps/juicefs-s3-gateway.app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
#### 2.2 使用 Minio CLI 访问 (推荐)

为避免兼容性问题，我们推荐采用的 mc 的版本为 `RELEASE.2021-04-22T17-40-00Z`，你可以在[这个地址](https://dl.min.io/client/mc/release)找到历史版本和不同架构的 mc, 推荐版本下载地址：
- [linux amd64](https://dl.min.io/client/mc/release/linux-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- [mac amd64](https://dl.min.io/client/mc/release/darwin-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- [mac arm64](https://dl.min.io/client/mc/release/darwin-arm64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- [windows amd64](https://dl.min.io/client/mc/release/windows-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- ....
* [linux amd64](https://dl.min.io/client/mc/release/linux-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* [mac amd64](https://dl.min.io/client/mc/release/darwin-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* [mac arm64](https://dl.min.io/client/mc/release/darwin-arm64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* [windows amd64](https://dl.min.io/client/mc/release/windows-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* ....


```bash
Expand All @@ -38,8 +38,6 @@ export LOCAL_FILE_PATH=/tmp/${OBJECT_NAME}
echo "hello world" > ${LOCAL_FILE_PATH}
# create an alias for the Minio server
mc alias set ${ALIAS} ${API_ENDPOINT} ${ACCESS_KEY} ${SECRET_KEY}
# test the Connection
mc admin info ${ALIAS}
# list all buckets
mc ls ${ALIAS}
# create a bucket
Expand All @@ -61,7 +59,7 @@ mc alias remove ${ALIAS}

```

> 提示：可以进入任意一个 minio pod 容器, 环境中已经安装 minio CLI, 可以执行上述命令。endpoint 需要调整 `export API_ENDPOINT=juicefs-s3-gateway:9000`, 不要使用 ingress 地址，集群内dns可能无法解析。
> 提示：可以进入任意一个 minio pod 容器, 环境中已经安装 minio CLI, 可以执行上述命令。endpoint 需要调整 `export API_ENDPOINT=http://juicefs-s3-gateway:9000`, 不要使用 ingress 地址，集群内dns可能无法解析。


#### 2.3 使用 AWS CLI 访问
Expand Down
37 changes: 6 additions & 31 deletions catalog/juicefs/apps/juicefs-s3-gateway.app/i18n/en/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Open the ingress address in a browser, for example, http://juicefs-s3-gateway-kd

#### 2.2 Access via Minio CLI (Recommended)
To avoid compatibility issues, we recommend using the `RELEASE.2021-04-22T17-40-00Z` version of mc. You can find historical versions and different architectures of mc at [this address](https://dl.min.io/client/mc/release). Recommended version download links:
- [linux amd64](https://dl.min.io/client/mc/release/linux-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- [mac amd64](https://dl.min.io/client/mc/release/darwin-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- [mac arm64](https://dl.min.io/client/mc/release/darwin-arm64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- [windows amd64](https://dl.min.io/client/mc/release/windows-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
- ...
* [linux amd64](https://dl.min.io/client/mc/release/linux-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* [mac amd64](https://dl.min.io/client/mc/release/darwin-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* [mac arm64](https://dl.min.io/client/mc/release/darwin-arm64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* [windows amd64](https://dl.min.io/client/mc/release/windows-amd64/archive/mc.RELEASE.2021-04-22T17-40-00Z)
* ...


```bash
Expand All @@ -34,8 +34,6 @@ export LOCAL_FILE_PATH=/tmp/${OBJECT_NAME}
echo "hello world" > ${LOCAL_FILE_PATH}
# create an alias for the Minio server
mc alias set ${ALIAS} ${API_ENDPOINT} ${ACCESS_KEY} ${SECRET_KEY}
# test the Connection
mc admin info ${ALIAS}
# list all buckets
mc ls ${ALIAS}
# create a bucket
Expand All @@ -57,30 +55,7 @@ mc alias remove ${ALIAS}

```

> 提示：可以进入任意一个 minio pod 容器, 环境中已经安装 minio CLI, 可以执行上述命令。endpoint 需要调整 `export API_ENDPOINT=juicefs-s3-gateway:9000`, 不要使用 ingress 地址，集群内dns可能无法解析。


#### 2.3 使用 AWS CLI 访问

从 https://aws.amazon.com/cli 下载并安装 AWS CLI，然后进行配置：

```bash
aws configure
# Access Key ID and Secret Access Key are the same as the Minio admin username and password
AWS Access Key ID [None]: admin
AWS Secret Access Key [None]: admin.password
Default region name [None]:
Default output format [None]:

# List buckets
aws --endpoint-url http://juicefs-s3-gateway-kdp-data.kdp-e2e.io s3 ls

# List objects in bucket
aws --endpoint-url http://juicefs-s3-gateway-kdp-data.kdp-e2e.io s3 ls s3://<bucket>

```

> Tip: You can enter any Minio pod container where the Minio CLI is already installed and execute the above commands. Adjust the endpoint with `export API_ENDPOINT=juicefs-s3-gateway:9000`, and do not use the ingress address as the cluster's internal DNS may not resolve it correctly.
> Tip: You can enter any Minio pod container where the Minio CLI is already installed and execute the above commands. Adjust the endpoint with `export API_ENDPOINT=http://juicefs-s3-gateway:9000`, and do not use the ingress address as the cluster's internal DNS may not resolve it correctly.


#### 2.3 Access via AWS CLI
Expand Down
132 changes: 61 additions & 71 deletions catalog/juicefs/x-definitions/app-juicefs-s3-gateway.cue
View file
Open in desktop

Large diffs are not rendered by default.