Prerequisites for YBA

What you need to install YugabyteDB Anywhere

You can install YugabyteDB Anywhere (YBA) using the following methods:

Method Using Use If
YBA Installer yba-ctl CLI You are performing a new installation.
You are ready to migrate from a Replicated installation. EA
Replicated Docker containers Your installation already uses Replicated.
Kubernetes Helm chart You're deploying in Kubernetes.

All installation methods support installing YBA with and without (airgapped) Internet connectivity.

Licensing (such as a license file in the case of YBA Installer or Replicated, or appropriate repository access in the case of Kubernetes) may be required prior to installation. Contact Yugabyte Support for assistance.

Replicated end of life

YugabyteDB Anywhere will end support for Replicated installation at the end of 2024. You can migrate existing Replicated YugabyteDB Anywhere installations using YBA Installer. See Migrate from Replicated.

Installing using Replicated requires the following:

  • Ability to install and configure docker-engine.
  • Ability to install and configure Replicated, which is a containerized application itself and needs to pull containers from its own Replicated.com container registry.
  • Ability to pull Yugabyte container images from the Quay.io container registry (this will be done by Replicated automatically).

Supported Linux distributions

YugabyteDB Anywhere is supported on all Linux distributions that Replicated supports. This includes, but is not limited to the following:

  • CentOS 7
  • AlmaLinux 8
  • AlmaLinux 9
  • Ubuntu 18
  • Ubuntu 20
  • RedHat Enterprise Linux 7
  • RedHat Enterprise Linux 8
  • SUSE Linux Enterprise Server (SLES) 15 SP4 EA

Hardware requirements

A node running YugabyteDB Anywhere is expected to meet the following requirements:

  • 4 cores
  • 8 GB memory
  • 265+ GB disk space (see following table)
Path Usage Free Space Required
/ Assuming /opt/yugabyte shares a file system with / 50 GB
/tmp Used during Install and Upgrade 10 GB1
/opt/yugabyte Database configuration and Prometheus logs 150+ GB1,2
/var/lib/docker Running YBA components 40 GB1
/var/lib/replicated Images and staging 15 GB1

1 Where two or more of these paths share a file system, the free space required on that file system is the sum of the free space requirements.

2 YugabyteDB Anywhere installations managing many nodes, or universes with many tables may require more than 150 GB to retain Prometheus logs, depending on retention. Installations managing fewer objects may need as little as 50-100 GB for /opt/yugabyte.

Prepare the host

YugabyteDB Anywhere uses Replicated scheduler for software distribution and container management. You need to ensure that the host can pull containers from the Replicated Docker Registries.

Replicated installs a compatible Docker version if it is not pre-installed on the host. The currently supported Docker version is 20.10.n.

Airgapped hosts

Installing YugabyteDB Anywhere on airgapped hosts (without access to any Internet traffic (inbound or outbound)) requires the following additional configuration:

  • Whitelist endpoints: To install Replicated and YugabyteDB Anywhere on a host with no Internet connectivity, you have to first download the binaries on a computer that has Internet connectivity, and then copy the files over to the appropriate host. In case of restricted connectivity, whitelist the following endpoints to ensure that they are accessible from the host marked for installation:

    • https://downloads.yugabyte.com
    • https://download.docker.com

  • Ensure that Docker Engine version 20.10.n is available. If it is not installed, you need to follow the procedure described in Installing Docker in airgapped.

    If you want to set up Docker on Amazon Linux OS, perform the following:

    1. Install Docker using the following commands:

      sudo yum install docker
sudo systemctl daemon-reload

    2. Start Docker using the following command:

      sudo systemctl start docker.service

  • Ensure that the following ports are open on the YugabyteDB Anywhere host:

    • 8800 – HTTP access to the Replicated UI
    • 80 or 443 – HTTP and HTTPS access to the YugabyteDB Anywhere UI, respectively
    • 22 – SSH

  • Obtain the YugabyteDB Anywhere airgapped install package. Contact Yugabyte Support for more information.

  • Sign the Yugabyte license agreement. Contact Yugabyte Support for more information.