On-premises provider configurations

Before you can deploy universes to private clouds using YugabyteDB Anywhere, you must have an on-premises provider configuration.

With on-premises providers, VMs are not auto-created by YugabyteDB Anywhere; you must create your VMs, install the Linux operating system and additional software, provision them with YugabyteDB software, and then add them to the provider's free pool of nodes.

Automatic provisioning

Using the YugabyteDB Anywhere node agent package, you can provision VMs, create an on-premises provider, and add the VMs to the provider.

Before provisioning nodes, ensure YugabyteDB Anywhere is installed and running.

1. Have your network administrator set up firewalls to open the ports required for YugabyteDB Anywhere and the nodes to communicate. Refer to Networking.

2. Have your system administrator create VMs that will be used as nodes in universes. This is typically done using your hypervisor or cloud provider. Do the following:

   • Locate the VMs in the regions and availability zones where you will be deploying universes.
   • Install a YugabyteDB-supported Linux OS on the VMs.

   For instructions on creating VMs that are suitable for deploying YugabyteDB, refer to Software requirements for on-premises nodes.

3. Have your system administrator provision the VMs. This requires:

   • Downloading the YugabyteDB Anywhere node agent package to the VM.
   • Modifying the configuration file.
   • Running the provisioning script (as root or via sudo).

   These steps prepare the node for use by YugabyteDB Anywhere.

   The provisioning script will additionally perform the following tasks (YugabyteDB Anywhere must be installed and running):

   • Create (or update) the on-premises provider.
   • Create the instance type.
   • Add the node instance to the provider.

   Refer to Automatically provision on-premises nodes.

Create a provider manually

If the on-premises provider wasn't created when provisioning the VMs, you can manually create the provider using the YugabyteDB Anywhere UI. Refer to Manage the provider configuration. Note: You must enable the Manually Provision Nodes option (under Advanced).

If the instance type and instances weren't created when provisioning the VMs, you can manually add the provisioned VMs to the provider. Obtain the IP addresses of the provisioned VMs from your system administrator. You need these to add the nodes to the provider. Refer to Add nodes to the on-premises provider.

Legacy provisioning

To create, provision, and add nodes to your on-premises provider using legacy provisioning, you will perform tasks in roughly three stages.

Stage 1: Prepare your infrastructure

• Have your network administrator set up firewalls to open the ports required for YugabyteDB Anywhere and the nodes to communicate. Refer to Networking.

• Have your system administrator create VMs that will be used as nodes in universes. This is typically done using your hypervisor or cloud provider. Do the following:

  • Locate the VMs in the regions and availability zones where you will be deploying universes.
  • Install a YugabyteDB-supported Linux OS on the VMs.
  • Set up a yugabyte user with root privileges (SSH access and sudo-capable).

  For instructions on creating VMs that are suitable for deploying YugabyteDB, refer to Legacy provisioning.

Stage 2: Create an on-premises provider configuration

In YugabyteDB Anywhere, create an on-premises provider. This involves the following:

• Defining the regions and availability zones where the provider will be deploying universes.
• Providing SSH credentials for the yugabyte user.
• Providing NTP setup.
• If the SSH user does not have passwordless sudo access, enabling Manual provisioning for the provider.

Refer to Create the provider configuration.

Stage 3: Add nodes to the provider free pool

In YugabyteDB Anywhere, navigate to the provider you created in Stage 2 and do the following:

1. Define instance types. An instance type defines some basic properties of the VMs you will be adding.
2. Provision the VMs. YugabyteDB Anywhere supports 3 ways of provisioning nodes for running YugabyteDB depending upon the level of SSH access provided to YugabyteDB Anywhere:

   Provisioning	Description	What happens
   Legacy automatic (deprecated)	YugabyteDB Anywhere is provided an SSH user with sudo access for the nodes it needs to provision. For example, the ec2-user for AWS EC2 instances.	No action. YugabyteDB Anywhere will automatically provision the VMs that you add.
   Legacy fully manual (deprecated)	Neither YugabyteDB Anywhere nor the user has access to an SSH user with sudo access; only a local (non-SSH) user is available with sudo access.	Follow a sequence of steps to provision each VM manually before adding the VM to the pool.

1. Add the VMs (instances) to the provider.

2. Run pre-checks to validate the nodes you added.

Refer to Add nodes to the on-premises provider.