https://github.com/komminarlabs/terraform-provider-mageai
Terraform provider to manage Mage AI
https://github.com/komminarlabs/terraform-provider-mageai
etl mageai terraform terraform-provider
Last synced: 7 months ago
JSON representation
Terraform provider to manage Mage AI
- Host: GitHub
- URL: https://github.com/komminarlabs/terraform-provider-mageai
- Owner: komminarlabs
- License: apache-2.0
- Created: 2024-08-27T08:12:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-13T12:14:14.000Z (10 months ago)
- Last Synced: 2025-01-15T19:23:11.546Z (9 months ago)
- Topics: etl, mageai, terraform, terraform-provider
- Language: Go
- Homepage: https://registry.terraform.io/providers/komminarlabs/mageai/latest
- Size: 135 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://developer.hashicorp.com/terraform/downloads) >= 1.0
- [Go](https://golang.org/doc/install) >= 1.20
## Building The Provider
1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:
```shell
go install
```
## Adding Dependencies
This provider uses [Go modules](https://github.com/golang/go/wiki/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:
```shell
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
terraform {
required_providers {
mageai = {
source = "komminarlabs/mageai"
}
}
}
```
Initialize the provider
```terraform
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](http://www.golang.org) installed on your machine (see [Requirements](#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.
```shell
make testacc
```