Skip to content

Commit 546aba5

Browse files
authored
fix docs for fleets for required parameters (#214)
1 parent 268a157 commit 546aba5

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

docs/resources/bindplane_fleet.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ and uses a selector to match agents to the fleet based on labels.
1616
| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------ |
1717
| `name` | string | required | The resource name for the fleet. Used internally and cannot be changed after creation. |
1818
| `display_name` | string | optional | A user-friendly name for the fleet. Can be changed anytime. |
19-
| `agent_type` | string | optional | The collector agent type for agents in this fleet. |
20-
| `platform` | string | optional | The platform (OS/architecture) for agents in this fleet. |
19+
| `agent_type` | string | required | The collector agent type for agents in this fleet. Cannot be changed after creation. |
20+
| `platform` | string | required | The platform (OS/architecture) for agents in this fleet. Cannot be changed after creation. |
2121
| `configuration` | string | optional | Name of the configuration assigned to the fleet. |
2222

2323
## Examples
@@ -58,12 +58,13 @@ resource "bindplane_fleet" "staging" {
5858

5959
### Minimal Fleet
6060

61-
This example creates a fleet with minimal required fields.
61+
This example creates a fleet with minimal required fields (no configuration assigned).
6262

6363
```hcl
6464
resource "bindplane_fleet" "development" {
65-
name = "development-fleet"
66-
display_name = "Development"
65+
name = "development-fleet"
66+
agent_type = "observiq-otel-collector"
67+
platform = "linux"
6768
}
6869
```
6970

@@ -80,6 +81,8 @@ and returns an error if it doesn't:
8081
# This will fail if "missing-config" doesn't exist
8182
resource "bindplane_fleet" "example" {
8283
name = "my-fleet"
84+
agent_type = "observiq-otel-collector"
85+
platform = "linux"
8386
configuration = "missing-config" # ← Error: configuration 'missing-config' does not exist
8487
}
8588
```

0 commit comments

Comments
 (0)