v2.23 Preview Preview release - not for production v2024.1 STS Stable release with standard-term support v2.20 LTS Stable release with long-term support v2.18 STS Stable release with standard-term support v2.14 LTS Stable release with long-term support Unsupported versions

Prerequisites to deploy YBA on a VM

Prepare a VM for YugabyteDB Anywhere

When installing YugabyteDB Anywhere (YBA) on-premises or on a public cloud (AWS, GCP, and Azure), you install YBA onto a virtual machine server with a Linux operating system (OS).

To meet the hardware and software prerequisites for YBA, create a VM that satisfies the following requirements.

Hardware requirements

The server for YugabyteDB Anywhere must meet the following hardware requirements:

  • 4 cores
  • 8 GB memory
  • 215 GB disk space
  • x86 (Intel, AMD) architecture

Software requirements

YugabyteDB Anywhere has the following software requirements:

  • x86 Linux operating system
  • License
  • Python 3.8-3.11
  • Sudo root permissions for installation

Linux OS

You can install YugabyteDB Anywhere onto any x86 Linux operating system supported by YugabyteDB. YugabyteDB Anywhere can't be installed on ARM architectures (but can be used to deploy universes to ARM-based nodes).

YugabyteDB Anywhere may also work on other Linux distributions; contact your YugabyteDB support representative if you need added support.

License

You need your license file to install YugabyteDB Anywhere. Contact Yugabyte Support for assistance.

Python

Python v3.8 to v3.11 must be pre-installed.

Both python and python3 must symbolically link to Python 3. One way to achieve this is to use alternatives. For example:

sudo yum install @python38 -y
sudo alternatives --config python
# choose Python 3.8 from list

sudo alternatives --config python3
# choose Python 3.8 from list

python -V
# output: Python 3.8.16

python3 -V
# output: Python 3.8.16

Permissions

You need sudo root permissions for installation for production use. (Without sudo root permissions, you can install YBA for non-production use.)

If your sudo permissions are limited, add the following commands to the sudoers file:

/usr/bin/yba-ctl clean
<path-to-yba-ctl>/yba-ctl clean
/usr/bin/yba-ctl createBackup
<path-to-yba-ctl>/yba-ctl generate-config
/usr/bin/yba-ctl help
<path-to-yba-ctl>/yba-ctl help
<path-to-yba-ctl>/yba-ctl install
/usr/bin/yba-ctl license
<path-to-yba-ctl>/yba-ctl license
/usr/bin/yba-ctl log-bundle
/usr/bin/yba-ctl preflight
<path-to-yba-ctl>/yba-ctl preflight
/usr/bin/yba-ctl reconfigure
<path-to-yba-ctl>/yba-ctl replicated-migrate
/usr/bin/yba-ctl replicated-migrate
/usr/bin/yba-ctl restart
<path-to-yba-ctl>/yba-ctl restart
/usr/bin/yba-ctl restoreBackup
/usr/bin/yba-ctl start
<path-to-yba-ctl>/yba-ctl start
/usr/bin/yba-ctl status
<path-to-yba-ctl>/yba-ctl status
/usr/bin/yba-ctl stop
<path-to-yba-ctl>/yba-ctl stop
<path-to-yba-ctl>/yba-ctl upgrade
/usr/bin/yba-ctl version
<path-to-yba-ctl>/yba-ctl version

Where path-to-yba-ctl is the location where you will install YBA Installer.

High availability deployments

If you plan to deploy YBA in active-passive high-availability mode, you need two VMs (identical in hardware and software); one for the active YBA instance, and another for the standby YBA instance.