Terraform-Provider

Überblick

Der offizielle Terraform-Provider okstatus verwaltet Monitors, Vorfälle, Statusseiten, Alarmkanäle und Wartungsfenster als Code — nützlich, um das Monitoring zusammen mit der überwachten Infrastruktur bereitzustellen oder eine Flotte von Monitors in der Versionsverwaltung zu halten, statt sich durch das Dashboard zu klicken.

Der Provider ist in der Terraform Registry veröffentlicht, dort steht auch die vollständige Referenz aller Ressourcen und Datenquellen. Diese Anleitung deckt nur den Einstieg ab — jedes Feld finden Sie in der Registry-Dokumentation.

Tarif Max erforderlich

API-Schlüssel (oks_live_...) gibt es nur im Tarif Max (Dashboard → Einstellungen → API-Schlüssel). Der Provider braucht einen zur Authentifizierung.

Installieren

terraform {
  required_providers {
    okstatus = {
      source = "clearcloud-fr/okstatus"
    }
  }
}

provider "okstatus" {
  # api_key kann auch aus der Umgebungsvariablen OKSTATUS_API_KEY kommen.
  # api_key = "oks_live_..."
}

Bevorzugen Sie die Umgebungsvariable, statt den Schlüssel in Ihre .tf-Dateien zu schreiben:

export OKSTATUS_API_KEY="oks_live_..."

Ein erster Monitor

resource "okstatus_monitor" "api" {
  name                  = "Produktions-API"
  url                   = "https://api.example.com/health"
  type                  = "http"
  interval              = 60
  regions               = ["fr-dc3", "de-fra", "es-mad"]
  accepted_status_codes = ["200-299"]
}

Welche regions-Werte tatsächlich erlaubt sind, hängt von Ihrem Tarif ab — eine Region, die Ihr Tarif nicht enthält, scheitert beim apply mit einer 400, nicht schon beim plan. Die Liste je Tarif steht unter Regionen und Intervalle.

Einen Alarmkanal anhängen

Die config eines Alarmkanals verwendet die Feldnamen des Backends (camelCase), nicht das in Terraform übliche snake_case — die Form jedes Kanaltyps steht in der Referenz zu okstatus_alert_channel.

resource "okstatus_alert_channel" "team_discord" {
  type = "discord"
  config = {
    webhookUrl = "https://discord.com/api/webhooks/..."
  }
}

Was abgedeckt ist

Ressource / Datenquelle	Verwaltet
okstatus_monitor	HTTP-, TCP-, Ping- und DNS-Monitors
okstatus_llm_monitor	KI-Modell-Monitore (LLM) (ab Max)
okstatus_alert_channel	E-Mail, Discord, Webhook, Slack, Telegram und weitere
okstatus_incident	Vorfälle und ihre mit Zeitstempel versehenen Aktualisierungen
okstatus_maintenance	Geplante Wartungsfenster
okstatus_status_page	Öffentliche Statusseiten
data.okstatus_monitors	Vorhandene Monitors nachschlagen (etwa zur Referenz über den Namen)
data.okstatus_org	Tarif und Einstellungen der aktuellen Organisation lesen
data.okstatus_alert_channels	Vorhandene Alarmkanäle nachschlagen

Vollständiges Schema, jedes Feld und alle Standardwerte: registry.terraform.io/providers/clearcloud-fr/okstatus.

Vorhandene Ressourcen importieren

Über das Dashboard angelegte Ressourcen lassen sich mit terraform import unter Terraform-Verwaltung bringen, über die ID der Ressource (sichtbar in der Dashboard-URL oder über die REST-API):

terraform import okstatus_monitor.api <monitor-id>