Skip to content

Commit

Permalink
Rename LPA to HDA (#372)
Browse files Browse the repository at this point in the history
  • Loading branch information
fivetran-aleksandrboldyrev authored Nov 12, 2024
1 parent 62dc137 commit 6514d6a
Show file tree
Hide file tree
Showing 46 changed files with 1,703 additions and 250 deletions.
15 changes: 13 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ 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.4.1...HEAD)
## [Unreleased](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.4.0...HEAD)

## [1.4.1](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.4.0...v1.4.1)
## [1.4.0](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.3.2...v1.4.0)

## Added
- New resource `fivetran_private_link` that allows to manage Private Links.
Expand All @@ -27,6 +27,17 @@ Updates to support management of private links:
- Datasource `fivetran_destination` updates:
- Added field `fivetran_destination.private_link_id`.

## Updated
In connection with the general availability of the hybrid deployment functionality and in order to synchronize internal terminology, we have implemented new resources and datasources to replace the deprecated ones. The deprecated resources will be removed in version 1.5.0

- New resource `fivetran_hybrid_deployment_agent` instead of deprecated `fivetran_local_processing_agent`
- New data source `fivetran_hybrid_deployment_agent` instead of deprecated `fivetran_local_processing_agent`.
- New data source `fivetran_hybrid_deployment_agents` instead of deprecated `fivetran_local_processing_agents`.
- New field `fivetran_connector.hybrid_deployment_id` instead of deprecated `fivetran_connector.local_processing_agent_id`.
- New field `fivetran_destination.hybrid_deployment_id` instead of deprecated `fivetran_destination.local_processing_agent_id`.

Old fields and resources are marked as Deprecated, please follow the migration guide to update the schema

## [1.3.2](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.3.1...v1.3.2)

## Added
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ data "fivetran_connector" "connector" {
- `destination_schema` (Block, Read-only) (see [below for nested schema](#nestedblock--destination_schema))
- `failed_at` (String) The timestamp of the time the connector sync failed last time.
- `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.
- `hybrid_deployment_agent_id` (String) The hybrid deployment 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.
- `local_processing_agent_id` (String) (Deprecated) The hybrid deployment 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, SshTunnel, ProxyAgent.
- `pause_after_trial` (Boolean) Specifies whether the connector should be paused after the free trial period has ended.
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ data "fivetran_destination" "dest" {
- `config` (Block, Read-only) (see [below for nested schema](#nestedblock--config))
- `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.
- `hybrid_deployment_agent_id` (String) The hybrid deployment 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.
- `local_processing_agent_id` (String) (Deprecated) The hybrid deployment 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, SshTunnel, ProxyAgent.
- `private_link_id` (String) The private link ID.
- `region` (String) Data processing location. This is where Fivetran will operate and run computation on data.
Expand Down
28 changes: 28 additions & 0 deletions docs/data-sources/hybrid_deployment_agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
page_title: "Data Source: fivetran_hybrid_deployment_agents"
---

# Data Source: fivetran_hybrid_deployment_agents

This data source returns a hybrid deployment agent object.

## Example Usage

```hcl
data "fivetran_hybrid_deployment_agents" "hybrid_deployment_agent" {
id = "hybrid_deployment_agent_id"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier for the hybrid deployment agent within your account.

### Read-Only

- `display_name` (String) The unique name for the hybrid deployment agent.
- `group_id` (String) The unique identifier for the Group within the Fivetran system.
- `registered_at` (String) The timestamp of the time the hybrid deployment agent was created in your account.
34 changes: 34 additions & 0 deletions docs/data-sources/hybrid_deployment_agents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
page_title: "Data Source: fivetran_hybrid_deployment_agents"
---

# Data Source: fivetran_hybrid_deployment_agents

This data source returns a list of all hybrid deployment agents within your Fivetran account.

## Example Usage

```hcl
data "fivetran_hybrid_deployment_agents" "hybrid_deployment_agents" {
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `items` (Attributes Set) (see [below for nested schema](#nestedatt--items))

<a id="nestedatt--items"></a>
### Nested Schema for `items`

Required:

- `id` (String) The unique identifier for the hybrid deployment agent within your account.

Read-Only:

- `display_name` (String) The unique name for the hybrid deployment agent.
- `group_id` (String) The unique identifier for the Group within the Fivetran system.
- `registered_at` (String) The timestamp of the time the hybrid deployment agent was created in your account.
2 changes: 2 additions & 0 deletions docs/data-sources/local_processing_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ page_title: "Data Source: fivetran_local_processing_agent"

# Data Source: fivetran_local_processing_agent

NOTE: In connection with the general availability of the hybrid deployment functionality and in order to synchronize internal terminology, we have deprecate this data source.

This data source returns a local processing agent object.

## Example Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/data-sources/local_processing_agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ page_title: "Data Source: fivetran_local_processing_agents"

# Data Source: fivetran_local_processing_agents

NOTE: In connection with the general availability of the hybrid deployment functionality and in order to synchronize internal terminology, we have deprecate this data source.

This data source returns a list of all local processing agents within your Fivetran account.

## Example Usage
Expand Down
104 changes: 104 additions & 0 deletions docs/guides/version_1.4.0_update_guides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
----
page_title: "Version Update 1.4.0"
subcategory: "Upgrade Guides"
---

# Version 1.4.0

## What's new in 1.4.0

In version `1.4.0` of Fivetran Terraform provider, resource `fivetran_local_processing_agent` renamed to `fivetran_hybrid_deployment_agent`

## Migration guide

### Provider

Update your provider configuration in the following way:

Previous configuration:

```hcl
required_providers {
fivetran = {
version = "~> 1.3.0"
source = "fivetran/fivetran"
}
}
```

Updated configuration:

```hcl
required_providers {
fivetran = {
version = ">= 1.4.0"
source = "fivetran/fivetran"
}
}
```

### Resource `fivetran_hybrid_deployment_agent`

Update all your local processing agent resources (`fivetran_local_processing_agent`):

Previous configuration:

```hcl
resource "fivetran_local_processing_agent" "test_agent" {
}
```

Updated configuration:

```hcl
resource "fivetran_hybrid_deployment_agent" "test_agent" {
}
```

### Resource `fivetran_connector`

Update all your connector resources (`fivetran_connector`):

Previous configuration:

```hcl
resource "fivetran_connector" "test_connector" {
local_processing_agent_id = agent_id
}
```

Updated configuration:

```hcl
resource "fivetran_connector" "test_connector" {
hybrid_deployment_agent_id = agent_id
}
```

### Resource `fivetran_destination`

Update all your destination resources (`fivetran_destination`):

Previous configuration:

```hcl
resource "fivetran_destination" "test_destination" {
local_processing_agent_id = agent_id
}
```

Updated configuration:

```hcl
resource "fivetran_destination" "test_destination" {
hybrid_deployment_agent_id = agent_id
}
```

### Update terraform state

Once all configurations have been updated, run:

```
terraform init -upgrade
```
3 changes: 2 additions & 1 deletion docs/resources/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ resource "fivetran_connector" "amplitude" {
- `auth` (Block, Optional) (see [below for nested schema](#nestedblock--auth))
- `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.
- `hybrid_deployment_agent_id` (String) The hybrid deployment 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.
- `local_processing_agent_id` (String, Deprecated) (Deprecated) The hybrid deployment 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, SshTunnel, ProxyAgent.
- `private_link_id` (String) The private link ID.
- `proxy_agent_id` (String) The proxy agent ID.
Expand Down
3 changes: 2 additions & 1 deletion docs/resources/destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ 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.
- `hybrid_deployment_agent_id` (String) The hybrid deployment 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.
- `local_processing_agent_id` (String, Deprecated) (Deprecated) The hybrid deployment 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, SshTunnel, ProxyAgent.
- `private_link_id` (String) The private link ID.
- `run_setup_tests` (Boolean) Specifies whether the setup tests should be run automatically. The default value is TRUE.
Expand Down
41 changes: 41 additions & 0 deletions docs/resources/hybrid_deployment_agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
page_title: "Resource: fivetran_hybrid_deployment_agent"
---

# Resource: fivetran_hybrid_deployment_agent

This resource allows you to create, update, and delete hybrid deployment agents.

## Example Usage

```hcl
resource "fivetran_hybrid_deployment_agent" "hybrid_deployment_agent" {
provider = fivetran-provider
display_name = "display_name"
group_id = "group_id"
auth_type = "AUTO"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `auth_type` (String) Type of authentification. Possible values `AUTO`,`MANUAL`
- `display_name` (String) The unique name for the hybrid deployment agent.
- `group_id` (String) The unique identifier for the Group within the Fivetran system.

### Optional

- `authentication_counter` (Number) Determines whether re-authentication needs to be performed.

### Read-Only

- `auth_json` (String) Base64-encoded content of the auth.json file.
- `config_json` (String) Base64-encoded content of the config.json file.
- `docker_compose_yaml` (String) Base64-encoded content of the compose file for the chosen containerization type.
- `id` (String) The unique identifier for the hybrid deployment agent within your account.
- `registered_at` (String) The timestamp of the time the hybrid deployment agent was created in your account.
- `token` (String) Base64 encoded content of token.
3 changes: 3 additions & 0 deletions docs/resources/local_processing_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ page_title: "Resource: fivetran_local_processing_agent"

# Resource: fivetran_local_processing_agent

NOTE: In connection with the general availability of the hybrid deployment functionality and in order to synchronize internal terminology, we have deprecate this resource.

This resource allows you to create, update, and delete local processing agents.


## Example Usage

```hcl
Expand Down
Loading

0 comments on commit 6514d6a

Please sign in to comment.