Skip to content

Commit 5c2ee57

Browse files
committed
chore(docs): Add doctool screenshots and fix spelling + grammar
1 parent d528e80 commit 5c2ee57

6 files changed

+14
-14
lines changed

docsource/aws-acm-v3.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Overview
22

33
The AWS Certificate Manager v3 Store Type provides enhanced authentication options for managing certificates in ACM.
4-
Each defined Certificate Store of this type targes a specific AWS Region with a specific Destination account in mind.
5-
Therefore each Certificate Store instance is intended to represent a single Role's certificates in a single AWS Region.
4+
Each defined Certificate Store of this type targets a specific AWS Region with a specific Destination account in mind.
5+
Therefore, each Certificate Store instance is intended to represent a single Role's certificates in a single AWS Region.
66

77
Some authentication configurations do not adhere strictly to this, so when using the various methods offered in the Default SDK auth option,
88
a full understanding of how permissions work in AWS is recommended.

docsource/content.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ After initial authentication, temporary credentials are used by using the Assume
1010

1111
This integration also supports the reading of existing certificate ACM key/value pair tags during inventory and adding these tags when adding new certificates.
1212
Modifying and adding ACM tags during certificate renewal, however, is NOT supported.
13-
This is due to the fact that the AWS API does not allow for ACM tag modification when updating a certificate in one step.
13+
This is because the AWS API does not allow for ACM tag modification when updating a certificate in one step.
1414
This would need to be done in multiple steps, leading to the possibility of the certificate being left in an error state if any intermediate step were to fail.
1515
However, while the modification/addition of ACM tags is not supported, all existing ACM tags WILL remain in place during renewal.
1616

@@ -25,16 +25,16 @@ However, while the modification/addition of ACM tags is not supported, all exist
2525

2626
Field usage has changed in v3, notably:
2727
* `ServerUsername` and `ServerPassword` are no longer used
28-
* Specific fields for IAM and OAuth are defined for credentials of those type
28+
* Specific fields for IAM and OAuth are defined for credentials of those types
2929
* `Store Path` only allows a __single__ AWS Region to be defined
3030
* The Entry Parameter for AWS Region is no longer used
3131
* `Client Machine` requires the _full_ Role ARN to be used for Assume Role calls
3232

3333
As a result, previous Store Types are no longer supported, and Certificate Stores of those types need to be migrated to the v3 type.
34-
Inventory jobs will need be to run after creating the new Certificate Stores to begin tracking those certificates again.
34+
Inventory jobs will need to be to run after creating the new Certificate Stores to begin tracking those certificates again.
3535
The deprecated Stores and Store Types can be deleted after they are no longer needed.
3636

37-
_Currently there is no provided migration utility to perform this programatically._
37+
_Currently, there is no provided migration utility to perform this programmatically._
3838

3939
### Setting up AWS Authentication (Examples)
4040

@@ -55,9 +55,9 @@ If the EC2 Role assigned to the instance is only to be used initially, and a new
5555
then the `Assume new Role using Default SDK Auth` should also be selected.
5656

5757
### AWS Setup
58-
_Note: In this scenario the AWS-ACM-v3 extension needs to be running inside of an EC2 instance._
58+
_Note: In this scenario, the AWS-ACM-v3 extension needs to be running inside an EC2 instance._
5959
1. Assign or note the existing IAM Role assigned to the EC2 instance running. [Found in EC2 here](docsource/images/ec2-instance-iam-role.gif).
60-
2. Ensure a [Trust Relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/edit_trust.html) is setup for that role. [Example](docsource/images/ec2-role-arn-trust-relationship.gif).
60+
2. Ensure a [Trust Relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/edit_trust.html) is set up for that role. [Example](docsource/images/ec2-role-arn-trust-relationship.gif).
6161
3. Verify the permissions match the requirements for accessing ACM.
6262

6363
</details>
@@ -69,15 +69,15 @@ _Note: In this scenario the AWS-ACM-v3 extension needs to be running inside of a
6969
Select the `Use OAuth` option for a certificate store to use an OAuth Identity Provider.
7070

7171
### AWS Setup
72-
1. A 3rd party [Identity Provider](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) similar to [this](docsource/images/AWSIdentityProvider.gif) needs to be setup in AWS.
72+
1. A 3rd party [Identity Provider](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) similar to [this](docsource/images/AWSIdentityProvider.gif) needs to be set up in AWS.
7373
2. An [AWS Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) needs to be created to be used with your Identity Provider.
74-
3. Ensure the [Trust Relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/edit_trust.html) is setup for that role with the Identity Provider. [Example](docsource/images/AWSRole2.gif).
74+
3. Ensure the [Trust Relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/edit_trust.html) is set up for that role with the Identity Provider. [Example](docsource/images/AWSRole2.gif).
7575
4. Verify the permissions match the requirements for accessing ACM.
7676

7777
### OKTA Setup
78-
1. Ensure your Authorization Server Is Setup in OKTA. Here is a [sample](docsource/images/OktaSampleAuthorizationServer.gif).
79-
2. Ensure the appropriate scopes are setup in Okta. Here is a [sample](docsource/images/OktaSampleAuthorizationServer-scopes.gif).
80-
3. Setup an Okta App with similar settings to [this](docsource/images/OktaApp1.gif) and [this](docsource/images/OktaApp2.gif).
78+
1. Ensure your Authorization Server Is Set up in OKTA. Here is a [sample](docsource/images/OktaSampleAuthorizationServer.gif).
79+
2. Ensure the appropriate scopes are set up in Okta. Here is a [sample](docsource/images/OktaSampleAuthorizationServer-scopes.gif).
80+
3. Set up an Okta App with similar settings to [this](docsource/images/OktaApp1.gif) and [this](docsource/images/OktaApp2.gif).
8181

8282
</details>
8383

@@ -89,7 +89,7 @@ Select the `Use IAM` option for a certificate store to use an IAM User credentia
8989

9090
### AWS Setup
9191
1. An [AWS Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html) to Assume with your IAM User needs to be created.
92-
2. Ensure a [Trust Relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/edit_trust.html) is setup for that role. [Example](docsource/images/AssumeRoleTrust.gif).
92+
2. Ensure a [Trust Relationship](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/edit_trust.html) is set up for that role. [Example](docsource/images/AssumeRoleTrust.gif).
9393
3. AWS does not support programmatic access for AWS SSO accounts. The account used here must be a [standard AWS IAM User](docsource/images/UserAccount.gif) with an Access Key credential type.
9494
4. Verify the permissions match the requirements for accessing ACM.
9595

Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)