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

Prepare release documentation #186

Merged
merged 2 commits into from
Apr 25, 2024
Merged
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
36 changes: 36 additions & 0 deletions docs/data-sources/audit_log_event_ids.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "couchbase-capella_audit_log_event_ids Data Source - terraform-provider-couchbase-capella"
subcategory: ""
description: |-

---

# couchbase-capella_audit_log_event_ids (Data Source)





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

### Required

- `cluster_id` (String)
- `organization_id` (String)
- `project_id` (String)

### Read-Only

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

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

Read-Only:

- `description` (String)
- `id` (Number)
- `module` (String)
- `name` (String)
42 changes: 42 additions & 0 deletions docs/data-sources/audit_log_export.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "couchbase-capella_audit_log_export Data Source - terraform-provider-couchbase-capella"
subcategory: ""
description: |-

---

# couchbase-capella_audit_log_export (Data Source)





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

### Required

- `cluster_id` (String)
- `organization_id` (String)
- `project_id` (String)

### Read-Only

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

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

Read-Only:

- `audit_log_download_url` (String)
- `cluster_id` (String)
- `created_at` (String)
- `end` (String)
- `expiration` (String)
- `id` (String)
- `organization_id` (String)
- `project_id` (String)
- `start` (String)
- `status` (String)
36 changes: 36 additions & 0 deletions docs/data-sources/audit_log_settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "couchbase-capella_audit_log_settings Data Source - terraform-provider-couchbase-capella"
subcategory: ""
description: |-

---

# couchbase-capella_audit_log_settings (Data Source)





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

### Required

- `cluster_id` (String)
- `organization_id` (String)
- `project_id` (String)

### Read-Only

- `audit_enabled` (Boolean)
- `disabled_users` (Attributes Set) (see [below for nested schema](#nestedatt--disabled_users))
- `enabled_event_ids` (Set of Number)

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

Read-Only:

- `domain` (String)
- `name` (String)
2 changes: 1 addition & 1 deletion docs/data-sources/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Read-Only:
- `disk` (Attributes) (see [below for nested schema](#nestedatt--data--service_groups--node--disk))

<a id="nestedatt--data--service_groups--node--compute"></a>
### Nested Schema for `data.service_groups.node.disk`
### Nested Schema for `data.service_groups.node.compute`

Read-Only:

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

# Couchbase Capella Provider 1.2.0: Upgrade and Information Guide

Here is a list of what's new in 1.2.0

## New Features
aniket-Kumar-c marked this conversation as resolved.
Show resolved Hide resolved

aniket-Kumar-c marked this conversation as resolved.
Show resolved Hide resolved
* Enable audit logging for clusters and manage audit log settings with [`couchbase-capella_audit_log_settings`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/resources/audit_log_settings)
* Export capella audit logs with [`couchbase-capella_audit_log_export`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/resources/audit_log_export)
* Retrieve audit log events for a cluster with data-source [`couchbase-capella_audit_log_event_ids`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/data-sources/audit_log_event_ids)

## Changes

There are no deprecations as part of this release.

## Enable audit logging for clusters and manage audit log settings

To create a new audit log settings, use the `audit_log_settings` resource as follows:

```
resource "couchbase-capella_audit_log_settings" "new_auditlogsettings" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
audit_enabled = var.auditlogsettings.audit_enabled
enabled_event_ids = var.auditlogsettings.enabled_event_ids
disabled_users = var.auditlogsettings.disabled_users
}
```

Utilize the `audit_log_settings` data source to fetch the existing list of audit log settings.

```
output "existing_auditlogsettings" {
value = data.couchbase-capella_audit_log_settings.existing_auditlogsettings
}

data "couchbase-capella_audit_log_settings" "existing_auditlogsettings" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
}
```
For more information, see the [managing audit log settings examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples/audit_log_settings)


## Export Capella Audit logs

To export audit logs, use the `audit_log_export` resource as follows:

```
resource "couchbase-capella_audit_log_export" "new_auditlogexport" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
start = var.audit_log_export.start
end = var.audit_log_export.end
}
```

Utilize the `audit_log_export` data source to fetch the existing list of audit log export jobs.

```
output "existing_auditlogexport" {
value = data.couchbase-capella_audit_log_export.existing_auditlogexport
}

data "couchbase-capella_audit_log_export" "existing_auditlogexport" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
}
```

For more information, see the [managing audit log exports examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples/audit_log_export)

## Retrieve audit log events for a cluster

Utilize the `audit_log_event_ids` data source to fetch the existing list of audit log event IDs for a cluster.

```
output "existing_auditlogeventids" {
value = data.couchbase-capella_audit_log_event_ids.existing_auditlogeventids
}

data "couchbase-capella_audit_log_event_ids" "existing_auditlogeventids" {
organization_id = var.organization_id
project_id = var.project_id
cluster_id = var.cluster_id
}
```
For more information, see the [retrieving audit log events examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples/audit_logs_event_ids)


### 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)
12 changes: 12 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,3 +258,15 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec

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.

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

Export Audit Logs.

* [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.

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

---

# couchbase-capella_audit_log_export (Resource)





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

### Required

- `audit_log_download_url` (String)
- `cluster_id` (String)
- `created_at` (String)
- `end` (String)
- `expiration` (String)
- `organization_id` (String)
- `project_id` (String)
- `start` (String)
- `status` (String)

### Read-Only

- `id` (String) The ID of this resource.
36 changes: 36 additions & 0 deletions docs/resources/audit_log_settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "couchbase-capella_audit_log_settings Resource - terraform-provider-couchbase-capella"
subcategory: ""
description: |-

---

# couchbase-capella_audit_log_settings (Resource)





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

### Required

- `cluster_id` (String)
- `organization_id` (String)
- `project_id` (String)

### Optional

- `audit_enabled` (Boolean)
- `disabled_users` (Attributes Set) (see [below for nested schema](#nestedatt--disabled_users))
- `enabled_event_ids` (Set of Number)

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

Required:

- `domain` (String)
- `name` (String)
17 changes: 10 additions & 7 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,17 @@ require (
)

require (
github.com/BurntSushi/toml v1.2.1 // indirect
github.com/Kunde21/markdownfmt/v3 v3.1.0 // indirect
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver/v3 v3.2.0 // indirect
github.com/Masterminds/sprig/v3 v3.2.3 // indirect
github.com/ProtonMail/go-crypto v1.1.0-alpha.0 // indirect
github.com/ProtonMail/go-crypto v1.1.0-alpha.2 // indirect
github.com/agext/levenshtein v1.2.2 // indirect
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/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 @@ -39,12 +41,12 @@ require (
github.com/hashicorp/go-plugin v1.6.0 // indirect
github.com/hashicorp/go-uuid v1.0.3 // indirect
github.com/hashicorp/go-version v1.6.0 // indirect
github.com/hashicorp/hc-install v0.6.3 // indirect
github.com/hashicorp/hc-install v0.6.4 // indirect
github.com/hashicorp/hcl/v2 v2.20.0 // indirect
github.com/hashicorp/logutils v1.0.0 // indirect
github.com/hashicorp/terraform-exec v0.20.0 // indirect
github.com/hashicorp/terraform-json v0.21.0 // indirect
github.com/hashicorp/terraform-plugin-docs v0.18.0 // indirect
github.com/hashicorp/terraform-plugin-docs v0.19.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 @@ -71,13 +73,14 @@ require (
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.6.0 // indirect
github.com/yuin/goldmark v1.7.0 // indirect
github.com/yuin/goldmark-meta v1.1.0 // indirect
github.com/zclconf/go-cty v1.14.3 // indirect
github.com/zclconf/go-cty v1.14.4 // indirect
go.abhg.dev/goldmark/frontmatter v0.2.0 // indirect
golang.org/x/crypto v0.21.0 // indirect
golang.org/x/exp v0.0.0-20231226003508-02704c960a9b // indirect
golang.org/x/mod v0.15.0 // indirect
golang.org/x/net v0.21.0 // indirect
golang.org/x/mod v0.16.0 // indirect
golang.org/x/net v0.22.0 // indirect
golang.org/x/sys v0.18.0 // indirect
golang.org/x/text v0.14.0 // indirect
golang.org/x/tools v0.16.0 // indirect
Expand Down
Loading
Loading