Skip to content

Commit

Permalink
ci: Prepare for the 1.1.0 release (#595)
Browse files Browse the repository at this point in the history
* ci: Prepare for the 1.1.0 release

* fix: updated changelog.md

* fix: fixed review comments

---------

Co-authored-by: PC-2NR0VQ3\wai.wong <[email protected]>
  • Loading branch information
edbamolvyavahare and wai-wong-edb authored Oct 21, 2024
1 parent a60af1e commit 1a4740c
Show file tree
Hide file tree
Showing 54 changed files with 715 additions and 66 deletions.
1 change: 1 addition & 0 deletions .wordlist-en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ BigAnimal
BigAnimal's
CIDR
CSP
csp
EDB
GUC
IAM
Expand Down
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
## v1.1.0 (October 21. 2024)
Features:
* New Resource and Data Source to manage tags: `biganimal_tag`
* New Resource and Data Source to manage csp tags: `biganimal_csp_tag`
* Support to assign tags in `biganimal_cluster`, `biganimal_analytics_cluster`, `biganimal_faraway_replica`, `biganimal_pgd`, `biganimal_projects` and `biganimal_region` resources
* Support for read-only connections in `biganimal_pgd` resources
* Support service_name in `biganimal_cluster` resources

Enhancements:
* Updated authentication information in docs
* Updated AWS examples to use series 6 instance types by default

Bug Fixes:
* Fixed cluster_architecture.name not computing when changing cluster_architecture.id in `biganimal_cluster` resources

## v1.0.0 (August 07. 2024)
Features:
* Transparent Data Encryption (TDE) is now supported in `biganimal_cluster` and `biganimal_faraway_replica` resources
Expand Down
2 changes: 1 addition & 1 deletion GNUmakefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ HOSTNAME=registry.terraform.io
NAMESPACE=EnterpriseDB
NAME=biganimal
BINARY=terraform-provider-${NAME}
VERSION=1.0.0
VERSION=1.1.0

# Figure out the OS and ARCH of the
# builder machine
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ terraform {
required_providers {
biganimal = {
source = "EnterpriseDB/biganimal"
version = "1.0.0"
version = "1.1.0"
}
}
}
Expand Down
11 changes: 11 additions & 0 deletions docs/data-sources/analytics_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ output "service_account_ids" {
- `private_networking` (Boolean) Is private networking enabled.
- `region` (String) Region to deploy the cluster. See [Supported regions](https://www.enterprisedb.com/docs/biganimal/latest/overview/03a_region_support/) for supported regions.
- `resizing_pvc` (List of String) Resizing PVC.
- `tags` (Attributes Set) show tags associated with this resource (see [below for nested schema](#nestedatt--tags))

<a id="nestedatt--allowed_ip_ranges"></a>
### Nested Schema for `allowed_ip_ranges`
Expand Down Expand Up @@ -164,3 +165,13 @@ Optional:
- `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).


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

Read-Only:

- `color` (String)
- `tag_id` (String)
- `tag_name` (String)
20 changes: 20 additions & 0 deletions docs/data-sources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,14 @@ output "service_account_ids" {
output "volume_snapshot_backup" {
value = coalesce(data.biganimal_cluster.this.post_gis, false)
}
output "service_name" {
value = data.biganimal_cluster.this.service_name
}
output "tags" {
value = data.biganimal_cluster.this.tags
}
```

<!-- schema generated by tfplugindocs -->
Expand Down Expand Up @@ -148,6 +156,7 @@ output "volume_snapshot_backup" {
- `read_only_connections` (Boolean) Is read only connection enabled.
- `service_account_ids` (Set of String) A Google Cloud Service Account is used for logs. If you leave this blank, then you will be unable to access log details for this cluster. Required when cluster is deployed on BigAnimal's cloud account.
- `superuser_access` (Boolean) Enable to grant superuser access to the edb_admin role.
- `tags` (Attributes Set) Show existing tags associated with this resource (see [below for nested schema](#nestedatt--tags))
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
- `transparent_data_encryption` (Attributes) Transparent Data Encryption (TDE) key (see [below for nested schema](#nestedatt--transparent_data_encryption))
- `volume_snapshot_backup` (Boolean) Volume snapshot.
Expand All @@ -173,6 +182,7 @@ output "volume_snapshot_backup" {
- `region` (String) Region to deploy the cluster. See [Supported regions](https://www.enterprisedb.com/docs/biganimal/latest/overview/03a_region_support/) for supported regions.
- `resizing_pvc` (List of String) Resizing PVC.
- `ro_connection_uri` (String) Cluster read-only connection URI. Only available for high availability clusters.
- `service_name` (String) Cluster connection service name.
- `storage` (Attributes) Storage. (see [below for nested schema](#nestedatt--storage))
- `transparent_data_encryption_action` (String) Transparent data encryption action.

Expand Down Expand Up @@ -232,6 +242,16 @@ Required:
- `value` (String) GUC value.


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

Read-Only:

- `color` (String)
- `tag_id` (String)
- `tag_name` (String)


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Expand Down
93 changes: 93 additions & 0 deletions docs/data-sources/csp_tag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "biganimal_csp_tag Data Source - terraform-provider-biganimal"
subcategory: ""
description: |-
CSP Tags will enable users to categorize and organize resources across types and improve the efficiency of resource retrieval
---

# biganimal_csp_tag (Data Source)

CSP Tags will enable users to categorize and organize resources across types and improve the efficiency of resource retrieval

## Example Usage

```terraform
terraform {
required_providers {
biganimal = {
source = "EnterpriseDB/biganimal"
version = "1.1.0"
}
}
}
data "biganimal_csp_tag" "this" {
project_id = "<ex-project-id>" # ex: "prj_12345"
cloud_provider_id = "<ex-cloud-provider-id>" # ex: "aws"
}
output "csp_tags" {
value = data.biganimal_csp_tag.this.csp_tags
}
```

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

### Required

- `cloud_provider_id` (String)
- `project_id` (String)

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `add_tags` (Attributes List) (see [below for nested schema](#nestedatt--add_tags))
- `csp_tags` (Attributes List) CSP Tags on cluster (see [below for nested schema](#nestedatt--csp_tags))
- `delete_tags` (List of String)
- `edit_tags` (Attributes List) (see [below for nested schema](#nestedatt--edit_tags))
- `id` (String) The ID of this resource.

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).


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

Read-Only:

- `csp_tag_key` (String)
- `csp_tag_value` (String)


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

Read-Only:

- `csp_tag_id` (String)
- `csp_tag_key` (String)
- `csp_tag_value` (String)
- `status` (String)


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

Read-Only:

- `csp_tag_id` (String)
- `csp_tag_key` (String)
- `csp_tag_value` (String)
- `status` (String)
14 changes: 14 additions & 0 deletions docs/data-sources/faraway_replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ output "volume_snapshot_backup" {
- `resizing_pvc` (List of String) Resizing PVC.
- `source_cluster_id` (String) Source cluster ID.
- `storage` (Attributes) Storage. (see [below for nested schema](#nestedatt--storage))
- `tags` (Attributes Set) show tags associated with this resource (see [below for nested schema](#nestedatt--tags))
- `transparent_data_encryption_action` (String) Transparent data encryption action.
- `volume_snapshot_backup` (Boolean) Enable to take a snapshot of the volume.

Expand Down Expand Up @@ -216,3 +217,16 @@ Optional:
- `iops` (String) IOPS for the selected volume.
- `size` (String) Size of the volume.
- `throughput` (String) Throughput.


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

Required:

- `tag_name` (String)

Read-Only:

- `color` (String)
- `tag_id` (String)
10 changes: 3 additions & 7 deletions docs/data-sources/pgd.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,6 @@ output "data_groups" {
output "witness_groups" {
value = data.biganimal_pgd.this.witness_groups
}
output "ro_connection_uri" {
value = data.biganimal_cluster.this.ro_connection_uri
}
```

## PGD Data Source Example
Expand Down Expand Up @@ -78,7 +74,7 @@ terraform {
required_providers {
biganimal = {
source = "EnterpriseDB/biganimal"
version = "1.0.0"
version = "1.1.0"
}
}
}
Expand All @@ -102,7 +98,6 @@ terraform {
- `data_groups` (Attributes Set) Cluster data groups. (see [below for nested schema](#nestedatt--data_groups))
- `id` (String) The ID of this resource.
- `witness_groups` (Attributes Set) (see [below for nested schema](#nestedatt--witness_groups))
- `ro_connection_uri` (String) PGD Cluster read-only connection URI. Only available for high availability clusters.

<a id="nestedatt--data_groups"></a>
### Nested Schema for `data_groups`
Expand All @@ -129,11 +124,12 @@ Read-Only:
- `pg_version` (Attributes) Postgres version. (see [below for nested schema](#nestedatt--data_groups--pg_version))
- `phase` (String) Current phase of the cluster group.
- `private_networking` (Boolean) Is private networking enabled.
- `read_only_connections` (Boolean) Is read-only connections enabled.
- `region` (Attributes) Region. (see [below for nested schema](#nestedatt--data_groups--region))
- `resizing_pvc` (Set of String) Resizing PVC.
- `ro_connection_uri` (Set of String) Read-only connection URI.
- `service_account_ids` (Set of String) A Google Cloud Service Account is used for logs. If you leave this blank, then you will be unable to access log details for this cluster. Required when cluster is deployed on BigAnimal's cloud account.
- `storage` (Attributes) Storage. (see [below for nested schema](#nestedatt--data_groups--storage))
- `read_only_connections` (Boolean) Is Read-only Connections/workloads enabled.

<a id="nestedatt--data_groups--allowed_ip_ranges"></a>
### Nested Schema for `data_groups.allowed_ip_ranges`
Expand Down
11 changes: 11 additions & 0 deletions docs/data-sources/region.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ output "cloud_provider_id" {

- `id` (String) Datasource ID.
- `regions` (Attributes List) Region information. (see [below for nested schema](#nestedatt--regions))
- `tags` (Attributes Set) show tags associated with this resource (see [below for nested schema](#nestedatt--tags))

<a id="nestedatt--regions"></a>
### Nested Schema for `regions`
Expand All @@ -62,3 +63,13 @@ Read-Only:
- `name` (String) Region name of the region.
- `region_id` (String) Region ID of the region.
- `status` (String) Region status of the region.


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

Read-Only:

- `color` (String)
- `tag_id` (String)
- `tag_name` (String)
62 changes: 62 additions & 0 deletions docs/data-sources/tag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "biganimal_tag Data Source - terraform-provider-biganimal"
subcategory: ""
description: |-
Tags will enable users to categorize and organize resources across types and improve the efficiency of resource retrieval
---

# biganimal_tag (Data Source)

Tags will enable users to categorize and organize resources across types and improve the efficiency of resource retrieval

## Example Usage

```terraform
terraform {
required_providers {
biganimal = {
source = "EnterpriseDB/biganimal"
version = "1.1.0"
}
}
}
data "biganimal_tag" "this" {
tag_id = "tag-id"
}
output "tag_name" {
value = data.biganimal_tag.this.tag_name
}
output "color" {
value = data.biganimal_tag.this.color
}
```

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

### Required

- `tag_id` (String)

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `color` (String)
- `id` (String) The ID of this resource.
- `tag_name` (String)

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
5 changes: 2 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ see [Getting started with the BigAnimal free trial.](https://www.enterprisedb.co
```terraform
# Configure the BigAnimal Provider
provider "biganimal" {
// ba_access_key: This can also be set as an environment variable. If it is set both here and
// in an environment variable then the access key set in the environment variable
// will take priority and be used
ba_access_key = "<redacted>"
}
# Manage the resources
Expand All @@ -40,3 +37,5 @@ Credentials can be provided by using the `BA_ACCESS_KEY` environment variables.
### Optional

- `ba_access_key` (String) BigAnimal Access Key
- `ba_api_uri` (String) BigAnimal API URL
- `ba_bearer_token` (String) BigAnimal Bearer Token
Loading

0 comments on commit 1a4740c

Please sign in to comment.