Product Documentation

Appearance

Installing ybtools on Linux ​

Make sure that Java 1.8 64-bit is installed on your client system. See Installing the Java Runtime Environment.

Follow these steps to install the client tools on an Ubuntu, Debian, or CentOS Linux client system:

  1. Download the package for your client operating system from the Yellowbrick Manager. Go to Support > Drivers and Tools > Client Tools.

  2. If necessary, copy the downloaded package to the client system.

  3. From the client directory where the download file was copied, run the appropriate installation commands, which must be run as sudo:

  • Ubuntu 16.04 LTS, 18.04 LTS, 20.04 LTS: Install the ybtools package:

    $ sudo apt-get install ./ybtools-6.1.12-7a4d6a43.3360.ubuntu.20.04.x86_64.deb

    where the package name is ybtools-6.1.12-7a4d6a43.3360.ubuntu.20.04.x86_64.deb in this example.

  • RHEL/CentOS 7.0:

    1. Remove the old version of ybtools:

      $ sudo yum remove ybtools

    2. Install the new ybtools package:

      $ sudo yum install ybtools-6.1.2-a8363b32.1234.el7.x86_64.rpm

      where the package name is ybtools-6.1.2-a8363b32.1234.el7.x86_64.rpm in this RHEL 7.0 example.

For example, the following installation was run on an Ubuntu 16 client system:

$ sudo apt-get install ./ybtools-6.1.12-7a4d6a43.3360.ubuntu.20.04.x86_64.deb 
Reading package lists... Done
Building dependency tree       
Reading state information... Done
Note, selecting 'ybtools' instead of './ybtools-6.1.12-7a4d6a43.3360.ubuntu.20.04.x86_64.deb'
The following packages were automatically installed and are no longer required:
  bsh libasm3-java libganymed-ssh2-java libisl13 libjackrabbit-java libjline-java libjna-java libjna-jni libjna-platform-java libjsch-agent-proxy-java
  libjsoncpp0v5 liblldb-3.8 libllvm3.8 libmaven-scm-java libnetbeans-cvsclient-java libruby2.2 libsisu-guice-java llvm-3.8 llvm-3.8-dev llvm-3.8-runtime
  nagios-plugins-common python3-bcdoc ruby2.1-dev
Use 'sudo apt autoremove' to remove them.
The following packages will be upgraded:
  ybtools
1 upgraded, 0 newly installed, 0 to remove and 346 not upgraded.
Need to get 0 B/185 MB of archives.
After this operation, 0 B of additional disk space will be used.
Get:1 /home/brumsby/ybtools-6.1.12-7a4d6a43.3360.ubuntu.20.04.x86_64.deb ybtools amd64 6.1.12-7a4d6a43.3360 [185 MB]
(Reading database ... 229176 files and directories currently installed.)
Preparing to unpack .../ybtools-6.1.12-7a4d6a43.3360.ubuntu.20.04.x86_64.deb ...
Unpacking ybtools (6.1.12-7a4d6a43.3360) over (5.4.0-20220620182315) ...
Setting up ybtools (6.1.12-7a4d6a43.3360) ...
update-alternatives: setting up automatic selection of ybbackup
update-alternatives: using /opt/ybtools/bin/ybbackup to provide /usr/bin/ybbackup (ybbackup) in auto mode
update-alternatives: setting up automatic selection of ybbackupctl
update-alternatives: using /opt/ybtools/bin/ybbackupctl to provide /usr/bin/ybbackupctl (ybbackupctl) in auto mode
update-alternatives: setting up automatic selection of ybdumproles
update-alternatives: using /opt/ybtools/bin/ybdumproles to provide /usr/bin/ybdumproles (ybdumproles) in auto mode
update-alternatives: setting up automatic selection of ybdumpschema
update-alternatives: using /opt/ybtools/bin/ybdumpschema to provide /usr/bin/ybdumpschema (ybdumpschema) in auto mode
update-alternatives: setting up automatic selection of ybload
update-alternatives: using /opt/ybtools/bin/ybload to provide /usr/bin/ybload (ybload) in auto mode
update-alternatives: setting up automatic selection of ybrelay
update-alternatives: using /opt/ybtools/bin/ybrelay to provide /usr/bin/ybrelay (ybrelay) in auto mode
update-alternatives: setting up automatic selection of ybrestore
update-alternatives: using /opt/ybtools/bin/ybrestore to provide /usr/bin/ybrestore (ybrestore) in auto mode
update-alternatives: setting up automatic selection of ybsql
update-alternatives: using /opt/ybtools/bin/ybsql to provide /usr/bin/ybsql (ybsql) in auto mode
update-alternatives: setting up automatic selection of ybtoken
update-alternatives: using /opt/ybtools/bin/ybtoken to provide /usr/bin/ybtoken (ybtoken) in auto mode
update-alternatives: setting up automatic selection of ybunload
update-alternatives: using /opt/ybtools/bin/ybunload to provide /usr/bin/ybunload (ybunload) in auto mode
update-alternatives: setting up automatic selection of ybrelay-init
update-alternatives: using /opt/ybtools/config/ybrelay-init to provide /usr/bin/ybrelay-init (ybrelay-init) in auto mode

On Linux clients, the tools are installed by default in /opt/ybtools. For example:

$ cd /opt/ybtools
me@yb:/opt/ybtools$ ls
bin  config  integrations  lib  license.txt

Note: On RHEL and AIX clients, you can install ybtools in a different preferred location. You do not have to use the default installation directory.

If the locale on the client system is not compatible with the locale set for the database, you may see an error of the following form when you connect to a database with the ybsql client:

$ ybsql -d yellowbrick -h vm100.yb.io -U yellowbrick
Password for user yellowbrick: 
ybsql: FATAL:  conversion between LATIN1 and LATIN9 is not supported

Make sure your client locale is consistent with the database locale. You can use the locale command to return client settings:

$ locale
LANG="en_US.UTF-8"
LC_COLLATE="en_US.UTF-8"
LC_CTYPE="en_US.UTF-8"
LC_MESSAGES="en_US.UTF-8"
...

To check which locales are installed on your client system, use the locale -a command.

Parent topic:Installing ybtools