AWS parallelcluster documentation change
Summary
Rephrasing of API invocation documentation. Clarifies requirements for AdditionalIamPolicies configuration and SigV4 signing process.
Security assessment
Changes focus on improving readability of existing security-related configurations (IAM policy patterns and authentication requirements). No new security vulnerabilities are addressed or security features documented. The modifications maintain existing security posture without introducing new protections or exposing risks.
Diff
diff --git a/parallelcluster/latest/ug/api-reference-invoke-v3.md b/parallelcluster/latest/ug/api-reference-invoke-v3.md index 08169f1c9..1dcdfe2dc 100644 --- a//parallelcluster/latest/ug/api-reference-invoke-v3.md +++ b//parallelcluster/latest/ug/api-reference-invoke-v3.md @@ -20 +20 @@ To obtain temporary credentials for the default IAM user, run the [ STS AssumeRo -You can retrieve the AWS ParallelCluster API endpoint by running the following command: +To retrieve the AWS ParallelCluster API endpoint run the following command: @@ -34 +34 @@ Requests need to be SigV4 signed as documented [here](https://docs.aws.amazon.co -At this time, we do not offer any official API client implementation. However, API clients can be easily generated from the OpenAPI model by using [ OpenAPI Generator](https://openapi-generator.tech/). Once the client is generated SigV4 signing needs to be added if not provided out of the box. +At this time, we do not offer any official API client implementation. However, you can use the [OpenAPI Generator](https://openapi-generator.tech/) to easily generate API clients from the OpenAPI model. Once the client is generated, SigV4 signing needs to be added if not provided out of the box. @@ -46 +46 @@ An IAM user that is authorized to invoke the AWS ParallelCluster API, can indire -When creating a cluster with `AdditionalIamPolicies` specified in the configuration, the additional policies must match one of the following patterns: +When you create a cluster with `AdditionalIamPolicies` specified in the configuration, the additional policies must match one of the following patterns: @@ -70 +70 @@ Add the policy in the `ArnLike/iam:PolicyARN` section. - * Omit specifying policies for `AdditionalIamPolicies` in the configuration file and manually add policies to the AWS ParallelCluster Instance Role created within the cluster. + * Don't specify policies for `AdditionalIamPolicies` in the configuration file and manually add policies to the AWS ParallelCluster Instance Role created within the cluster.