Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k-yomo/terraform-provider-algolia
Terraform Provider for Algolia
https://github.com/k-yomo/terraform-provider-algolia
algolia terraform terraform-provider
Last synced: about 23 hours ago
JSON representation
Terraform Provider for Algolia
- Host: GitHub
- URL: https://github.com/k-yomo/terraform-provider-algolia
- Owner: k-yomo
- License: mpl-2.0
- Created: 2021-04-20T03:13:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T20:58:33.000Z (8 months ago)
- Last Synced: 2024-04-13T19:01:44.924Z (7 months ago)
- Topics: algolia, terraform, terraform-provider
- Language: Go
- Homepage: https://registry.terraform.io/providers/k-yomo/algolia/latest/docs
- Size: 549 KB
- Stars: 36
- Watchers: 3
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Terraform Provider Algolia
[](./LICENSE)
[](https://github.com/k-yomo/terraform-provider-algolia/actions/workflows/test.yml)
[](https://codecov.io/gh/k-yomo/terraform-provider-algolia)
[](https://goreportcard.com/report/k-yomo/terraform-provider-algolia)
Terraform Provider for [Algolia](https://www.algolia.com).
## Documentation
Full, comprehensive documentation is available on the Terraform website:
[https://registry.terraform.io/providers/k-yomo/algolia/latest/docs](https://registry.terraform.io/providers/k-yomo/algolia/latest/docs)
## Using the provider
Set an environment variable `ALGOLIA_API_KEY` to store your Algolia API key.
```sh
$ export ALGOLIA_API_KEY=
```
The example below demonstrates the following operations:
- create index
- create rule for the index
- create api key to search the index
```terraform
terraform {
required_providers {
algolia = {
source = "k-yomo/algolia"
version = ">= 0.1.0, < 1.0.0"
}
}
}
provider "algolia" {
app_id = "XXXXXXXXXX"
}
resource "algolia_index" "example" {
name = "example"
attributes_config {
searchable_attributes = [
"title",
"category,tag",
"unordered(description)",
]
attributes_for_faceting = [
"category"
]
unretrievable_attributes = [
"author_email"
]
attributes_to_retrieve = [
"title",
"category",
"tag",
"description",
"body"
]
}
ranking_config {
ranking = [
"words",
"proximity"
]
}
faceting_config {
max_values_per_facet = 50
sort_facet_values_by = "alpha"
}
languages_config {
remove_stop_words_for = ["en"]
}
}
resource "algolia_rule" "example" {
index_name = algolia_index.example.name
object_id = "example-rule"
conditions {
pattern = "{facet:category}"
anchoring = "contains"
}
consequence {
params_json = jsondecode({
automaticFacetFilters = {
facet = "category"
disjunctive = true
}
})
}
}
resource "algolia_api_key" "example" {
acl = [
"search",
"browse"
]
expires_at = "2030-01-01T00:00:00Z"
max_hits_per_query = 100
max_queries_per_ip_per_hour = 10000
description = "This is a example api key"
indexes = [algolia_index.example.name]
referers = ["https://algolia.com/\\*"]
}
```
## Supported resources
- [x] [Settings](https://www.algolia.com/doc/api-client/methods/settings/)
- [x] [Rule](https://www.algolia.com/doc/api-client/methods/rules/)
- [x] [Api Keys](https://www.algolia.com/doc/api-client/methods/api-keys/)
- [x] [Synonym](https://www.algolia.com/doc/api-client/methods/synonyms/)
- [x] [Query Suggestions](https://www.algolia.com/doc/rest-api/query-suggestions/)
- [ ] [A/B Test](https://www.algolia.com/doc/api-client/methods/ab-test/)
- [ ] [Dictionaries](https://www.algolia.com/doc/api-client/methods/dictionaries/)
- [ ] [Personalization](https://www.algolia.com/doc/api-client/methods/personalization/)
## Contributing
I appreciate your help!
To contribute, please read the [Contributing to Terraform - Algolia Provider](./CONTRIBUTING.md)
## Sponsor
ManoMano