Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release docs for terraform version V1.4.0 #243

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/data-sources/azure_network_peer_command.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "couchbase-capella_azure_network_peer_command Data Source - terraform-provider-couchbase-capella"
subcategory: ""
description: |-

---

# couchbase-capella_azure_network_peer_command (Data Source)





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

### Required

- `cluster_id` (String)
- `organization_id` (String)
- `project_id` (String)
- `resource_group` (String)
- `subscription_id` (String)
- `tenant_id` (String)
- `vnet_id` (String)
- `vnet_peering_service_principal` (String)

### Read-Only

- `command` (String)
1 change: 1 addition & 0 deletions docs/data-sources/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Read-Only:
- `couchbase_server` (Attributes) (see [below for nested schema](#nestedatt--data--couchbase_server))
- `current_state` (String)
- `description` (String)
- `enable_private_dns_resolution` (Boolean)
- `id` (String)
- `name` (String)
- `organization_id` (String)
Expand Down
14 changes: 14 additions & 0 deletions docs/data-sources/network_peers.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Read-Only:
Read-Only:

- `aws_config` (Attributes) (see [below for nested schema](#nestedatt--data--provider_config--aws_config))
- `azure_config` (Attributes) (see [below for nested schema](#nestedatt--data--provider_config--azure_config))
- `gcp_config` (Attributes) (see [below for nested schema](#nestedatt--data--provider_config--gcp_config))

<a id="nestedatt--data--provider_config--aws_config"></a>
Expand All @@ -68,6 +69,19 @@ Read-Only:
- `vpc_id` (String)


<a id="nestedatt--data--provider_config--azure_config"></a>
### Nested Schema for `data.provider_config.azure_config`

Read-Only:

- `cidr` (String)
- `provider_id` (String)
- `resource_group` (String)
- `subscription_id` (String)
- `tenant_id` (String)
- `vnet_id` (String)


<a id="nestedatt--data--provider_config--gcp_config"></a>
### Nested Schema for `data.provider_config.gcp_config`

Expand Down
119 changes: 119 additions & 0 deletions docs/guides/1.4.0-upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
layout: "couchbase-capella"
page_title: "Couchbase Capella Provider 1.4.0: Upgrade and Information Guide"
sidebar_current: "docs-couchbase-capella-guides-140-upgrade-guide"
description: |-
Couchbase Capella Provider 1.4.0: Upgrade and Information Guide
---


# Couchbase Capella Provider 1.4.0: Upgrade and Information Guide

New features in 1.4.0


## New Features
simon-dew marked this conversation as resolved.
Show resolved Hide resolved
* Enable Flush Bucket [`couchbase-capella_flush`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/resources/flush)
* Enable Azure Network Peer [`couchbase-capella_network_peer`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/resources/network_peer)


## Flush Bucket
Use the new `flush` resource to flush a bucket.
```
output "new_bucket" {
value = couchbase-capella_bucket.new_bucket
}
```
```
output "bucket_id" {
value = couchbase-capella_bucket.new_bucket.id
}
```
```
resource "couchbase-capella_bucket" "new_bucket" {
name = var.bucket.name
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
type = var.bucket.type
storage_backend = var.bucket.storage_backend
memory_allocation_in_mb = var.bucket.memory_allocation_in_mb
bucket_conflict_resolution = var.bucket.bucket_conflict_resolution
durability_level = var.bucket.durability_level
replicas = var.bucket.replicas
flush = var.bucket.flush
time_to_live_in_seconds = var.bucket.time_to_live_in_seconds
eviction_policy = var.bucket.eviction_policy
}
```
```
output "new_flush" {
value = couchbase-capella_flush.new_flush
}
```
```
resource "couchbase-capella_flush" "new_flush" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
bucket_id = var.bucket_id
}
```
For more information, see the [flush bucket examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/flush_bucket).

## Azure Network Peer

Use the `azure_network_peer_command` data source to get an Azure CLI command for configuring VNET endpoint.
```
output "azure_network_peer_command" {
value = data.couchbase-capella_azure_network_peer_command.azure_network_peer_command
}
```
```
data "couchbase-capella_azure_network_peer_command" "azure_network_peer_command" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
tenant_id = var.tenant_id
vnet_id = var.vnet_id
subscription_id = var.subscription_id
resource_group = var.resource_group
vnet_peering_service_principal = var.vnet_peering_service_principal
}
```
To create a new Azure network peer, use the `network-peer` resource as follows:
```
output "new_network_peer" {
value = couchbase-capella_network_peer.new_network_peer
}
```
```
output "peer_id" {
value = couchbase-capella_network_peer.new_network_peer.id
}
```
```
resource "couchbase-capella_network_peer" "new_network_peer" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
name = var.network_peer.name
provider_type = var.network_peer.provider_type
provider_config = {
azure_config = {
tenant_id = var.azure_config.tenant_id
resource_group = var.azure_config.resource_group
subscription_id = var.azure_config.subscription_id
cidr = var.azure_config.cidr
vnet_id = var.azure_config.vnet_id
}
}
}
```
For more information, see the [network peer examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/network_peer).

### Helpful Links

- [Getting Started with the Terraform Provider](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples/getting_started)
- [Capella V4 Management APIs](https://docs.couchbase.com/cloud/management-api-reference/index.html)
- [Specific Examples in the examples folder](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples)
76 changes: 43 additions & 33 deletions docs/index.md

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. There are still two top-level headings in this file called Example Usage. Suggest changing the second one to Links to Further Examples or similar.
  2. Glad to see there are further descriptions under the links. The last few links (from Manage Private Endpoints onward) still just repeat the link text.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to dismiss this conversation and merge if you need to progress the PR

Original file line number Diff line number Diff line change
Expand Up @@ -222,79 +222,89 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec

The [buckets](https://docs.couchbase.com/cloud/clusters/data-service/about-buckets-scopes-collections.html#buckets) is the top-level storage container for data in a Capella database.

* [Configure App Services](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/appservice)
* [Configure App Services](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/appservice):

Create and Manage App Services in Capella.
App Services synchronizes data between the Couchbase Capella database and your apps running on mobile applications.

* [Configure Bucket Backup & Restore](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/backup)
* [Configure Bucket Backup & Restore](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/backup):

A bucket is the fundamental space for storing data in Couchbase Capella.
Create and Manage Backups in Capella.

* [Create & Manage Scopes](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/bucket/scopes)
* [Create & Manage Scopes](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/bucket/scopes):

Create and Manage Scopes within a bucket.
Create and Manage Scopes within a bucket. A scope is a mechanism for the grouping of multiple collections.

* [Create & Manage Collections](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/bucket/collections)
* [Create & Manage Collections](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/bucket/collections):

Create and Manage Collections within a bucket.
Create and Manage Collections within a bucket. A collection is a data container for related documents.

* [Configure Cluster On/Off Schedule](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/cluster_onoff_schedule)
* [Configure Cluster On/Off Schedule](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/cluster_onoff_schedule):

Configure cluster on/off schedule.
The On/Off Schedule endpoint enables you to schedule when your provisioned database should turn on or off to save costs.

* [Turn Clusters On/Off On Demand](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/cluster_onoff_ondemand)
* [Turn Clusters On/Off On Demand](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/cluster_onoff_ondemand):

Turn Clusters on/off on demand.
Turning off your database only turns off the compute. All of your data, schema (buckets, scopes, and collections), and indexes remain, as well as your cluster configuration, including users and allow lists.
When you turn your provisioned database off, you will be charged the OFF amount for the database.

* [Turn App Service On/Off On Demand](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/app_service_onoff_ondemand)
* [Turn App Service On/Off On Demand](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/app_service_onoff_ondemand):

Turn App Services on/off on-demand.
You can turn the cluster and any linked app services on or off on demand using the [cluster API](https://docs.couchbase.com/cloud/management-api-reference/index.html#tag/clusters).

* [Import Sample Dataset Buckets](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/sample_bucket)
* [Import Sample Dataset Buckets](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/sample_bucket):

Import Sample Dataset Buckets.
The sampleBucket endpoint lets users easily create a bucket filled with sample data. This is a quick way for users to try out features and learn how things work with ready-to-use data.

* [Manage Storage Auto Expansion for Azure Clusters](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/cluster/azure)
* [Manage Storage Auto Expansion for Azure Clusters](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/cluster/azure):

Manage Storage Auto-expansion for Azure Clusters.

* [Manage Audit Log Settings in Capella](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/audit_log_settings)

Manage Audit Log Settings.
* [Manage Audit Log Settings in Capella](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/audit_log_settings):

* [Export Capella Audit Logs](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/audit_log_export)
Users can easily configure audit log support on Capella database.

Export Audit Logs.
* [Export Capella Audit Logs](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/audit_log_export):

* [Retrieve Audit Log Events for a Cluster](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/audit_logs_event_ids)

Retrieve Audit Logs Events.
Users can export audit logs from cloud blob storage to an AWS S3 bucket.

* [Manage Network Peer](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/network_peer)
* [Retrieve Audit Log Events for a Cluster](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/audit_logs_event_ids):

Manage Network Peer
Users can retrieve audit logs from a pre-signed download URL. Logs are retained for 30 days.

* [Retrieve Specific Event](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/event)
* [Manage Network Peer](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/network_peer):

Network Peering enables you to configure a secure private network connection between the Virtual Private Cloud (VPC) hosting your applications and the VPC of your Couchbase Capella database.

* [Retrieve Specific Event](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/event):

Retrieve Specific Event

* [Retrieve All Events](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/events)
* [Retrieve All Events](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/events):

Retrieve All Events

* [Retrieve Private Endpoint Command for AWS](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoint_command/AWS)
* [Retrieve Private Endpoint Command for AWS](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoint_command/AWS):

Retrieve Private Endpoint Command for AWS

* [Retrieve Private Endpoint Command for Azure](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoint_command/Azure)
* [Retrieve Private Endpoint Command for Azure](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoint_command/Azure):

Retrieve Private Endpoint Command for Azure

* [Manage Private Endpoint Service](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoint_service)
* [Manage Private Endpoint Service](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoint_service):

Manage Private Endpoint Service
Access your Capella cluster from your cloud provider's private network.

* [Manage Private Endpoints](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoints)
* [Manage Private Endpoints](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoints):

Manage Private Endpoints

* [Manage Azure Network Peer](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/network_peer):

Manage Azure Network Peer

* [Manage Flush Bucket](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/flush_bucket):

Manage Flush Bucket

1 change: 1 addition & 0 deletions docs/resources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ description: |-
- `configuration_type` (String, Deprecated)
- `couchbase_server` (Attributes) (see [below for nested schema](#nestedatt--couchbase_server))
- `description` (String)
- `enable_private_dns_resolution` (Boolean)
- `if_match` (String)

### Read-Only
Expand Down
23 changes: 23 additions & 0 deletions docs/resources/flush.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "couchbase-capella_flush Resource - terraform-provider-couchbase-capella"
subcategory: ""
description: |-

---

# couchbase-capella_flush (Resource)





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

### Required

- `bucket_id` (String)
- `cluster_id` (String)
- `organization_id` (String)
- `project_id` (String)
20 changes: 20 additions & 0 deletions docs/resources/network_peer.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ description: |-
Optional:

- `aws_config` (Attributes) (see [below for nested schema](#nestedatt--provider_config--aws_config))
- `azure_config` (Attributes) (see [below for nested schema](#nestedatt--provider_config--azure_config))
- `gcp_config` (Attributes) (see [below for nested schema](#nestedatt--provider_config--gcp_config))

<a id="nestedatt--provider_config--aws_config"></a>
Expand All @@ -57,6 +58,25 @@ Read-Only:
- `provider_id` (String)


<a id="nestedatt--provider_config--azure_config"></a>
### Nested Schema for `provider_config.azure_config`

Required:

- `cidr` (String)

Optional:

- `resource_group` (String)
- `subscription_id` (String)
- `tenant_id` (String)
- `vnet_id` (String)

Read-Only:

- `provider_id` (String)


<a id="nestedatt--provider_config--gcp_config"></a>
### Nested Schema for `provider_config.gcp_config`

Expand Down
Loading
Loading