From b9d95d97f57b01cc9b55c83d016af6c87b4a7466 Mon Sep 17 00:00:00 2001 From: Richard Joerger Date: Tue, 14 May 2024 14:05:21 +0000 Subject: [PATCH 1/3] docs: added valid options for mm config offset_syncs_topic_location takes a string of "source" or "target" but the docs did not reflect that. The config also lacks a default and that was not captured. This adds the valid options and the lack of a default --- docs/resources/mirrormaker_replication_flow.md | 2 +- .../sdkprovider/service/kafka/mirrormaker_replication_flow.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/resources/mirrormaker_replication_flow.md b/docs/resources/mirrormaker_replication_flow.md index f750498b7..cb03439b7 100644 --- a/docs/resources/mirrormaker_replication_flow.md +++ b/docs/resources/mirrormaker_replication_flow.md @@ -38,7 +38,7 @@ resource "aiven_mirrormaker_replication_flow" "f1" { ### Required - `enable` (Boolean) Enable of disable replication flows for a service. -- `offset_syncs_topic_location` (String) Offset syncs topic location. +- `offset_syncs_topic_location` (String) Offset syncs topic location. Possible values are `source` & `target`. There is no default value. - `project` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. - `replication_policy_class` (String) Replication policy class. The possible values are `org.apache.kafka.connect.mirror.DefaultReplicationPolicy` and `org.apache.kafka.connect.mirror.IdentityReplicationPolicy`. The default value is `org.apache.kafka.connect.mirror.DefaultReplicationPolicy`. - `service_name` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. diff --git a/internal/sdkprovider/service/kafka/mirrormaker_replication_flow.go b/internal/sdkprovider/service/kafka/mirrormaker_replication_flow.go index 830e30416..e1bf5c31e 100644 --- a/internal/sdkprovider/service/kafka/mirrormaker_replication_flow.go +++ b/internal/sdkprovider/service/kafka/mirrormaker_replication_flow.go @@ -104,7 +104,7 @@ var aivenMirrorMakerReplicationFlowSchema = map[string]*schema.Schema{ "offset_syncs_topic_location": { Type: schema.TypeString, Required: true, - Description: "Offset syncs topic location.", + Description: "Offset syncs topic location. Possible values are `source` & `target`. There is no default value.", ValidateFunc: validation.StringInSlice([]string{"source", "target"}, false), }, } From 4f8af1d7e0809dae93e8a89e5ee7630159011cdb Mon Sep 17 00:00:00 2001 From: Richard Joerger Date: Tue, 14 May 2024 10:12:53 -0500 Subject: [PATCH 2/3] docs: add missing doc string in mm datasource Adding in the missing docs line so its the same across the resouce and data source for mirrormaker_replication_flow --- docs/data-sources/mirrormaker_replication_flow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/data-sources/mirrormaker_replication_flow.md b/docs/data-sources/mirrormaker_replication_flow.md index 3a74ce62f..349f1f8f4 100644 --- a/docs/data-sources/mirrormaker_replication_flow.md +++ b/docs/data-sources/mirrormaker_replication_flow.md @@ -37,7 +37,7 @@ data "aiven_mirrormaker_replication_flow" "f1" { - `emit_heartbeats_enabled` (Boolean) Whether to emit heartbeats to the target cluster. The default value is `false`. - `enable` (Boolean) Enable of disable replication flows for a service. - `id` (String) The ID of this resource. -- `offset_syncs_topic_location` (String) Offset syncs topic location. +- `offset_syncs_topic_location` (String) Offset syncs topic location. Possible values are `source` & `target`. There is no default value. - `replication_policy_class` (String) Replication policy class. The possible values are `org.apache.kafka.connect.mirror.DefaultReplicationPolicy` and `org.apache.kafka.connect.mirror.IdentityReplicationPolicy`. The default value is `org.apache.kafka.connect.mirror.DefaultReplicationPolicy`. - `sync_group_offsets_enabled` (Boolean) Sync consumer group offsets. The default value is `false`. - `sync_group_offsets_interval_seconds` (Number) Frequency of consumer group offset sync. The default value is `1`. From 5052bbc21f97eaf0f9e3a122f282ccb7543b8020 Mon Sep 17 00:00:00 2001 From: Richard Joerger Date: Tue, 14 May 2024 10:27:52 -0500 Subject: [PATCH 3/3] docs: fixed extra spaces in mm replication docs git diff on push shows extra spaces. Have to remove them as `make docs` isn't working. --- docs/data-sources/mirrormaker_replication_flow.md | 2 +- docs/resources/mirrormaker_replication_flow.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/data-sources/mirrormaker_replication_flow.md b/docs/data-sources/mirrormaker_replication_flow.md index 349f1f8f4..f4164b6fb 100644 --- a/docs/data-sources/mirrormaker_replication_flow.md +++ b/docs/data-sources/mirrormaker_replication_flow.md @@ -37,7 +37,7 @@ data "aiven_mirrormaker_replication_flow" "f1" { - `emit_heartbeats_enabled` (Boolean) Whether to emit heartbeats to the target cluster. The default value is `false`. - `enable` (Boolean) Enable of disable replication flows for a service. - `id` (String) The ID of this resource. -- `offset_syncs_topic_location` (String) Offset syncs topic location. Possible values are `source` & `target`. There is no default value. +- `offset_syncs_topic_location` (String) Offset syncs topic location. Possible values are `source` & `target`. There is no default value. - `replication_policy_class` (String) Replication policy class. The possible values are `org.apache.kafka.connect.mirror.DefaultReplicationPolicy` and `org.apache.kafka.connect.mirror.IdentityReplicationPolicy`. The default value is `org.apache.kafka.connect.mirror.DefaultReplicationPolicy`. - `sync_group_offsets_enabled` (Boolean) Sync consumer group offsets. The default value is `false`. - `sync_group_offsets_interval_seconds` (Number) Frequency of consumer group offset sync. The default value is `1`. diff --git a/docs/resources/mirrormaker_replication_flow.md b/docs/resources/mirrormaker_replication_flow.md index cb03439b7..89a592703 100644 --- a/docs/resources/mirrormaker_replication_flow.md +++ b/docs/resources/mirrormaker_replication_flow.md @@ -38,7 +38,7 @@ resource "aiven_mirrormaker_replication_flow" "f1" { ### Required - `enable` (Boolean) Enable of disable replication flows for a service. -- `offset_syncs_topic_location` (String) Offset syncs topic location. Possible values are `source` & `target`. There is no default value. +- `offset_syncs_topic_location` (String) Offset syncs topic location. Possible values are `source` & `target`. There is no default value. - `project` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. - `replication_policy_class` (String) Replication policy class. The possible values are `org.apache.kafka.connect.mirror.DefaultReplicationPolicy` and `org.apache.kafka.connect.mirror.IdentityReplicationPolicy`. The default value is `org.apache.kafka.connect.mirror.DefaultReplicationPolicy`. - `service_name` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.