Terraform Provider OnFinality (Terraform Plugin Framework)

_This repository is built on the Terraform Plugin Framework.

These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the HashiCorp Learn platform. Terraform Plugin Framework specific guides are titled accordingly.

Please see the GitHub template repository documentation for how to create a new repository from this template on GitHub.

Once you've written your provider, you'll want to publish it on the Terraform Registry so that others can use it.

Requirements

• Terraform >= 1.0
• Go >= 1.18

Building The Provider

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

go install

Using the provider

OnFinality Platform Credentials

1. Generate your access_key and secret_key from app.onfinality.io Account Settings Page
2. Define variable and config the provider

variable "onf_access_key" {}
variable "onf_secret_key" {}

provider "onfinality" {
  access_key = var.onf_access_key
  secret_key = var.onf_secret_key
}

3. Export them to env

export TF_VAR_onf_access_key=...
export TF_VAR_onf_secret_key=...

Doc

onfinality_node

Examples

Manage OnFinality Nodes

terraform {
  required_providers {
    onfinality = {
      source  = "terraform.local/local/onfinality"
      version = "1.0.0"
      # Other parameters...
    }
  }
}

variable "onf_access_key" {}
variable "onf_secret_key" {}

provider "onfinality" {
  access_key = var.onf_access_key
  secret_key = var.onf_secret_key
}

resource "onfinality_node" "n1" {
  # Workspace id, can get it from url https://app.onfinality.io/workspaces/<workspace_id>/nodes
  workspace_id     = 6635707676612587520
  # Network of the node, can get from `onf network-spec list` & `onf network-spec list-backups`
  network_spec_key = "polkadot"
  # Node Spec of the node, always put key="unit", 1 * unit ~ 0.5 cpu 1.5G mem
  node_spec = {
    key        = "unit"
    multiplier = 4
  }
  # full or archive or validator, depends on network
  node_type     = "full"
  node_name     = "ian test2"
  # Cluster where the node will be deployed, check `onf info cluster` for all available clusters
  cluster_hash  = "jm"
  # Disk size of the node, <num>Gi , e.g 100Gi
  storage       = "100Gi"
  image_version = "v0.9.27"
  # <Optional> Change it to true will stop the node
  # stopped = false
}

Import running nodes

1. Define the resource in .tf file
2. run

TF_VAR_onf_access_key=<your_access_key> \
TF_VAR_onf_secret_key="<your_secret_key>" \
terraform import onfinality_node.<resource_name> <wsId>:<nodeId> 

Developing the Provider

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

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

To generate or update documentation, run go generate.

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

Local Debug

• use examples/local
• run with TF_LOG_PROVIDER=debug