Skip to content

Commit f2fcc13

Browse files
committed
update live-events page with Shalev
1 parent 8efe17f commit f2fcc13

File tree

1 file changed

+16
-90
lines changed
  • docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/installations

1 file changed

+16
-90
lines changed

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

Lines changed: 16 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,7 @@ import Image from "@theme/IdealImage";
1111
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.
1212

1313
:::info Current Limitations
14-
Live events are currently only available for:
15-
- **Single account installations** (not multi-account).
16-
- **Default Terraform installation** with support for three resource types by default:
17-
- `EC2 Instances`.
18-
- `S3 Buckets`.
19-
- `CloudFormation Stacks`.
14+
Live events are currently only available for **Single account installations** (not multi-account).
2015
:::
2116

2217
## Prerequisites
@@ -35,8 +30,6 @@ Before setting up live events, ensure you have:
3530

3631
## How live events work
3732

38-
<img src='/img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/live-events-diagram.svg' width='50%' border='1px' />
39-
4033
The live events flow follows these steps:
4134

4235
1. **AWS Services** generate events when resources change.
@@ -45,6 +38,9 @@ The live events flow follows these steps:
4538
4. **API Gateway** receives the events and forwards them to Port.
4639
5. **Port Integration** processes the events and updates your software catalog.
4740

41+
<img src='/img/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/live-events-diagram.svg' width='50%' border='1px' />
42+
<br></br>
43+
4844
## Setup methods
4945

5046
<Tabs>
@@ -184,93 +180,23 @@ Replace `"AWS::SSM::Parameter"` with the appropriate AWS resource type:
184180
</TabItem>
185181
</Tabs>
186182

187-
## Testing your setup
188-
189-
### Verify existing rules
190-
191-
If you have other live event rules (e.g., S3 Bucket sync), verify they're working:
192-
193-
1. Go to **EventBridge****Rules**.
194-
2. Check that your rules are **Enabled**.
195-
3. Look for any recent invocations in the **Metrics** tab.
196-
197-
### Test live events
198-
199-
1. **Trigger a test event**:
200-
- Modify/create a resource (e.g., create an SSM Parameter).
201-
- Update an existing resource.
202-
- Delete a resource.
203-
204-
2. **Verify in Port**:
205-
- Check your software catalog for real-time updates.
206-
- Look for the resource changes in Port's interface.
207-
208-
### Example test for SSM parameters
209-
210-
1. Go to **Systems Manager****Parameter Store**
211-
2. Create a new parameter:
212-
- Name: `/test/my-parameter`
213-
- Type: `String`
214-
- Value: `test-value`
215-
3. Check Port for the new parameter entity.
216183

217-
## Troubleshooting
184+
## Supported AWS services
218185

219-
### Common issues
186+
The complete list of AWS services that support live events can be found [here](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html).
220187

221-
**Events not appearing in Port:**
222-
- Verify the EventBridge rule is enabled
223-
- Check that the API Gateway endpoint is correct
224-
- Ensure the Port API key is valid
225-
- Verify the input transformer mapping is correct
188+
### Add other services
226189

227-
**Wrong resource type in Port:**
228-
- Check the `resource_type` field in your input transformer template
229-
- Ensure it matches the expected AWS resource type
190+
To add live events for additional AWS services, follow these steps:
191+
1. Identify the service's event source and detail type.
192+
2. Create an EventBridge rule with the appropriate pattern.
193+
3. Configure the input transformer with the correct resource type.
230194

231-
**Missing headers:**
232-
- Verify both `Content-Type` and `x-port-aws-ocean-api-key` headers are set
233-
- Check that the API key is the correct one for your Port environment
195+
:::info Default Terraform installation
234196

235-
### Debugging Steps
236-
237-
1. **Check EventBridge Metrics**:
238-
- Go to EventBridge → Rules → Your Rule → Metrics
239-
- Look for successful invocations and any errors
240-
241-
2. **Check API Gateway Logs**:
242-
- Go to API Gateway → Your API → Stages → production → Logs
243-
- Look for incoming requests and any errors
244-
245-
3. **Verify Event Pattern**:
246-
- Test your event pattern with sample events
247-
- Use EventBridge's "Test pattern" feature
248-
249-
## Supported AWS Services
250-
251-
The following AWS services can be configured for live events:
252-
253-
| Service | Event Source | Detail Type | Resource Type |
254-
|---------|--------------|-------------|---------------|
255-
| EC2 | `aws.ec2` | `EC2 Instance State-change Notification` | `AWS::EC2::Instance` |
256-
| S3 | `aws.s3` | `Object Created`, `Object Deleted` | `AWS::S3::Bucket` |
257-
| CloudFormation | `aws.cloudformation` | `CloudFormation Stack State Change` | `AWS::CloudFormation::Stack` |
258-
| Systems Manager | `aws.ssm` | `Parameter Store Change` | `AWS::SSM::Parameter` |
259-
260-
:::info Adding More Services
261-
To add live events for additional AWS services, follow the same pattern:
262-
1. Identify the service's event source and detail type
263-
2. Create an EventBridge rule with the appropriate pattern
264-
3. Configure the input transformer with the correct resource type
197+
with support for three resource types by default:
198+
- `EC2 Instances`.
199+
- `S3 Buckets`.
200+
- `CloudFormation Stacks`.
265201
:::
266202

267-
## Next Steps
268-
269-
After setting up live events:
270-
271-
1. **Monitor Performance**: Keep an eye on EventBridge metrics and API Gateway logs.
272-
2. **Scale as Needed**: Add more resource types as your requirements grow.
273-
3. **Optimize Patterns**: Fine-tune event patterns to reduce noise and improve performance.
274-
275-
For more advanced configuration options, see the [AWS integration examples](../examples/examples.md).
276-

0 commit comments

Comments
 (0)