Skip to content

Add EFS access point support (aws-parallelcluster#2337) #6359

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.

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

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ CHANGELOG
**ENHANCEMENTS**

- Add support for custom actions on login nodes.
- Add new configuration `SharedStorage/EfsSettings/AccessPointId` to specify an optional EFS access point for a mount

**BUG FIXES**
- Fix validator `EfaPlacementGroupValidator` so that it does not suggest to configure a Placement Group when Capacity Blocks are used.
Expand Down
11 changes: 11 additions & 0 deletions cli/src/pcluster/aws/efs.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,14 @@ def describe_file_system(self, efs_fs_id):
:return: the mount_target_ids
"""
return self._client.describe_file_systems(FileSystemId=efs_fs_id)

@AWSExceptionHandler.handle_client_exception
@Cache.cached
def describe_access_point(self, access_point_id):
"""
Describe access point attributes for the given EFS access point id.

:param efaccess_point_ids_ap_id: EFS access point Id
:return: the access_point details
"""
return self._client.describe_access_points(AccessPointId=access_point_id)
3 changes: 3 additions & 0 deletions cli/src/pcluster/config/cluster_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,7 @@ def __init__(
deletion_policy: str = None,
encryption_in_transit: bool = None,
iam_authorization: bool = None,
access_point_id: str = None,
):
super().__init__()
self.mount_dir = Resource.init_param(mount_dir)
Expand All @@ -387,6 +388,7 @@ def __init__(
)
self.encryption_in_transit = Resource.init_param(encryption_in_transit, default=False)
self.iam_authorization = Resource.init_param(iam_authorization, default=False)
self.access_point_id = Resource.init_param(access_point_id)

def _register_validators(self, context: ValidatorContext = None): # noqa: D102 #pylint: disable=unused-argument
self._register_validator(SharedStorageNameValidator, name=self.name)
Expand All @@ -398,6 +400,7 @@ def _register_validators(self, context: ValidatorContext = None): # noqa: D102
EfsMountOptionsValidator,
encryption_in_transit=self.encryption_in_transit,
iam_authorization=self.iam_authorization,
access_point_id=self.access_point_id,
name=self.name,
)

Expand Down
10 changes: 9 additions & 1 deletion cli/src/pcluster/schemas/cluster_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,9 @@ class EfsSettingsSchema(BaseSchema):
deletion_policy = fields.Str(
validate=validate.OneOf(DELETION_POLICIES), metadata={"update_policy": UpdatePolicy.SUPPORTED}
)
access_point_id = fields.Str(
validate=validate.Regexp(r"^fsap-[0-9a-z]{17}$"), metadata={"update_policy": UpdatePolicy.SUPPORTED}
)
encryption_in_transit = fields.Bool(metadata={"update_policy": UpdatePolicy.UNSUPPORTED})
iam_authorization = fields.Bool(metadata={"update_policy": UpdatePolicy.UNSUPPORTED})

Expand All @@ -331,7 +334,12 @@ def validate_file_system_id_ignored_parameters(self, data, **kwargs):
messages = []
if data.get("file_system_id") is not None:
for key in data:
if key is not None and key not in ["encryption_in_transit", "iam_authorization", "file_system_id"]:
if key is not None and key not in [
"encryption_in_transit",
"iam_authorization",
"file_system_id",
"access_point_id"
]:
messages.append(EFS_MESSAGES["errors"]["ignored_param_with_efs_fs_id"].format(efs_param=key))
if messages:
raise ValidationError(message=messages)
Expand Down
5 changes: 5 additions & 0 deletions cli/src/pcluster/templates/cluster_stack.py
Original file line number Diff line number Diff line change
Expand Up @@ -1109,6 +1109,7 @@ def _add_efs_storage(self, id: str, shared_efs: SharedEfs):
shared_efs.encryption_in_transit
)
self.shared_storage_attributes[SharedStorageType.EFS]["IamAuthorizations"].append(shared_efs.iam_authorization)
self.shared_storage_attributes[SharedStorageType.EFS]["AccessPointIds"].append(shared_efs.access_point_id)

return efs_id

Expand Down Expand Up @@ -1288,6 +1289,10 @@ def _add_head_node(self):
"efs_iam_authorizations": to_comma_separated_string(
self.shared_storage_attributes[SharedStorageType.EFS]["IamAuthorizations"], use_lower_case=True
),
"efs_access_point_ids": to_comma_separated_string(
self.shared_storage_attributes[SharedStorageType.EFS]["AccessPointIds"],
use_lower_case=True,
),
"fsx_fs_ids": get_shared_storage_ids_by_type(self.shared_storage_infos, SharedStorageType.FSX),
"fsx_mount_names": to_comma_separated_string(
self.shared_storage_attributes[SharedStorageType.FSX]["MountNames"]
Expand Down
4 changes: 4 additions & 0 deletions cli/src/pcluster/templates/login_nodes_stack.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,10 @@ def _add_login_nodes_pool_launch_template(self):
self._shared_storage_attributes[SharedStorageType.EFS]["IamAuthorizations"],
use_lower_case=True,
),
"efs_access_point_ids": to_comma_separated_string(
self._shared_storage_attributes[SharedStorageType.EFS]["AccessPointIds"],
use_lower_case=True,
),
"enable_intel_hpc_platform": "true" if self._config.is_intel_hpc_platform_enabled else "false",
"ephemeral_dir": DEFAULT_EPHEMERAL_DIR,
"fsx_fs_ids": get_shared_storage_ids_by_type(self._shared_storage_infos, SharedStorageType.FSX),
Expand Down
4 changes: 4 additions & 0 deletions cli/src/pcluster/templates/queues_stack.py
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,10 @@ def _add_compute_resource_launch_template(
self._shared_storage_attributes[SharedStorageType.EFS]["IamAuthorizations"],
use_lower_case=True,
),
"efs_access_point_ids": to_comma_separated_string(
self._shared_storage_attributes[SharedStorageType.EFS]["AccessPointIds"],
use_lower_case=True,
),
"fsx_fs_ids": get_shared_storage_ids_by_type(self._shared_storage_infos, SharedStorageType.FSX),
"fsx_mount_names": to_comma_separated_string(
self._shared_storage_attributes[SharedStorageType.FSX]["MountNames"]
Expand Down
2 changes: 1 addition & 1 deletion cli/src/pcluster/validators/efs_validators.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class EfsMountOptionsValidator(Validator):
IAM Authorization requires Encryption in Transit.
"""

def _validate(self, encryption_in_transit: bool, iam_authorization: bool, name: str):
def _validate(self, encryption_in_transit: bool, iam_authorization: bool, accesspoint_id: str, name: str):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The validator should verify that the provided access point exists

if iam_authorization and not encryption_in_transit:
self._add_failure(
"EFS IAM authorization cannot be enabled when encryption in-transit is disabled. "
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ def convert_efs_settings(self, section_name):
("efs_kms_key_id", "KmsKeyId"),
("provisioned_throughput", "ProvisionedThroughput", "getint"),
("throughput_mode", "ThroughputMode"),
("access_point_id", "AccessPointId"),
]
efs_section, efs_dict, _section_label = self.convert_storage_base(
"efs", efs_label.strip(), additional_items
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"efs_fs_ids": "",
"efs_iam_authorizations": "",
"efs_shared_dirs": "",
"efs_access_point_ids": "",
"enable_intel_hpc_platform": "false",
"ephemeral_dir": "/scratch",
"fsx_dns_names": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"efs_fs_ids": "",
"efs_iam_authorizations": "",
"efs_shared_dirs": "",
"efs_access_point_ids": "",
"enable_intel_hpc_platform": "false",
"ephemeral_dir": "/scratch",
"fsx_dns_names": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"efs_fs_ids": "",
"efs_iam_authorizations": "",
"efs_shared_dirs": "",
"efs_access_point_ids": "",
"enable_intel_hpc_platform": "false",
"ephemeral_dir": "/scratch",
"fsx_dns_names": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"efs_fs_ids": "",
"efs_iam_authorizations": "",
"efs_shared_dirs": "",
"efs_access_point_ids": "",
"enable_efa": "NONE",
"enable_efa_gdr": "NONE",
"enable_intel_hpc_platform": "false",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"efs_fs_ids": "",
"efs_iam_authorizations": "",
"efs_shared_dirs": "",
"efs_access_point_ids": "",
"enable_efa": "NONE",
"enable_efa_gdr": "NONE",
"enable_intel_hpc_platform": "false",
Expand Down