Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ Easily fill your software catalog with data directly from your AWS Organization,
## Supported resources

The integration currently supports the following AWS resource types:
- `AWS Account Info`: Core account details such as account ID and name.
- `AWS Organizations Accounts`: Organization account details and metadata.
- `S3 Buckets`: Complete bucket information including properties, tags, and metadata.
- `ECS Clusters`: Cluster details, services, and task definitions.
- `EKS Clusters`: Cluster details including status, version, endpoint, and tags.
- `EC2 Instances`: Instance information, security groups, and networking details.

:::info More Resource Types Coming Soon
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ import S3BucketProperties from './examples/s3/buckets/_s3_bucket_properties.mdx'
import EcsClusterBlueprint from './examples/ecs/clusters/_ecs_cluster_blueprint.mdx'
import EcsClusterConfig from './examples/ecs/clusters/_ecs_cluster_port_app_config.mdx'
import EcsClusterProperties from './examples/ecs/clusters/_ecs_cluster_properties.mdx'
import EksClusterBlueprint from './examples/eks/clusters/_eks_cluster_blueprint.mdx'
import EksClusterConfig from './examples/eks/clusters/_eks_cluster_port_app_config.mdx'
import EksClusterProperties from './examples/eks/clusters/_eks_cluster_properties.mdx'
import Ec2InstanceBlueprint from './examples/ec2/instances/_ec2_instance_blueprint.mdx'
import Ec2InstanceConfig from './examples/ec2/instances/_ec2_instance_port_app_config.mdx'
import Ec2InstanceProperties from './examples/ec2/instances/_ec2_instance_properties.mdx'
Expand Down Expand Up @@ -89,6 +92,24 @@ You can reference any of the following ECS cluster properties in your mapping co

For more details about ECS cluster properties, refer to the [AWS ECS API documentation](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeClusters.html).

## Amazon EKS

### EKS clusters

The following example demonstrates how to ingest your AWS EKS clusters to Port.

You can use the following Port blueprint definitions and integration configuration:

<EksClusterBlueprint/>

<EksClusterConfig/>

You can reference any of the following EKS cluster properties in your mapping configuration:

<EksClusterProperties/>

For more details about EKS cluster properties, refer to the [AWS EKS API documentation](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeCluster.html).

## Amazon EC2

### EC2 instances
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<details>
<summary><b>EKS cluster blueprint (Click to expand)</b></summary>

```json showLineNumbers
{
"identifier": "eksCluster",
"description": "This blueprint represents an AWS EKS cluster in our software catalog",
"title": "EKS cluster",
"icon": "AWS",
"schema": {
"properties": {
"status": {
"type": "string",
"title": "Status"
},
"version": {
"type": "string",
"title": "Version"
},
"endpoint": {
"type": "string",
"title": "Endpoint"
},
"arn": {
"type": "string",
"title": "ARN"
},
"tags": {
"type": "array",
"title": "Tags",
"items": {
"type": "object",
"properties": {
"Key": { "type": "string", "title": "Key" },
"Value": { "type": "string", "title": "Value" }
}
}
}
},
"required": []
},
"mirrorProperties": {},
"calculationProperties": {},
"aggregationProperties": {},
"relations": {
"account": {
"title": "Account",
"target": "awsAccount",
"required": true,
"many": false
}
}
}
```

</details>

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<details>
<summary><b>EKS cluster mapping configuration (Click to expand)</b></summary>

```yaml showLineNumbers
resources:
- kind: AWS::EKS::Cluster
selector:
query: 'true'
# includeActions: No optional actions available for EKS clusters
# All properties are included by default via DescribeClusterAction
port:
entity:
mappings:
identifier: .Properties.Arn
title: .Properties.Name
blueprint: '"eksCluster"'
properties:
status: .Properties.Status
version: .Properties.Version
endpoint: .Properties.Endpoint
arn: .Properties.Arn
tags: (.Properties.Tags | to_entries | map({Key: .key, Value: .value}))
relations:
account: .__ExtraContext.AccountId
```

</details>

Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<details>
<summary><b>EKS cluster properties (Click to expand)</b></summary>

| Property | JQ Path | Type | Action Required |
|----------|---------|------|-----------------|
| Name | `.Properties.Name` | string | DescribeClusterAction (default) |
| ARN | `.Properties.Arn` | string | DescribeClusterAction (default) |
| Status | `.Properties.Status` | string | DescribeClusterAction (default) |
| Version | `.Properties.Version` | string | DescribeClusterAction (default) |
| Platform Version | `.Properties.PlatformVersion` | string | DescribeClusterAction (default) |
| Endpoint | `.Properties.Endpoint` | string | DescribeClusterAction (default) |
| Role ARN | `.Properties.RoleArn` | string | DescribeClusterAction (default) |
| Created At | `.Properties.CreatedAt` | datetime | DescribeClusterAction (default) |
| Certificate Authority | `.Properties.CertificateAuthority` | object | DescribeClusterAction (default) |
| Identity | `.Properties.Identity` | object | DescribeClusterAction (default) |
| Kubernetes Network Config | `.Properties.KubernetesNetworkConfig` | object | DescribeClusterAction (default) |
| Logging | `.Properties.Logging` | object | DescribeClusterAction (default) |
| Resources VPC Config | `.Properties.ResourcesVpcConfig` | object | DescribeClusterAction (default) |
| Storage Config | `.Properties.StorageConfig` | object | DescribeClusterAction (default) |
| Upgrade Policy | `.Properties.UpgradePolicy` | object | DescribeClusterAction (default) |
| Access Config | `.Properties.AccessConfig` | object | DescribeClusterAction (default) |
| Compute Config | `.Properties.ComputeConfig` | object | DescribeClusterAction (default) |
| Zonal Shift Config | `.Properties.ZonalShiftConfig` | object | DescribeClusterAction (default) |
| Tags | `.Properties.Tags` | object | DescribeClusterAction (default) |

</details>