Skip to content

Commit

Permalink
updating examples
Browse files Browse the repository at this point in the history
  • Loading branch information
jordan-aws committed Feb 3, 2020
1 parent ba14046 commit ba03c34
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 7 deletions.
8 changes: 6 additions & 2 deletions examples/kubernetes/dynamic_provisioning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@ provisioner: fsx.csi.aws.com
parameters:
subnetId: subnet-056da83524edbe641
securityGroupIds: sg-086f61ea73388fb6b
deploymentType: PERSISTENT_1
```
* subnetId - the subnet ID that the FSx for Lustre filesystem should be created inside.
* securityGroupIds - a comman separated list of security group IDs that should be attached to the filesystem

* securityGroupIds - a common separated list of security group IDs that should be attached to the filesystem
* deploymentType (Optional) - FSx for Lustre supports three deployment types, SCRATCH_1, SCRATCH_2 and PERSISTENT_1. Default: SCRATCH_1.
* kmsKeyId (Optional) - for deployment type PERSISTENT_1, customer can specific a KMS key to use.
* perUnitStorageThroughput (Optional) - for deployment type PERSISTENT_1, customer can specific the storage throughput. Default: 200.

### Edit [Persistent Volume Claim Spec](./specs/claim.yaml)
```
apiVersion: v1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ provisioner: fsx.csi.aws.com
parameters:
subnetId: subnet-0930cbd463b9688c5
securityGroupIds: sg-03a4b6bd8afb19051,sg-05a37bfe01467059a
deploymentType: PERSISTENT_1
mountOptions:
- flock
12 changes: 8 additions & 4 deletions examples/kubernetes/dynamic_provisioning_s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,19 @@ parameters:
securityGroupIds: sg-086f61ea73388fb6b
s3ImportPath: s3://ml-training-data-000
s3ExportPath: s3://ml-training-data-000/export
deploymentType: SCRATCH_2
```
* subnetId - the subnet ID that the FSx for Lustre filesystem should be created inside.
* securityGroupIds - a comman separated list of security group IDs that should be attached to the filesystem
* s3ImportPath(Optional) - S3 data repository you want to copy from S3 to persistent volume
* s3ExportPath(Optional) - S3 data repository you want to export new or modified files from persistent volume to S3
* securityGroupIds - a common separated list of security group IDs that should be attached to the filesystem.
* s3ImportPath(Optional) - S3 data repository you want to copy from S3 to persistent volume.
* s3ExportPath(Optional) - S3 data repository you want to export new or modified files from persistent volume to S3.
* deploymentType (Optional) - FSx for Lustre supports three deployment types, SCRATCH_1, SCRATCH_2 and PERSISTENT_1. Default: SCRATCH_1.
* kmsKeyId (Optional) - for deployment type PERSISTENT_1, customer can specific a KMS key to use.
* perUnitStorageThroughput (Optional) - for deployment type PERSISTENT_1, customer can specific the storage throughput. Default: 200.

Note:
- S3 Bucket in s3ImportPath and s3ExportPath must be same, otherwise the driver can not create FSx for lustre successfully.
- s3ImportPath can stand alone and a random path will be created automatically like `s3://ml-training-data-000/FSxLustre20190308T012310Z`
- s3ImportPath can stand alone and a random path will be created automatically like `s3://ml-training-data-000/FSxLustre20190308T012310Z`.
- s3ExportPath can not be given without specifying S3ImportPath.

### Edit [Persistent Volume Claim Spec](./specs/claim.yaml)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ parameters:
securityGroupIds: sg-05a37bfe01467059a
s3ImportPath: s3://ml-training-data-000
s3ExportPath: s3://ml-training-data-000/export
deploymentType: SCRATCH_2
mountOptions:
- flock
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ provisioner: fsx.csi.aws.com
parameters:
subnetId: subnet-0d7b5e117ad7b4961
securityGroupIds: sg-05a37bfe01467059a
deploymentType: SCRATCH_2
mountOptions:
- flock
4 changes: 4 additions & 0 deletions examples/kubernetes/multiple_pods/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ provisioner: fsx.csi.aws.com
parameters:
subnetId: subnet-056da83524edbe641
securityGroupIds: sg-086f61ea73388fb6b
deploymentType: SCRATCH_2
```
* subnetId - the subnet ID that the FSx for Lustre filesystem should be created inside.
* securityGroupIds - a comman separated list of security group IDs that should be attached to the filesystem
* deploymentType (Optional) - FSx for Lustre supports three deployment types, SCRATCH_1, SCRATCH_2 and PERSISTENT_1. Default: SCRATCH_1.
* kmsKeyId (Optional) - for deployment type PERSISTENT_1, customer can specific a KMS key to use.
* perUnitStorageThroughput (Optional) - for deployment type PERSISTENT_1, customer can specific the storage throughput. Default: 200.

### Deploy the Application
Create PV, persistence volume claim (PVC), storageclass and the pods that consume the PV:
Expand Down
1 change: 1 addition & 0 deletions examples/kubernetes/multiple_pods/specs/storageclass.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ provisioner: fsx.csi.aws.com
parameters:
subnetId: subnet-056da83524edbe641
securityGroupIds: sg-086f61ea73388fb6b
deploymentType: SCRATCH_2
mountOptions:
- flock
3 changes: 2 additions & 1 deletion examples/kubernetes/static_provisioning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ spec:
volumeHandle: [FileSystemId]
volumeAttributes:
dnsname: [DNSName]
mountname: [MountName]
```
Replace `volumeHandle` with `FileSystemId` and `dnsname` with `DNSName`. You can get both `FileSystemId` and `DNSName` using AWS CLI:
Replace `volumeHandle` with `FileSystemId`, `dnsname` with `DNSName` and `mountname` with `MountName`. You can get both `FileSystemId`, `DNSName` and `MountName` using AWS CLI:

```sh
>> aws fsx describe-file-systems
Expand Down
1 change: 1 addition & 0 deletions examples/kubernetes/static_provisioning/specs/pv.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ spec:
volumeHandle: fs-0199e5a63bd90f796
volumeAttributes:
dnsname: fs-0199e5a63bd90f796.fsx.us-east-1.amazonaws.com
mountname: fsx

0 comments on commit ba03c34

Please sign in to comment.