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 2 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
a-atri marked this conversation as resolved.
Show resolved Hide resolved
```
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 AWS command for configuring VPC endpoint.
a-atri marked this conversation as resolved.
Show resolved Hide resolved
```
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
}
```
Create a new Azure network peer, use the `network-peer` resource as follows:
a-atri marked this conversation as resolved.
Show resolved Hide resolved
```
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)
8 changes: 8 additions & 0 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 @@ -298,3 +298,11 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec

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
simon-dew marked this conversation as resolved.
Show resolved Hide resolved

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
33 changes: 18 additions & 15 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
module github.com/couchbasecloud/terraform-provider-couchbase-capella

go 1.21.4
go 1.22.7

toolchain go1.22.9

require (
github.com/couchbase/tools-common/functional v1.2.0
Expand All @@ -25,7 +27,7 @@ require (
github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
github.com/armon/go-radix v1.0.0 // indirect
github.com/bgentry/speakeasy v0.1.0 // indirect
github.com/bmatcuk/doublestar/v4 v4.6.1 // indirect
github.com/bmatcuk/doublestar/v4 v4.7.1 // indirect
github.com/cloudflare/circl v1.3.7 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/fatih/color v1.16.0 // indirect
Expand All @@ -36,17 +38,18 @@ require (
github.com/hashicorp/go-checkpoint v0.5.0 // indirect
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect
github.com/hashicorp/go-hclog v1.6.2 // indirect
github.com/hashicorp/go-hclog v1.6.3 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
github.com/hashicorp/go-plugin v1.6.0 // indirect
github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
github.com/hashicorp/go-uuid v1.0.3 // indirect
github.com/hashicorp/go-version v1.7.0 // indirect
github.com/hashicorp/hc-install v0.7.0 // indirect
github.com/hashicorp/hc-install v0.9.0 // indirect
github.com/hashicorp/hcl/v2 v2.20.0 // indirect
github.com/hashicorp/logutils v1.0.0 // indirect
github.com/hashicorp/terraform-exec v0.21.0 // indirect
github.com/hashicorp/terraform-json v0.22.1 // indirect
github.com/hashicorp/terraform-plugin-docs v0.19.4 // indirect
github.com/hashicorp/terraform-json v0.23.0 // indirect
github.com/hashicorp/terraform-plugin-docs v0.20.0 // indirect
github.com/hashicorp/terraform-plugin-sdk/v2 v2.33.0 // indirect
github.com/hashicorp/terraform-registry-address v0.2.3 // indirect
github.com/hashicorp/terraform-svchost v0.1.1 // indirect
Expand All @@ -66,23 +69,23 @@ require (
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/posener/complete v1.2.3 // indirect
github.com/rogpeppe/go-internal v1.12.0 // indirect
github.com/rogpeppe/go-internal v1.13.1 // indirect
github.com/shopspring/decimal v1.3.1 // indirect
github.com/spf13/cast v1.5.0 // indirect
github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
github.com/yuin/goldmark v1.7.1 // indirect
github.com/yuin/goldmark v1.7.7 // indirect
github.com/yuin/goldmark-meta v1.1.0 // indirect
github.com/zclconf/go-cty v1.14.4 // indirect
github.com/zclconf/go-cty v1.15.0 // indirect
go.abhg.dev/goldmark/frontmatter v0.2.0 // indirect
golang.org/x/crypto v0.21.0 // indirect
golang.org/x/crypto v0.24.0 // indirect
golang.org/x/exp v0.0.0-20231226003508-02704c960a9b // indirect
golang.org/x/mod v0.17.0 // indirect
golang.org/x/net v0.23.0 // indirect
golang.org/x/sys v0.18.0 // indirect
golang.org/x/text v0.15.0 // indirect
golang.org/x/tools v0.16.0 // indirect
golang.org/x/mod v0.21.0 // indirect
golang.org/x/net v0.26.0 // indirect
golang.org/x/sys v0.21.0 // indirect
golang.org/x/text v0.19.0 // indirect
golang.org/x/tools v0.22.0 // indirect
google.golang.org/appengine v1.6.8 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240227224415-6ceb2ff114de // indirect
google.golang.org/grpc v1.63.2 // indirect
Expand Down
Loading
Loading