Skip to content

Commit

Permalink
docs(lts): fix and adjust the lts document descriptions (#5298)
Browse files Browse the repository at this point in the history
  • Loading branch information
Lance52259 authored Aug 2, 2024
1 parent 7525941 commit 257b0e4
Show file tree
Hide file tree
Showing 19 changed files with 87 additions and 72 deletions.
3 changes: 2 additions & 1 deletion docs/data-sources/lts_structuring_custom_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_structuring_custom_templates"
description: ""
description: |-
Use this data source to get the list of LTS structuring custom templates.
---

# huaweicloud_lts_structuring_custom_templates
Expand Down
5 changes: 3 additions & 2 deletions docs/resources/lts_aom_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_aom_access"
description: ""
description: |-
Manages an AOM to LTS log mapping rule resource within HuaweiCloud.
---

# huaweicloud_lts_aom_access
Expand Down Expand Up @@ -110,7 +111,7 @@ The following arguments are supported:
* `region` - (Optional, String, ForceNew) Specifies the region in which to create the resource.
If omitted, the provider-level region will be used. Changing this parameter will create a new resource.

* `name` - (Required, String) Specifies the unique rule name. The name consists of 1 to 100 characters,
* `name` - (Required, String) Specifies the unique rule name. The name consists of `1` to `100` characters,
including letters, digits, underscores (_), hyphens (-) and dots (.).

* `cluster_id` - (Required, String) Specifies the CCE or CCI cluster ID. It is fixed to **CCI-ClusterID** for CCI.
Expand Down
7 changes: 4 additions & 3 deletions docs/resources/lts_cce_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_cce_access"
description: ""
description: |-
Manages an LTS CCE access resource within HuaweiCloud.
---

# huaweicloud_lts_cce_access
Expand Down Expand Up @@ -130,7 +131,7 @@ The following arguments are supported:

* `tags` - (Optional, Map) Specifies the key/value pairs to associate with the CCE access.

* `binary_collect` - (Optional, Bool) Specifies whether collect in binary format. Default is false.
* `binary_collect` - (Optional, Bool) Specifies whether collect in binary format. Default is **false**.

* `log_split` - (Optional, Bool) Specifies whether to split log. Default is false.

Expand Down Expand Up @@ -163,7 +164,7 @@ The `access_config` block supports:

* `stdout` - (Optional, Bool) Specifies whether output is standard. Default is false.

* `stderr` - (Optional, Bool) Specifies whether error output is standard. Default is false.
* `stderr` - (Optional, Bool) Specifies whether error output is standard. Default is **false**.

-> If the value of `path_type` is **container_stdout**, `stdout` or `stderr` must be **true**.

Expand Down
3 changes: 2 additions & 1 deletion docs/resources/lts_cross_account_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_cross_account_access"
description: ""
description: |-
Manages an LTS cross account access resource within HuaweiCloud.
---

# huaweicloud_lts_cross_account_access
Expand Down
12 changes: 7 additions & 5 deletions docs/resources/lts_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_group"
description: ""
description: |-
Manages a log group resource within HuaweiCloud.
---

# huaweicloud_lts_group
Expand All @@ -12,7 +13,7 @@ Manages a log group resource within HuaweiCloud.
## Example Usage

```hcl
resource "huaweicloud_lts_group" "log_group1" {
resource "huaweicloud_lts_group" "test" {
group_name = "log_group1"
ttl_in_days = 30
}
Expand All @@ -28,7 +29,8 @@ The following arguments are supported:
* `group_name` - (Required, String, ForceNew) Specifies the log group name. Changing this parameter will create a new
resource.

* `ttl_in_days` - (Required, Int) Specifies the log expiration time(days), value range: 1-365.
* `ttl_in_days` - (Required, Int) Specifies the log expiration time(days).
The value is range from `1` to `365`.

* `tags` - (Optional, Map) Specifies the key/value pairs to associate with the log group.

Expand All @@ -44,6 +46,6 @@ In addition to all arguments above, the following attributes are exported:

The log group can be imported using the `id`, e.g.

```
$ terraform import huaweicloud_lts_group.group_1 7117d38e-4c8f-4624-a505-bd96b97d024c
```bash
$ terraform import huaweicloud_lts_group.test <id>
```
13 changes: 7 additions & 6 deletions docs/resources/lts_host_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_host_access"
description: ""
description: |-
Manages an LTS host access resource within HuaweiCloud.
---

# huaweicloud_lts_host_access
Expand Down Expand Up @@ -40,7 +41,7 @@ The following arguments are supported:
* `region` - (Optional, String, ForceNew) Specifies the region in which to create the resource.
If omitted, the provider-level region will be used. Changing this parameter will create a new resource.

* `name` - (Required, String, ForceNew) Specifies the host access name. The name consists of 1 to 64 characters.
* `name` - (Required, String, ForceNew) Specifies the host access name. The name consists of `1` to `64` characters.
Only letters, digits, underscores (_), and periods (.) are allowed, and the period cannot be the first or last character.
Changing this parameter will create a new resource.

Expand Down Expand Up @@ -134,9 +135,9 @@ The `windows_log_info` block supports:
* `time_offset` - (Required, Int) Specifies the collection time offset. This time takes effect only for the first
time to ensure that the logs are not collected repeatedly.

+ When `time_offset_unit` is set to **day**, the value ranges from 1 to 7 days.
+ When `time_offset_unit` is set to **hour**, the value ranges from 1 to 168 hours.
+ When `time_offset_unit` is set to **sec**, the value ranges from 1 to 604800 seconds.
+ When `time_offset_unit` is set to **day**, the value ranges from `1` to `7` days.
+ When `time_offset_unit` is set to **hour**, the value ranges from `1` to `168` hours.
+ When `time_offset_unit` is set to **sec**, the value ranges from `1` to `604,800` seconds.

## Attribute Reference

Expand All @@ -155,5 +156,5 @@ In addition to all arguments above, the following attributes are exported:
The host access can be imported using the `name`, e.g.

```bash
$ terraform import huaweicloud_lts_host_access.test access-demo
$ terraform import huaweicloud_lts_host_access.test <name>
```
14 changes: 7 additions & 7 deletions docs/resources/lts_host_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_host_group"
description: ""
description: |-
Manages an LTS host group resource within HuaweiCloud.
---

# huaweicloud_lts_host_group
Expand All @@ -13,15 +14,14 @@ Manages an LTS host group resource within HuaweiCloud.

```hcl
variable "group_name" {}
variable "host_id_1" {}
variable "host_id_2" {}
variable "host_ids" {
type = list(string)
}
resource "huaweicloud_lts_host_group" "test" {
name = var.group_name
type = "linux"
host_ids = [
var.host_id_1, var.host_id_2
]
host_ids = var.host_ids
tags = {
foo = "bar"
Expand Down Expand Up @@ -63,5 +63,5 @@ In addition to all arguments above, the following attributes are exported:
The host group can be imported using the `id`, e.g.

```bash
$ terraform import huaweicloud_lts_host_group.test 020f77b3-765a-4f4c-8d67-c5de35576d14
$ terraform import huaweicloud_lts_host_group.test <id>
```
5 changes: 3 additions & 2 deletions docs/resources/lts_keywords_alarm_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_keywords_alarm_rule"
description: ""
description: |-
Manages an LTS keywords alarm rule resource within HuaweiCloud.
---

# huaweicloud_lts_keywords_alarm_rule
Expand Down Expand Up @@ -178,7 +179,7 @@ In addition to all arguments above, the following attributes are exported:
The keywords alarm rule can be imported using the `id`, e.g.

```bash
$ terraform import huaweicloud_lts_keywords_alarm_rule.test ed8a4e02-b017-4c22-919d-8877b10cf505
$ terraform import huaweicloud_lts_keywords_alarm_rule.test <id>
```

Note that the imported state may not be identical to your resource definition, due to some attributes missing from the
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/lts_log_converge.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The `log_stream_config` block supports:

* `target_log_stream_id` - (Optional, String) Specifies the ID of the log stream for source side.

-> If you want to use an existing log group, this parameter (`target_log_stream_id`) is required.
-> If you want to use an existing log stream, this parameter (`target_log_stream_id`) is required.

## Attribute Reference

Expand Down
3 changes: 2 additions & 1 deletion docs/resources/lts_log_converge_switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_log_converge_switch"
description: ""
description: |-
Using this resource to enable the LTS log receiving status within HuaweiCloud.
---

# huaweicloud_lts_log_converge_switch
Expand Down
3 changes: 2 additions & 1 deletion docs/resources/lts_notification_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_notification_template"
description: ""
description: |-
Manages an LTS notification template resource within HuaweiCloud.
---

# huaweicloud_lts_notification_template
Expand Down
5 changes: 3 additions & 2 deletions docs/resources/lts_search_criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_search_criteria"
description: ""
description: |-
Manages an LTS search criteria resource within HuaweiCloud.
---

# huaweicloud_lts_search_criteria
Expand Down Expand Up @@ -60,7 +61,7 @@ In addition to all arguments above, the following attributes are exported:

## Import

The search criteria can be imported using the group ID, stream ID, and resource ID separated by a slash, e.g.
The search criteria can be imported using the group ID, stream ID, and resource ID separated by the slashes, e.g.

```bash
$ terraform import huaweicloud_lts_search_criteria.test <log_group_id>/<log_stream_id>/<id>
Expand Down
5 changes: 3 additions & 2 deletions docs/resources/lts_sql_alarm_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_sql_alarm_rule"
description: ""
description: |-
Manages an LTS SQL alarm rule resource within HuaweiCloud.
---

# huaweicloud_lts_sql_alarm_rule
Expand Down Expand Up @@ -179,7 +180,7 @@ In addition to all arguments above, the following attributes are exported:
The sql alarm rule can be imported using the `id`, e.g.

```bash
$ terraform import huaweicloud_lts_sql_alarm_rule.test ed8a4e02-b017-4c22-919d-8877b10cf505
$ terraform import huaweicloud_lts_sql_alarm_rule.test <id>
```

Note that the imported state may not be identical to your resource definition, due to some attributes missing from the
Expand Down
30 changes: 14 additions & 16 deletions docs/resources/lts_stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_stream"
description: ""
description: |-
Manage a log stream resource within HuaweiCloud.
---

# huaweicloud_lts_stream
Expand All @@ -12,13 +13,10 @@ Manage a log stream resource within HuaweiCloud.
## Example Usage

```hcl
resource "huaweicloud_lts_group" "test_group" {
group_name = "test_group"
ttl_in_days = 1
}
variable "group_id" {}
resource "huaweicloud_lts_stream" "test_stream" {
group_id = huaweicloud_lts_group.test_group.id
resource "huaweicloud_lts_stream" "test" {
group_id = var.group_id
stream_name = "testacc_stream"
}
```
Expand Down Expand Up @@ -59,7 +57,7 @@ In addition to all arguments above, the following attributes are exported:
The log stream can be imported using the group ID and stream ID separated by a slash, e.g.

```bash
$ terraform import huaweicloud_lts_stream.stream_1 <group_id>/<stream_id>
$ terraform import huaweicloud_lts_stream.test <group_id>/<id>
```

Note that the imported state may not be identical to your resource definition, due to `ttl_in_days` attribute missing
Expand All @@ -68,12 +66,12 @@ You can then decide if changes should be applied to the resource, or the resourc
align with the resource. Also you can ignore changes as below.

```
resource "huaweicloud_lts_stream" "stream_1" {
...
lifecycle {
ignore_changes = [
ttl_in_days,
]
}
resource "huaweicloud_lts_stream" "test" {
...
lifecycle {
ignore_changes = [
ttl_in_days,
]
}
}
11 changes: 6 additions & 5 deletions docs/resources/lts_struct_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Manage a log structuring template resource within HuaweiCloud.
variable "group_id" {}
variable "stream_id" {}
resource "huaweicloud_lts_struct_template" "template_1" {
resource "huaweicloud_lts_struct_template" "test" {
log_group_id = var.group_id
log_stream_id = var.stream_id
template_type = "built_in"
Expand All @@ -33,7 +33,7 @@ resource "huaweicloud_lts_struct_template" "template_1" {
variable "group_id" {}
variable "stream_id" {}
resource "huaweicloud_lts_struct_template" "template_1" {
resource "huaweicloud_lts_struct_template" "test" {
log_group_id = var.group_id
log_stream_id = var.stream_id
template_type = "custom"
Expand Down Expand Up @@ -70,8 +70,9 @@ In addition to all arguments above, the following attributes are exported:

## Import

The structuring templates can be imported using the template ID, lts group ID and stream ID separated by a slash, e.g.
The structuring templates can be imported using the template ID, lts group ID and stream ID separated by the slashes,
e.g.

```
$ terraform import huaweicloud_lts_struct_template.demo_1 2f148a75-acd3-4ce7-8f63-d5c9fadab3a0/393f2bfd-2244-11ea-adb7-286ed488c87f/72855918-20b1-11ea-80e0-286ed488c880
```bash
$ terraform import huaweicloud_lts_struct_template.test <id>/<log_group_id>/<log_stream_id>
```
3 changes: 2 additions & 1 deletion docs/resources/lts_structing_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_structing_template"
description: ""
description: |-
Manages an LTS structuring configuration resource within HuaweiCloud.
---

# huaweicloud_lts_structing_template
Expand Down
3 changes: 2 additions & 1 deletion docs/resources/lts_structuring_custom_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
subcategory: "Log Tank Service (LTS)"
layout: "huaweicloud"
page_title: "HuaweiCloud: huaweicloud_lts_structuring_custom_configuration"
description: ""
description: |-
Manages an LTS structuring custom configuration resource within HuaweiCloud.
---

# huaweicloud_lts_structuring_custom_configuration
Expand Down
Loading

0 comments on commit 257b0e4

Please sign in to comment.