terraform-provider-yba

README

Terraform Provider YugabyteDB Anywhere

This Terraform provider manages the following resources for YugabyteDB Anywhere:

• Cloud Providers - AWS, GCP, Azure
• On Prem Provider
• Universes
• Backup Storage Configurations
• Backup Schedules
• Restores
• Customers

In addition, there are modules included for installing and managing YugabyteDB Anywhere instances/clusters in the following clouds:

• AWS
• GCP
• Azure

Prerequisites

This provider required some API changes that are only available in YugabyteDB versions >=2.17.3. The automated tests in this repository are based on the Alpha channel of yugaware application in Replicated.

Installation

Install the Terraform CLI. Once the CLI is installed, there are a few steps to manually install and test the local provider:

• Run make install in the root directory of the project
• Add the following block to the configuration file to test the local provider:

terraform {
  required_providers {
    yba = {
      version = "0.1.0-dev"
      source  = "yugabyte/yba"
    }
  }
}

Resource files

Examples of configuration setting files can be found in the directory resources

• YBA installer configuration file

• Replicated based installation:

  1. replicated.conf: For configuration of replicated settings.
  2. application_settings.conf: YugabyteDB Anywhere application settings in Replicated console.

Examples

There are example configurations located within the examples directory in yba-terraform-workflow-example for using the provider and modules. These bring up actual resources in the internal Yugabyte development environment. More information can be found in the README located in the examples directory. In the directory of the example you wish to run (i.e. examples/docker/gcp):

• terraform init installs the required providers
• terraform apply generates a plan, which, when approved, will create the desired resources

Acceptance Testing

Self-hosted runners have been set up in AWS, Azure, and GCP. There are also separate projects, each with their own service account credentials. All of the credentials (for accessing the projects and runner instances) are in Keybase under teams/yugabyte/terraform-acctest.

• acctest-gce.json for accessing Google project yugabyte-terraform-test and the runner instance
• aws_creds.csv for accessing AWS account yugabyte-terraform-test
• aws-acctest.pem for accessing AWS runner instance
• azure_creds.txt for accessing Azure app deployment (resource group is yugabyte-terraform-test)
• azure-acctest.pem for accessing Azure runner instance
• replicated.conf is the replicated configuration used in the acceptance tests (the file is copied onto each runner instance)
• acctest.rli is the development replicated license used in acceptance tests (the file is copied onto each runner instance)
• application_settings.conf is the application settings used in acceptance tests (the file is copied onto each runner instance)