Install YugabyteDB Anywhere

Install YBA software using YBA Installer

For higher availability, you can install additional YugabyteDB Anywhere (YBA) instances, and configure them later to serve as passive warm standby servers. See Enable High Availability for more information.

Use YBA Installer to install YugabyteDB Anywhere on a host, either online or airgapped. YBA Installer performs preflight checks to validate if the workspace is ready to run YugabyteDB Anywhere.

You can also use YBA Installer to migrate an existing Replicated installation. Note that you may first need to use Replicated to upgrade your YBA to version 2.20.1.

-> To perform a new installation, follow the steps in Quick start.

-> To upgrade an installation of YBA that was installed using YBA Installer, refer to Upgrade.

-> To migrate an installation from Replicated, refer to Migrate from Replicated.

-> For troubleshooting, refer to Install and upgrade issues.

After the installation is complete, you can use YBA Installer to manage your installation. This includes backup and restore, upgrading, basic licensing, and uninstalling the software.

Root permissions

YBA Installer also supports non-root installation. Refer to Non-sudo installation.

Before you begin

Make sure your machine satisfies the minimum prerequisites.

Installation requires a license file. To obtain your license, contact your sales representative. If you are not yet a customer and want to try YugabyteDB Anywhere, book a demo.

Keep the control plane separate from the data plane

Don't install YugabyteDB Anywhere on servers that you will use for database clusters, and vice-versa.

Quick start

To install YugabyteDB Anywhere using YBA Installer, do the following:

Download and extract the YBA Installer by entering the following commands:

wget https://downloads.yugabyte.com/releases/2.25.2.0/yba_installer_full-2.25.2.0-b359-linux-x86_64.tar.gz
tar -xf yba_installer_full-2.25.2.0-b359-linux-x86_64.tar.gz
cd yba_installer_full-2.25.2.0-b359/

Using sudo, run a preflight check to ensure your environment satisfies the requirements. Respond with y when prompted to create a default configuration.
```
sudo ./yba-ctl preflight
```
If there are no issues (aside from the lack of a license), install the software, providing your license.
```
sudo ./yba-ctl install -l /path/to/license
```

After the installation succeeds, you can immediately start using YBA.

If the installation fails due to permissions or other issues, you can retry after running yba-ctl clean all to remove all traces of the previous attempt.

For more detailed installation instructions and information on how to use YBA Installer to manage your installation, refer to the following sections.

Download and configure YBA Installer

Download YBA Installer

Download and extract the YBA Installer by entering the following commands:

wget https://downloads.yugabyte.com/releases/2.25.2.0/yba_installer_full-2.25.2.0-b359-linux-x86_64.tar.gz
tar -xf yba_installer_full-2.25.2.0-b359-linux-x86_64.tar.gz
cd yba_installer_full-2.25.2.0-b359/

This bundle provides everything needed (except your license), to complete a fresh install of YBA:

yba-ctl executable binary is used to perform all of the YBA Installer workflows.
yba-ctl.yml.reference is a YAML reference for the available configuration options for both YBA Installer and YugabyteDB Anywhere.

To see a full list of commands, run the following command:

./yba-ctl help

yba-ctl commands need to be run in the correct context; see Running yba-ctl commands.

Configure YBA Installer

Many YBA Installer commands require a configuration file, including preflight and install. When using these commands without a configuration file, you are prompted to continue using default values. For example:

sudo ./yba-ctl preflight

No config file found at '/opt/yba-ctl/yba-ctl.yml', creating it with default values now.
Do you want to proceed with the default config? [yes/NO]:

Respond with y or yes to create the configuration file using default configuration settings and continue the operation.

Respond with n or no to create the configuration file using default configuration settings and exit the command.

By default, YBA Installer installs YBA in /opt/yugabyte and creates a Linux user yugabyte to run YBA processes.

To change these and other default values, edit the yba-ctl.yml file, and then re-run the yba-ctl command. For a list of options, refer to Configuration options.

You can change some configuration options post-installation using the reconfigure command.

Install YBA using YBA Installer

Provide a license

Provide the license to YBA Installer by running the license command as follows:

sudo ./yba-ctl license add -l /path/to/license

You can use this command to update to a new license if needed.

You can also provide a license when running the install command. Refer to Install the software.

Run preflight checks

Start by running the preflight checks to ensure that the expected ports are available, the hardware meets the minimum requirements, and so forth. The preflight check generates a report you can use to fix any issues before continuing with the installation.

sudo ./yba-ctl preflight

#  Check name             Status   Error
1  license                Critical stat /opt/yba-ctl/YBA.lic: no such file or directory
2  install does not exist Pass
3  validate-config        Pass
4  user                   Pass
5  cpu                    Pass
6  memory                 Pass
7  port                   Pass
8  python                 Pass
9  disk-availability      Pass
10 postgres               Pass

Some checks, such as CPU or memory, can be skipped, though this is not recommended for a production installation. Others, such as having a license and python installed, are hard requirements, and YugabyteDB Anywhere can't work until these checks pass. All checks should pass for a production installation.

If you are installing YBA for testing and evaluation and you want to skip a check that is failing, you can pass --skip_preflight <name>[,<name2>]. For example:

sudo ./yba-ctl preflight --skip_preflight cpu

Install the software

To perform an install, run the install command. Once started, an install can take several minutes to complete.

sudo ./yba-ctl install

You can also provide a license when running the install command by using the -l flag if you haven't set the license prior to install:

sudo ./yba-ctl install -l /path/to/license

               YBA Url |   Install Root |            yba-ctl config |              yba-ctl Logs |
  https://10.150.0.218 |  /opt/yugabyte |  /opt/yba-ctl/yba-ctl.yml |  /opt/yba-ctl/yba-ctl.log |

Services:
  Systemd service |       Version |  Port |                            Log File Locations |  Running Status |
         postgres |         10.23 |  5432 |          /opt/yugabyte/data/logs/postgres.log |         Running |
       prometheus |        2.42.0 |  9090 |  /opt/yugabyte/data/prometheus/prometheus.log |         Running |
      yb-platform |  2.25.2.0-b359 |   443 |       /opt/yugabyte/data/logs/application.log |         Running |
INFO[2023-04-24T23:19:59Z] Successfully installed YugabyteDB Anywhere!

The install command runs all preflight checks first, and then proceeds to do a full install, and then waits for YBA to start. After the install succeeds, you can immediately start using YBA.

Use a stand-alone data disk

By default, YugabyteDB Anywhere stores its data in /opt/yugabyte/data. You can also use a stand-alone data disk for YugabyteDB Anywhere data.

Using a stand-alone data disk allows you to swap your YugabyteDB Anywhere data between installations for tasks such as boot disk replacement.

Prerequisites

The data disk should have a minimum of 200GB free space. If you use a data disk, the root disk does not need the full size requirement.
The data disk should be formatted and have a filesystem. YBA Installer does not format, partition, or run mkfs on the disk.
If you are replacing a data disk, the data on the replacement must be from the same or earlier version of YugabyteDB Anywhere. YugabyteDB Anywhere will not start if you attempt to use a data disk from a later version of YugabyteDB Anywhere.

Note that if you run clean –-all, the data disk will be cleaned, regardless of the installation type.

New installation

To have YugabyteDB Anywhere use a new stand-alone data disk, do the following:

Mount the data disk to /opt/yugabyte/data. For example:
```
mount /dev/sdb1 /opt/yugabyte/data
```
Install YugabyteDB Anywhere.
```
sudo ./yba-ctl install
```
Add the mount to /etc/fstab.

Existing installation

To use an existing data disk, first unmount the disk from the existing YugabyteDB Anywhere installation as follows:

Run sudo yba-ctl stop to stop YugabyteDB Anywhere.
Unmount the data disk:
```
unmount /opt/yugabyte/data
```
Optionally, with the disk unmounted you can safely clean up the YugabyteDB Anywhere installation by running sudo yba-ctl clean --all.

The disk is now ready to be reused with a new installation.

To use the data disk with a new installation, do the following:

Install YugabyteDB Anywhere using the --without-data option:
```
sudo ./yba-ctl install --without-data
```
Mount the data disk to /opt/yugabyte/data. For example:
```
mount /dev/sdb1 /opt/yugabyte/data
```
Start YugabyteDB Anywhere by running sudo yba-ctl start.
Add the mount to /etc/fstab.

Manage a YBA installation

Reconfigure

You can use YBA Installer to make changes to an installed YBA instance.

To reconfigure an installation, edit the configuration file with your changes, and then run the command as follows:

sudo yba-ctl reconfigure

For more information, refer to Configuration options. Note that some settings can't be reconfigured, such as the install root, service username, or the PostgreSQL version.

Service management

YBA Installer provides basic service management, with start, stop, and restart commands. Each of these can be performed for all the services (platform, postgres, and prometheus), or any individual service.

sudo yba-ctl [start, stop, restart]
sudo yba-ctl [start, stop, restart] prometheus

In addition to the state changing operations, you can use the status command to show the status of all YugabyteDB Anywhere services, in addition to other information such as the log and configuration location, versions of each service, and the URL to access the YugabyteDB Anywhere UI.

sudo yba-ctl status

               YBA Url |   Install Root |            yba-ctl config |              yba-ctl Logs |
  https://10.150.0.218 |  /opt/yugabyte |  /opt/yba-ctl/yba-ctl.yml |  /opt/yba-ctl/yba-ctl.log |

Services:
  Systemd service |       Version |  Port |                            Log File Locations |  Running Status |
         postgres |         10.23 |  5432 |          /opt/yugabyte/data/logs/postgres.log |         Running |
       prometheus |        2.42.0 |  9090 |  /opt/yugabyte/data/prometheus/prometheus.log |         Running |
      yb-platform |  2.25.2.0-b359 |   443 |       /opt/yugabyte/data/logs/application.log |         Running |

Upgrade

To upgrade using YBA Installer, first download the version of YBA Installer corresponding to the version of YBA you want to upgrade to. See Download YBA Installer.

Upgrade works similarly to the install workflow, by first running preflight checks to validate the system is in a good state.

When ready to upgrade, run the upgrade command from the untarred directory of the target version of the YBA upgrade:

sudo ./yba-ctl upgrade

The upgrade takes a few minutes to complete. When finished, use the status command to verify that YBA has been upgraded to the target version.

Backup and restore

YBA Installer also provides utilities to take full backups of the YBA state (not YugabyteDB however) and later restore from them. This includes YugabyteDB Anywhere data and metrics stored in Prometheus.

To perform a backup, provide the full path to the directory where the backup will be generated. The createBackup command creates a timestamped tgz file for the backup. For example:

sudo yba-ctl createBackup ~/test_backup
ls test_backup/

backup_23-04-25-16-54.tgz

To restore from the same backup, use the restoreBackup command:

sudo yba-ctl restoreBackup ~/test_backup/backup_23-04-25-16-64.tgz

For more information, refer to Back up and restore YugabyteDB Anywhere.

Clean (uninstall)

To uninstall a YBA instance, YBA Installer also provides a clean command.

By default, clean removes the YugabyteDB Anywhere software, but keeps any data such as PostgreSQL or Prometheus information:

sudo yba-ctl clean

INFO[2023-04-24T23:58:13Z] Uninstalling yb-platform
INFO[2023-04-24T23:58:14Z] Uninstalling prometheus
INFO[2023-04-24T23:58:14Z] Uninstalling postgres

To delete all data, run clean with the --all flag as follows:

sudo yba-ctl clean --all

--all was specified. This will delete all data with no way to recover. Continue? [yes/NO]: y
INFO[2023-04-24T23:58:13Z] Uninstalling yb-platform
INFO[2023-04-24T23:58:14Z] Uninstalling prometheus
INFO[2023-04-24T23:58:14Z] Uninstalling postgres

Running yba-ctl commands

YBA Installer commands are run in the following contexts:

local execution path using ./yba-ctl
installed execution path using yba-ctl

This is because some commands require local execution context, while others require the context of the installed system.

The following commands must be run using the local execution path:

install
upgrade

The following commands must be run using the installed execution path:

createBackup
restoreBackup
clean
start, stop, restart, and status
reconfigure

The help, license, and preflight commands can be run in either context.

If you don't use the correct execution path, yba-ctl fails with an error:

sudo ./yba-ctl createBackup ~/backup.tgz

FATAL[2023-04-25T00:14:57Z] createBackup must be run from the installed yba-ctl

Non-sudo installation

EA YBA Installer supports non-sudo installation, where sudo access is not required for any step of the installation.

To facilitate a non-sudo install, YBA Installer will not create any additional users or set up services in systemd. The target location for the installation defaults to the current user's home directory, instead of /opt, ensuring YBA Installer has write access to the base install directory. Instead of using systemd to manage services, basic cron jobs are used to start the services on bootup with basic management scripts used to restart the services after a crash.

To perform a non-sudo installation, run any of the preceding commands without sudo access. You can't switch between a sudo and non-sudo access installation, and yba-ctl will return an error if sudo is not used when operating in an installation where sudo access was used.

Configuration options

To customize your installation, edit the settings in the yba-ctl.yml configuration file.

YBA Installer automatically generates the file when you run certain commands. Alternatively, you can edit the yba-ctl.yml.reference file included in the installer bundle, and copy it to the appropriate location.

Installation type	Location for configuration file
sudo	opt/yba-ctl/
non-sudo	~/opt/yba-ctl/

To make changes to an existing installation, edit the configuration file with your changes and run the reconfigure command. Note that some settings (marked with ) cannot be changed after installation.

Note that the file must include all fields. Optional fields may be left blank.

Configure YBA Installer

You can configure YBA Installer by setting the following options.

Option	Description
`installRoot`	Location where YBA is installed. Default for a sudo installation is `/opt/yugabyte`; for a non-sudo installation, it is the current user's home directory.
`host`	Hostname or IP Address used for CORS and certificate creation. Optional.
`support_origin_url`	Specify an alternate hostname or IP address for CORS. For example, for a load balancer. Optional
`server_cert_path` `server_key_path`	If you are using custom certificates, provide the path to the location of the server cert and server key files (in PEM format). If you don't specify server_cert_path and server_key_path, the installation process generates self-signed certificates in $installRoot/data/yba-installer/certs. Optional.
`service_username`	The Linux user that will run the YBA processes. Default is `yugabyte`. The install process will create the `yugabyte` user. If you wish to use a different user, create that user beforehand and specify it in `service_username`. YBA Installer only creates the `yugabyte` user, not custom usernames.
`as_root`	If you are providing a custom configuration file, set to true to perform a sudo installation, or false for non-sudo. If the configuration is auto-generated, this is set automatically according to whether you used sudo to run the command that triggered the auto generation - true with sudo, or false for non-sudo. Note that you can't switch between running yba-ctl as sudo and non-sudo.

You can't change these settings after installation.

Configure YBA

You can configure YugabyteDB Anywhere using the following options.

Option	Description
`port`	Specify a custom port for the YBA UI to run on. Default: 443.
`keyStorePassword`	Password for the Java keystore. Automatically generated if left empty.
`appSecret`	Play framework crypto secret. Automatically generated if left empty.

OAuth

OAuth related settings are described in the following table. With the exception of useOauth, they are all optional. Only set these fields if you intend to use OIDC SSO for your YugabyteDB Anywhere installation (otherwise leave them empty).

Option	Description
`useOauth`	Boolean that determines if OIDC SSO needs to be enabled for YBA. Default is false. Set to true if you intend on using OIDC SSO for your YBA installation (must be a boolean).
`ybSecurityType`	The Security Type corresponding to the OIDC SSO for your YBA installation.
`ybOidcClientId`	The Client ID corresponding to the OIDC SSO for your YBA installation.
`ybOidcSecret`	The OIDC Secret Key corresponding to the OIDC SSO for your YBA installation.
`ybOidcDiscoveryUri`	The OIDC Discovery URI corresponding to the OIDC SSO for your YBA installation. Must be a valid URL.
`ywWrl`	The Platform IP corresponding to the OIDC SSO for your YBA installation. Must be a valid URL.
`ybOidcScope`	The OIDC Scope corresponding to the OIDC SSO for your YBA installation.
`ybOidcEmailAtr`	The OIDC Email Attribute corresponding to the OIDC SSO for your YBA installation. Must be a valid email address.

Proxy

When configuring proxy values for YBA, all values must be set correctly. On AWS, ensure 169.254.169.254 is in the no_proxy and java_non_proxy lists, as this enables access to the EC2 metadata service.

If you are setting these values on an existing system, run yba-ctl reconfigure to set the new values for YBA.

Option	Description
`enable`	A boolean to turn the proxy on or off without having to change further values. If `false`, no proxy settings will be used.
`http_proxy`	Specify the HTTP_PROXY and http_proxy environment variables, in the form `http://<host>:<port>`
`java_http_proxy_port`	Specify -Dhttp.proxyPort port value
`java_http_proxy_host`	Specify -Dhttp.proxyHost as a hostname or IP address
`https_proxy`	Specify the HTTPS_PROXY and https_proxy environment variables, in the form `https://<host>:<port>`
`java_https_proxy_port`	Specify -Dhttps.proxyPort port
`java_https_proxy_host`	Specify -Dhttps.proxyHost as a hostname or IP address
`no_proxy`	Specify the NO_PROXY and no_proxy environment variables, as a comma-separated list of URLs and IP addresses that will not be sent to the proxy server. For example, `127.0.0.1,localhost,169.254.169.254`
`java_non_proxy`	Specify -Dhttps.nonProxyHosts, as a vertical bar (\|) separated list of URLs and IP addresses that will not be sent to the proxy server. For example, `127.0.0.1\|localhost\|169.254.169.254`

Configure Prometheus

Option	Description
`port`	External Prometheus port. Default: 9090.
`restartSeconds`	Systemd will restart Prometheus after this number of seconds after a crash.
`scrapeInterval`	How often Prometheus scrapes for database metrics.
`scrapeTimeout`	Timeout for inactivity during scraping.
`maxConcurrency`	Maximum concurrent queries to be executed by Prometheus.
`maxSamples`	Maximum number of samples that a single query can load into memory.
`timeout`	The time threshold for inactivity after which Prometheus will be declared inactive.
`retentionTime`	How long Prometheus retains the database metrics.

Configure PostgreSQL

By default, YBA Installer provides a version of PostgreSQL. If you prefer, you can use your own version of PostgreSQL.

PostgreSQL configuration is divided into two different subsections:

install - contains information on how YBA Installer should install PostgreSQL.
useExisting - provides YBA Installer with information on how to connect to a PostgreSQL instance that you provision and manage separately.

These options are mutually exclusive, and can be turned on or off using the enabled option. Exactly one of these two sections must have enabled = true, while the other must have enabled = false.

Install options

Option	Description
`enabled`	Boolean indicating whether yba-ctl will install PostgreSQL. Default: true
`port`	Port PostgreSQL is listening to.
`restartSecond`	Wait time to restart PostgreSQL if the service crashes.
`locale`	locale is used during initialization of the database.
`ldap_enabled`	Boolean indicating whether LDAP is enabled.

You can't change these settings after installation.

useExisting options

Option	Description
`enabled`	Boolean indicating whether to use a PostgreSQL instance that you provision and manage separately. Default: false
`host`	IP address/domain name of the PostgreSQL server.
`port`	Port PostgreSQL is running on.
`username` and `password`	Used to authenticate with PostgreSQL.
`pg_dump_path` `pg_restore_path`	Required paths to `pgdump` and `pgrestore` on the locale system that are compatible with the version of PostgreSQL you provide. `pgdump` and `pgrestore` are used for backup and restore workflows, and are required for a functioning install.

You can't change this setting after installation.