https://github.com/komminarlabs/terraform-provider-cratedb

Terraform provider to manage CrateDB
https://github.com/komminarlabs/terraform-provider-cratedb

cratedb iiot postgresql terraform terraform-provider timeseries-database

Last synced: 4 days ago
JSON representation

Terraform provider to manage CrateDB

• Host: GitHub
• URL: https://github.com/komminarlabs/terraform-provider-cratedb
• Owner: komminarlabs
• License: apache-2.0
• Created: 2024-10-05T20:09:42.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-10-08T13:20:18.000Z (about 1 month ago)
• Last Synced: 2024-10-17T17:53:16.829Z (22 days ago)
• Topics: cratedb, iiot, postgresql, terraform, terraform-provider, timeseries-database
• Language: Go
• Homepage: https://registry.terraform.io/providers/komminarlabs/cratedb/latest
• Size: 63.5 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-cratedb

Terraform provider to manage CrateDB

## 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 {

    cratedb = {

      source = "komminarlabs/cratedb"

    }

  }

}

```

Initialize the provider

```terraform

provider "cratedb" {

  api_key    = "*******"

  api_secret = "*******"

  url        = "https://console.cratedb.cloud/"

}

```

## Available functionalities

### Data Sources

* `cratedb_cluster`

* `cratedb_organization`

* `cratedb_organizations`

* `cratedb_project`

### Resources

* `cratedb_cluster`

* `cratedb_organization`

* `cratedb_project`

## 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

```