You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-\[AV-126800\] Allow to filter on cluster or project [\#543](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/543) ([l0n3star](https://github.com/l0n3star))
10
+
-\[AV-123821\] Implement a UUID parsing helper function [\#506](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/506) ([stanleefdz](https://github.com/stanleefdz))
11
+
12
+
**Fixed bugs:**
13
+
14
+
-\[AV-128730\] Prevent perpetual state drift by preserving nil CORS configuration [\#566](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/566) ([stanleefdz](https://github.com/stanleefdz))
15
+
-\[AV-125170\] Fix app endpoint creation without CORS [\#565](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/565) ([stanleefdz](https://github.com/stanleefdz))
-\[AV-127117\] Make CopyToRegions a Set [\#548](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/548) ([SophieWegmann](https://github.com/SophieWegmann))
18
+
-\[AV-125172\] Set state straight after successful App Endpoint creation [\#540](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/540) ([IsaacLambat](https://github.com/IsaacLambat))
19
+
20
+
**Closed issues:**
21
+
22
+
- endpoint creation - lost state? [\#469](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/issues/469)
# generated by https://github.com/hashicorp/terraform-plugin-docs
3
+
page_title: "couchbase-capella_cluster Data Source - terraform-provider-couchbase-capella"
4
+
subcategory: ""
5
+
description: |-
6
+
The data source retrieves the details of a single Couchbase Capella cluster.
7
+
---
8
+
9
+
# couchbase-capella_cluster (Data Source)
10
+
11
+
The data source retrieves the details of a single Couchbase Capella cluster.
12
+
13
+
14
+
15
+
<!-- schema generated by tfplugindocs -->
16
+
## Schema
17
+
18
+
### Required
19
+
20
+
-`organization_id` (String) The GUID4 ID of the organization.
21
+
-`project_id` (String) The GUID4 ID of the project.
22
+
23
+
### Read-Only
24
+
25
+
-`app_service_id` (String) The GUID4 ID of the appService.
26
+
-`audit` (Attributes) Couchbase audit data. (see [below for nested schema](#nestedatt--audit))
27
+
-`availability` (Attributes) (see [below for nested schema](#nestedatt--availability))
28
+
-`cloud_provider` (Attributes) (see [below for nested schema](#nestedatt--cloud_provider))
29
+
-`configuration_type` (String)
30
+
-`connection_string` (String)
31
+
-`couchbase_server` (Attributes) (see [below for nested schema](#nestedatt--couchbase_server))
32
+
-`current_state` (String)
33
+
-`description` (String)
34
+
-`enable_private_dns_resolution` (Boolean)
35
+
-`etag` (String) Entity tag for the resource, used for caching and conditional requests.
36
+
-`id` (String) The ID of this resource.
37
+
-`if_match` (String) A precondition header that specifies the entity tag of a resource.
38
+
-`name` (String)
39
+
-`service_groups` (Attributes List) (see [below for nested schema](#nestedatt--service_groups))
40
+
-`support` (Attributes) (see [below for nested schema](#nestedatt--support))
41
+
-`zones` (List of String)
42
+
43
+
<aid="nestedatt--audit"></a>
44
+
### Nested Schema for `audit`
45
+
46
+
Read-Only:
47
+
48
+
-`created_at` (String) - The RFC3339 timestamp associated with when the resource was initially created.
49
+
-**Format**: Date-time in RFC3339 format
50
+
-`created_by` (String) - The user who created the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users.
51
+
-`modified_at` (String) - The RFC3339 timestamp associated with when the resource was last modified.
52
+
-**Format**: Date-time in RFC3339 format
53
+
-`modified_by` (String) - The user who last modified the resource; this will be a UUID4 ID for standard users and wilmal be a string such as "internal-support" for internal Couchbase support users.
54
+
-`version` (Number) - The version of the document. This value is incremented each time the resource is modified.
55
+
56
+
57
+
<aid="nestedatt--availability"></a>
58
+
### Nested Schema for `availability`
59
+
60
+
Read-Only:
61
+
62
+
-`type` (String) - Availability zone type, either 'single' or 'multi'. Availability zone type allowed for singleNode cluster is only 'single'.
-`region` (String) - Cloud provider region, for example `us-west-2`.
74
+
-`type` (String) - Cloud provider type. Note: For singleNode cluster, only AWS type cloud provider is allowed. `aws`: Amazon Web Services `gcp`: Google Cloud Platform `azure`: Microsoft Azure
75
+
-**Valid Values**: `aws`, `gcp`, `azure`
76
+
77
+
78
+
<aid="nestedatt--couchbase_server"></a>
79
+
### Nested Schema for `couchbase_server`
80
+
81
+
Read-Only:
82
+
83
+
-`version` (String)
84
+
85
+
86
+
<aid="nestedatt--service_groups"></a>
87
+
### Nested Schema for `service_groups`
88
+
89
+
Read-Only:
90
+
91
+
-`node` (Attributes) (see [below for nested schema](#nestedatt--service_groups--node))
92
+
-`num_of_nodes` (Number)
93
+
-`services` (List of String)
94
+
95
+
<aid="nestedatt--service_groups--node"></a>
96
+
### Nested Schema for `service_groups.node`
97
+
98
+
Read-Only:
99
+
100
+
-`compute` (Attributes) (see [below for nested schema](#nestedatt--service_groups--node--compute))
101
+
-`disk` (Attributes) (see [below for nested schema](#nestedatt--service_groups--node--disk))
### Nested Schema for `service_groups.node.compute`
105
+
106
+
Read-Only:
107
+
108
+
-`cpu` (Number)
109
+
-`ram` (Number)
110
+
111
+
112
+
<aid="nestedatt--service_groups--node--disk"></a>
113
+
### Nested Schema for `service_groups.node.disk`
114
+
115
+
Read-Only:
116
+
117
+
-`autoexpansion` (Boolean)
118
+
-`iops` (Number)
119
+
-`storage` (Number)
120
+
-`type` (String)
121
+
122
+
123
+
124
+
125
+
<aid="nestedatt--support"></a>
126
+
### Nested Schema for `support`
127
+
128
+
Read-Only:
129
+
130
+
-`plan` (String) - Plan type, either 'Basic', 'Developer Pro', or 'Enterprise'. Plan type allowed for singleNode cluster is either 'Basic', or 'Developer Pro'. In case of 'Basic' plan timezone field value is ignored.
# generated by https://github.com/hashicorp/terraform-plugin-docs
3
+
page_title: "couchbase-capella_project Data Source - terraform-provider-couchbase-capella"
4
+
subcategory: ""
5
+
description: |-
6
+
The data source to retrieve information about a Capella project.
7
+
---
8
+
9
+
# couchbase-capella_project (Data Source)
10
+
11
+
The data source to retrieve information about a Capella project.
12
+
13
+
## Example Usage
14
+
15
+
```terraform
16
+
data "couchbase-capella_projects" "existing_projects" {
17
+
organization_id = "<organization_id>"
18
+
}
19
+
```
20
+
21
+
<!-- schema generated by tfplugindocs -->
22
+
## Schema
23
+
24
+
### Required
25
+
26
+
-`id` (String) - A GUID4 identifier of the project.
27
+
-**Format**: UUID (GUID4)
28
+
-`organization_id` (String) The GUID4 ID of the organization.
29
+
30
+
### Optional
31
+
32
+
-`if_match` (String) A precondition header that specifies the entity tag of a resource.
33
+
34
+
### Read-Only
35
+
36
+
-`audit` (Attributes) Couchbase audit data. (see [below for nested schema](#nestedatt--audit))
37
+
-`description` (String) - A short description of the project (up to 256 characters).
38
+
-**Constraints**: Maximum length: 256 characters
39
+
-`etag` (String) Entity tag for the resource, used for caching and conditional requests.
40
+
-`name` (String) - The name of the project (up to 128 characters).
41
+
-**Constraints**: Maximum length: 128 characters
42
+
43
+
<aid="nestedatt--audit"></a>
44
+
### Nested Schema for `audit`
45
+
46
+
Read-Only:
47
+
48
+
-`created_at` (String) - The RFC3339 timestamp associated with when the resource was initially created.
49
+
-**Format**: Date-time in RFC3339 format
50
+
-`created_by` (String) - The user who created the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users.
51
+
-`modified_at` (String) - The RFC3339 timestamp associated with when the resource was last modified.
52
+
-**Format**: Date-time in RFC3339 format
53
+
-`modified_by` (String) - The user who last modified the resource; this will be a UUID4 ID for standard users and wilmal be a string such as "internal-support" for internal Couchbase support users.
54
+
-`version` (Number) - The version of the document. This value is incremented each time the resource is modified.
Couchbase Capella Provider 1.8.1: Upgrade and Information Guide
7
+
---
8
+
9
+
# Couchbase Capella Provider 1.8.1: Upgrade and Information Guide
10
+
11
+
Here is a list of what's new in 1.8.1
12
+
13
+
## New Features
14
+
15
+
* UUID Parsing Helper: New helper function for parsing UUIDs consistently across resources.
16
+
* Filter by Cluster or Project: Enhanced filtering capabilities for data sources.
17
+
18
+
## Bug Fixes
19
+
20
+
* Prevent perpetual state drift by preserving nil CORS configuration [#566](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/566)
21
+
* Fix app endpoint creation without CORS [#565](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/565)
* Make CopyToRegions a Set to prevent ordering issues [#548](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/548)
24
+
* Set state straight after successful App Endpoint creation [#540](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/pull/540)
25
+
26
+
## Breaking Changes
27
+
28
+
There are no breaking changes as part of this release.
29
+
30
+
## Changes
31
+
32
+
1.8.1 includes bug fixes and general improvements. See the [CHANGELOG](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/CHANGELOG.md) for more specific information.
33
+
34
+
### Helpful Links
35
+
36
+
-[Getting Started with the Terraform Provider](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples/getting_started)
37
+
-[Capella Management API v4.0](https://docs.couchbase.com/cloud/management-api-reference/index.html)
38
+
-[See Specific Examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples)
Copy file name to clipboardExpand all lines: docs/index.md
+36-2Lines changed: 36 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -174,15 +174,17 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec
174
174
175
175
Every API key is associated with an allowed IP Address list, and one or more organization roles, which determine the [privileges that the API key has](https://docs.couchbase.com/cloud/management-api-guide/management-api-start.html#understand-management-api-keys) within the organization.
Within organizations, [projects](https://docs.couchbase.com/cloud/projects/projects.html) are used to organize and manage groups of Couchbase databases.
180
180
An organization can contain any number of projects, and a project can contain any number of databases.
181
+
You can also retrieve the details of an existing project using the `couchbase-capella_project` datasource.
The Cluster is the individual instance of a [Couchbase Database](https://docs.couchbase.com/cloud/clusters/databases.html), spanning one or more nodes on your Cloud Service Provider, and containing the Data Service, and any other services which you choose to deploy.
185
186
Within this sits the hierarchy of bucket, scope, collection, and document.
187
+
You can also retrieve the details of an existing cluster using the `couchbase-capella_cluster` datasource.
Manage the logging configuration for App Endpoints. Controls what logs are streamed to the log collector configured on the App Service. Requires App Service Log Streaming to be enabled.
Set up import filters to control which documents are synced from the Couchbase Server to mobile clients.
@@ -291,10 +301,22 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec
291
301
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.
292
302
When you turn your provisioned database off, you will be charged the OFF amount for the database.
Retrieve statistics for a specific cluster in Capella, including resource utilization and performance metrics.
307
+
294
308
*[Turn App Service On/Off On Demand](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/app_service_onoff_ondemand):
295
309
296
310
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).
297
311
312
+
*[Configure App Service Log Streaming](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/app_service_log_streaming):
313
+
314
+
Set up and manage log streaming for a Capella App Service to forward logs to an external log collector.
315
+
316
+
*[Manage App Service Log Streaming Activation Status](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/app_service_log_streaming_activation_status):
317
+
318
+
Control whether App Service Log Streaming is paused or enabled. Log Streaming must already be configured on the App Service.
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.
@@ -327,6 +349,14 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec
327
349
328
350
List the information of all the events within an organization. The list can be customized using filters.
329
351
352
+
*[Retrieve a Specific Project Event](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/project_event):
353
+
354
+
Fetch the details of any specific event within a project using the event ID, project ID, and organization ID.
355
+
356
+
*[Retrieve All Project Events](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/project_events):
357
+
358
+
List all events within a project. The list can be filtered by cluster ID, user ID, severity levels, tags, time range, and other attributes.
359
+
330
360
*[Retrieve Private Endpoint Command for AWS](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/private_endpoint_command/AWS):
331
361
332
362
Retrieve the AWS command used to configure a VPC endpoint.
@@ -339,6 +369,10 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec
339
369
340
370
Retrieve the Azure command used to configure a private endpoint.
341
371
372
+
*[Retrieve Azure Network Peer Role Assignment Command](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/network_peer_command_azure):
373
+
374
+
Retrieve the Azure role assignment command to be run in the Azure CLI to configure a network peer. Requires the Admin consent granting process to be completed through the Capella UI first.
0 commit comments