Skip to content

Commit b7e71e1

Browse files
bansal01yashbansal01yash
committed
integration and related resources doc improvements
1 parent cf43d9d commit b7e71e1

10 files changed

+36
-26
lines changed

‎docs/resources/associate_metrics_exporter_cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
page_title: "ybm_associate_metrics_exporter_cluster Resource - YugabyteDB Aeon"
33
description: |-
4-
The resource to manage metrics export configuration for a cluster in YugabyteDB Aeon.
4+
The resource to associate export configurations created using the ybm_integration resource to clusters for exporting metrics.
55
---
66

77
# ybm_associate_metrics_exporter_cluster (Resource)
88

9-
The resource to manage metrics export configuration for a cluster in YugabyteDB Aeon.
9+
The resource to associate export configurations created using the `ybm_integration` resource to clusters for exporting metrics.
1010

1111

1212
## Example Usage

‎docs/resources/cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ resource "ybm_private_service_endpoint" "npsenonok-region" {
616616
- `cluster_allow_list_ids` (List of String) List of IDs of the allow lists assigned to the cluster.
617617
- `cmk_spec` (Attributes) KMS Provider Configuration. (see [below for nested schema](#nestedatt--cmk_spec))
618618
- `database_track` (String) The track of the database. Production or Innovation or Preview.
619-
- `desired_state` (String) The desired state of the database, Active or Paused. This parameter can be used to pause/resume a cluster.
619+
- `desired_state` (String) The desired state of the cluster, Active or Paused. This parameter can be used to pause/resume a cluster.
620620
- `fault_tolerance` (String) The fault tolerance of the cluster. NONE, NODE, ZONE or REGION.
621621
- `node_config` (Attributes, Deprecated) (see [below for nested schema](#nestedatt--node_config))
622622
- `num_faults_to_tolerate` (Number) The number of domain faults the cluster can tolerate. 0 for NONE, 1 for ZONE and [1-3] for NODE and REGION

‎docs/resources/db_audit_logging.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
page_title: "ybm_db_audit_logging Resource - ybm"
44
subcategory: ""
55
description: |-
6-
The resource to manage DB Audit log configuration for a cluster in YugabyteDB Aeon.
6+
The resource to manage DB Audit log configuration for a cluster
7+
This resource manages the association between the cluster and export configuration created using resource ybm_integration, specifying the parameters and rules for logging
78
---
89

910
# ybm_db_audit_logging (Resource)
1011

11-
The resource to manage DB Audit log configuration for a cluster in YugabyteDB Aeon.
12+
The resource to manage DB Audit log configuration for a cluster
13+
This resource manages the association between the cluster and export configuration created using resource `ybm_integration`, specifying the parameters and rules for logging
1214

1315
## Example Usage
1416

‎docs/resources/db_query_logging.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
page_title: "ybm_db_query_logging Resource - ybm"
44
subcategory: ""
55
description: |-
6-
The resource to manage DB query logging configuration for a cluster in YugabyteDB Aeon.
6+
The resource to manage DB query log configuration for a cluster
7+
This resource manages the association between the cluster and export configuration created using resource ybm_integration, specifying the parameters and rules for logging
78
---
89

910
# ybm_db_query_logging (Resource)
1011

11-
The resource to manage DB query logging configuration for a cluster in YugabyteDB Aeon.
12+
The resource to manage DB query log configuration for a cluster
13+
This resource manages the association between the cluster and export configuration created using resource `ybm_integration`, specifying the parameters and rules for logging
1214

1315

1416

‎docs/resources/integration.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
---
22
page_title: "ybm_integration Resource - YugabyteDB Aeon"
33
description: |-
4-
The resource to create an export configuration for the integration you want to use in YugabyteDB Aeon.
5-
Using the configuration you created, connect to your cluster:
6-
- Export metrics using resource ybm_associate_metrics_exporter_cluster
4+
Use this resource to create export configurations. Export configurations define parameters for connecting to third party tools, such as Datadog, for exporting cluster metrics and logs.
5+
To use an export configuration, assign it to a cluster using the following resources:
6+
-Export metrics using resource ybm_associate_metrics_exporter_cluster
7+
-Export query logs using resource ybm_db_query_logging
8+
-Export audit logs using resource ybm_db_audit_logging
79
---
810

911
# ybm_integration (Resource)
1012

11-
The resource to create an export configuration for the integration you want to use in YugabyteDB Aeon.
12-
13-
Using the configuration you created, connect to your cluster:
14-
- Export metrics using resource `ybm_associate_metrics_exporter_cluster`
13+
Use this resource to create export configurations. Export configurations define parameters for connecting to third party tools, such as Datadog, for exporting cluster metrics and logs.
14+
To use an export configuration, assign it to a cluster using the following resources:
15+
-Export metrics using resource `ybm_associate_metrics_exporter_cluster`
16+
-Export query logs using resource `ybm_db_query_logging`
17+
-Export audit logs using resource `ybm_db_audit_logging`
1518

1619

1720
## Example Usage

‎managed/resource_associate_me_cluster.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ type resourceAssociateMetricsExporterClusterType struct{}
2020

2121
func (r resourceAssociateMetricsExporterClusterType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
2222
return tfsdk.Schema{
23-
Description: `The resource to manage metrics export configuration for a cluster in YugabyteDB Aeon.`,
23+
Description: "The resource to associate export configurations created using the `ybm_integration` resource to clusters for exporting metrics.",
2424
Attributes: map[string]tfsdk.Attribute{
2525
"account_id": {
2626
Description: "ID of the account this metrics export configuration belongs to.",

‎managed/resource_cluster.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ func (r resourceClusterType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Di
499499
Computed: true,
500500
},
501501
"desired_state": {
502-
Description: "The desired state of the database, Active or Paused. This parameter can be used to pause/resume a cluster.",
502+
Description: "The desired state of the cluster, Active or Paused. This parameter can be used to pause/resume a cluster.",
503503
Type: types.StringType,
504504
Optional: true,
505505
Computed: true,

‎managed/resource_db_audit_logging.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ var validStatementClasses = []string{
2929

3030
func (r resourceDbAuditLoggingType) GetSchema(ctx context.Context) (tfsdk.Schema, diag.Diagnostics) {
3131
return tfsdk.Schema{
32-
Description: `The resource to manage DB Audit log configuration for a cluster in YugabyteDB Aeon.`,
33-
Attributes: map[string]tfsdk.Attribute{
32+
Description: "The resource to manage DB Audit log configuration for a cluster\n"+
33+
"This resource manages the association between the cluster and export configuration created using resource `ybm_integration`, specifying the parameters and rules for logging",
34+
Attributes: map[string]tfsdk.Attribute{
3435
"account_id": {
3536
Description: "ID of the account this DB Audit log configuration belongs to.",
3637
Type: types.StringType,

‎managed/resource_db_query_logging.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ type resourceDbQueryLoggingType struct{}
2121

2222
func (r resourceDbQueryLoggingType) GetSchema(ctx context.Context) (tfsdk.Schema, diag.Diagnostics) {
2323
return tfsdk.Schema{
24-
Description: `The resource to manage DB query logging configuration for a cluster in YugabyteDB Aeon.`,
24+
Description: "The resource to manage DB query log configuration for a cluster\n"+
25+
"This resource manages the association between the cluster and export configuration created using resource `ybm_integration`, specifying the parameters and rules for logging",
2526
Attributes: map[string]tfsdk.Attribute{
2627
"integration_name": {
2728
Description: "Name of the integration for this DB query logging configuration.",

‎managed/resource_integration.go

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@ import (
2323
type resourceIntegrationType struct{}
2424

2525
func (r resourceIntegrationType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
26-
return tfsdk.Schema{
27-
Description: `The resource to create an export configuration for the integration you want to use in YugabyteDB Aeon.
28-
29-
Using the configuration you created, connect to your cluster:
30-
- Export metrics using resource ` + "`ybm_associate_metrics_exporter_cluster`",
31-
Attributes: r.getSchemaAttributes(),
32-
}, nil
26+
return tfsdk.Schema{
27+
Description: "Use this resource to create export configurations. Export configurations define parameters for connecting to third party tools, such as Datadog, for exporting cluster metrics and logs.\n" +
28+
"To use an export configuration, assign it to a cluster using the following resources:\n" +
29+
"-Export metrics using resource `ybm_associate_metrics_exporter_cluster`\n" +
30+
"-Export query logs using resource `ybm_db_query_logging`\n" +
31+
"-Export audit logs using resource `ybm_db_audit_logging`",
32+
Attributes: r.getSchemaAttributes(),
33+
}, nil
3334
}
3435

3536
func (r resourceIntegrationType) getSchemaAttributes() map[string]tfsdk.Attribute {

0 commit comments

Comments
 (0)