Skip to content
This repository was archived by the owner on Sep 12, 2023. It is now read-only.

Commit 9e51b08

Browse files
committed
modules are now in the registry
1 parent cedb739 commit 9e51b08

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,25 @@ Jump Starts are [CloudFormation templates](https://github.com/marbot-io/monitori
88

99
At the moment, you can monitor:
1010

11-
| Monitoring goal | Module Source |
12-
| -------------------- | ------------------------------------------------------------------------------------- |
13-
| AWS basics | `git::https://github.com/marbot-io/monitoring-jump-start-tf.git//modules/basic` |
14-
| RDS cluster (Aurora) | `git::https://github.com/marbot-io/monitoring-jump-start-tf.git//modules/rds-cluster` |
11+
| Monitoring goal | Terraform registry |
12+
| -------------------- | ----------------------------------------------------------------------------- |
13+
| AWS basics | https://registry.terraform.io/modules/marbot-io/marbot-monitoring-basic |
14+
| RDS cluster (Aurora) | https://registry.terraform.io/modules/marbot-io/marbot-monitoring-rds-cluster |
1515

1616
## Usage
1717

18+
> This example connects you to all relevant sources of errors, warnings, and notifications published by AWS services, and forwards them to Slack managed by marbot.
19+
1820
1. Create a new directory
1921
2. Within the new directory, create a file `main.tf` with the following content:
2022
```
2123
provider "aws" {}
2224
23-
module "basic" {
24-
source = "git::https://github.com/marbot-io/monitoring-jump-start-tf.git//modules/basic"
25+
module "marbot-monitoring-basic" {
26+
source = "marbot-io/marbot-monitoring-basic/aws"
27+
#version = "x.y.z" # we recommend to pin the version
2528
26-
endpoint_id = "" # to get this value: select a Slack channel where marbot belongs to and send a message like this: "@marbot show me my endpoint id"
29+
endpoint_id = "" # to get this value, select a Slack channel where marbot belongs to and send a message like this: "@marbot show me my endpoint id"
2730
budget_threshold = 10 # in USD (optional)
2831
}
2932
```
@@ -35,14 +38,15 @@ terraform apply
3538

3639
## Update procedure
3740

38-
Run the following commands:
41+
1. Update the modules's `version` to the latest version
42+
2. Run the following commands:
3943
```
40-
terraform init -upgrade
44+
terraform get
4145
terraform apply
4246
```
4347

4448
## License
45-
All templates are published under Apache License Version 2.0.
49+
All modules are published under Apache License Version 2.0.
4650

4751
## About
4852
A [marbot.io](https://marbot.io/) project. Engineered by [widdix](https://widdix.net).

0 commit comments

Comments
 (0)