YugabyteDB Anywhere FAQ
What is YugabyteDB Anywhere?
YugabyteDB Anywhere (previously known as Yugabyte Platform and Yugaware) is a private database-as-a-service, used to create and manage YugabyteDB universes and clusters. YugabyteDB Anywhere can be used to deploy YugabyteDB in any public or private cloud.
You deploy and manage your YugabyteDB universes using the YugabyteDB Anywhere UI.
See also YugabyteDB Anywhere at yugabyte.com.
How are the build artifacts packaged and stored for YugabyteDB Anywhere?
YugabyteDB Anywhere software is packaged as a set of Docker container images hosted on the Quay.io container registry and managed by the Replicated management tool. Replicated ensures that YugabyteDB Anywhere remains highly available, and allows for instant upgrades by simply pulling the incremental container images associated with a newer YugabyteDB Anywhere release. If the host running the YugabyteDB Anywhere UI does not have the Internet connectivity, a fully air-gapped installation option is also available.
The data node (YugabyteDB) software is packaged into the YugabyteDB Anywhere application.
How does YugabyteDB Anywhere installation work?
YugabyteDB Anywhere first needs to be installed on a machine. The next step is to configure YugabyteDB Anywhere to work with public and/or private clouds. In the case of public clouds, YugabyteDB Anywhere spawns the machines to orchestrate bringing up the data platform. In the case of private clouds, you add the nodes you want to be a part of the data platform into YugabyteDB Anywhere. YugabyteDB Anywhere needs SSH access into these nodes to manage them.
Installation of YugabyteDB Anywhere 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. YugabyteDB Anywhere then distributes and installs YugabyteDB on the hosts identified to run the data nodes. Since the YugabyteDB software is already packaged into existing artifacts, the data node does not require any Internet connectivity.
For instructions on installing YugabyteDB Anywhere, refer to Install YugabyteDB Anywhere.
What are the OS requirements and permissions to run YugabyteDB Anywhere?
YugabyteDB Anywhere requires Replicated; currently, Replicated only supports Linux-based operating systems. The Linux OS should be 3.10+ kernel, 64-bit, and ready to run docker-engine 1.7.1 - 17.06.2-ce (with 17.06.2-ce being the recommended version).
For a complete list of operating systems supported by Replicated, see Supported Operating Systems.
NoteThis requirement applies only to YugabyteDB Anywhere. For a list of OSs supported by YugabyteDB, see the Deployment checklist for YugabyteDB.
YugabyteDB Anywhere also requires the following:
- Connectivity to the Internet, either directly or via an HTTP proxy.
- 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).
- The following ports open on the platform host:
80(http access to the YugabyteDB Anywhere UI),
- Attached disk storage (such as persistent EBS volumes on AWS): 100 GB SSD minimum.
- A YugabyteDB Anywhere license file from Yugabyte.
- Ability to connect from the YugabyteDB Anywhere host to all YugabyteDB data nodes via SSH.
For a complete list of prerequisites, refer to Prerequisites.
What are the requirements to run YugabyteDB data nodes?
Prerequisites for YugabyteDB data nodes are listed in the YugabyteDB Deployment checklist.
How does the YugabyteDB Anywhere UI interact with YugabyteDB data nodes?
The YugabyteDB Anywhere UI creates a passwordless SSH connection to interact with the data nodes.
Can I access the database machines that get spawned in public clouds?
Yes, you have access to all machines spawned. The machines are spawned by YugabyteDB Anywhere. YugabyteDB Anywhere runs on your machine in your region/data center. If you have configured YugabyteDB Anywhere to work with any public cloud (such as AWS or GCP), it will spawn YugabyteDB nodes using your credentials on your behalf. These machines run in your account, but are created and managed by YugabyteDB Anywhere on your behalf. You can log on to these machines any time. The YugabyteDB Anywhere UI additionally displays metrics per node and per universe.
How many machines do I need to try out YugabyteDB Anywhere against my load?
You need the following:
- One server to install YugabyteDB Anywhere on.
- A minimum number of servers for the data nodes as determined by the replication factor (RF). For example, one server for RF=1, and 3 servers in case of RF=3.
- A server to run the load tests on.
Typically, you can saturate a database server (or three in case of RF=3) with just one large enough test machine running a synthetic load tester that has a light usage pattern. YugabyteDB ships with some synthetic load-testers, which can simulate a few different workloads. For example, one load tester simulates a time series or IoT-style workload and another does a stock-ticker like workload. But if you have a load tester that emulates your planned usage pattern, you can use that.
Can I control the properties (such as VPC, IOPS, tenancy, and so on) of the machines YugabyteDB Anywhere spins up?
Yes, you can control what YugabyteDB Anywhere is spinning up. For example:
You can choose if YugabyteDB Anywhere should spawn a new VPC with peering to the VPC on which application servers are running (to isolate the database machines into a separate VPC) AWS, or ask it to reuse an existing VPC.
You can choose dedicated IOPs EBS drives on AWS and specify the number of dedicated IOPS you need.
YugabyteDB Anywhere also allows creating these machines out of band and importing these as an on-premises install.
How do I report a security vulnerability?
Follow the steps in the vulnerability disclosure policy to report a vulnerability to our security team. The policy outlines our commitments to you when you disclose a potential vulnerability, the reporting process, and how Yugabyte will respond.