Skip to content

Commit

Permalink
Generate documentation (Mongey#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mongey authored Jun 24, 2021
1 parent e14890d commit a65b712
Show file tree
Hide file tree
Showing 8 changed files with 204 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
page_title: "confluentcloud Provider"
subcategory: ""
description: |-
---

# confluentcloud Provider





## Schema

### Optional

- **password** (String, Sensitive)
- **username** (String)
33 changes: 33 additions & 0 deletions docs/resources/api_key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
page_title: "confluentcloud_api_key Resource - terraform-provider-confluentcloud"
subcategory: ""
description: |-
---

# Resource `confluentcloud_api_key`





## Schema

### Required

- **environment_id** (String) Environment ID

### Optional

- **cluster_id** (String)
- **description** (String) Description
- **id** (String) The ID of this resource.
- **logical_clusters** (List of String) Logical Cluster ID List to create API Key
- **user_id** (Number) User ID

### Read-only

- **key** (String)
- **secret** (String, Sensitive)


35 changes: 35 additions & 0 deletions docs/resources/connector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
page_title: "confluentcloud_connector Resource - terraform-provider-confluentcloud"
subcategory: ""
description: |-
---

# Resource `confluentcloud_connector`





## Schema

### Required

- **cluster_id** (String) ID of containing cluster, e.g. lkc-abc123
- **config** (Map of String) Type-specific Configuration of cluster. String keys and values
- **environment_id** (String) ID of containing environment, e.g. env-abc123
- **name** (String) The name of the connector

### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

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

Optional:

- **create** (String)


24 changes: 24 additions & 0 deletions docs/resources/environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
page_title: "confluentcloud_environment Resource - terraform-provider-confluentcloud"
subcategory: ""
description: |-
---

# Resource `confluentcloud_environment`





## Schema

### Required

- **name** (String) The name of the environment

### Optional

- **id** (String) The ID of this resource.


37 changes: 37 additions & 0 deletions docs/resources/kafka_cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
page_title: "confluentcloud_kafka_cluster Resource - terraform-provider-confluentcloud"
subcategory: ""
description: |-
---

# Resource `confluentcloud_kafka_cluster`





## Schema

### Required

- **availability** (String) LOW(single-zone) or HIGH(multi-zone)
- **environment_id** (String) Environment ID
- **name** (String) The name of the cluster
- **region** (String) where
- **service_provider** (String) AWS / GCP

### Optional

- **cku** (Number) cku
- **deployment** (Map of String) Deployment settings. Currently only `sku` is supported.
- **id** (String) The ID of this resource.
- **network_egress** (Number) Network egress limit(MBps)
- **network_ingress** (Number) Network ingress limit(MBps)
- **storage** (Number) Storage limit(GB)

### Read-only

- **bootstrap_servers** (String)


30 changes: 30 additions & 0 deletions docs/resources/schema_registry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
page_title: "confluentcloud_schema_registry Resource - terraform-provider-confluentcloud"
subcategory: ""
description: |-
---

# Resource `confluentcloud_schema_registry`





## Schema

### Required

- **environment_id** (String) Environment ID
- **region** (String) where
- **service_provider** (String) Cloud provider

### Optional

- **id** (String) The ID of this resource.

### Read-only

- **endpoint** (String)


25 changes: 25 additions & 0 deletions docs/resources/service_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
page_title: "confluentcloud_service_account Resource - terraform-provider-confluentcloud"
subcategory: ""
description: |-
---

# Resource `confluentcloud_service_account`





## Schema

### Required

- **description** (String) Service Account Description
- **name** (String) Service Account Name

### Optional

- **id** (String) The ID of this resource.


1 change: 1 addition & 0 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
)

//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
func main() {
plugin.Serve(&plugin.ServeOpts{ProviderFunc: c.Provider})
}

0 comments on commit a65b712

Please sign in to comment.