summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJulien Dessaux2024-01-10 23:55:26 +0100
committerJulien Dessaux2024-01-10 23:55:26 +0100
commitf8ec32d16797f74c677099b2c12859c94ec10069 (patch)
tree9147f1a2212cdc5fe074db6b7fef9384396b714e /README.md
parentUpdated dependencies (diff)
downloadterraform-provider-eventline-f8ec32d16797f74c677099b2c12859c94ec10069.tar.gz
terraform-provider-eventline-f8ec32d16797f74c677099b2c12859c94ec10069.tar.bz2
terraform-provider-eventline-f8ec32d16797f74c677099b2c12859c94ec10069.zip
Added README at last!
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1281b5b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Eventline terraform provider
+
+[Read the full documentation here](https://registry.terraform.io/providers/adyxax/eventline/latest/docs)
+
+The [Eventline](https://www.exograd.com/products/eventline/) provider is used to interact with the resources supported by Eventline. The provider needs to be configured with the proper credentials before it can be used. It requires terraform 1.0 or later.
+
+## Example Usage
+
+```terraform
+terraform {
+ required_providers {
+ eventline = {
+ source = "adyxax/eventline"
+ }
+ }
+}
+
+provider "eventline" {
+ api_key = var.eventline_api_key
+ endpoint = "http://localhost:8085/"
+}
+
+data "eventline_project" "main" {
+ name = "main"
+}
+
+resource "eventline_identity" "example" {
+ name = "example"
+ project_id = data.eventline_project.main.id
+
+ connector = "eventline"
+ data = jsonencode({ "key" = "test" })
+ type = "api_key"
+}
+```