diff --git a/Makefile b/Makefile index ab61c7b..399c132 100644 --- a/Makefile +++ b/Makefile @@ -13,3 +13,4 @@ lint: docs: go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs tfplugindocs generate + @echo "Use this site to preview markdown rendering: https://registry.terraform.io/tools/doc-preview" diff --git a/README.md b/README.md index fedd323..2081e1b 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,17 @@ provider "influxdb" { } ``` +## Supported InfluxDB flavours + +### v3 + +* [InfluxDB Cloud Serverless](https://www.influxdata.com/products/influxdb-cloud/serverless/) + +### v2 + +* [InfluxDB Cloud TSM](https://docs.influxdata.com/influxdb/cloud/) +* [InfluxDB OSS](https://docs.influxdata.com/influxdb/v2/) + ## Available functionalities ### Data Sources diff --git a/docs/index.md b/docs/index.md index e984279..6f4840f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,9 +10,28 @@ description: |- Use the InfluxDB provider to deploy and manage resources supported by InfluxDB. You must configure the provider with the proper credentials before you can use it. +## Supported InfluxDB flavours + +### v3 + +* [InfluxDB Cloud Serverless](https://www.influxdata.com/products/influxdb-cloud/serverless/) + +### v2 + +* [InfluxDB Cloud TSM](https://docs.influxdata.com/influxdb/cloud/) +* [InfluxDB OSS](https://docs.influxdata.com/influxdb/v2/) + ## Example Usage ```terraform +terraform { + required_providers { + influxdb = { + source = "komminarlabs/influxdb" + } + } +} + provider "influxdb" {} ``` diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf index 951cdda..dbbdc03 100644 --- a/examples/provider/provider.tf +++ b/examples/provider/provider.tf @@ -1 +1,9 @@ +terraform { + required_providers { + influxdb = { + source = "komminarlabs/influxdb" + } + } +} + provider "influxdb" {} diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 563ab25..ceb9a64 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -10,6 +10,17 @@ description: |- Use the InfluxDB provider to deploy and manage resources supported by InfluxDB. You must configure the provider with the proper credentials before you can use it. +## Supported InfluxDB flavours + +### v3 + +* [InfluxDB Cloud Serverless](https://www.influxdata.com/products/influxdb-cloud/serverless/) + +### v2 + +* [InfluxDB Cloud TSM](https://docs.influxdata.com/influxdb/cloud/) +* [InfluxDB OSS](https://docs.influxdata.com/influxdb/v2/) + ## Example Usage {{tffile "examples/provider/provider.tf"}}