Skip to content

Use this Komodor provider as a bridge between Terraform and the Komodor API

Notifications You must be signed in to change notification settings

komodorio/terraform-provider-komodor

Repository files navigation

Terraform logo

Terraform Provider for Komodor

Requirements

  • Terraform >= 1.3.x
  • Go >= 1.18 ((to build the provider plugin)

Installation

Add the following to your terraform configuration

terraform {
  required_providers {
    komodor = {
      source  = "komodorio/komodor"
      version = "~> 1.0.6"
    }
  }
}

How to use

First, you need a Komodor account.

Once you have the account, you should create an API key. Go to the API Keys tab in the User Settings Page. Click on Generate Key button and generate the key.

Configure the terraform provider like so

variable "komodor_api_key" {
  type = string
}

provider "komodor" {
  api_key = var.komodor_api_key
}

To see examples of how to use this provider, check out the examples directory in the source code here.

Developing The Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.18+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

Clone the repository:

mkdir -p $GOPATH/src/github.com/terraform-providers; cd "$_"
git clone https://github.com/komodorio/terraform-provider-komodor.git

Change to the clone directory and run make to install the dependent tooling needed to test and build the provider.

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

cd $GOPATH/src/github.com/komodor/terraform-provider-komodor
make 
$GOPATH/bin/terraform-provider-komodor

To build the provider for a specific OS and architecture, run make with the OS_ARCH variable set to the desired target. For example, to build the provider for macOS ARM CPU, run make with OS_ARCH=darwin_arm64.

make OS_ARCH=darwin_arm64

About

Use this Komodor provider as a bridge between Terraform and the Komodor API

Resources

Stars

Watchers

Forks

Packages

No packages published