diff --git a/README.md b/README.md index 21d011c..533c308 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Terraform module to deploy the Kosli environment reporter as an AWS lambda funct 3. Configure your AWS credentials: Terraform needs access to your AWS account to be able to manage your resources. You can set up your AWS credentials by following the instructions in the [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) -4. Create a Terraform configuration: In order to use the Kosli reporter module, you'll need to create a Terraform configuration. Here are configuration examples that will track [ECS](./examples/ecs), [Lambda](./examples/lambda), [S3](./examples/s3) resources. +4. Create a Terraform configuration: In order to use the Kosli reporter module, you'll need to create a Terraform configuration. There are configuration examples ([see here](https://github.com/kosli-dev/terraform-aws-kosli-reporter/tree/master/examples)) that will track ECS cluster, S3 bucket and Lambda functions - `lambda-report-all`, which will report all Lambda functions in the region and `lambda-report-selectively`, which reports only selected functions. 5. Initialize and run Terraform: Once Terraform configuration is created, you'll need to initialize Terraform by running the `terraform init` command in the same directory as your configuration files. This will download the necessary modules and providers for your configuration. Then, you can run the `terraform apply` command to apply your configuration. diff --git a/examples/lambda-report-all/README.md b/examples/lambda-report-all/README.md new file mode 100644 index 0000000..3230cfb --- /dev/null +++ b/examples/lambda-report-all/README.md @@ -0,0 +1 @@ +This example deploys Kosli reporter to track all Lambda functions in your AWS region. \ No newline at end of file diff --git a/examples/lambda/report-all/main.tf b/examples/lambda-report-all/main.tf similarity index 100% rename from examples/lambda/report-all/main.tf rename to examples/lambda-report-all/main.tf diff --git a/examples/lambda/report-all/versions.tf b/examples/lambda-report-all/versions.tf similarity index 100% rename from examples/lambda/report-all/versions.tf rename to examples/lambda-report-all/versions.tf diff --git a/examples/lambda-report-selectively/README.md b/examples/lambda-report-selectively/README.md new file mode 100644 index 0000000..14cf09d --- /dev/null +++ b/examples/lambda-report-selectively/README.md @@ -0,0 +1 @@ +This example deploys Kosli reporter to track only selected Lambda functions in your AWS region. \ No newline at end of file diff --git a/examples/lambda/report-selectively/main.tf b/examples/lambda-report-selectively/main.tf similarity index 100% rename from examples/lambda/report-selectively/main.tf rename to examples/lambda-report-selectively/main.tf diff --git a/examples/lambda/report-selectively/versions.tf b/examples/lambda-report-selectively/versions.tf similarity index 100% rename from examples/lambda/report-selectively/versions.tf rename to examples/lambda-report-selectively/versions.tf diff --git a/examples/lambda/README.md b/examples/lambda/README.md deleted file mode 100644 index 3fad915..0000000 --- a/examples/lambda/README.md +++ /dev/null @@ -1 +0,0 @@ -There are 2 Reporter configuration examples. [First](./report-all) one deploys Kosli Reporter to track all Lambda functions in your AWS region. [Second](./report-selectively) configuration demonstrates how you can select Lambda functions to track. \ No newline at end of file