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 @@ -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 EcsServiceBlueprint from './examples/ecs/services/_ecs_service_blueprint.mdx'
import EcsServiceConfig from './examples/ecs/services/_ecs_service_port_app_config.mdx'
import EcsServiceProperties from './examples/ecs/services/_ecs_service_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,22 @@ 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).

### ECS services

The following example demonstrates how to ingest your AWS ECS services to Port.

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

<EcsServiceBlueprint/>

<EcsServiceConfig/>

You can reference any of the following ECS service properties in your mapping configuration:

<EcsServiceProperties/>

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

## Amazon EC2

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

```json showLineNumbers
{
"identifier": "ecsService",
"description": "This blueprint represents an AWS ECS service in our software catalog",
"title": "ECS service",
"icon": "AWS",
"schema": {
"properties": {
"serviceArn": {
"type": "string",
"title": "Service ARN"
},
"status": {
"type": "string",
"title": "Status"
},
"desiredCount": {
"type": "number",
"title": "Desired count"
},
"runningCount": {
"type": "number",
"title": "Running count"
},
"tags": {
"type": "array",
"title": "Tags",
"items": {
"type": "object",
"properties": {
"Key": {
"type": "string"
},
"Value": {
"type": "string"
}
}
}
}
},
"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>ECS service mapping configuration (Click to expand)</b></summary>

```yaml showLineNumbers
resources:
- kind: AWS::ECS::Service
selector:
query: 'true'
# includeActions: No optional actions available for ECS services
# All properties are included by default via ListServicesAction and DescribeServicesAction
port:
entity:
mappings:
identifier: .Properties.ServiceArn
title: .Properties.ServiceName
blueprint: '"ecsService"'
properties:
serviceArn: .Properties.ServiceArn
status: .Properties.Status
desiredCount: .Properties.DesiredCount
runningCount: .Properties.RunningCount
tags: .Properties.Tags
relations:
account: .__ExtraContext.AccountId
```

</details>

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

| Property | JQ Path | Type | Action Required |
|----------|---------|------|-----------------|
| Availability Zone Rebalancing | `.Properties.AvailabilityZoneRebalancing` | string | DescribeServicesAction (default) |
| Capacity Provider Strategy | `.Properties.CapacityProviderStrategy` | array | DescribeServicesAction (default) |
| Cluster ARN | `.Properties.ClusterArn` | string | DescribeServicesAction (default) |
| Created At | `.Properties.CreatedAt` | string | DescribeServicesAction (default) |
| Created By | `.Properties.CreatedBy` | string | DescribeServicesAction (default) |
| Deployment Configuration | `.Properties.DeploymentConfiguration` | object | DescribeServicesAction (default) |
| Deployment Controller | `.Properties.DeploymentController` | object | DescribeServicesAction (default) |
| Deployments | `.Properties.Deployments` | array | DescribeServicesAction (default) |
| Desired Count | `.Properties.DesiredCount` | number | DescribeServicesAction (default) |
| Enable ECS Managed Tags | `.Properties.EnableECSManagedTags` | boolean | DescribeServicesAction (default) |
| Enable Execute Command | `.Properties.EnableExecuteCommand` | boolean | DescribeServicesAction (default) |
| Events | `.Properties.Events` | array | DescribeServicesAction (default) |
| Health Check Grace Period Seconds | `.Properties.HealthCheckGracePeriodSeconds` | number | DescribeServicesAction (default) |
| Launch Type | `.Properties.LaunchType` | string | DescribeServicesAction (default) |
| Load Balancers | `.Properties.LoadBalancers` | array | DescribeServicesAction (default) |
| Network Configuration | `.Properties.NetworkConfiguration` | object | DescribeServicesAction (default) |
| Pending Count | `.Properties.PendingCount` | number | DescribeServicesAction (default) |
| Placement Constraints | `.Properties.PlacementConstraints` | array | DescribeServicesAction (default) |
| Placement Strategy | `.Properties.PlacementStrategy` | array | DescribeServicesAction (default) |
| Platform Family | `.Properties.PlatformFamily` | string | DescribeServicesAction (default) |
| Platform Version | `.Properties.PlatformVersion` | string | DescribeServicesAction (default) |
| Propagate Tags | `.Properties.PropagateTags` | string | DescribeServicesAction (default) |
| Role ARN | `.Properties.RoleArn` | string | DescribeServicesAction (default) |
| Running Count | `.Properties.RunningCount` | number | DescribeServicesAction (default) |
| Scheduling Strategy | `.Properties.SchedulingStrategy` | string | DescribeServicesAction (default) |
| Service ARN | `.Properties.ServiceArn` | string | ListServicesAction (default) |
| Service Name | `.Properties.ServiceName` | string | DescribeServicesAction (default) |
| Service Registries | `.Properties.ServiceRegistries` | array | DescribeServicesAction (default) |
| Status | `.Properties.Status` | string | DescribeServicesAction (default) |
| Tags | `.Properties.Tags` | array | DescribeServicesAction (default) |
| Task Definition | `.Properties.TaskDefinition` | string | DescribeServicesAction (default) |
| Task Sets | `.Properties.TaskSets` | array | DescribeServicesAction (default) |
| Updated At | `.Properties.UpdatedAt` | string | DescribeServicesAction (default) |

</details>