Skip to content

Commit a9d11f6

Browse files
committed
Update documentation with v1.0.5 features
- Add Features section to README highlighting capabilities - Add Talos Linux example to provider docs - Update full-provisioning example with boot_check_pattern variable - Highlight Talos Linux and TLS flexibility features
1 parent e44459b commit a9d11f6

File tree

3 files changed

+35
-4
lines changed

3 files changed

+35
-4
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77

88
A Terraform provider for managing Turing Pi's Baseboard Management Controller (BMC), enabling power management, firmware flashing, and node provisioning.
99

10+
## Features
11+
12+
- **Power Management** - Control power state of individual compute nodes (1-4)
13+
- **Firmware Flashing** - Flash firmware images to nodes with automatic resource recreation
14+
- **Boot Verification** - Monitor UART output with configurable patterns to verify successful boot
15+
- **Talos Linux Support** - Built-in boot detection for Talos Linux clusters
16+
- **TLS Flexibility** - Skip certificate verification for self-signed or expired BMC certificates
17+
- **Environment Variables** - Configure provider via environment variables for CI/CD pipelines
18+
1019
## Installation
1120

1221
The provider is available on the [Terraform Registry](https://registry.terraform.io/providers/jfreed-dev/turingpi). Terraform will automatically download it when you run `terraform init`.

docs/index.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ The Turing Pi provider enables Terraform-based management of [Turing Pi 2.5](htt
1313

1414
- **Power Management** - Control power state of individual compute nodes
1515
- **Firmware Flashing** - Flash firmware images to nodes
16-
- **Boot Verification** - Monitor UART output to verify successful boot
16+
- **Boot Verification** - Monitor UART output to verify successful boot with configurable patterns
1717
- **Node Provisioning** - Combined resource for complete node management
18+
- **Talos Linux Support** - Built-in support for Talos Linux boot detection
19+
- **TLS Flexibility** - Skip certificate verification for self-signed or expired BMC certificates
1820

1921
## Example Usage
2022

@@ -40,6 +42,18 @@ resource "turingpi_power" "node1" {
4042
}
4143
```
4244

45+
### Talos Linux Example
46+
47+
```hcl
48+
resource "turingpi_node" "talos_node" {
49+
node = 1
50+
power_state = "on"
51+
boot_check = true
52+
boot_check_pattern = "machine is running and ready"
53+
login_prompt_timeout = 180
54+
}
55+
```
56+
4357
## Authentication
4458

4559
The provider requires BMC credentials to authenticate with the Turing Pi board.

examples/full-provisioning/main.tf

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,28 @@ variable "boot_timeout" {
2121
default = 120
2222
}
2323

24+
variable "boot_pattern" {
25+
description = "Pattern to detect in UART output for boot verification"
26+
type = string
27+
default = "login:" # Use "machine is running and ready" for Talos Linux
28+
}
29+
2430
# Fully provision node 1 with firmware and boot verification
2531
resource "turingpi_node" "node1" {
2632
node = 1
2733
power_state = "on"
2834
firmware_file = var.firmware_path != "" ? var.firmware_path : null
2935
boot_check = true
36+
boot_check_pattern = var.boot_pattern
3037
login_prompt_timeout = var.boot_timeout
3138
}
3239

3340
# Provision node 2 without firmware flash
3441
resource "turingpi_node" "node2" {
35-
node = 2
36-
power_state = "on"
37-
boot_check = true
42+
node = 2
43+
power_state = "on"
44+
boot_check = true
45+
boot_check_pattern = var.boot_pattern
3846
}
3947

4048
# Keep node 3 powered off

0 commit comments

Comments
 (0)