terraform-provider-mageai

Terraform provider to manage Mage AI

Caution

This Terraform provider is currently in active development and is not considered stable. Features, configurations, and behavior may change without notice, and there may be bugs or incomplete functionality.

DO NOT use this provider in any production environment. It is intended for testing and development purposes only.

Please proceed with caution and keep this in mind when using it in any environment.

Requirements

• Terraform >= 1.0
• Go >= 1.20

Building The Provider

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

go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

Add the below code to your configuration.

terraform {
  required_providers {
    mageai = {
      source = "komminarlabs/mageai"
    }
  }
}

Initialize the provider

provider "mageai" {
  api_key = "*******"
  host    = "http://localhost:6789"
}

Available functionalities

Data Sources

• mageai_block
• mageai_blocks
• mageai_pipeline
• mageai_pipelines

Resources

• mageai_block
• mageai_pipeline

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 make docs.

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