aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJulien Dessaux2023-06-19 13:04:25 +0200
committerJulien Dessaux2023-06-19 13:08:03 +0200
commit21b3a6e58787aae54938b772e3e66f1c14e86766 (patch)
tree5ec9085f196d0311ea71050d7e8edf663bf09b32 /docs
parentDeactivate 32bits builds because the ksuid library does not support those (diff)
downloadterraform-provider-eventline-21b3a6e58787aae54938b772e3e66f1c14e86766.tar.gz
terraform-provider-eventline-21b3a6e58787aae54938b772e3e66f1c14e86766.tar.bz2
terraform-provider-eventline-21b3a6e58787aae54938b772e3e66f1c14e86766.zip
Terraform registry documentation bootstrapv0.0.2
Diffstat (limited to 'docs')
-rw-r--r--docs/data-sources/projects.md5
-rw-r--r--docs/index.md22
-rw-r--r--docs/resources/project.md14
3 files changed, 34 insertions, 7 deletions
diff --git a/docs/data-sources/projects.md b/docs/data-sources/projects.md
index 63b4985..7642834 100644
--- a/docs/data-sources/projects.md
+++ b/docs/data-sources/projects.md
@@ -10,7 +10,12 @@ description: |-
Eventline projects data source
+## Example Usage
+```terraform
+data "projects" "example" {
+}
+```
<!-- schema generated by tfplugindocs -->
## Schema
diff --git a/docs/index.md b/docs/index.md
index c43341d..035ab09 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,20 +1,28 @@
---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "eventline Provider"
-subcategory: ""
-description: |-
-
+layout: ""
+page_title: "Provider: eventline"
+description: "The eventline provider allows you to interact with the eventline API."
---
-# eventline Provider
+# Eventline Provider
+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.
+Use the navigation to the left to read about the available resources.
## Example Usage
```terraform
+terraform {
+ required_providers {
+ eventline = {
+ source = "adyxax/eventline"
+ }
+ }
+}
+
provider "eventline" {
- api_key = "12345678-9abc-def0-1234-56789abcdef0"
+ api_key = var.eventline_api_key
endpoint = "http://localhost:8085/"
}
```
diff --git a/docs/resources/project.md b/docs/resources/project.md
index 21f179f..ac1953d 100644
--- a/docs/resources/project.md
+++ b/docs/resources/project.md
@@ -10,7 +10,13 @@ description: |-
Eventline project resource
+## Example Usage
+```terraform
+resource "project" "example" {
+ name = "example"
+}
+```
<!-- schema generated by tfplugindocs -->
## Schema
@@ -22,3 +28,11 @@ Eventline project resource
### Read-Only
- `id` (String) Project Id
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import eventline_project.test 0123456789ABCDEFGHIJKLMNOPQ
+```