Terraform Provider for RUVDS

RuVDS is an IAAS (cloud and VDS/VPS) provider offering virtual servers, dedicated hosting, domain registration, and DDoS protection at competitive prices. It features data centers in 7 countries, supporting both Linux and Windows environments.

This repository is a Terraform/OpenTofu provider allowing dynamic resource description, planning and provisioning on RuVDP and containing:

• Resources and data sources (internal/provider/),
• Examples (examples/) and generated documentation (docs/),
• Github actions pipeline (.github/) for building, testing, releasing,
• Tools for generating documentation, processing files, formatting *.tf files, etc (tools/)
• Miscellaneous meta files.

Requirements

• Terraform >= 1.0 or OpenTofu
• Go >= 1.23

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install or buld command:

make install

Functionality of the provider

This OpenTofu provider contains data sources, resources, functions as described in the table below:

Entity	Type	Name	Description
	Provider	ruvds	Allows gettings info and managing infrastructure on RuVDS cloud
Data center	Data Source	ruvds_datacenters	Gets list of data centers filtered by country
Data center	Data Source	ruvds_datacenter	Gets information about specific Data center by code
OS	Data Source	ruvds_os_list	Gets list of all available OSes (codes)
OS	Data Source	ruvds_os	Gets OS details by code
Servers	Data Source	ruvds_vps_list	Gets list of created VPS
Servers	Resource	ruvds_vps	CRUD operations on virtual servers
Templates	-	-	-
SSH Keys	Data Source	ruvds_ssh_list	Gets list of deployed SSH keys
SSH Keys	Resource	ruvds_ssh	Imports,creates, deletes SSH keys
Tarifs	-	-	-
Balance	-	-	-
Payments	-	-	-

Using the provider

For using RuVDS provider you need to obtain API v2 token first. After that you can use it in your Terraform/OpenTofu configurations for getting data and provision resources.

The provider is available on public terraform registry and public OpenTofu registry.

Sample usage of the provider:

terraform {
  required_providers {
    ruvds = {
      source  = "rustamkulenov/ruvds"
      # Choose required version
      version = "1.0.0"
    }
  }
}

provider "ruvds" {
    # Provide your own API v2 token
    token = "apiv2.*****YOUR-TOKEN*****"
}

# Get a data center by its code
data "ruvds_datacenter" "zur1" {
  with_code = "ZUR1"
}

output "datacenter_zur1" {
  value = data.ruvds_datacenter.zur1
}

# Get list of datacenters in Russia
data "ruvds_datacenters" "dcs" {
    in_country = "RU"
}

output "dcs_in_ru" {
    value = data.ruvds_datacenters.dcs
}

After

tofu plan

you'll see output like this:

data.ruvds_datacenter.zur1: Reading...
data.ruvds_datacenters.dcs: Reading...
data.ruvds_datacenters.dcs: Read complete after 1s
data.ruvds_datacenter.zur1: Read complete after 1s [name=ZUR1: Швейцария, Цюрих]

Changes to Outputs:
  + datacenter_zur1 = {
      + code      = "ZUR1"
      + country   = "CH"
      + id        = 2
      + name      = "ZUR1: Швейцария, Цюрих"
      + with_code = "ZUR1"
    }
  + dcs_in_ru       = {
      + codes      = [
          + "BUNKER",
          + "M9",
          + "LINXDATACENTER",
          + "ITPARK",
          + "EKB",
          + "SIBTELCO",
          + "OSTANKINO",
          + "PORTTELEKOM",
          + "TELEMAKS",
          + "SMARTKOM",
          + "ARKTICHESKIJ COD",
        ]
      + in_country = "RU"
    }

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

The provider is built on the Terraform Plugin Framework and uses RuVDS API v2.24.

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

go build will build the provider and put into current folder.

To generate or update documentation, run make generate.

Testing

The repository contains unit and integration tests.

Unit tests do not consume real resources and can be run even without internet connection at any time.

make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

make testacc

Environment variables

The following environment variables are used in building pipeline and code:

Variable	Purpose
TF_ACC	If set to '1' then acceptance tests will be run by github actions or localy (make testacc)
RUVDS_API_TOKEN	API v2 Token for RuVDS. Shall be set if you want to run aceptance tests (or unit tests for testing API) localy

How to set environment variables in VS Code (in .vscode/settings.json):

{
    "go.testEnvVars": {        
        "TF_ACC": "0",
        "RUVDS_API_TOKEN": "apiv2.*****YOUR-TOKEN*******"
    }
}

Local provider override

If you need to use/debug local provider in opentofu scripts then you'll probably need to configure tofu like this. Create ~/.tofurc file with similar content (replace with your path to compiled provider folder):

provider_installation {

  # Use provided path as an overridden package directory
  # for the hashicorp/ruvds provider. This disables the version and checksum
  # verifications for this provider and forces OpenTofu to look for the
  # provider plugin in the given directory.
  dev_overrides {
    "hashicorp/ruvds" = "/Users/rustam/projects/devops/terraform-provider-ruvds"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, OpenTofu will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}