https://github.com/paulden/terraform-provider-meilisearch
Terraform provider for Meilisearch
https://github.com/paulden/terraform-provider-meilisearch
meilisearch terraform
Last synced: 25 days ago
JSON representation
Terraform provider for Meilisearch
- Host: GitHub
- URL: https://github.com/paulden/terraform-provider-meilisearch
- Owner: paulden
- License: mpl-2.0
- Created: 2023-03-03T10:51:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T12:59:44.000Z (about 1 month ago)
- Last Synced: 2025-05-05T13:54:41.465Z (about 1 month ago)
- Topics: meilisearch, terraform
- Language: Go
- Homepage: https://registry.terraform.io/providers/pauldn-wttj/meilisearch/latest
- Size: 386 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Terraform Provider for Meilisearch.
[](https://github.com/paulden/terraform-provider-meilisearch/releases)
[](https://registry.terraform.io/providers/paulden/meilisearch/latest/docs)
[](https://github.com/paulden/terraform-provider-meilisearch/blob/main/LICENSE)
This Terraform provider implements resource management for Meilisearch.
## Overview
### Using the provider
To use this provider, you must install it and provide authentication credentials:
```hcl
terraform {
required_providers {
meilisearch = {
source = "paulden/meilisearch"
version = "0.0.1"
}
}
}
provider "meilisearch" {
host = "http://localhost:7700"
api_key = "T35T-M45T3R-K3Y"
}
```
Alternatively, you may use environment variables `MEILISEARCH_API_KEY` and / or `MEILISEARCH_HOST` for authentication.
The `MEILISEARCH_API_KEY` should have admin privileges since it may be used to create all kinds of resources.
### Resources
- `meilisearch_api_key`: create and manage API keys for Meilisearch.
- `meilisearch_index`: create and manage an index in Meilisearch.
### Data sources
- `meilisearch_api_key`: read API keys for Meilisearch.
- `meilisearch_index`: read a Meilisearch index.
## Development
_This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework)._
### Requirements
- [Terraform](https://www.terraform.io/downloads.html) >= 1.0
- [Go](https://golang.org/doc/install) >= 1.23
- [Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) >= 3.7 for development
- [golangci-lint](https://golangci-lint.run/usage/install/) for development
### 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`.
### 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.
Don't forget that if you want to use a local binary for a Terraform provider, you need to add the following block to your `~/.terraformrc` file:
```
provider_installation {
dev_overrides {
"terraform.io/paulden/meilisearch" = ""
}
direct {}
}
```
before using it in a `.tf` file such as:
```
terraform {
required_providers {
meilisearch = {
source = "terraform.io/paulden/meilisearch"
}
}
}
```
To generate or update documentation, run `go generate`.
In order to run the full suite of Acceptance tests, run `make testacc`.
```shell
make testacc
```
Tests are run against a Meilisearch Docker container to ease development (see `docker_compose/` folder). The task will:
- Start a Docker container running a Meilisearch instance
- Seed data on the Meilisearch instance
- Run Terraform tests from the provider
- Clean up Docker volume
### Run linter
Install [golangci-lint](https://golangci-lint.run/usage/install/) and run the linter:
```shell
golangci-lint run
```
Or using Docker:
```shell
docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.52.2 golangci-lint run
```