https://github.com/cloudforet-io/plugin-aws-ec2-inven-collector
Plugin for AWS EC2
https://github.com/cloudforet-io/plugin-aws-ec2-inven-collector
collector inventory plugin
Last synced: about 1 year ago
JSON representation
Plugin for AWS EC2
- Host: GitHub
- URL: https://github.com/cloudforet-io/plugin-aws-ec2-inven-collector
- Owner: cloudforet-io
- License: apache-2.0
- Created: 2022-09-05T01:11:34.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T07:49:26.000Z (over 1 year ago)
- Last Synced: 2025-03-26T07:04:22.969Z (about 1 year ago)
- Topics: collector, inventory, plugin
- Language: Python
- Homepage:
- Size: 6.68 MB
- Stars: 6
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AWS EC2 Instance Collector
**Plugin to collect EC2 information**
> SpaceONE's [plugin-aws-ec2-inven-collector](https://github.com/spaceone-dev/plugin-aws-ec2-inven-collector) is a convenient tool to get EC2 resources information from AWS.
Find us also at [Dockerhub](https://hub.docker.com/repository/docker/spaceone/plugin-aws-ec2-inven-collector)
> Latest stable version : 1.14.3
Please contact us if you need any further information. ()
---
## AWS Service Endpoint (in use)
There is an endpoints used to collect AWS resources information.
AWS endpoint is a URL consisting of a region and a service code.
https://ec2.[region-code].amazonaws.com
https://autoscaling.[region-code].amazonaws.com
https://elbv2.[region-code].amazonaws.com
We use a lots of endpoints because we collect information from many regions.
### Region list
Below is the AWS region information.
The regions we collect are not all regions supported by AWS. Exactly, we target the regions results returned by [describe_regions()](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_regions) of AWS ec2 client.
|No.|Region name|Region Code|
|---|------|---|
|1|US East (Ohio)|us-east-2|
|2|US East (N. Virginia)|us-east-1|
|3|US West (N. California)|us-west-1|
|4|US West (Oregon)|us-west-2|
|5|Asia Pacific (Mumbai)|ap-south-1|
|6|Asia Pacific (Osaka)|ap-northeast-3|
|7|Asia Pacific (Seoul)|ap-northeast-2|
|8|Asia Pacific (Singapore)|ap-southeast-1|
|9|Asia Pacific (Sydney)|ap-southeast-2|
|10|Asia Pacific (Tokyo)|ap-northeast-1|
|11|Canada (Central)|ca-central-1|
|12|Europe (Frankfurt)|eu-central-1|
|13|Europe (Ireland)|eu-west-1|
|14|Europe (London)|eu-west-2|
|15|Europe (Paris)|eu-west-3|
|16|Europe (Stockholm)|eu-north-1|
|17|South America (São Paulo)|sa-east-1|
---
### Service list
The following is a list of services being collected and service code information.
|No.|Service name|Service Code|
|---|------|---|
|1|EC2 Instance|AmazonEC2|
---
## Authentication Overview
Registered service account on SpaceONE must have certain permissions to collect cloud service data Please, set
authentication privilege for followings:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"autoscaling:Describe*",
"ec2:Describe*",
"elasticloadbalancing:Describe*"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
---
## API List for collecting resources
### Boto3 info
* [describe_regions](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_regions)
* [describe_instances](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_instances)
* [describe_instance_types](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_instance_types)
* [describe_instance_attribute](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_instance_attribute)
* [describe_auto_scaling_groups](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/autoscaling.html#AutoScaling.Client.describe_auto_scaling_groups)
* [describe_launch_configurations](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/autoscaling.html#AutoScaling.Client.describe_launch_configurations)
* [describe_launch_templates](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_launch_templates)
* [describe_load_balancers](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.describe_load_balancers)
* [describe_target_groups](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.describe_target_groups)
* [describe_listeners](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.describe_listeners)
* [describe_target_health](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.describe_target_health)
* [describe_security_groups](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_security_groups)
* [describe_subnets](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_subnets)
* [describe_vpcs](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_vpcs)
* [describe_volumes](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_volumes)
* [describe_images](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_images)
* [describe_addresses](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_addresses)
* [get_caller_identity](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html#STS.Client.get_caller_identity)
* [assume_role](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html#STS.Client.assume_role)
---
# Release Note
## Version 1.14.3
FIX BUG: [Links in Security Group do not work](https://github.com/cloudforet-io/plugin-aws-ec2-inven-collector/issues/11)
## Version 1.12.1
Remove region filter in secret_data. It is not used.
## Version 1.3.1
Support collect Large Capacity of EC2s (More than 2k)
* Handling API 'rate exceeded'
* Default maximum number of retries has set to handle up to 10k APIs