terraform-provider-kaleido

README

Kaleido Terraform Provider

The Kaleido Terraform Provider is our official provider for the Kaleido Enterprise Platform and Kaleido Blockchain-as-a-Service.

Check out the Kaleido Terraform Provider documentation for the latest provider schema and examples.

Getting Started

Prerequisites:

• OpenTofu or Terraform
• A Kaleido Enterprise Platform account and API key

terraform {
  required_providers {
    kaleido = {
      source = "kaleido-io/kaleido"
      version = ">1.2.0"
    }
  }
}

provider "kaleido" {
  alias = "provider"
  platform_api = var.kaleido_platform_api                 # https://<account-name>.${PLATFORM_DOMAIN}
  platform_username = var.kaleido_platform_username       # the name of the API key
  platform_password = var.kaleido_platform_password       # the secret of the API key
}

NOTE: if you are using the provider against local Kaleido platform instance via the software quick start or internally for development, include KALEIDO_PLATFORM_INSECURE=true in your shell in order to ignore self-signed development certificates.

See the official Terraform modules repository for useful modules and relevant examples.

Development

Prerequisites:

• Go 1.25 or greater
• make

Build & Unit Tests

make

Using

To install the provider from a local build with Terraform 1.x or OpenTofu, configure your ~/.terraformrc with:

provider_installation {
  dev_overrides {
    "registry.terraform.io/kaleido-io/kaleido" = "/path/to/terraform-provider-kaleido" # for Terraform
    "kaleido-io/kaleido" = "/path/to/terraform-provider-kaleido"                       # for OpenTofu
  }
  direct {}
}

then be sure to build the binary you are testing using:

make build

NOTE: binaries built via make build-${OS} will not be detected by Terraform's dev_overrides.

Kaleido Terraform Provider uses terrraform-plugin-docs to generate all documentation markdown files. To update the provider documentation after any schema, example, or description changes run:

make docs

Cross Compiling

make build-linux
make build-mac
make build-win