Skip to content

Refine dmctl error messages for "secret key is not initialized " #12046

@Frank945946

Description

@Frank945946

What did you do?

Since v8.0, the hardcoded secret key for dmctl has been removed. As a result, when customers want to use dmctl to encrypt and decrypt the passwords of the source and target databases in the DM task configuration files, they need to upload the secret key to the DM Master and set the secret-key-path parameter in the DM Master configuration file. Otherwise, an error will be returned:

[root@svr1 ~]# tiup dmctl encrypt 'abc!@#123' --master-addr [192.168.0.2:8261](http://192.168.0.2:8261/)
Starting component dmctl: /root/.tiup/components/dmctl/v8.1.0/dmctl/dmctl encrypt abc!@#123 --master-addr [192.168.0.2:8261](http://192.168.0.2:8261/)
Error: secret key is not initialized 

The error message is unhelpful, as users do not know how to resolve the issue.

What did you expect to see?

Refine the error message to help users resolve the issue easily on their own.
For example:
Error: The secret key for dmctl has not been initialized. Please ensure that the required key has been uploaded to the DM Master node and that the secret-key-path parameter in the DM Master configuration file is set to its path on the DM Master.

What did you see instead?

Error: secret key is not initialized

Versions of the cluster

v8.1 and v8.5

(paste DM version here, and you must ensure versions of dmctl, DM-worker and DM-master are same)

Upstream MySQL/MariaDB server version:

(paste upstream MySQL/MariaDB server version here)

Downstream TiDB cluster version (execute SELECT tidb_version(); in a MySQL client):

(paste TiDB cluster version here)

How did you deploy DM: tiup or manually?

(leave TiUP or manually here)

Other interesting information (system version, hardware config, etc):

>
>

current status of DM cluster (execute query-status <task-name> in dmctl)

(paste current status of DM cluster here)

Metadata

Metadata

Assignees

No one assigned

    Labels

    affects-8.1This bug affects the 8.1.x(LTS) versions.affects-8.5This bug affects the 8.5.x(LTS) versions.area/dmIssues or PRs related to DM.good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.severity/moderatetype/bugThe issue is confirmed as a bug.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions