Try our Experimental-AI powered search above!

You can install YugabyteDB Anywhere on a host machine using Replicated in both online and airgapped environments.

Installation starts with installing Replicated on a Linux host. Replicated installs the docker-engine, the Docker container runtime, and then pulls its own container images from the Replicated.com container registry. YugabyteDB Anywhere then becomes a managed application of Replicated, which starts by pulling the YugabyteDB Anywhere (yugaware) container images from Quay.io for the very first time.

Prerequisites

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)

¹ 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.

² 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.

Install Replicated

• Online
• Airgapped

curl -sSL https://get.replicated.com/docker | sudo bash

curl -x http://<proxy_address>:<proxy_port> https://get.replicated.com/docker | sudo bash

sudo docker ps --format "{{.ID}}: {{.Image}}: {{.Command}}: {{.Ports}}"

sudo docker ps

Set up HTTPS (optional)

Launch the Replicated UI via http://yugaware-host-public-ip:8800. Expect to see a warning stating that the connection to the server is not yet private. This condition is resolved once HTTPS for the Replicated Admin Console is set up in the next step. Proceed by clicking Continue to Setup > ADVANCED to bypass the warning and access the Replicated Admin Console, as shown in the following illustration:

You can provide your own custom SSL certificate and a hostname, as per the following illustration:

It is recommended that you start with using a self-signed certificate, and then add the custom SSL certificate later. Note that in this case you connect to the Replicated Admin Console using an IP address, as per following illustration:

Upload the license file

Upload the Yugabyte license file that you received from Yugabyte, as shown in the following illustration:

When prompted to choose the installation type, do one of the following:

• Online - If you are performing an online installation, choose the Online installation type and click Continue. If you are offered a choice of software versions, select the one that meets your requirements.

• Airgapped - If you are performing an airgapped installation, choose the Airgapped installation type, enter the absolute path to the YugabyteDB Anywhere airgapped install package that you obtained from Yugabyte Support, and click Continue.

Secure Replicated

Add a password to protect the Replicated Admin Console, which is different from the Admin Console for YugabyteDB used by YugabyteDB Anywhere, as per the following illustration:

Perform preflight checks

Replicated performs a set of preflight checks to ensure that the host is set up correctly for YugabyteDB Anywhere, as shown in the following illustration:

Click Continue to configure YugabyteDB Anywhere.

If the preflight check fails, review the Troubleshoot YugabyteDB Anywhere to resolve the issue.

Set the TLS version for Yugaware frontend

Under Application config, specify TLS versions as shown in the following illustration:

The recommended TLS version is 1.2.

Optionally, you can specify a Support Origin URL to provide an alternate hostname or IP address to whitelist for the CORS filter. For example, for a load balancer.

Set up HTTP/HTTPS proxy

YugabyteDB Anywhere sometimes initiates HTTP or HTTPS connections to other servers. For example, HTTP or HTTPS connections (depending on your setup) can be used to do the following, or more:

• Contact a public cloud provider to create VMs.
• Deposit backups on a public cloud provider's object storage service.
• Contact an external load balancer.

You can set up YBA to use an HTTP/HTTPS proxy server via Application config, and select Enable Proxy as per the following illustration:

When completing the Enable Proxy settings, keep in mind the following:

• If your proxy is using the default ports for each protocol, then set the ports for the HTTP and HTTPS proxies to the default (80 and 443 respectively), instead of 8080 and 8443 as shown in the preceding illustration.

• If you have only one proxy set up (HTTP or HTTPS), then set the same values for both.

• This configuration sets operating system environment variables and Java system properties. The help text for each field shows which Java system property or environment variable gets set by the field. System properties have the "-D" prefix. For example "Specify -Dhttps.proxyPort".

• The no proxy fields (HTTP no proxy setting, HTTP no proxy setting for Java) are lists of exception hosts, provided as a comma-delimited list of addresses or hostnames. Include the following addresses:

  • The Docker gateway address (172.17.0.1 by default).
  • The address of any previously-specified web proxy.
  • Any other IP addresses that you deem safe to bypass the proxy.

• These settings comprehensively govern all network connections that YBA initiates. For example, if you specify a proxy server for HTTP, all unencrypted connections initiated by YBA will be affected. If you want YBA to bypass the proxy server when connecting to database universe nodes, then you must explicitly specify the database universe node IP addresses as exception hosts (also known as "no proxy").

• Because some YBA network connections are driven by YBA's Java process, while others are driven outside of Java (for example, via Python or a Linux shell execution), each (Java and non-Java) has its own separate configurable parameters.

• The Java fields can accept values as Java system properties, including the use of pipe ("|") as a field separator. Refer to Java Networking and Proxies for more details about the properties.

• YugabyteDB Anywhere follows community standards for setting proxy environment variables, where two environment variables are exported with lowercase and uppercase names. For example, if you enter "http://my.Proxy.host:8080" for HTTP Proxy setting, then two environment variables are exported as follows:

  HTTP_PROXY = http://my.Proxy.host:8080
  http_proxy = http://my.Proxy.host:8080