ui

Description

Run a web UI to install SingleStore and deploy a cluster.

This server can be used to install SingleStore and deploy a cluster using a web UI rather than using the command line.

A configurable local server is started that acts as both a UI and an API endpoint.

The web UI can be accessed via browser.

Usage

Usage:
  sdb-deploy ui [flags]

  For flags that can accept multiple values (indicated by VALUES after the name of the flag),
  separate each value with a comma.

Flags:
      --cert FILE_PATH              HTTPS certificate file to use for secure connection
  -h, --help                        Help for ui
      --key FILE_PATH               HTTPS certificate key file to use for secure connection
      --port PORT                   Listen on the provided port (default 8081)
      --studio-location string      Address of an running studio instance. For example http://127.0.0.2:8081
      --success-shutdown duration   Server shutdown after successful installation timeout (default 30m0s)
      --time-to-live duration       Server time-to-live. It will shutdown automatically after expiration (default 24h0m0s)

Global Flags:
      --backup-cache FILE_PATH                File path for the backup cache
      --cache-file FILE_PATH                  File path for the Toolbox node cache
  -c, --config FILE_PATH                      File path for the Toolbox configuration
      --disable-colors                        Disable color output in console, which some terminal sessions/environments may have difficulty with
      --disable-spinner                       Disable the progress spinner, which some terminal sessions/environments may have issues with
  -j, --json                                  Enable JSON output
      --parallelism POSITIVE_INTEGER          Maximum number of operations to run in parallel
      --runtime-dir DIRECTORY_PATH            Where to store Toolbox runtime data
      --ssh-max-sessions POSITIVE_INTEGER     Maximum number of SSH sessions to open per host, must be at least 3
      --ssh-strict-host-key-checking          Enable strict host key checking for SSH connections
      --ssh-user-known-hosts-file FILE_PATH   Path to the user known_hosts file for SSH connections. If not set, /dev/null will be used
      --state-file FILE_PATH                  Toolbox state file path
  -v, --verbosity count                       Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count
  -y, --yes                                   Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default

Remarks

This command is interactive unless you use either --yes or --json flags to override interactive behavior.

Last modified: April 22, 2024

Was this article helpful?