Skip to content
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.

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

Backup: open mysql client TLS in backup #2003

Merged
merged 21 commits into from
Mar 23, 2020
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
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
13 changes: 12 additions & 1 deletion cmd/backup-manager/app/backup/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,26 @@ func (bm *Manager) ProcessBackup() error {
})
}

enableTLSClient := false
if backup.Spec.From.TLSClient != nil && backup.Spec.From.TLSClient.Enabled {
enableTLSClient = true
}

if backup.Spec.BR == nil {
return fmt.Errorf("no br config in %s", bm)
}

bm.setOptions(backup)

var db *sql.DB
var dsn string
err = wait.PollImmediate(constants.PollInterval, constants.CheckTimeout, func() (done bool, err error) {
db, err = util.OpenDB(bm.GetDSN())
dsn, err = bm.GetDSN(enableTLSClient)
if err != nil {
klog.Errorf("can't get dsn of tidb cluster %s, err: %s", bm, err)
return false, err
}
db, err = util.OpenDB(dsn)
if err != nil {
klog.Warningf("can't connect to tidb cluster %s, err: %s", bm, err)
return false, nil
Expand Down
10 changes: 9 additions & 1 deletion cmd/backup-manager/app/export/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,16 @@ func (bm *BackupManager) ProcessBackup() error {
bm.setOptions(backup)

var db *sql.DB
var dsn string
err = wait.PollImmediate(constants.PollInterval, constants.CheckTimeout, func() (done bool, err error) {
db, err = util.OpenDB(bm.GetDSN())
// TLS is not currently supported
dsn, err = bm.GetDSN(false)
DanielZhangQD marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
klog.Errorf("can't get dsn of tidb cluster %s, err: %s", bm, err)
return false, err
}

db, err = util.OpenDB(dsn)
if err != nil {
klog.Warningf("can't connect to tidb cluster %s, err: %s", bm, err)
return false, nil
Expand Down
10 changes: 9 additions & 1 deletion cmd/backup-manager/app/import/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,16 @@ func (rm *RestoreManager) ProcessRestore() error {
rm.setOptions(restore)

var db *sql.DB
var dsn string
err = wait.PollImmediate(constants.PollInterval, constants.CheckTimeout, func() (done bool, err error) {
db, err = util.OpenDB(rm.GetDSN())
// TLS is not currently supported
dsn, err = rm.GetDSN(false)
DanielZhangQD marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
klog.Errorf("can't get dsn of tidb cluster %s, err: %s", rm, err)
return false, err
}

db, err = util.OpenDB(dsn)
if err != nil {
klog.Warningf("can't connect to tidb cluster %s, err: %s", rm, err)
return false, nil
Expand Down
14 changes: 13 additions & 1 deletion cmd/backup-manager/app/restore/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,23 @@ func (rm *Manager) ProcessRestore() error {
return fmt.Errorf("no br config in %s", rm)
}

enableTLSClient := false
if restore.Spec.To.TLSClient != nil && restore.Spec.To.TLSClient.Enabled {
enableTLSClient = true
}

rm.setOptions(restore)

var db *sql.DB
var dsn string
err = wait.PollImmediate(constants.PollInterval, constants.CheckTimeout, func() (done bool, err error) {
db, err = util.OpenDB(rm.GetDSN())
dsn, err = rm.GetDSN(enableTLSClient)
if err != nil {
klog.Errorf("can't get dsn of tidb cluster %s, err: %s", rm, err)
return false, err
}

db, err = util.OpenDB(dsn)
if err != nil {
klog.Warningf("can't connect to tidb cluster %s, err: %s", rm, err)
return false, nil
Expand Down
36 changes: 34 additions & 2 deletions cmd/backup-manager/app/util/generic.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,18 @@
package util

import (
"crypto/tls"
"crypto/x509"
"database/sql"
"errors"
"fmt"
"io/ioutil"
"path"

"github.com/go-sql-driver/mysql"
"github.com/pingcap/tidb-operator/cmd/backup-manager/app/constants"
"github.com/pingcap/tidb-operator/pkg/util"
corev1 "k8s.io/api/core/v1"
)

// GenericOptions contains the generic input arguments to the backup/restore command
Expand All @@ -35,8 +43,32 @@ func (bo *GenericOptions) String() string {
return fmt.Sprintf("%s/%s", bo.Namespace, bo.ResourceName)
}

func (bo *GenericOptions) GetDSN() string {
return fmt.Sprintf("%s:%s@(%s:%d)/%s?charset=utf8", bo.User, bo.Password, bo.Host, bo.Port, constants.TidbMetaDB)
func (bo *GenericOptions) GetDSN(enabledTLSClient bool) (string, error) {
if !enabledTLSClient {
return fmt.Sprintf("%s:%s@(%s:%d)/%s?charset=utf8", bo.User, bo.Password, bo.Host, bo.Port, constants.TidbMetaDB), nil
}
rootCertPool := x509.NewCertPool()
pem, err := ioutil.ReadFile(path.Join(util.TiDBClientTLSPath, corev1.ServiceAccountRootCAKey))
if err != nil {
return "", err
}
if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
return "", errors.New("Failed to append PEM")
}
clientCert := make([]tls.Certificate, 0, 1)
certs, err := tls.LoadX509KeyPair(
path.Join(util.TiDBClientTLSPath, corev1.TLSCertKey),
path.Join(util.TiDBClientTLSPath, corev1.TLSPrivateKeyKey))
if err != nil {
return "", err
}
clientCert = append(clientCert, certs)
mysql.RegisterTLSConfig("customer", &tls.Config{
RootCAs: rootCertPool,
Certificates: clientCert,
ServerName: bo.Host,
})
return fmt.Sprintf("%s:%s@(%s:%d)/%s?tls=customer&charset=utf8", bo.User, bo.Password, bo.Host, bo.Port, constants.TidbMetaDB), nil
}

func (bo *GenericOptions) GetTikvGCLifeTime(db *sql.DB) (string, error) {
Expand Down
31 changes: 31 additions & 0 deletions docs/api-references/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -7056,6 +7056,21 @@ <h3 id="pingcap.com/v1alpha1.TiDBAccessConfig">TiDBAccessConfig
<p>SecretName is the name of secret which stores tidb cluster&rsquo;s password.</p>
</td>
</tr>
<tr>
<td>
<code>tlsClient</code></br>
<em>
<a href="#pingcap.com/v1alpha1.TiDBTLSClient">
TiDBTLSClient
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Whether enable the TLS connection between the SQL client and TiDB server
Optional: Defaults to nil</p>
</td>
</tr>
</tbody>
</table>
<h3 id="pingcap.com/v1alpha1.TiDBConfig">TiDBConfig
Expand Down Expand Up @@ -8045,6 +8060,7 @@ <h3 id="pingcap.com/v1alpha1.TiDBTLSClient">TiDBTLSClient
</h3>
<p>
(<em>Appears on:</em>
<a href="#pingcap.com/v1alpha1.TiDBAccessConfig">TiDBAccessConfig</a>,
<a href="#pingcap.com/v1alpha1.TiDBSpec">TiDBSpec</a>)
</p>
<p>
Expand Down Expand Up @@ -8083,6 +8099,21 @@ <h3 id="pingcap.com/v1alpha1.TiDBTLSClient">TiDBTLSClient
4. Set Enabled to <code>true</code>.</p>
</td>
</tr>
<tr>
<td>
<code>tlsSecret</code></br>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Specify a secret of client cert for backup/restore
Optional: Defaults to <cluster>-tidb-client-secret
If you want to specify a secret for backup/restore, generate a Secret Object according to the third step of the above procedure, The difference is the Secret Name can be freely defined, and then copy the Secret Name to TLSSecret
this field only work in backup/restore process</p>
</td>
</tr>
</tbody>
</table>
<h3 id="pingcap.com/v1alpha1.TiKVBlockCacheConfig">TiKVBlockCacheConfig
Expand Down
6 changes: 5 additions & 1 deletion manifests/backup/backup-aws-s3-br.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ spec:
br:
cluster: myCluster
# clusterNamespce: <backup-namespace>
# enableTLSClient: true
# tlsCluster:
# enabled: false
# logLevel: info
# statusAddr: <status-addr>
# concurrency: 4
Expand All @@ -26,6 +27,9 @@ spec:
secretName: mySecret
# port: 4000
# user: root
# tlsClient:
# enabled: false
# tlsSecret: <backup-tls-secretname>
s3:
provider: aws
region: us-west-2
Expand Down
6 changes: 5 additions & 1 deletion manifests/backup/backup-s3-br.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ spec:
br:
cluster: myCluster
# clusterNamespce: <backup-namespace>
# enableTLSClient: true
# tlsCluster:
# enabled: false
# logLevel: info
# statusAddr: <status-addr>
# concurrency: 4
Expand All @@ -26,6 +27,9 @@ spec:
secretName: mySecret
# port: 4000
# user: root
# tlsClient:
# enabled: false
# tlsSecret: <backup-tls-secretname>
s3:
provider: ceph
endpoint: http://10.233.57.220
Expand Down
6 changes: 5 additions & 1 deletion manifests/backup/backup-schedule-aws-s3-br.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ spec:
br:
cluster: myCluster
# clusterNamespce: backupNamespace
# enableTLSClient: true
# tlsCluster:
# enabled: false
# logLevel: info
# statusAddr: <status-addr>
# concurrency: 4
Expand All @@ -31,6 +32,9 @@ spec:
secretName: mysecret
# port: 4000
# user: root
# tlsClient:
# enabled: false
# tlsSecret: <backup-tls-secretname>
s3:
provider: aws
region: us-west-2
Expand Down
6 changes: 5 additions & 1 deletion manifests/backup/backup-schedule-s3-br.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ spec:
br:
cluster: myCluster
# clusterNamespce: backupNamespace
# enableTLSClient: true
# tlsCluster:
# enabled: false
# logLevel: info
# statusAddr: <status-addr>
# concurrency: 4
Expand All @@ -31,6 +32,9 @@ spec:
secretName: mysecret
# port: 4000
# user: root
# tlsClient:
# enabled: false
# tlsSecret: <backup-tls-secretname>
s3:
provider: ceph
endpoint: http://10.233.57.220
Expand Down
6 changes: 5 additions & 1 deletion manifests/backup/restore-aws-s3-br.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ spec:
br:
cluster: myCluster
# clusterNamespce: <restore-namespace>
# enableTLSClient: true
# tlsCluster:
# enabled: false
# db: <db-name>
# table: <table-name>
# logLevel: info
Expand All @@ -28,6 +29,9 @@ spec:
secretName: mySecret
# port: 4000
# user: root
# tlsClient:
# enabled: false
# tlsSecret: <restore-tls-secretname>
s3:
provider: aws
region: us-west-2
Expand Down
6 changes: 5 additions & 1 deletion manifests/backup/restore-s3-br.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ spec:
br:
cluster: myCluster
# clusterNamespce: <restore-namespace>
# enableTLSClient: true
# tlsCluster:
# enabled: false
# db: <db-name>
# table: <table-name>
# logLevel: info
Expand All @@ -28,6 +29,9 @@ spec:
secretName: mySecret
# port: 4000
# user: root
# tlsClient:
# enabled: false
# tlsSecret: <restore-tls-secretname>
s3:
provider: ceph
endpoint: http://10.233.57.220
Expand Down
3 changes: 3 additions & 0 deletions manifests/crd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6918,6 +6918,7 @@ spec:
description: SecretName is the name of secret which stores tidb
cluster's password.
type: string
tlsClient: {}
user:
description: User is the user for login tidb cluster
type: string
Expand Down Expand Up @@ -7854,6 +7855,7 @@ spec:
description: SecretName is the name of secret which stores tidb
cluster's password.
type: string
tlsClient: {}
user:
description: User is the user for login tidb cluster
type: string
Expand Down Expand Up @@ -8645,6 +8647,7 @@ spec:
description: SecretName is the name of secret which stores tidb
cluster's password.
type: string
tlsClient: {}
user:
description: User is the user for login tidb cluster
type: string
Expand Down
8 changes: 8 additions & 0 deletions pkg/apis/pingcap/v1alpha1/openapi_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions pkg/apis/pingcap/v1alpha1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,12 @@ type TiDBTLSClient struct {
// 4. Set Enabled to `true`.
// +optional
Enabled bool `json:"enabled,omitempty"`
// Specify a secret of client cert for backup/restore
// Optional: Defaults to <cluster>-tidb-client-secret
// +optional
// If you want to specify a secret for backup/restore, generate a Secret Object according to the third step of the above procedure, The difference is the Secret Name can be freely defined, and then copy the Secret Name to TLSSecret
// this field only work in backup/restore process
TLSSecret string `json:"tlsSecret,omitempty"`
}

// TLSCluster can enable TLS connection between TiDB server components
Expand Down Expand Up @@ -781,6 +787,10 @@ type TiDBAccessConfig struct {
User string `json:"user,omitempty"`
// SecretName is the name of secret which stores tidb cluster's password.
SecretName string `json:"secretName"`
// Whether enable the TLS connection between the SQL client and TiDB server
// Optional: Defaults to nil
// +optional
TLSClient *TiDBTLSClient `json:"tlsClient,omitempty"`
shuijing198799 marked this conversation as resolved.
Show resolved Hide resolved
}

// +k8s:openapi-gen=true
Expand Down
Loading