Skip to content

Commit

Permalink
Add warning for setting loger controller's provisioner timeout when u…
Browse files Browse the repository at this point in the history
…sing Data Repository Associasions
  • Loading branch information
everpeace committed Jan 18, 2024
1 parent 9ee7b8f commit 8d23e81
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ There are potential race conditions on node startup (especially when a node is f

This feature is activated by default, and cluster administrators should use the taint `fsx.csi.aws.com/agent-not-ready:NoExecute` (any effect will work, but `NoExecute` is recommended). For example, EKS Managed Node Groups [support automatically tainting nodes](https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html).

### CSI controller's provisioner timeout

**WARNING** If you will use [Dynamic Provisioning with Data Repository Associations](../examples/kubernetes/dynamic_provisioning_s3_association/README.md), you are strongly recommended to set longer CSI controller's provisioner timeout (e.g. `60m`) because attaching Data Repository Associations to FSx for Lustre filesystem is prone to take long time. Please see the next section for how to set the timeout.

### Deploy driver
You may deploy the FSx for Lustre CSI driver via Kustomize or Helm

Expand All @@ -92,6 +96,16 @@ You may deploy the FSx for Lustre CSI driver via Kustomize or Helm
kubectl apply -k "github.com/kubernetes-sigs/aws-fsx-csi-driver/deploy/kubernetes/overlays/stable/?ref=release-1.1"
```

```sh
# To set CSI controller's provisioner timeout,
# Please follow the instruction
$ cd $(mktemp -d)
$ kustomize init
$ kustomize edit add resource "github.com/kubernetes-sigs/aws-fsx-csi-driver/deploy/kubernetes/overlays/stable/?ref=release-1.1"
$ kustomize edit add configmap fsx-csi-controller --from-literal=CONTROLLER_PROVISIONER_TIMEOUT=30m --behavior=merge
$ kubectl apply -k .
```

*Note: Using the master branch to deploy the driver is not supported as the master branch may contain upcoming features incompatible with the currently released stable version of the driver.*

#### Helm
Expand All @@ -108,6 +122,15 @@ helm upgrade --install aws-fsx-csi-driver \
aws-fsx-csi-driver/aws-fsx-csi-driver
```

```sh
# To set CSI controller's provisioner timeout,
# Please follow the instruction
helm template --install aws-fsx-csi-driver \
--namespace kube-system \
--set-string "controller.provisionerTimeout=60m" \
aws-fsx-csi-driver/aws-fsx-csi-driver
```

Review the [configuration values](https://github.com/kubernetes-sigs/aws-fsx-openzfs-csi-driver/blob/master/charts/aws-fsx-csi-driver/values.yaml) for the Helm chart.

#### Once the driver has been deployed, verify the pods are running:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Please note that data repository associations are supported on FSx for Lustre 2.

This integration means that you can seamlessly access the objects stored in your Amazon S3 buckets from applications mounting your Amazon FSx for Lustre file system. Please check [Using Data Repositories](https://docs.aws.amazon.com/fsx/latest/LustreGuide/fsx-data-repositories.html) for details.

**WARNING** If you will use this feature, you are strongly recommended to set longer CSI controller's provisioner timeout (e.g. `60m`). See [here](../../../docs/install.md#csi-controllers-provisioner-timeout).

### Edit [StorageClass](./specs/storageclass.yaml)
```yaml
kind: StorageClass
Expand Down

0 comments on commit 8d23e81

Please sign in to comment.