Wizard-Client (CLI) Installation

Wizard-Client Requirements

1. Supported host operating systems:

• Ubuntu 20.04, 22.04, 24.04
• Rocky Linux 9.2
• RHEL 9.2,
• Windows (amd64)
• MacOS (amd64 or arm64)

Install Wizard-Client

The file naming convention is wizard-client-<version>-<distribution>. In this guide we will use version 0.4.0.
See Wizard-Client Downloads for alternative versions and distributions.

1. Download a release tarball from Wizard-Client Downloads
2. Extract the tarball for wizard-client binary and the README file:

 tar -xvf wizard-client-0.4.0-<distribution>.tgz;

3. Setup Wizard-Client

   • Requirements:
     • A Cluster-Wizard server must be installed and running.
     • If Cluster-Wizard is deployed without a certificate signed by a trusted Certificate Authority (CA), a CA certificate must be configured.
     • If Cluster-Wizard is deployed with a certificate that includes dnsNames, those DNS entries must be resolvable from the current host. Consider:
       • Adding the required entries to your DNS server.
       • On Linux or MacOS adding entries to /etc/hosts.
       • On Windows adding entries to C:\Windows\System32\drivers\etc\hosts.
   note

   The Wizard-Client defaults to a DNS name of cluster-wizard and port 50001 . To use a different name or port:

   • On Linux or MacOS, set the environment variable CLUSTER_WIZARD_SERVER and CLUSTER_WIZARD_PORT

   Example:

   export CLUSTER_WIZARD_SERVER="my-cluster-wizard.corespeq.com"
   export CLUSTER_WIZARD_PORT="443"

   • Alternatively, wizard-client accepts the -s (server address) and -p (port) parameters.

   Example:

   wizard-client -s my-cluster-wizard.corespeq.com -p 443

Configure Wizard-Client with client certificate and CA

• Client certificate
  1. Generate certificate key pair

     wizard-client -c cert-gen-keys

  2. Generate certificate signing request (CSR). The CSR will be sent to the Cluster-Wizard admin, who may approve the CSR and provide the client certificate and ca files.

     wizard-client -c cert-create-csr

  3. Use the cert-set command to configure the client certificate.
     If Cluster-Wizard is deployed without a certificate signed by a trusted CA, use the -ca flag to specify the CA certificate:

     wizard-client -c cert-set -cert <cert_file> -ca <ca_file>

• Optional: Set Up Shell Auto-Completion (Linux Only)
  • Install required packages:

    apt install jq

  • Enable auto-completion:

    source <(wizard-client --autocompletion)