Skip to content

Update README #18

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 1 commit into from
Mar 2, 2023
+4 −5
Merged

Update README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,6 @@ kubectl apply -k "github.com/kubernetes-sigs/aws-file-cache-csi-driver/deploy/ku
Alternatively, you could also install the driver using helm:


TODO: Add helm installation option
```sh
helm repo add aws-file-cache-csi-driver https://kubernetes-sigs.github.io/aws-file-cache-csi-driver/
helm repo update
Expand All @@ -190,16 +189,16 @@ helm upgrade --install aws-file-cache-csi-driver --namespace kube-system aws-fil

### Examples
Before the example, you need to:
* Get yourself familiar with how to setup Kubernetes on AWS and [create Anmazon File Cache](https://docs.aws.amazon.com/fsx/latest/FileCacheGuide/getting-started.html) if you are using static provisioning.
* Get yourself familiar with how to setup Kubernetes on AWS and [create Amazon File Cache](https://docs.aws.amazon.com/fsx/latest/FileCacheGuide/getting-started.html) if you are using static provisioning.
* When creating Amazon File Cache, make sure its VPC is accessible from Kuberenetes cluster's VPC and network traffic is allowed by security group.
* For Amazon File Cache VPC, you can either create an Amazon File Cache inside the same VPC as Kubernetes cluster or using VPC peering.
* For security group, make sure port 988 is allowed for the security groups that are attached the file cache ENI.
* Install Amazon File Cache CSI driver following the [Installation](README.md#Installation) steps.

#### Example Links
* [Static provisioning](examples/kubernetes/static_provisioning/README.md)
* [Dynamic provisioning](examples/kubernetes/dynamic_provisioning/README.md)
* [Accessing the file cache from multiple pods](examples/kubernetes/multiple_pods/README.md)
* [Static provisioning](../examples/kubernetes/static_provisioning/README.md)
* [Dynamic provisioning](../examples/kubernetes/dynamic_provisioning/README.md)
* [Accessing the file cache from multiple pods](../examples/kubernetes/multiple_pods/README.md)

## Development

Expand Down