Skip to content

Commit d2f78ad

Browse files
author
Sean Smith
committed
Modify FSx Docs
* `fsx_kms_key_id` is used only for windows based file systems. * https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html * `imported_file_chunk_size` or `export_path` are only valid when using `import_path`. Signed-off-by: Sean Smith <[email protected]>
1 parent 9e76b10 commit d2f78ad

File tree

2 files changed

+23
-37
lines changed

2 files changed

+23
-37
lines changed

docs/configuration.rst

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,10 +1000,9 @@ Or create and configure a new file system, with the following parameters ::
10001000
[fsx fs]
10011001
shared_dir = /fsx
10021002
storage_capacity = 3600
1003-
fsx_kms_key_id = 9e8a129c-0e85-459-865b-3a5be974a22b
1003+
import_path = s3://bucket
10041004
imported_file_chunk_size = 1024
10051005
export_path = s3://bucket/folder
1006-
import_path = s3://bucket
10071006
weekly_maintenance_start_time = 1:00:00
10081007

10091008
shared_dir
@@ -1034,16 +1033,16 @@ Defaults to 3,600 GiB. ::
10341033

10351034
storage_capacity = 3600
10361035

1037-
fsx_kms_key_id
1038-
""""""""""""""
1039-
**Optional** The ID of your AWS Key Management Service (AWS KMS) key.
1036+
import_path
1037+
"""""""""""
1038+
**Optional** S3 Bucket to load data from into the file system. Also serves as the export bucket. See ``export_path``.
10401039

1041-
This ID is used to encrypt the data in your file system at rest.
1040+
Import occurs on cluster creation, see `Importing Data from your Amazon S3 Bucket
1041+
<https://docs.aws.amazon.com/fsx/latest/LustreGuide/fsx-data-repositories.html#import-data-repository>`_
10421042

1043-
This must be used with a custom ``ec2_iam_role``. See
1044-
:ref:`Disk Encryption with a Custom KMS Key <tutorials_encrypted_kms_fs>`. ::
1043+
If not provided, file system will be empty. ::
10451044

1046-
fsx_kms_key_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
1045+
import_path = s3://bucket
10471046

10481047
imported_file_chunk_size
10491048
""""""""""""""""""""""""
@@ -1052,31 +1051,23 @@ and maximum amount of data per file (in MiB) stored on a single physical disk. T
10521051
file can be striped across is limited by the total number of disks that make up the file system.
10531052

10541053
The chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB).
1055-
Amazon S3 objects have a maximum size of 5 TB. ::
1054+
Amazon S3 objects have a maximum size of 5 TB.
1055+
1056+
Valid only when using ``import_path``. ::
10561057

10571058
imported_file_chunk_size = 1024
10581059

10591060
export_path
10601061
"""""""""""
1061-
10621062
**Optional** The S3 path where the root of your file system is exported. The path **must** be in the same S3 bucket as
10631063
the ``import_path`` parameter.
10641064

10651065
Defaults to ``s3://import-bucket/FSxLustre[creation-timestamp]`` where ``import-bucket`` is the bucket provided in
1066-
``import_path`` parameter. ::
1066+
``import_path`` parameter.
10671067

1068-
export_path = s3://bucket/folder
1069-
1070-
import_path
1071-
"""""""""""
1072-
***Optional** S3 Bucket to load data from into the file system. Also serves as the export bucket. See ``export_path``.
1068+
Valid only when using ``import_path``. ::
10731069

1074-
Import occurs on cluster creation, see `Importing Data from your Amazon S3 Bucket
1075-
<https://docs.aws.amazon.com/fsx/latest/LustreGuide/fsx-data-repositories.html#import-data-repository>`_
1076-
1077-
If not provided, file system will be empty. ::
1078-
1079-
import_path = s3://bucket
1070+
export_path = s3://bucket/folder
10801071

10811072
weekly_maintenance_start_time
10821073
"""""""""""""""""""""""""""""

docs/tutorials/04_encrypted_kms_fs.rst

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
Disk Encryption with a Custom KMS Key
88
#####################################
99

10-
AWS ParallelCluster supports the configuration options ``ebs_kms_key_id`` and ``fsx_kms_key_id``, which allow you to
11-
provide a custom KMS key for EBS Disk encryption or FSx Lustre. To use them you'll need to specify a ``ec2_iam_role``.
10+
AWS ParallelCluster supports the configuration options ``ebs_kms_key_id``, which allows you to
11+
provide a custom KMS key for EBS Disk encryption. To use it you'll need to specify a ``ec2_iam_role``.
1212

1313
In order for the cluster to create, the KMS key needs to know the name of the cluster's role. This prevents you from
1414
using the role created on cluster create, requiring a custom ``ec2_iam_role``.
@@ -57,20 +57,15 @@ Now create a cluster, here's an example of a cluster with encrypted ``Raid 0`` d
5757
encrypted = true
5858
ebs_kms_key_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
5959

60-
Here's an example with FSx Lustre file system: ::
60+
Here's an example with EBS: ::
6161

6262
[cluster default]
6363
...
64-
fsx_settings = fs
64+
ebs_settings = custom1
6565
ec2_iam_role = ParallelClusterInstanceRole
6666

67-
[fsx fs]
68-
shared_dir = /fsx
69-
storage_capacity = 3600
70-
imported_file_chunk_size = 1024
71-
export_path = s3://bucket/folder
72-
import_path = s3://bucket
73-
weekly_maintenance_start_time = 1:00:00
74-
fsx_kms_key_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
75-
76-
Similar configuration applies for EBS and FSx based file systems.
67+
[ebs custom1]
68+
shared_dir = vol1
69+
ebs_kms_key_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
70+
volume_type = io1
71+
volume_iops = 200

0 commit comments

Comments
 (0)