add links to README files for terraform registry

axiomhq · Oct 9, 2024 · a9db552 · a9db552
1 parent 554653d
commit a9db552
Show file tree

Hide file tree

Showing 9 changed files with 108 additions and 56 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,8 @@
 </a>
 &nbsp;
 
-Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to forward logs from Amazon CloudWatch to [Axiom](https://axiom.co). It includes a Lambda function to handle the forwarding and stacks to create CloudWatch log group subscription filters for both existing and future log groups.
+Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
+
 
 ## Documentation
 

diff --git a/examples/forwarder/README.md b/examples/forwarder/README.md
@@ -0,0 +1,18 @@
+# Axiom CloudWatch Forwarder Terraform Module
+
+<a href="https://axiom.co">
+<picture>
+  <source media="(prefers-color-scheme: dark) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-vertical.svg">
+  <source media="(prefers-color-scheme: light) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-dark-vertical.svg">
+  <source media="(prefers-color-scheme: dark) and (max-width: 599px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-horizontal.svg">
+  <img alt="Axiom.co banner" src="https://axiom.co/assets/github/axiom-github-banner-dark-horizontal.svg" align="right">
+</picture>
+</a>
+&nbsp;
+
+Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
+
+
+## Documentation
+
+For more information about how to set up and use the Axiom CloudWatch Forwarder, see the [Axiom documentation](https://axiom.co/docs/send-data/cloudwatch).
diff --git a/examples/forwarder/main.tf b/examples/forwarder/main.tf
@@ -3,23 +3,23 @@ resource "axiom_dataset" "lambda_forwarder" {
   description = "Test"
 }
 
-module "forwarder" {
-  source        = "../../modules/forwarder"
+module "forwarder_example" {
+  source        = "axiomhq/axiom-cloudwatch-forwarder/aws//modules/forwarder"
   axiom_dataset = axiom_dataset.lambda_forwarder.name
   axiom_token   = ""
   prefix        = "axiom-cloudwatch-forwarder"
 }
 
-module "subscriber" {
-  source               = "../../modules/subscriber"
-  prefix               = "axiom-cloudwatch-tf-test"
+module "subscriber_example" {
+  source               = "axiomhq/axiom-cloudwatch-forwarder/aws//modules/subscriber"
+  prefix               = "axiom-cloudwatch-forwarder"
   forwarder_lambda_arn = module.forwarder.lambda_arn
   log_groups_prefix    = "/aws/lambda/"
 }
 
-module "listener" {
-  source               = "../../modules/listener"
-  prefix               = "axiom-cloudwatch-tf-test"
+module "listener_example" {
+  source               = "axiomhq/axiom-cloudwatch-forwarder/aws//modules/listener"
+  prefix               = "axiom-cloudwatch-forwarder"
   forwarder_lambda_arn = module.forwarder.lambda_arn
   log_groups_prefix    = "/aws/lambda/"
 }

diff --git a/examples/unsubscriber/README.md b/examples/unsubscriber/README.md
@@ -0,0 +1,18 @@
+# Axiom CloudWatch Forwarder Terraform Module
+
+<a href="https://axiom.co">
+<picture>
+  <source media="(prefers-color-scheme: dark) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-vertical.svg">
+  <source media="(prefers-color-scheme: light) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-dark-vertical.svg">
+  <source media="(prefers-color-scheme: dark) and (max-width: 599px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-horizontal.svg">
+  <img alt="Axiom.co banner" src="https://axiom.co/assets/github/axiom-github-banner-dark-horizontal.svg" align="right">
+</picture>
+</a>
+&nbsp;
+
+Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
+
+
+## Documentation
+
+For more information about how to set up and use the Axiom CloudWatch Forwarder, see the [Axiom documentation](https://axiom.co/docs/send-data/cloudwatch).
diff --git a/examples/unsubscriber/main.tf b/examples/unsubscriber/main.tf
@@ -1,5 +1,5 @@
-module "unsubscriber" {
-  source               = "../../modules/unsubscriber"
+module "unsubscriber_example" {
+  source               = "axiomhq/axiom-cloudwatch-forwarder/aws//modules/unsubscriber"
   prefix               = "axiom-cloudwatch-forwarder"
   forwarder_lambda_arn = "Forwarder lambda ARN"
   log_groups_prefix    = "/aws/lambda/"

diff --git a/modules/forwarder/README.md b/modules/forwarder/README.md
@@ -1,14 +1,18 @@
-# Axiom Cloudwatch Forwarder
+# Axiom CloudWatch Forwarder Terraform Module
 
-Forward logs from AWS Cloudwatch to Axiom.
+<a href="https://axiom.co">
+<picture>
+  <source media="(prefers-color-scheme: dark) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-vertical.svg">
+  <source media="(prefers-color-scheme: light) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-dark-vertical.svg">
+  <source media="(prefers-color-scheme: dark) and (max-width: 599px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-horizontal.svg">
+  <img alt="Axiom.co banner" src="https://axiom.co/assets/github/axiom-github-banner-dark-horizontal.svg" align="right">
+</picture>
+</a>
+&nbsp;
 
-## Setup
+Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
 
-```hcl
-module "forwarder" {
-  source        = "https://github.com/axiomhq/axiom-cloudwatch-forwarder/tree/main/modules/forwarder"
-  prefix        = "axiom-cloudwatch-forwarder"
-  axiom_dataset = "DATASET_NAME"
-  axiom_token   = "xaat-***"
-}
-```
+
+## Documentation
+
+For more information about how to set up and use the Axiom CloudWatch Forwarder, see the [Axiom documentation](https://axiom.co/docs/send-data/cloudwatch).
diff --git a/modules/listener/README.md b/modules/listener/README.md
@@ -1,14 +1,18 @@
-# Axiom Cloudwatch Forwarder - Listener
+# Axiom CloudWatch Forwarder Terraform Module
 
-This module sets up a lambda function that listens to Cloudwatch logs and subscribers the Axiom's Forwarder to these groups.
+<a href="https://axiom.co">
+<picture>
+  <source media="(prefers-color-scheme: dark) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-vertical.svg">
+  <source media="(prefers-color-scheme: light) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-dark-vertical.svg">
+  <source media="(prefers-color-scheme: dark) and (max-width: 599px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-horizontal.svg">
+  <img alt="Axiom.co banner" src="https://axiom.co/assets/github/axiom-github-banner-dark-horizontal.svg" align="right">
+</picture>
+</a>
+&nbsp;
 
-## Setup
+Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
 
-```hcl
-module "listener" {
-  source               = "https://github.com/axiomhq/axiom-cloudwatch-forwarder/tree/main/modules/listener"
-  prefix               = "axiom-cloudwatch-forwarder"
-  forwarder_lambda_arn = module.forwarder.lambda_arn
-  log_groups_prefix    = "/aws/lambda/"
-}
-```
+
+## Documentation
+
+For more information about how to set up and use the Axiom CloudWatch Forwarder, see the [Axiom documentation](https://axiom.co/docs/send-data/cloudwatch).
diff --git a/modules/subscriber/README.md b/modules/subscriber/README.md
@@ -1,15 +1,18 @@
-# Axiom Cloudwatch Forwarder - Subscriber
+# Axiom CloudWatch Forwarder Terraform Module
 
-Creates a Lambda function that subscribers the Forwarder to AWS Cloudwatch log groups.
+<a href="https://axiom.co">
+<picture>
+  <source media="(prefers-color-scheme: dark) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-vertical.svg">
+  <source media="(prefers-color-scheme: light) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-dark-vertical.svg">
+  <source media="(prefers-color-scheme: dark) and (max-width: 599px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-horizontal.svg">
+  <img alt="Axiom.co banner" src="https://axiom.co/assets/github/axiom-github-banner-dark-horizontal.svg" align="right">
+</picture>
+</a>
+&nbsp;
 
-## Setup
+Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
 
-```hcl
-module "subscriber" {
-  source               = "https://github.com/axiomhq/axiom-cloudwatch-forwarder/tree/main/modules/subscriber"
-  prefix               = "axiom-cloudwatch-forwarder"
-  axiom_dataset        = "DATASET_NAME"
-  log_groups_prefix    = "/aws/lambda/"
-  forwarder_lambda_arn = module.forwarder.lambda_arn
-}
-```
+
+## Documentation
+
+For more information about how to set up and use the Axiom CloudWatch Forwarder, see the [Axiom documentation](https://axiom.co/docs/send-data/cloudwatch).
diff --git a/modules/unsubscriber/README.md b/modules/unsubscriber/README.md
@@ -1,14 +1,18 @@
-# Axiom Cloudwatch Forwarder - Unubscriber
+# Axiom CloudWatch Forwarder Terraform Module
 
-Creates a Lambda function that removes log groups subscriptions from the Forwarder.
+<a href="https://axiom.co">
+<picture>
+  <source media="(prefers-color-scheme: dark) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-vertical.svg">
+  <source media="(prefers-color-scheme: light) and (min-width: 600px)" srcset="https://axiom.co/assets/github/axiom-github-banner-dark-vertical.svg">
+  <source media="(prefers-color-scheme: dark) and (max-width: 599px)" srcset="https://axiom.co/assets/github/axiom-github-banner-light-horizontal.svg">
+  <img alt="Axiom.co banner" src="https://axiom.co/assets/github/axiom-github-banner-dark-horizontal.svg" align="right">
+</picture>
+</a>
+&nbsp;
 
-## Setup
+Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
 
-```hcl
-module "unsubscriber" {
-  source               = "https://github.com/axiomhq/axiom-cloudwatch-forwarder/tree/main/modules/unsubscriber"
-  prefix               = "axiom-cloudwatch-forwarder"
-  log_groups_prefix    = "/aws/lambda/"
-  forwarder_lambda_arn = module.forwarder.lambda_arn
-}
-```
+
+## Documentation
+
+For more information about how to set up and use the Axiom CloudWatch Forwarder, see the [Axiom documentation](https://axiom.co/docs/send-data/cloudwatch).
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,8 @@ @@
     </a>
     &nbsp;
-    Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to forward logs from Amazon CloudWatch to [Axiom](https://axiom.co). It includes a Lambda function to handle the forwarding and stacks to create CloudWatch log group subscription filters for both existing and future log groups.
+    Axiom CloudWatch Forwarder Terraform module is a set of easy-to-use Terraform modules to install [Axiom Cloudwatch Forwarder](http://github.com/axiomhq/axiom-cloudwatch-forwarder).
     ## Documentation
@@ Expand Down @@