Collects cloud resources in a given account. Supports multiple cloud providers.
The AWS Collector requires you to provide region and credential information. You can do this either by setting up shared credential and config files or by setting environment variables.
To setup the credential and config files do the following:
- Create a text file with the following content (replacing the keys with your AWS keys)
[default]
aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY
If you are using Windows save the file under C:\Users\<yourUserName>\.aws\credentials
.
If you are using Linux, MacOS, or Unix save the file under ~/.aws/credentials
- Create a text file with the following content (choosing the appropriate region)
[default]
region = eu-north-1
output = json
If you are using Windows save the file under C:\Users\<yourUserName>\.aws\config
.
If you are using Linux, MacOS, or Unix save the file under ~/.aws/config
Alternatively, you can set the following environment files:
export AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY_ID
export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY
export AWS_REGION=eu-north-1
Note: Pagination is not yet implemented, the collector will return only the first page of resources.
The IBM collector requires an IBM API key to be supplied through the following environment variable:
export IBMCLOUD_API_KEY=<ibm-cloud-api-key>
./bin/collector collect --provider <provider> [flags]
Flags:
-h, --help help for collect
--out string file path to store results
-r, --region stringArray cloud region from which to collect resources
--resource-group string resource group id or name from which to collect resources
- Value of
--provider
must be eitheribm
oraws
- IBM only: The
--region
argument can appear multiple times. If running with no--region
arguments, resources from all regions are collected. - If running with no
--resource-group
argument, resources from all resource groups are collected.
./bin/collector get-regions --provider <provider>
Requires Go version 1.22 or later.
git clone [email protected]:np-guard/cloud-resource-collector.git
cd cloud-resource-collector
make build