Skip to content

Latest commit

 

History

History
116 lines (84 loc) · 2.72 KB

README.md

File metadata and controls

116 lines (84 loc) · 2.72 KB
Raw

terraform-provider-anaml

A Terraform provider for anaml resources, such as entities, tables, and features.

Installation

Configure the anaml and/or the anaml-operations Terraform providers through your Terraform manifest:

terraform {
  required_version = "~> 0.14"
  required_providers {
    anaml = {
      source  = "simple-machines/anaml"
    }
    anaml-operations = {
      source  = "simple-machines/anaml-operations"
    }
  }
}

provider "anaml" {
  host       = "http://localhost:8080"
  username   = "admin"
  password   = "admin-password"
  branch     = "official"
}

provider "anaml-operations" {
  host       = "http://localhost:8080"
  username   = "admin"
  password   = "admin-password"
}

When there is a new release, run terraform init -upgrade to upgrade to the latest version.

Development

Prerequisites

  • Go 1.14 or later

Alternatively, use Nix to get a quick, reproducible development environment.

Building

To start a Nix shell with Go installed:

nix-shell -p go

To build the Go modules:

go build ./...

To build and test modules locally:

  1. Build all modules

    go build ./providers/terraform-provider-anaml-operations
go build ./providers/terraform-provider-anaml

  2. Create version.sh script in root folder

    export VERSION=<version>

  3. Run install.sh

Testing with Terraform

To start a Nix shell that builds and installs the Terraform provider:

nix-shell tf-shell.nix

To run example Terraform manifests:

cd examples
terraform init
terraform apply

Set the environment variable TF_LOG=debug when running Terraform to set debug level logging.

Releasing

To release a new version of the Terraform provider, create a new Git tag with a tag that matches the regular expression: ^v[0-9]+\.[0-9]+\.[0-9]+$. Do not create a GitHub release, the build process will automatically create a GitHub release when the build is successful.

For example, to release version 1.0.0, create a GitHub release with the tag v1.0.0.

Terraform assumes that providers follows Semantic Versioning.

The versioning semantics are used to select the latest version of a Terraform provider when no exact version number is specified in the provider configuration, such as if no version number is specified, or if version constraints are specified instead.

The Terraform providers are published to the public Terraform Registry.

CI/CD configuration for publishing to the Terraform Registry is based on the documentation from the Terraform website on Publishing Providers.