diff --git a/docs/data-sources/private_endpoint_config.md b/docs/data-sources/private_endpoint_config.md new file mode 100644 index 00000000..cb777671 --- /dev/null +++ b/docs/data-sources/private_endpoint_config.md @@ -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 + +### 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. + + diff --git a/docs/index.md b/docs/index.md index 829cb9bb..3be53055 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,12 +25,9 @@ provider "clickhouse" { ## 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. diff --git a/docs/resources/private_endpoint_registration.md b/docs/resources/private_endpoint_registration.md new file mode 100644 index 00000000..c4e06429 --- /dev/null +++ b/docs/resources/private_endpoint_registration.md @@ -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 + +### 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 + + diff --git a/docs/resources/service.md b/docs/resources/service.md index 820ae12e..4536fec4 100644 --- a/docs/resources/service.md +++ b/docs/resources/service.md @@ -32,6 +32,7 @@ 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 @@ -39,6 +40,7 @@ description: |- - `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)) ### Nested Schema for `ip_access` @@ -62,3 +64,12 @@ Read-Only: - `protocol` (String) Endpoint protocol: https or nativesecure + +### 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 + +