Skip to content

CHINA-495: Add custom TLS certificate for clickhouse #109

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.

Sign up for GitHub

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

Open
ianton-ru wants to merge 4 commits into
base: main
Choose a base branch
from
Open

CHINA-495: Add custom TLS certificate for clickhouse #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dfe9a53
CHINA-495: Add custom TLS certificate for clickhouse
ianton-ru Sep 17, 2024
e26b191
Fix after review
ianton-ru Sep 25, 2024
d5f0746
Merge main
ianton-ru Sep 26, 2024
c756f04
fix mudules versions
ianton-ru Sep 26, 2024
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
19 changes: 19 additions & 0 deletions docs/data-sources/clickhouse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Clickhouse data source

- `cloud_type` (String) Cloud provider (`aws`, `gcp`, or `azure`)
- `connection_info` (Attributes) Public connection info (see [below for nested schema](#nestedatt--connection_info))
- `custom_certificate` (Attributes) Custom TLS certificate (see [below for nested schema](#nestedatt--custom_certificate))
- `description` (String) Cluster description
- `private_connection_info` (Attributes) Private connection info (see [below for nested schema](#nestedatt--private_connection_info))
- `region_id` (String) Region where the cluster is located
Expand All @@ -40,26 +41,44 @@ Read-Only:

- `host` (String) Host to connect to
- `https_port` (Number) Port to connect to using the HTTPS protocol
- `https_port_ctls` (Number) Port to connect to using the HTTPS protocol with custom TLS certificate
- `https_uri` (String) URI to connect to using the HTTPS protocol
- `https_uri_ctls` (String) URI to connect to using the HTTPS protocol with custom TLS certificate
- `jdbc_uri` (String) URI to connect to using the JDBC protocol
- `native_protocol` (String) Connection string for the ClickHouse native protocol
- `native_protocol_ctls` (String) Connection string for the ClickHouse native protocol with custom TLS certificate
- `odbc_uri` (String) URI to connect to using the ODBC protocol
- `password` (String, Sensitive) Password for the ClickHouse user
- `tcp_port_secure` (Number) Port to connect to using the TCP/native protocol
- `tcp_port_secure_ctls` (Number) Port to connect to using the TCP/native protocol with custom TLS certificate
- `user` (String) ClickHouse user


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

Read-Only:

- `certificate` (String) Public certificate
- `key` (String) Private certificate key
Copy link
Author

@ianton-ru ianton-ru Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove 'key' from datasource

Copy link
Author

@ianton-ru ianton-ru Sep 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without key can't check changes in private part
For example if customer used at first time wrong private part, changing in private part is not detected withoput changing in public part (certificate).

- `root_ca` (String) Root certificate


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

Read-Only:

- `host` (String) Host to connect to
- `https_port` (Number) Port to connect to using the HTTPS protocol
- `https_port_ctls` (Number) Port to connect to using the HTTPS protocol with custom TLS certificate
- `https_uri` (String) URI to connect to using the HTTPS protocol
- `https_uri_ctls` (String) URI to connect to using the HTTPS protocol with custom TLS certificate
- `jdbc_uri` (String) URI to connect to using the JDBC protocol
- `native_protocol` (String) Connection string for the ClickHouse native protocol
- `native_protocol_ctls` (String) Connection string for the ClickHouse native protocol with custom TLS certificate
- `odbc_uri` (String) URI to connect to using the ODBC protocol
- `password` (String, Sensitive) Password for the ClickHouse user
- `tcp_port_secure` (Number) Port to connect to using the TCP/native protocol
- `tcp_port_secure_ctls` (Number) Port to connect to using the TCP/native protocol with custom TLS certificate
- `user` (String) ClickHouse user
19 changes: 19 additions & 0 deletions docs/resources/clickhouse_cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ resource "doublecloud_clickhouse_cluster" "example-clickhouse" {

- `access` (Block, Optional) Access control configuration (see [below for nested schema](#nestedblock--access))
- `config` (Block, Optional) (see [below for nested schema](#nestedblock--config))
- `custom_certificate` (Block, Optional) Custom TLS certificate (see [below for nested schema](#nestedblock--custom_certificate))
- `description` (String) Cluster description
- `id` (String) Cluster ID
- `resources` (Block, Optional) Cluster resources (see [below for nested schema](#nestedblock--resources))
Expand Down Expand Up @@ -179,6 +180,16 @@ Optional:



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

Optional:

- `certificate` (String) Public certificate
- `key` (String) Private certificate key
- `root_ca` (String) Root certificate


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

Expand Down Expand Up @@ -222,12 +233,16 @@ Read-Only:

- `host` (String) Host to connect to
- `https_port` (Number) Port to connect to using the HTTPS protocol
- `https_port_ctls` (Number) Port to connect to using the HTTPS protocol with custom TLS certificate
- `https_uri` (String) URI to connect to using the HTTPS protocol
- `https_uri_ctls` (String) URI to connect to using the HTTPS protocol with custom TLS certificate
- `jdbc_uri` (String) URI to connect to using the JDBC protocol
- `native_protocol` (String) Connection string for the ClickHouse native protocol
- `native_protocol_ctls` (String) Connection string for the ClickHouse native protocol with custom TLS certificate
- `odbc_uri` (String) URI to connect to using the ODBC protocol
- `password` (String, Sensitive) Password for the ClickHouse user
- `tcp_port_secure` (Number) Port to connect to using the TCP/native protocol
- `tcp_port_secure_ctls` (Number) Port to connect to using the TCP/native protocol with custom TLS certificate
- `user` (String) ClickHouse user


Expand All @@ -238,10 +253,14 @@ Read-Only:

- `host` (String) Host to connect to
- `https_port` (Number) Port to connect to using the HTTPS protocol
- `https_port_ctls` (Number) Port to connect to using the HTTPS protocol with custom TLS certificate
- `https_uri` (String) URI to connect to using the HTTPS protocol
- `https_uri_ctls` (String) URI to connect to using the HTTPS protocol with custom TLS certificate
- `jdbc_uri` (String) URI to connect to using the JDBC protocol
- `native_protocol` (String) Connection string for the ClickHouse native protocol
- `native_protocol_ctls` (String) Connection string for the ClickHouse native protocol with custom TLS certificate
- `odbc_uri` (String) URI to connect to using the ODBC protocol
- `password` (String, Sensitive) Password for the ClickHouse user
- `tcp_port_secure` (Number) Port to connect to using the TCP/native protocol
- `tcp_port_secure_ctls` (Number) Port to connect to using the TCP/native protocol with custom TLS certificate
- `user` (String) ClickHouse user
168 changes: 84 additions & 84 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,91 +5,91 @@ go 1.22
toolchain go1.22.1

require (
github.com/doublecloud/go-genproto v0.0.0-20240925040734-4ee53097d55f
github.com/doublecloud/go-sdk v0.0.0-20240906203850-b5930ce34fca
github.com/golang/protobuf v1.5.4
github.com/google/uuid v1.6.0
github.com/hashicorp/terraform-plugin-docs v0.19.0
github.com/hashicorp/terraform-plugin-framework v1.8.0
github.com/hashicorp/terraform-plugin-framework-validators v0.12.0
github.com/hashicorp/terraform-plugin-go v0.22.2
github.com/hashicorp/terraform-plugin-log v0.9.0
github.com/hashicorp/terraform-plugin-testing v1.7.0
github.com/stretchr/testify v1.9.0
google.golang.org/grpc v1.65.0
google.golang.org/protobuf v1.34.2
github.com/doublecloud/go-genproto v0.0.0-20240925040734-4ee53097d55f
github.com/doublecloud/go-sdk v0.0.0-20240906203850-b5930ce34fca
github.com/golang/protobuf v1.5.4
github.com/google/uuid v1.6.0
github.com/hashicorp/terraform-plugin-docs v0.19.0
github.com/hashicorp/terraform-plugin-framework v1.8.0
github.com/hashicorp/terraform-plugin-framework-validators v0.12.0
github.com/hashicorp/terraform-plugin-go v0.22.2
github.com/hashicorp/terraform-plugin-log v0.9.0
github.com/hashicorp/terraform-plugin-testing v1.7.0
github.com/stretchr/testify v1.9.0
google.golang.org/grpc v1.65.0
google.golang.org/protobuf v1.34.2
)

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.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
github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
github.com/google/go-cmp v0.6.0 // indirect
github.com/hashicorp/cli v1.1.6 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-checkpoint v0.5.0 // indirect
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect
github.com/hashicorp/go-hclog v1.6.3 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
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.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-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
github.com/hashicorp/yamux v0.1.1 // indirect
github.com/huandu/xstrings v1.3.3 // indirect
github.com/imdario/mergo v0.3.15 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-runewidth v0.0.9 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/go-testing-interface v1.14.1 // indirect
github.com/mitchellh/go-wordwrap v1.0.0 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/oklog/run v1.1.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/posener/complete v1.2.3 // indirect
github.com/shopspring/decimal v1.3.1 // indirect
github.com/spf13/cast v1.5.0 // indirect
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.7.0 // indirect
github.com/yuin/goldmark-meta v1.1.0 // indirect
github.com/zclconf/go-cty v1.14.4 // indirect
go.abhg.dev/goldmark/frontmatter v0.2.0 // indirect
golang.org/x/crypto v0.23.0 // indirect
golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df // indirect
golang.org/x/mod v0.16.0 // indirect
golang.org/x/net v0.25.0 // indirect
golang.org/x/sync v0.7.0 // indirect
golang.org/x/sys v0.20.0 // indirect
golang.org/x/text v0.15.0 // indirect
golang.org/x/tools v0.13.0 // indirect
google.golang.org/appengine v1.6.8 // indirect
google.golang.org/genproto v0.0.0-20240429193739-8cf5692501f6 // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20240528184218-531527333157 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240528184218-531527333157 // indirect
gopkg.in/yaml.v2 v2.3.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
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.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
github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
github.com/google/go-cmp v0.6.0 // indirect
github.com/hashicorp/cli v1.1.6 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-checkpoint v0.5.0 // indirect
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect
github.com/hashicorp/go-hclog v1.6.3 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
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.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-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
github.com/hashicorp/yamux v0.1.1 // indirect
github.com/huandu/xstrings v1.3.3 // indirect
github.com/imdario/mergo v0.3.15 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-runewidth v0.0.9 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/go-testing-interface v1.14.1 // indirect
github.com/mitchellh/go-wordwrap v1.0.0 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/oklog/run v1.1.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/posener/complete v1.2.3 // indirect
github.com/shopspring/decimal v1.3.1 // indirect
github.com/spf13/cast v1.5.0 // indirect
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.7.0 // indirect
github.com/yuin/goldmark-meta v1.1.0 // indirect
github.com/zclconf/go-cty v1.14.4 // indirect
go.abhg.dev/goldmark/frontmatter v0.2.0 // indirect
golang.org/x/crypto v0.23.0 // indirect
golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df // indirect
golang.org/x/mod v0.16.0 // indirect
golang.org/x/net v0.25.0 // indirect
golang.org/x/sync v0.7.0 // indirect
golang.org/x/sys v0.20.0 // indirect
golang.org/x/text v0.15.0 // indirect
golang.org/x/tools v0.13.0 // indirect
google.golang.org/appengine v1.6.8 // indirect
google.golang.org/genproto v0.0.0-20240429193739-8cf5692501f6 // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20240528184218-531527333157 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240528184218-531527333157 // indirect
gopkg.in/yaml.v2 v2.3.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
Loading