Skip to content

Commit 6ce73fd

Browse files
himsharma01himsharma01
committed
Updating READMEs
1 parent a8828e9 commit 6ce73fd

File tree

3 files changed

+36
-21
lines changed

3 files changed

+36
-21
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The modules configure/create the following resources:
3030
}
3131
sumologic = {
3232
source = "sumologic/sumologic"
33-
version = ">= 2.31.3, < 3.0.0"
33+
version = ">= 2.31.3, < 4.0.0"
3434
}
3535
jira = {
3636
source = "fourplusone/jira"

‎sumologic/README.md‎

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,35 +11,50 @@ This module is used to create Sumo Logic resource. Features include
1111

1212
| Name | Version |
1313
|------|---------|
14-
| terraform | >= 0.13.0 |
15-
| null | >= 2.1 |
16-
| sumologic | >= 2.9.0 |
14+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
15+
| <a name="requirement_null"></a> [null](#requirement\_null) | >= 2.1 |
16+
| <a name="requirement_sumologic"></a> [sumologic](#requirement\_sumologic) | >= 2.31.3, < 4.0.0 |
1717

1818
## Providers
1919

2020
| Name | Version |
2121
|------|---------|
22-
| null | >= 2.1 |
23-
| sumologic | >= 2.9.0 |
22+
| <a name="provider_null"></a> [null](#provider\_null) | >= 2.1 |
23+
| <a name="provider_sumologic"></a> [sumologic](#provider\_sumologic) | >= 2.31.3, < 4.0.0 |
24+
25+
## Modules
26+
27+
| Name | Source | Version |
28+
|------|--------|---------|
29+
| <a name="module_SumoLogicMonitors"></a> [SumoLogicMonitors](#module\_SumoLogicMonitors) | SumoLogic/sumo-logic-monitor/sumologic | n/a |
30+
31+
## Resources
32+
33+
| Name | Type |
34+
|------|------|
35+
| [null_resource.MetricRules](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
36+
| [sumologic_content.SumoLogicApps](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/content) | resource |
37+
| [sumologic_field.SumoLogicFields](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/field) | resource |
38+
| [sumologic_field_extraction_rule.SumoLogicFieldExtractionRules](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/field_extraction_rule) | resource |
2439

2540
## Inputs
2641

27-
| Name | Description | Type | Default | Required |
28-
|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|------|---------|:--------:|
29-
| access\_id | Sumo Logic Access ID. Visit https://help.sumologic.com/Manage/Security/Access-Keys#Create_an_access_key | `string` | n/a | yes |
30-
| access\_key | Sumo Logic Access Key. | `string` | n/a | yes |
31-
| environment | Enter au, ca, de, eu, fed, in, jp, kr, us1 or us2. Visit https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security | `string` | n/a | yes |
32-
| managed\_apps | The list of Application to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br> folder_id = string<br> content_json = string<br> }))</pre> | `{}` | no |
33-
| managed\_field\_extraction\_rules | The list of Field Extraction Rules to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br> name = string<br> parse_expression = string<br> scope = string<br> enabled = bool<br> }))</pre> | `{}` | no |
34-
| managed\_fields | The list of Fields to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br> field_name = string<br> data_type = string<br> state = bool<br> }))</pre> | `{}` | no |
35-
| managed\_metric\_rules | The list of metric rules to manage within the Sumo Logic AWS Observability solution. | <pre>map(object({<br> metric_rule_name = string<br> match_expression = string<br> sleep = number<br> variables_to_extract = list(object({<br> name = string<br> tagSequence = string<br> }))<br> }))</pre> | `{}` | no |
36-
| managed\_monitors | The list of Monitors to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br> monitor_name = string<br> monitor_description = string<br> monitor_monitor_type = string<br> monitor_parent_id = string<br> monitor_is_disabled = bool<br> queries = map(string)<br> triggers = list(object({<br> threshold_type = string<br> threshold = string<br> time_range = string<br> occurrence_type = string<br> trigger_source = string<br> trigger_type = string<br> detection_method = string<br> }))<br> connection_notifications = list(object(<br> {<br> connection_type = string,<br> connection_id = string,<br> payload_override = string,<br> run_for_trigger_types = list(string)<br> }<br> ))<br> email_notifications = list(object(<br> {<br> connection_type = string,<br> recipients = list(string),<br> subject = string,<br> time_zone = string,<br> message_body = string,<br> run_for_trigger_types = list(string)<br> }<br> ))<br> group_notifications = bool<br> }))</pre> | `{}` | no |
42+
| Name | Description | Type | Default | Required |
43+
|------|-------------|------|---------|:--------:|
44+
| <a name="input_access_id"></a> [access\_id](#input\_access\_id) | Sumo Logic Access ID. Visit https://help.sumologic.com/Manage/Security/Access-Keys#Create_an_access_key | `string` | n/a | yes |
45+
| <a name="input_access_key"></a> [access\_key](#input\_access\_key) | Sumo Logic Access Key. | `string` | n/a | yes |
46+
| <a name="input_environment"></a> [environment](#input\_environment) | Enter au, ca, de, eu, fed, in, jp, kr, us1 or us2. Visit https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security | `string` | n/a | yes |
47+
| <a name="input_managed_apps"></a> [managed\_apps](#input\_managed\_apps) | The list of Application to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br/> folder_id = string<br/> content_json = string<br/> }))</pre> | `{}` | no |
48+
| <a name="input_managed_field_extraction_rules"></a> [managed\_field\_extraction\_rules](#input\_managed\_field\_extraction\_rules) | The list of Field Extraction Rules to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br/> name = string<br/> parse_expression = string<br/> scope = string<br/> enabled = bool<br/> }))</pre> | `{}` | no |
49+
| <a name="input_managed_fields"></a> [managed\_fields](#input\_managed\_fields) | The list of Fields to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br/> field_name = string<br/> data_type = string<br/> state = bool<br/> }))</pre> | `{}` | no |
50+
| <a name="input_managed_metric_rules"></a> [managed\_metric\_rules](#input\_managed\_metric\_rules) | The list of metric rules to manage within the Sumo Logic AWS Observability solution. | <pre>map(object({<br/> metric_rule_name = string<br/> match_expression = string<br/> sleep = number<br/> variables_to_extract = list(object({<br/> name = string<br/> tagSequence = string<br/> }))<br/> }))</pre> | `{}` | no |
51+
| <a name="input_managed_monitors"></a> [managed\_monitors](#input\_managed\_monitors) | The list of Monitors to manage within the Sumo Logic AWS Observability Solution | <pre>map(object({<br/> monitor_name = string<br/> monitor_description = string<br/> monitor_monitor_type = string<br/> monitor_parent_id = string<br/> monitor_is_disabled = bool<br/> monitor_evaluation_delay = string<br/> queries = map(string)<br/> triggers = list(object({<br/> threshold_type = string<br/> threshold = string<br/> time_range = string<br/> occurrence_type = string<br/> trigger_source = string<br/> trigger_type = string<br/> detection_method = string<br/> }))<br/> connection_notifications = list(object(<br/> {<br/> connection_type = string,<br/> connection_id = string,<br/> payload_override = string,<br/> run_for_trigger_types = list(string)<br/> }<br/> ))<br/> email_notifications = list(object(<br/> {<br/> connection_type = string,<br/> recipients = list(string),<br/> subject = string,<br/> time_zone = string,<br/> message_body = string,<br/> run_for_trigger_types = list(string)<br/> }<br/> ))<br/> group_notifications = bool<br/> }))</pre> | `{}` | no |
3752

3853
## Outputs
3954

4055
| Name | Description |
4156
|------|-------------|
42-
| sumologic\_content | This output contains all the Apps. |
43-
| sumologic\_field | This output contains all the fields. |
44-
| sumologic\_field\_extraction\_rule | This output contains all the Field Extraction rules. |
45-
| sumologic\_metric\_rules | This output contains all the metric rules. |
57+
| <a name="output_sumologic_content"></a> [sumologic\_content](#output\_sumologic\_content) | This output contains all the Apps. |
58+
| <a name="output_sumologic_field"></a> [sumologic\_field](#output\_sumologic\_field) | This output contains all the fields. |
59+
| <a name="output_sumologic_field_extraction_rule"></a> [sumologic\_field\_extraction\_rule](#output\_sumologic\_field\_extraction\_rule) | This output contains all the Field Extraction rules. |
60+
| <a name="output_sumologic_metric_rules"></a> [sumologic\_metric\_rules](#output\_sumologic\_metric\_rules) | This output contains all the metric rules. |

‎sumologic/versions.tf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ terraform {
77
version = ">= 2.1"
88
}
99
sumologic = {
10-
version = ">= 2.31.3, < 3.0.0"
10+
version = ">= 2.31.3, < 4.0.0"
1111
source = "SumoLogic/sumologic"
1212
}
1313
}

0 commit comments

Comments
 (0)