Update docs (#333)

* Update docs * fix
fivetran · Jul 16, 2024 · 8291445 · 8291445
1 parent 7065ab7
commit 8291445
Show file tree

Hide file tree

Showing 21 changed files with 2,526 additions and 2,535 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,58 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.2.3...HEAD)
+## [Unreleased](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.2.4...HEAD)
+
+## [1.2.4](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.2.3...v1.2.4)
+
+## Updated
+- Documentation on using fields `fivetran_connector.networking_method` and `fivetran_destination.networking_method` has been clarified
+- Added documentation on migration to version 1.1.18
+
+New connection services supported:
+- Supported service: `anvyl`
+- Supported service: `boostr`
+- Supported service: `cloudbeds`
+- Supported service: `databricks_db`
+- Supported service: `exact_online`
+- Supported service: `factbird`
+- Supported service: `invoiced`
+- Supported service: `medallia_agile_research`
+- Supported service: `rundeck`
+- Supported service: `sigma_computing_source`
+- Supported service: `smartrecruiters`
+- Supported service: `splash`
+- Supported service: `statistics_netherlands_cbs`
+- Supported service: `teamtailor`
+- Supported service: `xandr`
+- Supported service: `zoho_inventory`
+
+New connector config fields supported:
+- Added field `fivetran_connector.config.service_account_username` for services: `mixpanel`.
+- Added field `fivetran_connector.config.identifier` for services: `statistics_netherlands_cbs`.
+- Added field `fivetran_connector.config.property_id` for services: `cloudbeds`.
+- Added field `fivetran_connector.config.http_path` for services: `databricks_db`.
+- Added field `fivetran_connector.config.x_key` for services: `medallia_agile_research`.
+- Added field `fivetran_connector.config.type_name` for services: `akamai`, `bubbleio`.
+- Added field `fivetran_connector.config.quota_project_id` for services: `bigquery_db`.
+- Added field `fivetran_connector.config.skip_empty_reports` for services: `google_ads`.
+- Added field `fivetran_connector.config.x_master_key` for services: `medallia_agile_research`.
+- Added field `fivetran_connector.config.tenant_configs` for services: `reltio`.
+- Added field `fivetran_connector.config.snc_source_name` for services: `sap_hana_db`.
+- Added field `fivetran_connector.config.api_server` for services: `sigma_computing_source`.
+- Added field `fivetran_connector.config.rollback_window` for services: `appsflyer`.
+- Added field `fivetran_connector.config.private_token` for services: `eventbrite`.
+- Added field `fivetran_connector.config.service_account_secret` for services: `mixpanel`.
+- Added field `fivetran_connector.config.tenant_app_url` for services: `planful`.
+- Added field `fivetran_connector.config.catalog` for services: `databricks_db`.
+- Added field `fivetran_connector.config.access_id` for services: `planful`.
+- Added field `fivetran_connector.config.max_api_requests_per_day` for services: `reltio`.
+- Added field `fivetran_connector.config.snc_certificate_source` for services: `sap_hana_db`.
+- Added field `fivetran_connector.config.api_key` for services: `elastic_cloud`, `es_self_hosted`.
+
+New destination config fields supported:
+- Added field `fivetran_connector.config.snapshot_retention_period` for services: `adls`, `new_s3_datalake`, `onelake`.
+- Added field `fivetran_connector.config.table_format` for services: `new_s3_datalake`.
 
 ## [1.2.3](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.2.2...v1.2.3)
 
@@ -38,15 +89,15 @@ Updates to support management of local processing agents:
   - Added field `fivetran_connector.local_processing_agent_id`.
 
 - Resource `fivetran_destination` updates:
-  - Added field `fivetran_connector.local_processing_agent_id`.
-  - Added field `fivetran_connector.networking_method`.
+  - Added field `fivetran_destination.local_processing_agent_id`.
+  - Added field `fivetran_destination.networking_method`.
 
 - Datasource `fivetran_connector` updates:
   - Added field `fivetran_connector.local_processing_agent_id`.
 
 - Datasource `fivetran_destination` updates:
-  - Added field `fivetran_connector.local_processing_agent_id`.
-  - Added field `fivetran_connector.networking_method`.
+  - Added field `fivetran_destination.local_processing_agent_id`.
+  - Added field `fivetran_destination.networking_method`.
 
 - Resource `fivetran_connector_schema_config` reworked, added new validation logic and new field `validation_level`.
     - `fivetran_connector_schema_config.validation_level` allows to setup desired level of schema validation before apply

diff --git a/auth-changes.txt b/auth-changes.txt
diff --git a/config-changes.txt b/config-changes.txt
diff --git a/destinatino-config-changes.txt b/destinatino-config-changes.txt
@@ -0,0 +1,2 @@
+- Added field `fivetran_connector.config.snapshot_retention_period` for services: `adls`, `new_s3_datalake`, `onelake`.
+- Added field `fivetran_connector.config.table_format` for services: `new_s3_datalake`.
diff --git a/docs/data-sources/connector.md b/docs/data-sources/connector.md
@@ -32,7 +32,7 @@ data "fivetran_connector" "connector" {
 - `group_id` (String) The unique identifier for the Group (Destination) within the Fivetran system.
 - `local_processing_agent_id` (String) The local processing agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
 - `name` (String) The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination.
-- `networking_method` (String) Possible values: Directly, PrivateLink, SshTunnel, ProxyAgent.
+- `networking_method` (String) Possible values: Directly, SshTunnel, ProxyAgent.
 - `pause_after_trial` (Boolean) Specifies whether the connector should be paused after the free trial period has ended.
 - `paused` (Boolean) Specifies whether the connector is paused.
 - `proxy_agent_id` (String) The proxy agent ID.

diff --git a/docs/data-sources/destination.md b/docs/data-sources/destination.md
@@ -27,7 +27,7 @@ data "fivetran_destination" "dest" {
 - `daylight_saving_time_enabled` (Boolean) Shift my UTC offset with daylight savings time (US Only)
 - `group_id` (String) The unique identifier for the Group within the Fivetran system.
 - `local_processing_agent_id` (String) The local processing agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
-- `networking_method` (String) Possible values: Directly, PrivateLink, SshTunnel, ProxyAgent.
+- `networking_method` (String) Possible values: Directly, SshTunnel, ProxyAgent.
 - `region` (String) Data processing location. This is where Fivetran will operate and run computation on data.
 - `service` (String) The destination type id within the Fivetran system.
 - `setup_status` (String) Destination setup status.

diff --git a/docs/guides/version_update_guides.md → docs/guides/version_0.7.2_update_guides.md b/docs/guides/version_update_guides.md → docs/guides/version_0.7.2_update_guides.md
diff --git a/docs/guides/version_1.1.18_update_guides.md b/docs/guides/version_1.1.18_update_guides.md
@@ -0,0 +1,98 @@
+----
+page_title: "Version Update 1.1.18"
+subcategory: "Upgrade Guides"
+---
+
+# Version 1.1.18
+
+## What's new in 1.1.18
+
+In version `1.1.18` of Fivetran Terraform provider, resource `fivetran_connector_schema_config` behavior changed:
+- If no columns settings specified in `table.columns` no settings will be applied. If table enabled - columns won't be blocked automatically by `BLOCK_ALL` policy.
+- Settings for sub-elements won't be managed if root element disabled: for `BLOCK_ALL` policy for disabled schema no settings for tables/columns will be applied.
+
+## Migration guide
+
+### Provider 
+
+Update your provider configuration in the following way:
+
+Previous configuration:
+
+```hcl
+required_providers {
+   fivetran = {
+     version = "~> 1.1.17"
+     source  = "fivetran/fivetran"                
+   }
+ }
+```
+
+Updated configuration:
+
+```hcl
+required_providers {
+   fivetran = {
+     version = ">= 1.1.18"
+     source  = "fivetran/fivetran"                
+   }
+ }
+```
+
+### Resource `fivetran_connector_schema_config`
+
+Update all your connector schema config resources (`fivetran_connector_schema_config`):
+
+Previous configuration:
+
+```hcl
+resource "fivetran_connector_schema_config" "test_schema" {
+  connector_id = "connector_id"
+  schema_change_handling = "ALLOW_ALL"
+  
+  schema {
+    name = "schema_name"
+    table {
+      name = "table_name"
+      sync_mode = "HISTORY"
+      column {
+        name = "hashed_column_name"
+        hashed = "true"
+      }
+    }
+  }
+}
+```
+
+Updated configuration:
+
+```hcl
+resource "fivetran_connector_schema_config" "test_schema" {
+  connector_id = "connector_id"
+  schema_change_handling = "ALLOW_ALL"
+
+  schemas = {
+    "schema_name" = {
+      tables = {
+        "table_name" = {
+          sync_mode = "HISTORY"
+          columns = {
+            "hashed_column_name" = {
+              hashed = true
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+```
+
+### Update terraform state
+
+Once all configurations have been updated, run:
+
+```
+terraform init -upgrade
+```
diff --git a/docs/resources/connector.md b/docs/resources/connector.md
@@ -71,7 +71,7 @@ resource "fivetran_connector" "amplitude" {
 - `config` (Block, Optional) (see [below for nested schema](#nestedblock--config))
 - `destination_schema` (Block, Optional) (see [below for nested schema](#nestedblock--destination_schema))
 - `local_processing_agent_id` (String) The local processing agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
-- `networking_method` (String) Possible values: Directly, PrivateLink, SshTunnel, ProxyAgent.
+- `networking_method` (String) Possible values: Directly, SshTunnel, ProxyAgent.
 - `proxy_agent_id` (String) The proxy agent ID.
 - `run_setup_tests` (Boolean) Specifies whether the setup tests should be run automatically. The default value is TRUE.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

diff --git a/docs/resources/destination.md b/docs/resources/destination.md
@@ -45,7 +45,7 @@ resource "fivetran_destination" "dest" {
 - `config` (Block, Optional) (see [below for nested schema](#nestedblock--config))
 - `daylight_saving_time_enabled` (Boolean) Shift my UTC offset with daylight savings time (US Only)
 - `local_processing_agent_id` (String) The local processing agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
-- `networking_method` (String) Possible values: Directly, PrivateLink, SshTunnel, ProxyAgent.
+- `networking_method` (String) Possible values: Directly, SshTunnel, ProxyAgent.
 - `run_setup_tests` (Boolean) Specifies whether the setup tests should be run automatically. The default value is TRUE.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 - `trust_certificates` (Boolean) Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Added field `fivetran_connector.config.snapshot_retention_period` for services: `adls`, `new_s3_datalake`, `onelake`.
		- Added field `fivetran_connector.config.table_format` for services: `new_s3_datalake`.