Update documentation

sendsmaily · Nov 28, 2024 · 34ebe2f · 34ebe2f
1 parent 5d4c008
commit 34ebe2f
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 0 deletions.
diff --git a/docs/resources/host.md b/docs/resources/host.md
@@ -39,6 +39,33 @@ resource "definednet_host" "example" {
   role_id    = "role-WSG78880Z655TQJVQFL5CZ405B"
   tags       = ["service:app"]
 }
+
+resource "definednet_host" "metrics_minimal" {
+  name       = "example.defined.test"
+  network_id = "network-7P81MCS2TVAY9XJWQTNJ3PWYPD"
+  role_id    = "role-WSG78880Z655TQJVQFL5CZ405B"
+  tags       = ["service:app"]
+
+  metrics {
+    enabled = true
+  }
+}
+
+resource "definednet_host" "metrics" {
+  name       = "example.defined.test"
+  network_id = "network-7P81MCS2TVAY9XJWQTNJ3PWYPD"
+  role_id    = "role-WSG78880Z655TQJVQFL5CZ405B"
+  tags       = ["service:app"]
+
+  metrics {
+    enabled              = true
+    listen               = "127.0.0.1:9100"
+    path                 = "/-/metrics"
+    namespace            = "infra"
+    subsystem            = "nebula"
+    enable_extra_metrics = true
+  }
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -51,6 +78,7 @@ resource "definednet_host" "example" {
 
 ### Optional
 
+- `metrics` (Block, Optional) Host's metrics exporter configuration (see [below for nested schema](#nestedblock--metrics))
 - `role_id` (String) Host's role ID on Defined.net
 - `tags` (List of String) Host's tags on Defined.net
 
@@ -59,3 +87,15 @@ resource "definednet_host" "example" {
 - `enrollment_code` (String, Sensitive) Host's enrollment code
 - `id` (String) Host's ID
 - `ip_address` (String) Host's IP address on Defined.net overlay network
+
+<a id="nestedblock--metrics"></a>
+### Nested Schema for `metrics`
+
+Optional:
+
+- `enable_extra_metrics` (Boolean) Enable extra metrics
+- `enabled` (Boolean) Enable metrics exporter
+- `listen` (String) Host-port for Prometheus metrics exporter listener
+- `namespace` (String) Prometheus metrics' namespace
+- `path` (String) Prometheus metrics exporter's HTTP path
+- `subsystem` (String) Prometheus metrics' subsystem
diff --git a/examples/resources/definednet_host/resource.tf b/examples/resources/definednet_host/resource.tf
@@ -13,3 +13,30 @@ resource "definednet_host" "example" {
   role_id    = "role-WSG78880Z655TQJVQFL5CZ405B"
   tags       = ["service:app"]
 }
+
+resource "definednet_host" "metrics_minimal" {
+  name       = "example.defined.test"
+  network_id = "network-7P81MCS2TVAY9XJWQTNJ3PWYPD"
+  role_id    = "role-WSG78880Z655TQJVQFL5CZ405B"
+  tags       = ["service:app"]
+
+  metrics {
+    enabled = true
+  }
+}
+
+resource "definednet_host" "metrics" {
+  name       = "example.defined.test"
+  network_id = "network-7P81MCS2TVAY9XJWQTNJ3PWYPD"
+  role_id    = "role-WSG78880Z655TQJVQFL5CZ405B"
+  tags       = ["service:app"]
+
+  metrics {
+    enabled              = true
+    listen               = "127.0.0.1:9100"
+    path                 = "/-/metrics"
+    namespace            = "infra"
+    subsystem            = "nebula"
+    enable_extra_metrics = true
+  }
+}