Skip to content

Provide https support for health check #912

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

Merged
sunsingerus merged 2 commits into from
Apr 7, 2022
Merged

Provide https support for health check #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c5e466
Provide https support for health check
bkuschel Apr 1, 2022
bd981ad
Make tls_config a constant
bkuschel Apr 4, 2022
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
1 change: 1 addition & 0 deletions cmd/metrics_exporter/app/metrics_exporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ func Run() {

exporter := metrics.StartMetricsREST(
metrics.NewCHAccessInfo(
chop.Config().ClickHouse.Access.Scheme,
chop.Config().ClickHouse.Access.Username,
chop.Config().ClickHouse.Access.Password,
chop.Config().ClickHouse.Access.Port,
Expand Down
3 changes: 3 additions & 0 deletions ...-install-bundle/clickhouse-operator-install-yaml-template-01-section-crd-02-chopconf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/clickhouse-operator-install-bundle-v1beta1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2747,6 +2747,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/clickhouse-operator-install-bundle.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2775,6 +2775,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/clickhouse-operator-install-template-dev.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2760,6 +2760,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/clickhouse-operator-install-template-v1beta1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2747,6 +2747,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/clickhouse-operator-install-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2775,6 +2775,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/clickhouse-operator-install-tf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2782,6 +2782,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
3 changes: 3 additions & 0 deletions deploy/operator/parts/crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2775,6 +2775,9 @@ spec:
access:
type: object
properties:
scheme:
type: string
description: "The scheme to user for connecting to ClickHouse. One of http or https"
username:
type: string
description: "ClickHouse username to be used by operator to connect to ClickHouse instances, deprecated, use chCredentialsSecretName"
Expand Down
4 changes: 2 additions & 2 deletions dev/go_build_universal.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ GOOS=${GOOS:-linux}
GOARCH=${GOARCH:-amd64}

if [[ "" != "${GCFLAGS:-}" ]]; then
GCFLAGS="-gcflags ${GCFLAGS:-}"
GCFLAG='-gcflags'
Copy link
Copy Markdown
Collaborator

@sunsingerus sunsingerus Apr 2, 2022

Choose a reason for hiding this comment

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

See my comment below on the call line

fi

if CGO_ENABLED=0 GO111MODULE=on GOOS="${GOOS}" GOARCH="${GOARCH}" go build \
Expand All @@ -29,7 +29,7 @@ if CGO_ENABLED=0 GO111MODULE=on GOOS="${GOOS}" GOARCH="${GOARCH}" go build \
-X ${REPO}/pkg/version.GitSHA=${GIT_SHA} \
-X ${REPO}/pkg/version.BuiltAt=${NOW} \
" \
${GCFLAGS:-} \
$GCFLAG "${GCFLAGS:-}" \
Copy link
Copy Markdown
Collaborator

@sunsingerus sunsingerus Apr 2, 2022

Choose a reason for hiding this comment

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

Can you, please, clarify, why would you like to create $GCFLAG as a separate var and not to add '-gcflags' to $GCFLAGS ?

Copy link
Copy Markdown
Contributor Author

@bkuschel bkuschel Apr 4, 2022

Choose a reason for hiding this comment

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

The original method had issues with the quotations being passed into go build. It wasn't parsing correctly, either wrapping the entire thing in single quotes (including the flag specificier) or each argument in single quotes. I was using go 1.17. I am not sure if it's particular to that version but doing it this way avoids the issue.

-o "${OUTPUT_BINARY}" \
"${MAIN_SRC_FILE}"
then
Expand Down
9 changes: 9 additions & 0 deletions pkg/apis/clickhouse.altinity.com/v1/type_config_chop.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ const (
// 1. Metrics requests
// 2. Schema maintenance
// User credentials can be specified in additional ClickHouse config files located in `chUsersConfigsPath` folder
defaultChScheme = "http"
defaultChUsername = ""
defaultChPassword = ""
defaultChPort = 8123
Expand Down Expand Up @@ -146,6 +147,7 @@ type OperatorConfigClickHouse struct {
// 1. Metrics requests
// 2. Schema maintenance
// User credentials can be specified in additional ClickHouse config files located in `chUsersConfigsPath` folder
Scheme string `json:"scheme" yaml:"scheme"`
Username string `json:"username" yaml:"username"`
Password string `json:"password" yaml:"password"`

Expand Down Expand Up @@ -324,6 +326,7 @@ type OperatorConfig struct {
// 1. Metrics requests
// 2. Schema maintenance
// User credentials can be specified in additional ClickHouse config files located in `chUsersConfigsPath` folder
CHScheme string `json:"chScheme" yaml:"chScheme"`
Copy link
Copy Markdown
Collaborator

@sunsingerus sunsingerus Apr 2, 2022

Choose a reason for hiding this comment

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

This section is kind of deprecated and is kept for backward-compatibility only. That's OK, it's just nice extra.

Copy link
Copy Markdown
Contributor Author

@bkuschel bkuschel Apr 4, 2022

Choose a reason for hiding this comment

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

I saw, wasn't sure, i thought it was no harm.

CHUsername string `json:"chUsername" yaml:"chUsername"`
CHPassword string `json:"chPassword" yaml:"chPassword"`
// Location of k8s Secret with username and password to be used by operator to connect to ClickHouse instances
Expand Down Expand Up @@ -645,6 +648,9 @@ func (c *OperatorConfig) normalizeAccessSection() {
// 1. Metrics requests
// 2. Schema maintenance
// User credentials can be specified in additional ClickHouse config files located in `chUsersConfigsPath` folder
if c.ClickHouse.Access.Scheme == "" {
c.ClickHouse.Access.Scheme = defaultChScheme
}
if c.ClickHouse.Access.Username == "" {
c.ClickHouse.Access.Username = defaultChUsername
}
Expand Down Expand Up @@ -941,6 +947,9 @@ func (c *OperatorConfig) move() {
// 1. Metrics requests
// 2. Schema maintenance
// User credentials can be specified in additional ClickHouse config files located in `chUsersConfigsPath` folder
if c.CHScheme != "" {
c.ClickHouse.Access.Password = c.CHScheme
}
if c.CHUsername != "" {
c.ClickHouse.Access.Username = c.CHUsername
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/apis/metrics/clickhouse_fetcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@ type ClickHouseFetcher struct {
}

// NewClickHouseFetcher creates new clickhouse fetcher object
func NewClickHouseFetcher(hostname, username, password string, port int) *ClickHouseFetcher {
func NewClickHouseFetcher(scheme, hostname, username, password string, port int) *ClickHouseFetcher {
return &ClickHouseFetcher{
connectionParams: clickhouse.NewConnectionParams(hostname, username, password, port),
connectionParams: clickhouse.NewConnectionParams(scheme, hostname, username, password, port),
}
}

Expand Down
1 change: 1 addition & 0 deletions pkg/apis/metrics/exporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ func (e *Exporter) updateWatched(chi *WatchedCHI) {
// newFetcher returns new Metrics Fetcher for specified host
func (e *Exporter) newFetcher(hostname string) *ClickHouseFetcher {
return NewClickHouseFetcher(
e.chAccessInfo.Scheme,
hostname,
e.chAccessInfo.Username,
e.chAccessInfo.Password,
Expand Down
4 changes: 3 additions & 1 deletion pkg/apis/metrics/type_ch_access_info.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@ package metrics

// CHAccessInfo specifies ClickHouse access info
type CHAccessInfo struct {
Scheme string
Username string
Password string
Port int
}

// NewCHAccessInfo creates new CHAccessInfo from specified access info
func NewCHAccessInfo(username, password string, port int) *CHAccessInfo {
func NewCHAccessInfo(scheme, username, password string, port int) *CHAccessInfo {
return &CHAccessInfo{
Scheme: scheme,
Username: username,
Password: password,
Port: port,
Expand Down
1 change: 1 addition & 0 deletions pkg/controller/chi/worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ func (c *Controller) newWorker(q queue.PriorityQueue, sys bool) *worker {
queue: q,
normalizer: chopmodel.NewNormalizer(c.kubeClient),
schemer: chopmodel.NewSchemer(
chop.Config().ClickHouse.Access.Scheme,
chop.Config().ClickHouse.Access.Username,
chop.Config().ClickHouse.Access.Password,
chop.Config().ClickHouse.Access.Port,
Expand Down
2 changes: 1 addition & 1 deletion pkg/model/clickhouse/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func (c *Cluster) SetHosts(hosts []string) *Cluster {

// getConnection gets connection
func (c *Cluster) getConnection(host string) *Connection {
return GetPooledDBConnection(NewConnectionParams(host, c.Username, c.Password, c.Port)).SetLog(c.l)
return GetPooledDBConnection(NewConnectionParams(c.Scheme, host, c.Username, c.Password, c.Port)).SetLog(c.l)
}

// QueryAny walks over all endpoints and runs query sequentially on each of them.
Expand Down
8 changes: 7 additions & 1 deletion pkg/model/clickhouse/connection.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ package clickhouse

import (
"context"
"crypto/tls"
databasesql "database/sql"
"fmt"
"time"
Expand All @@ -24,9 +25,13 @@ import (
"github.com/altinity/clickhouse-operator/pkg/util"

// go-clickhouse is explicitly required in order to setup connection to clickhouse db
_ "github.com/mailru/go-clickhouse"
goch "github.com/mailru/go-clickhouse"
)

func init(){
goch.RegisterTLSConfig(tlsSettings, &tls.Config{InsecureSkipVerify: true})
}

// Connection specifies clickhouse database connection object
type Connection struct {
params *ConnectionParams
Expand All @@ -41,6 +46,7 @@ func NewConnection(params *ConnectionParams) *Connection {
params: params,
l: log.New(),
}

}

// Params gets connection params
Expand Down
4 changes: 2 additions & 2 deletions pkg/model/clickhouse/connection_params.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ type ConnectionParams struct {
}

// NewConnectionParams creates new ConnectionParams
func NewConnectionParams(hostname, username, password string, port int) *ConnectionParams {
func NewConnectionParams(scheme, hostname, username, password string, port int) *ConnectionParams {
return &ConnectionParams{
NewEndpointCredentials(hostname, username, password, port),
NewEndpointCredentials(scheme, hostname, username, password, port),
NewTimeouts(),
}
}
16 changes: 13 additions & 3 deletions pkg/model/clickhouse/endpoint_credentials.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,22 @@ import (

const (
// http://user:password@host:8123/
chDsnUrlPattern = "http://%s%s:%s/"
chDsnUrlPattern = "%s://%s%s:%s/"

usernameReplacer = "***"
passwordReplacer = "***"

dsnUsernamePasswordPairPattern = "%s:%s@"
dsnUsernamePasswordPairUsernameOnlyPattern = "%s@"

httpsScheme = "https"
tlsSettings = "tls-settings"
)

// EndpointCredentials specifies credentials to access specified endpoint
type EndpointCredentials struct {
// External data
scheme string
hostname string
username string
password string
Expand All @@ -44,8 +48,9 @@ type EndpointCredentials struct {
}

// NewEndpointCredentials creates new EndpointCredentials object
func NewEndpointCredentials(hostname, username, password string, port int) *EndpointCredentials {
func NewEndpointCredentials(scheme, hostname, username, password string, port int) *EndpointCredentials {
params := &EndpointCredentials{
scheme: scheme,
hostname: hostname,
username: username,
password: password,
Expand Down Expand Up @@ -82,12 +87,17 @@ func (c *EndpointCredentials) makeUsernamePassword(hidden bool) string {

// makeDSN makes ClickHouse DSN
func (c *EndpointCredentials) makeDSN(hideCredentials bool) string {
return fmt.Sprintf(
baseUrl := fmt.Sprintf(
chDsnUrlPattern,
c.scheme,
c.makeUsernamePassword(hideCredentials),
c.hostname,
strconv.Itoa(c.port),
)
if c.scheme == httpsScheme {
baseUrl += "?tls_config=" + tlsSettings
}
return baseUrl
}

// GetDSN gets DSN
Expand Down
1 change: 1 addition & 0 deletions pkg/model/clickhouse/endpoint_credentials_cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ package clickhouse

// ClusterEndpointCredentials specifies cluster endpoint credentials
type ClusterEndpointCredentials struct {
Scheme string
Username string
Password string
Port int
Expand Down
3 changes: 2 additions & 1 deletion pkg/model/schemer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ type Schemer struct {
const ignoredDBs = `'system', 'information_schema', 'INFORMATION_SCHEMA'`

// NewSchemer creates new Schemer object
func NewSchemer(username, password string, port int) *Schemer {
func NewSchemer(scheme, username, password string, port int) *Schemer {
credentials := &clickhouse.ClusterEndpointCredentials{
Scheme: scheme,
Username: username,
Password: password,
Port: port,
Expand Down