feat: Add live events setup documentation for AWS integration #2844
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This new document outlines the process for configuring live events in Port's AWS integration, including prerequisites, setup methods (Terraform and manual), testing procedures, and troubleshooting tips. It also details supported AWS services and resource types for real-time event processing.
shalev007
force-pushed
the
PORT-16432-bug-add-documentation-for-aws-integration-live-events
branch
from
7a7b3da to
ceff42e
Compare
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
hadar-co
requested changes
Oct 19, 2025
|
|
||
| Port's AWS integration supports real-time event processing, allowing for accurate representation of your AWS infrastructure inside Port. This guide explains how to set up live events for your AWS resources. | ||
|
|
||
| :::info Current Limitations |
There was a problem hiding this comment.
this title implies that there are multiple limitations, while the content is very specific. Change this to something like "Supported account type"
|
|
||
| ## Prerequisites | ||
|
|
||
| Before setting up live events, ensure you have: |
There was a problem hiding this comment.
not all of the points in the list are something you need to have, so just a small rewording here is needed.
| - **Manual installation users**: Follow the AWS console setup steps. | ||
| ::: | ||
|
|
||
| ## How live events work |
There was a problem hiding this comment.
Suggested change
| ## How live events work | |
| ## Live-events flow |
|
|
||
| ## How live events work | ||
|
|
||
| The live events flow follows these steps: |
There was a problem hiding this comment.
Suggested change
| The live events flow follows these steps: | |
| The live events flow is comprised of the following steps: |
| 2. **CloudTrail** captures these events. | ||
| 3. **EventBridge Rules** filter and route specific events. | ||
| 4. **API Gateway** receives the events and forwards them to Port. | ||
| 5. **Port Integration** processes the events and updates your software catalog. |
There was a problem hiding this comment.
Suggested change
| 5. **Port Integration** processes the events and updates your software catalog. | |
| 5. Your **Port integration** processes the events and updates your software catalog. |
| - **S3 Buckets** (`AWS::S3::Bucket`) | ||
| - **CloudFormation Stacks** (`AWS::CloudFormation::Stack`) | ||
|
|
||
| <h3>Adding custom resource types</h3> |
There was a problem hiding this comment.
Suggested change
| <h3>Adding custom resource types</h3> | |
| <h3>Add custom resource types</h3> |
| </TabItem> | ||
| <TabItem value="manual" label="Manual AWS Console Setup"> | ||
|
|
||
| If you installed the AWS integration manually, follow these steps to create EventBridge rules in the AWS console. |
There was a problem hiding this comment.
Suggested change
| If you installed the AWS integration manually, follow these steps to create EventBridge rules in the AWS console. | |
| If you installed the AWS integration manually, follow these steps to create EventBridge rules in the AWS console: |
|
|
||
| :::info Default Terraform installation | ||
|
|
||
| with support for three resource types by default: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This new document outlines the process for configuring live events in Port's AWS integration, including prerequisites, setup methods (Terraform and manual), testing procedures, and troubleshooting tips. It also details supported AWS services and resource types for real-time event processing.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
Added docs pages
Please also include the path for the added docs
/)/platform-overview/port-components/blueprint)Updated docs pages
Please also include the path for the updated docs
/)/platform-overview/port-components/blueprint)