Skip to content

Commit 142e797

Browse files
authored
Merge pull request #419 from tzneal/auto-mode-docs
add documentation for Auto Mode specific settings
2 parents b2561b1 + e8f3a16 commit 142e797

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

docs/install.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,34 @@ Review the [configuration values](https://github.com/kubernetes-sigs/aws-fsx-ope
110110
#### Once the driver has been deployed, verify the pods are running:
111111
```sh
112112
kubectl get pods -n kube-system -l app.kubernetes.io/name=aws-fsx-csi-driver
113-
```
113+
```
114+
115+
#### EKS Auto Mode
116+
117+
[EKS Auto Mode](https://docs.aws.amazon.com/eks/latest/userguide/automode.html) extends AWS management of Kubernetes clusters beyond the cluster itself, to allow AWS to also set up and manage the infrastructure that enables the smooth operation of your workloads. Deploying support for Amazon FSx for Lustre CSI Driver onto an Auto Mode cluster requires a few specific changes from a general install.
118+
119+
- Specify the AWS region in the controller configuration
120+
- Use a newer Lustre filesystem version than the default which is compatible with Auto Mode's newer kernel
121+
122+
As a [best practice](https://docs.aws.amazon.com/eks/latest/best-practices/identity-and-access-management.html#_identities_and_credentials_for_eks_pods_recommendations), Auto Mode blocks access to IMDS for Pods that don't use host networking. To eliminate the need for the FSX controller to use IMDS, you need to configure the region for the controller.
123+
124+
```sh
125+
helm upgrade --install aws-fsx-csi-driver \
126+
--namespace kube-system \
127+
aws-fsx-csi-driver/aws-fsx-csi-driver \
128+
--set controller.region=us-west-2
129+
```
130+
131+
The supported Lustre filesystem versions [varies](https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-client-matrix.html) based on the Linux Kernel version of the Node. The current latest filesystem version which is compatible with Auto Mode is 2.15. This is configured in the FSX storage class:
132+
133+
```yaml
134+
kind: StorageClass
135+
apiVersion: storage.k8s.io/v1
136+
metadata:
137+
name: fsx-sc
138+
provisioner: fsx.csi.aws.com
139+
parameters:
140+
fileSystemTypeVersion: "2.15"
141+
subnetId: subnet-1234567890abcdef0
142+
securityGroupIds: sg-1234567890abcdef0
143+
```

0 commit comments

Comments
 (0)