v2.25 Preview Preview release - not for production v2024.2 LTS Stable release with long-term support v2024.1 STS Stable release with standard-term support v2.20 LTS Stable release with long-term support v2.18 STS Stable release with standard-term support v2.14 LTS Stable release with long-term support Unsupported versions

Create on-premises provider configuration

For deploying universes on your private cloud

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

With on-premises providers, VMs are not auto-created by YBA; you must manually 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 to provision VMs, you can have the provisioning script additionally create an on-premises provider for you.

Stage 1: Prepare your infrastructure

  • Have your network administrator set up firewalls to open the ports required for YBA 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.

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

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

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

    These steps prepare the node for use by YugabyteDB Anywhere. Refer to Automatically provision on-premises nodes.

If you have already installed and are running YugabyteDB Anywhere, running the provisioning script can additionally:

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

Stage 2: Create an on-premises provider configuration

If the on-premises provider wasn't created when provisioning the VMs, you will need to create the on-premises provider.

Refer to Create the provider configuration.

Note: You must enable the Manually Provision Nodes option (under Advanced).

Stage 3: Add nodes to the provider free pool

If the on-premises provider wasn't created when provisioning the VMs, you will need to 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 YBA 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 YBA, 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 YBA, 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. YBA supports 3 ways of provisioning nodes for running YugabyteDB depending upon the level of SSH access provided to YBA:

    Provisioning Description What happens
    Legacy automatic (deprecated) YBA 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. YBA will automatically provision the VMs that you add.
    Legacy assisted manual (deprecated) The SSH user requires a password for sudo access. Run a script, provided by YBA, to provision each VM, providing credentials for the SSH user with sudo access.
    Legacy fully manual (deprecated) Neither YBA 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.

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

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

Refer to Add nodes to the on-premises provider.