Skip to content

Commit

Permalink
generate docs for v0.0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
Kinzeng committed Feb 14, 2024
1 parent de061aa commit 5d67eb3
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 7 deletions.
27 changes: 27 additions & 0 deletions docs/data-sources/private_endpoint_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "clickhouse_private_endpoint_config Data Source - clickhouse"
subcategory: ""
description: |-
---

# clickhouse_private_endpoint_config (Data Source)





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

### Required

- `cloud_provider` (String) The cloud provider for the private endpoint. Valid values are 'aws' or 'gcp'.
- `region` (String) The region for the private endpoint. Valid values are specific to the cloud provider i.e. us-east-2

### Read-Only

- `endpoint_service_id` (String) The ID of the private endpoint that is used to securely connect to ClickHouse. This is a read-only attribute.


11 changes: 4 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,9 @@ provider "clickhouse" {
<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `organization_id` (String) ID of the organization the provider will create services under.
- `token_key` (String) Token key of the key/secret pair. Used to authenticate with OpenAPI.
- `token_secret` (String, Sensitive) Token secret of the key/secret pair. Used to authenticate with OpenAPI.

### Optional

- `api_url` (String) API URL of the ClickHouse OpenAPI the provider will interact with. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
- `api_url` (String) API URL of the ClickHouse OpenAPI the provider will interact with. Alternatively, can be configured using the `CLICKHOUSE_API_URL` environment variable. Only specify if you have a specific deployment of the ClickHouse OpenAPI you want to run against.
- `organization_id` (String) ID of the organization the provider will create services under. Alternatively, can be configured using the `CLICKHOUSE_ORG_ID` environment variable.
- `token_key` (String) Token key of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the `CLICKHOUSE_TOKEN_KEY` environment variable.
- `token_secret` (String, Sensitive) Token secret of the key/secret pair. Used to authenticate with OpenAPI. Alternatively, can be configured using the `CLICKHOUSE_TOKEN_SECRET` environment variable.
28 changes: 28 additions & 0 deletions docs/resources/private_endpoint_registration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "clickhouse_private_endpoint_registration Resource - clickhouse"
subcategory: ""
description: |-
---

# clickhouse_private_endpoint_registration (Resource)





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

### Required

- `cloud_provider` (String) Cloud provider of the private endpoint ID
- `id` (String) ID of the private endpoint
- `region` (String) Region of the private endpoint

### Optional

- `description` (String) Description of the private endpoint


11 changes: 11 additions & 0 deletions docs/resources/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,15 @@ description: |-
- `min_total_memory_gb` (Number) Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
- `password` (String, Sensitive) Password for the default user. One of either `password` or `password_hash` must be specified.
- `password_hash` (String, Sensitive) SHA256 hash of password for the default user. One of either `password` or `password_hash` must be specified.
- `private_endpoint_ids` (List of String) List of private endpoint IDs

### Read-Only

- `endpoints` (Attributes List) List of public endpoints. (see [below for nested schema](#nestedatt--endpoints))
- `iam_role` (String) IAM role used for accessing objects in s3.
- `id` (String) ID of the created service. Generated by ClickHouse Cloud.
- `last_updated` (String) Date for when the service was last updated by Terraform.
- `private_endpoint_config` (Attributes) Service config for private endpoints (see [below for nested schema](#nestedatt--private_endpoint_config))

<a id="nestedatt--ip_access"></a>
### Nested Schema for `ip_access`
Expand All @@ -62,3 +64,12 @@ Read-Only:
- `protocol` (String) Endpoint protocol: https or nativesecure


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

Read-Only:

- `endpoint_service_id` (String) Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
- `private_dns_hostname` (String) Private DNS Hostname of the VPC you created


0 comments on commit 5d67eb3

Please sign in to comment.