Skip to content
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

Jump to bottom

Update K8s doc link in README_CN.md #191

Merged
merged 2 commits into from
Feb 22, 2021
Merged

Update K8s doc link in README_CN.md #191

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
b5e49a3
Update K8s doc link in README_CN.md
xiaogaozi Feb 22, 2021
ddd3461
Update
xiaogaozi Feb 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ If you wanna use JuiceFS in Hadoop, check [Hadoop Java SDK](docs/en/hadoop_java_
- [Redis best practices](docs/en/redis_best_practices.md)
- [Mount JuiceFS at boot](docs/en/mount_at_boot.md)
- [How to setup object storage](docs/en/how_to_setup_object_storage.md)
- [Kubernetes CSI driver](https://github.com/juicedata/juicefs-csi-driver)
- [Using JuiceFS on Kubernetes](docs/en/how_to_use_on_kubernetes.md)

## POSIX Compatibility

Expand Down Expand Up @@ -184,7 +184,6 @@ It's considered as beta quality, the storage format is not stabilized yet. It's
## Roadmap

- Stabilize storage format
- S3 gateway
- Windows client
- Other databases for metadata

Expand Down
5 changes: 2 additions & 3 deletions README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ $ ./juicefs mount -d localhost ~/jfs

### Kubernetes

JuiceFS 提供 [K8s CSI 驱动](https://github.com/juicedata/juicefs-csi-driver)来简化部署。
在 Kubernetes 中使用 JuiceFS 非常便捷，请查看[这个文档](docs/en/how_to_use_on_kubernetes.md)了解更多信息。

### Hadoop Java SDK

Expand All @@ -104,7 +104,7 @@ JuiceFS 使用 [Hadoop Java SDK](docs/zh_cn/hadoop_java_sdk.md) 与 Hadoop 生
- [Redis 最佳实践](docs/en/redis_best_practices.md)
- [开机自动挂载 JuiceFS](docs/en/mount_at_boot.md)
- [如何设置对象存储](docs/en/how_to_setup_object_storage.md)
- [Kubernetes CSI 驱动](https://github.com/juicedata/juicefs-csi-driver)
- [在 Kubernetes 中使用 JuiceFS](docs/en/how_to_use_on_kubernetes.md)

## POSIX 兼容性测试

Expand Down Expand Up @@ -185,7 +185,6 @@ JuiceFS 目前是 beta 状态，核心的存储格式还没有完全确定，还
## 产品路线图

- 稳定存储格式
- S3 兼容网关
- Windows 客户端
- 支持其他数据库

Expand Down
14 changes: 7 additions & 7 deletions docs/en/how_to_use_on_kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ JuiceFS provides the [CSI driver](https://github.com/juicedata/juicefs-csi-drive

## Installation

### Install with helm
### Install with Helm

To install helm, refer to the [Helm install guide](https://github.com/helm/helm#install) , helm 3 is required.
To install Helm, refer to the [Helm install guide](https://github.com/helm/helm#install), Helm 3 is required.

1. Prepare a file `values.yaml` with access infomation about redis and object storage (take amazon s3 `us-east-1` as an example)
1. Prepare a file `values.yaml` with access infomation about Redis and object storage (take Amazon S3 `us-east-1` as an example)

```yaml
storageClasses:
Expand All @@ -32,7 +32,7 @@ storageClasses:
bucket: "https://juicefs-test.s3.us-east-1.amazonaws.com"
```

Here we assign AWS [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) for the EC2 Kuberentes node, otherwise the `accessKey` and `secretKey` cannot be empty. We use ElasticCache redis as the meta store.
Here we assign AWS [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) for the EC2 Kuberentes node, otherwise the `accessKey` and `secretKey` cannot be empty. We use ElastiCache for Redis as the meta store.

2. Install

Expand All @@ -44,8 +44,8 @@ helm upgrade juicefs-csi-driver juicefs-csi-driver/juicefs-csi-driver --install

3. Check the deployment

- Check running pods: the deployment will launch a `StatefulSet` with replica `1` for the `juicefs-csi-controller` and a `DaemonSet` for `juicefs-csi-node` ，so run `kubectl -n kube-system get pods | grep juicefs-csi` should see `n+1` （where `n` is the number of worker node of the kubernetes cluster) pods is running
- Check secret: `kubectl -n kube-system describe secret juicefs-sc-secret` will show the secret with above `backend` fields:
- Check running pods: the deployment will launch a `StatefulSet` with replica `1` for the `juicefs-csi-controller` and a `DaemonSet` for `juicefs-csi-node`, so run `kubectl -n kube-system get pods | grep juicefs-csi` should see `n+1` （where `n` is the number of worker node of the kubernetes cluster) pods is running.
- Check secret: `kubectl -n kube-system describe secret juicefs-sc-secret` will show the secret with above `backend` fields:

```
Name: juicefs-sc-secret
Expand Down Expand Up @@ -126,7 +126,7 @@ volumeBindingMode: Immediate
```


# Use JuiceFS
## Use JuiceFS

Now we can use JuiceFS in our pods. Here we create a `PVC` and refer it in a pod as an example:

Expand Down