Skip to content

Commit 9cf3953

Browse files
committed
add image for create_complete and change a couple more explanation lines
1 parent ae591e9 commit 9cf3953

File tree

4 files changed

+39
-45
lines changed

4 files changed

+39
-45
lines changed

docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/Overview.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,9 @@ We're actively working on adding support for additional AWS resource types to pr
4141

4242
AWS Hosted by Port provides several advantages over the standard AWS integration:
4343

44-
- **Fully Hosted**: No infrastructure to maintain, update, or monitor.
45-
- **Simplified Installation**: Just deploy CloudFormation templates to create IAM roles.
46-
- **Complete Data**: Ensures no missing or incomplete resource information.
47-
- **Periodic Sync**: Regular updates to keep your catalog current.
48-
- **Zero Maintenance**: Port handles all updates, scaling, and infrastructure management.
44+
- **Fully hosted**: No infrastructure to maintain, update, or monitor.
45+
- **Simplified installation**: Just deploy CloudFormation templates to create IAM roles.
46+
- **Complete data**: Ensures no missing or incomplete resource information.
4947

5048
## Getting started
5149

docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/iam-role-architecture.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ PortIntegrationOIDCProvider:
3737
Value: !Ref IntegrationIdentifier
3838
```
3939
40-
**Key Details**:
40+
**Key details**:
4141
- **EKS OIDC URL**: Points to Port's production EKS cluster in EU-West-1.
4242
- **Client ID**: Uses `sts.amazonaws.com` for IRSA authentication.
4343
- **Reusable**: Can be shared across multiple integrations in the same account.
@@ -66,11 +66,9 @@ The IAM role uses an **OIDC (OpenID Connect) trust policy** with **IRSA (IAM Rol
6666
}
6767
```
6868

69-
**Key Security Features**:
70-
- **IRSA Authentication**: Uses EKS service account-based authentication.
71-
- **Audience Validation**: Only AWS STS service can assume the role.
72-
- **Subject Validation**: Role is tied to Port's specific EKS service account.
73-
- **Temporary Credentials**: All access uses short-lived tokens (typically 1 hour).
69+
**Key security features**:
70+
- **OIDC authentication**: Role is tied to Port's specific EKS service account.
71+
- **Temporary credentials**: All access uses short-lived tokens (typically 1 hour).
7472

7573
### Permissions policy
7674

@@ -81,12 +79,12 @@ ManagedPolicyArns:
8179
- arn:aws:iam::aws:policy/ReadOnlyAccess
8280
```
8381

84-
**Strategic Benefits**:
85-
- **Future-Proof**: Automatically includes new AWS services without CloudFormation updates.
86-
- **Operational Simplicity**: No need to redeploy when adding support for new services.
87-
- **Comprehensive Coverage**: Access to all AWS services with read-only permissions.
88-
- **AWS Maintained**: AWS manages and updates the policy as needed.
89-
- **Read-Only Security**: Only read permissions, no write/delete/create access.
82+
**Strategic benefits**:
83+
- **Future-proof**: Automatically includes new AWS services without CloudFormation updates.
84+
- **Operational simplicity**: No need to redeploy when adding support for new services.
85+
- **Comprehensive coverage**: Access to all AWS services with read-only permissions.
86+
- **AWS maintained**: AWS manages and updates the policy as needed.
87+
- **Read-Only security**: Only read permissions, no write/delete/create access.
9088

9189
## Security considerations
9290

docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installations.md

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,15 @@ For a single AWS account, you will deploy a CloudFormation stack that creates th
5050

5151
<h4>Step 2: Deploy CloudFormation Stack</h4>
5252

53-
- **Access the CloudFormation Template**:
53+
- **Access the CloudFormation template**:
5454
- Go to [Data Sources](https://app.getport.io/settings/data-sources) page.
5555
- Click on the `+ Data source` button in the top right corner of the page.
5656
- Select **AWS Hosted by Port** from the cloud providers section.
57-
- Select **Single Account** and click the `Click here` link in step 3 of the installation form.
57+
- Select **Single Account**.
58+
- In step 3 of the installation form, click the `Click here` link. This will open CloudFormation with pre-configured parameters.
5859
- This will open CloudFormation with pre-configured parameters.
5960

60-
- **Deploy via AWS Console**:
61+
- **Deploy via AWS console**:
6162
- In the CloudFormation console, review the pre-configured parameters.
6263
- Scroll down to the bottom of the page.
6364
- Check the box that states **"I acknowledge that AWS CloudFormation might create IAM resources with custom names"**.
@@ -67,15 +68,16 @@ For a single AWS account, you will deploy a CloudFormation stack that creates th
6768

6869
<h4>Step 3: Configure Integration in Port</h4>
6970

70-
- **Get the Role ARN**:
71+
- **Get the role ARN**:
7172
- Ensure the stack shows `CREATE_COMPLETE` status.
73+
<img src='/img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/CREATE_COMPLETE.png' width='60%' border='1px' />
7274
- After CloudFormation deployment completes, go to the **Outputs** tab.
7375
- Copy the value of **PortIntegrationRoleArn**.
7476
<img src='/img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/PortIntegreationRoleArn-value.png' width='90%' border='1px' />
7577
- Paste it into the **Account Role Arn** field in the Port integration form.
7678
- Click `Done`.
7779

78-
- **Verify Connection**:
80+
- **Verify connection**:
7981
- Port will automatically detect the IAM role created by CloudFormation.
8082
- The integration will start discovering your AWS resources.
8183

@@ -87,13 +89,13 @@ For multiple AWS accounts, you will use AWS Organizations and deploy the integra
8789

8890
<h4>Understanding AWS Organizations</h4>
8991

90-
- **Management Account**: The main account that manages your organization.
91-
- **Member Accounts**: Individual AWS accounts in your organization.
92-
- **Organizational Units (OUs)**: Logical groupings of accounts (like folders in a file system).
92+
- **Management account**: The main account that manages your organization.
93+
- **Member accounts**: Individual AWS accounts in your organization.
94+
- **Organizational units (OUs)**: Logical groupings of accounts (like folders in a file system).
9395
- **OU IDs**: Unique identifiers for organizational units (format: `ou-abcd-12345678`).
9496
- **Root**: The top-level container for all accounts and OUs (format: `r-xxxxxxxxx`).
9597

96-
**Example Organization Structure**:
98+
**Example organization structure**:
9799
```
98100
Root (r-1234)
99101
├── Management Account (123456789012)
@@ -112,27 +114,23 @@ Root (r-1234)
112114
You must run the multi-account installation from your AWS Organizations **management account**. This is because only the management account can deploy StackSets across member accounts.
113115
:::
114116

115-
- **Access Management Account**:
117+
- **Find your OU ID**:
116118
- Log into your AWS Organizations management account.
117119
- Navigate to [AWS Organizations](https://us-east-1.console.aws.amazon.com/organizations/v2/home/accounts) service.
118-
119-
- **Find Your OU IDs**:
120-
- In AWS Organizations, open **organizational units** in the left sidebar.
121-
- Click an OU (e.g., **Production**).
122-
- Copy the OU ID from the details page (format `ou-xxxx-xxxxxxxx` or `r-xxxx`).
123-
- You can also target specific account IDs if needed.
120+
- Under **Organizational structure** copy the OU ID from the details page (format `ou-xxxx-xxxxxxxx` or `r-xxxx`).
121+
- You can also target specific account IDs if needed using the `Account scope` field.
124122

125123
<h4>Step 2: Deploy Multi-Account CloudFormation Stack</h4>
126124

127-
- **Access the CloudFormation Template**:
125+
- **Access the CloudFormation template**:
128126
- Go to the [Data sources](https://app.getport.io/settings/data-sources) page of your portal.
129127
- Click on the `+ Data source` button in the top right corner of the page.
130128
- Select **AWS Hosted by Port** from the cloud providers section.
131129
- Select **Multiple Accounts** and paste the OU ID you previously copied.
132130
- Choose the scope of the account (**All accounts**, **All accounts except selected**, **Selected accounts only**).
133-
- Click the `Click here` link in step 3 of the installation form, this will open CloudFormation with pre-configured parameters.
131+
- In step 3 of the installation form, click the `Click here` link, this will open CloudFormation with pre-configured parameters.
134132

135-
- **Deploy via AWS Console**:
133+
- **Deploy via AWS console**:
136134
- In the CloudFormation console, review the pre-configured parameters.
137135
- Scroll down to the bottom of the page.
138136
- Check the box **"I acknowledge that AWS CloudFormation might create IAM resources with custom names"**.
@@ -142,24 +140,24 @@ You must run the multi-account installation from your AWS Organizations **manage
142140

143141
<h4>Step 3: Monitor Deployment</h4>
144142

145-
- **Check StackSet Status**:
146-
- Go to **CloudFormation****Stack****Stack details****Events tab** in your management account.
147-
- Monitor the deployment progress across all target accounts.
148-
- Ensure all stack instances show `CREATE_COMPLETE` status.
143+
- **Check StackSet status**:
144+
- Go to **CloudFormation****Stacks** in your management account.
145+
- Make sure your stack status is `CREATE_COMPLETE`.
146+
<img src='/img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/CREATE_COMPLETE.png' width='60%' border='1px' />
149147

150-
- **Verify IAM Roles**:
148+
- **Verify IAM roles**:
151149
- Check that the IAM roles were created in each target account.
152150

153151
<h4>Step 4: Configure Integration in Port</h4>
154152

155-
- **Get the Role ARN**:
153+
- **Get the role ARN**:
156154
- After CloudFormation deployment completes, go to the **Outputs** tab.
157155
- Copy the value of **PortIntegrationRoleArn**.
158156
<img src='/img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/PortIntegreationRoleArn-value.png' width='90%' border='1px' />
159157
- Paste it into the **Account Role Arn** field in the Port integration form.
160158
- Click `Done`.
161159

162-
- **Verify Multi-Account Connection**:
160+
- **Verify multi-Account connection**:
163161
- Port will automatically detect the IAM roles across all accounts.
164162
- The integration will start discovering resources from all configured accounts.
165163

@@ -174,6 +172,6 @@ Common Installation Issue - CloudFormation Stack Creation Failures.
174172
**Error**: `Stack creation failed: CREATE_FAILED`
175173

176174
**Solutions**:
177-
- **Insufficient IAM Permissions**: Ensure your AWS user has CloudFormation and IAM permissions.
178-
- **OIDC Provider Already Exists**: Set "Create OIDC Provider" to `false` if you already have one.
175+
- **Insufficient IAM permissions**: Ensure your AWS user has CloudFormation and IAM permissions.
176+
- **OIDC provider already Eeists**: Set "Create OIDC Provider" to `false` if you already have one.
179177

32.7 KB
Loading

0 commit comments

Comments
 (0)