Entwickler

Terraform

Costfluent-Objekte mit dem Terraform-Provider als Code verwalten, Cloud-Konten im selben Apply verbinden und im Produkt angelegte Objekte unter Terraform bringen.

Costfluent veröffentlicht einen Terraform-Provider und drei Cost-Access-Module in der öffentlichen Terraform Registry. Die Registry enthält die vollständige Referenz zu jeder Ressource und jeder Eingabe; diese Seite zeigt, wie Sie sie einrichten, wie sie zusammenspielen und wie im Produkt angelegte Objekte unter Terraform kommen.

Bevor Sie beginnen

  • Das Token für den Provider mit der vollständigen Vorlage Lesen und schreiben zu erstellen erfordert die Organisationsrolle Eigentümer: Nur ein Eigentümer gibt einem Organisations-Token Workspace-Berechtigungen, und allen anderen bietet der Dialog die Vorlage beschränkt auf das an, was sie vergeben dürfen; siehe API-Authentifizierung.
  • Der Provider kann, was die Berechtigungen seines Tokens erlauben, und nichts darüber hinaus. Er liest das Token beim Start, und terraform plan bricht ab, bevor etwas geändert wird, wenn eine Ressource eine Berechtigung braucht, die dem Token fehlt, und nennt diese Berechtigung.

Token erstellen

  1. Öffnen Sie Einstellungen, dann API-Token, und wählen Sie API-Token erstellen.
  2. Geben Sie unter Name einen Namen ein, der sagt, wo das Token läuft, etwa den Namen der Pipeline.
  3. Wählen Sie unter Vorlage die Vorlage Lesen und schreiben. Diese Vorlage wählt unter Berechtigungen alles außer der Gruppe Benutzer, Teams und Kanäle, einschließlich Integrationen verwalten, Integrationen zu Arbeitsbereichen hinzufügen und Integrationen aus Arbeitsbereichen entfernen, die costfluent_workspace_provider braucht. Um costfluent_team, costfluent_team_member, costfluent_team_workspace_access oder costfluent_app zu verwalten oder ein Mitglied mit costfluent_user nachzuschlagen, wählen Sie zusätzlich die Berechtigungen dieser Gruppe.
  4. Wählen Sie den Ablauf und dann API-Token erstellen.
  5. Kopieren Sie das Token aus Ihr API-Token. Es wird nur einmal angezeigt.

Lesen und schreiben lässt Benutzer, Teams und Kanäle aus, deshalb wird ein Token allein aus dieser Vorlage abgewiesen, wenn es ein costfluent_team, ein costfluent_team_member, einen costfluent_team_workspace_access oder eine costfluent_app liest, anlegt, ändert oder löscht, und wenn es ein Mitglied mit costfluent_user nachschlägt: Personen, Teams und Kanäle zu lesen erfordert Mitglieder anzeigen. Alle anderen Ressourcen funktionieren mit Lesen und schreiben, auch costfluent_workspace_provider.

Halten Sie das Token aus der Versionsverwaltung heraus: Übergeben Sie es in der Umgebungsvariable COSTFLUENT_API_KEY oder in einer sensiblen Variable, die Ihre Pipeline aus ihrem Secret-Store füllt.

Provider konfigurieren

Code
terraform { required_providers { costfluent = { source = "costfluent/costfluent" version = "~> 0.6.0" } } } provider "costfluent" { # Jede Einstellung ist hier optional; die Umgebungsvariablen unten füllen sie stattdessen. # api_key = var.costfluent_api_key # workspace = "wsp_..." # base_url = "https://api.costfluent.com" # timeout = 30 }

Legen Sie den Provider auf eine Minor-Version fest, wie es die version-Zeile oben tut. Bis Version 1.0 kann eine neue Minor-Version Änderungen an Ihrer Konfiguration erfordern; die Upgrade-Anleitungen des Providers in der Registry nennen sie, für 0.4.0 und für 0.3.0. Eine Patch-Version tut das nie.

EinstellungUmgebungsvariableWas sie tut
api_keyCOSTFLUENT_API_KEYDas Token. An einer der beiden Stellen erforderlich.
workspaceCOSTFLUENT_WORKSPACEDie Workspace-ID, beginnend mit wsp_, die workspace-bezogene Ressourcen ohne eigene workspace_id verwenden.
base_urlCOSTFLUENT_BASE_URLDie Adresse der Public API. Standard ist https://api.costfluent.com. Muss https verwenden; einfaches http wird nur für localhost, 127.0.0.1 und ::1 akzeptiert.
timeoutkeineWie lange eine Anfrage dauern darf, in Sekunden. Standard ist 30.

Eine Einstellung im Provider-Block geht ihrer Umgebungsvariable vor.

AWS im selben Apply verbinden

Jedes Cost-Access-Modul legt in Ihrem eigenen Cloud-Konto den Lesezugriff an, den Costfluent braucht:

Die Module enthalten den Costfluent-Provider nicht, sodass kein Costfluent-Token in eine Cloud-Pipeline gelangt, solange Sie keines hinzufügen. Zusammen mit dem Provider legt ein Apply den Zugriff und die Verbindung an. Für AWS:

Code
terraform { required_providers { aws = { source = "hashicorp/aws" } costfluent = { source = "costfluent/costfluent" version = "~> 0.6.0" } } } provider "aws" { region = "us-east-1" } provider "costfluent" {} # Der Principal, dem Ihre Rolle vertrauen muss, und die External ID Ihrer Organisation. data "costfluent_aws_provider_info" "this" {} module "costfluent_aws" { source = "costfluent/cost-access/aws" version = "~> 0.5" costfluent_principal_arn = data.costfluent_aws_provider_info.this.principal_arn external_id = data.costfluent_aws_provider_info.this.external_id cost_export_bucket_name = "acme-costfluent-export" # in einem Mitgliedskonto weglassen } resource "costfluent_provider" "aws" { key = "aws" display_name = "AWS" credentials = module.costfluent_aws.credentials settings = module.costfluent_aws.settings }

Die neue Verbindung erscheint unter Integrationen; dort legen Sie fest, welche Workspaces ihre Kosten sehen (Verbindungen verwalten). Die Provider-Seiten behandeln jede Cloud vollständig, mit und ohne Terraform: AWS, Azure, Google Cloud.

Objekte verwalten

RessourceWas sie verwaltet
costfluent_workspaceEinen Workspace, seine Währungseinstellungen, seine Zeitzone und die automatische Synchronisierung
costfluent_providerEine Verbindung zu einem Cloud-Konto
costfluent_workspace_providerEine in einem Workspace aktivierte Verbindung, und welche ihrer Konten der Workspace liest
costfluent_gcp_service_accountDas Google-Cloud-Dienstkonto, das Costfluent für Ihre Organisation betreibt
costfluent_cost_reportEinen gespeicherten Kostenbericht
costfluent_business_metricEine Geschäftskennzahl, deren Kosten pro Einheit ein Bericht zeigt; ihre Werte werden per CSV oder API importiert
costfluent_folderEinen Berichtsordner
costfluent_dashboardEin Dashboard und der gespeicherte Filter, durch den seine Bericht-Widgets gelesen werden
costfluent_dashboard_widgetEin Widget auf einem Dashboard: ein gespeicherter Kostenbericht als Diagramm, Tabelle oder KPI, oder Text
costfluent_saved_filterEinen gespeicherten Filter
costfluent_savings_viewEine gespeicherte Ansicht der Einsparungsliste eines Workspaces: einen Tab und seine Filter unter einem Titel
costfluent_budgetEin Budget und seine Schwellen
costfluent_cost_alertEine Kostenwarnung
costfluent_segmentEin Segment
costfluent_allocation_ruleEine Zuordnungsregel
costfluent_virtual_tagEin virtuelles Tag
costfluent_tag_policyDie Tag-Richtlinie eines Workspaces: die erforderlichen Tag-Schlüssel, die seine Kosten tragen müssen
costfluent_cost_report_subscriptionEinen Kostenbericht, der nach Zeitplan an Benachrichtigungskanäle gesendet wird
costfluent_appEinen Benachrichtigungskanal: E-Mail, Slack, Microsoft Teams oder ein Webhook
costfluent_teamEin Team
costfluent_team_memberEin Mitglied der Organisation in einem Team, mit seiner Rolle dort
costfluent_team_workspace_accessDen Zugriff eines Teams auf einen Workspace und das Dashboard, das seine Mitglieder dort öffnen

Datenquellen lesen Workspaces, Verbindungen, Kostendaten, Kostenzusammenfassungen, Anomalien, die Potenziale in der Einsparungsliste eines Workspaces (costfluent_savings_items), die Berechtigungen Ihres Tarifs und das, wem eine AWS-Rolle vertrauen muss (costfluent_aws_provider_info).

In Planung: Commitment-Abdeckung

In Costfluent noch nicht verfügbar.

costfluent_commitments liest die Reservierungen, Savings Plans und Committed Use Discounts, die die Verbindungen eines Workspaces halten.

Ein Workspace mit einem Bericht und einem Budget:

Code
resource "costfluent_workspace" "production" { name = "Production" currency = "EUR" } resource "costfluent_cost_report" "by_service" { workspace_id = costfluent_workspace.production.id title = "Monthly cost by service" date_interval = "ThisMonth" date_bin = "Day" group_by = [{ dimension = "ServiceName" }] } resource "costfluent_budget" "monthly" { workspace_id = costfluent_workspace.production.id name = "Monthly cloud budget" amount = 10000 currency = "EUR" start_date = "2026-01-01" alerts = [ { threshold_percent = 80 }, { threshold_percent = 100 }, ] }

Bestehende Objekte unter Terraform bringen

Ein im Produkt oder über die Public API angelegtes Objekt kann Terraform verwalten, ohne es neu anzulegen. Schreiben Sie zuerst seinen resource-Block und importieren Sie es dann per ID mit terraform import oder einem import-Block:

TerminalCode
terraform import costfluent_cost_report.by_service wsp_1a2b3c:crp_4d5e6f
Code
import { to = costfluent_budget.monthly id = "bud_7g8h9i" }

Die Form der ID hängt von der Ressource ab:

RessourceImport-ID
costfluent_workspace, costfluent_provider, costfluent_budget, costfluent_team, costfluent_appDie ID des Objekts
costfluent_cost_report, costfluent_segment, costfluent_allocation_rule, costfluent_workspace_provider<Workspace-ID>:<Objekt-ID>; der Workspace ist erforderlich
costfluent_cost_alert, costfluent_cost_report_subscription, costfluent_dashboard, costfluent_folder, costfluent_saved_filter, costfluent_savings_view, costfluent_virtual_tag, costfluent_business_metric<Workspace-ID>:<Objekt-ID>, oder die ID des Objekts allein, das dann im workspace des Providers gelesen wird
costfluent_dashboard_widget<Workspace-ID>:<Dashboard-ID>:<Widget-ID>, oder <Dashboard-ID>:<Widget-ID> im workspace des Providers
costfluent_team_member<Team-ID>:<Benutzer-ID>
costfluent_team_workspace_access<Team-ID>:<Workspace-ID>
costfluent_tag_policyDie ID des Workspaces: Ein Workspace hat eine Tag-Richtlinie

costfluent_gcp_service_account lässt sich nicht importieren und braucht keinen Import: Costfluent legt ein Dienstkonto pro Organisation an, und die Ressource liest es. Sie stellt es bei jeder Aktualisierung bereit: Hat Costfluent das Konto gelöscht, weil nichts es genutzt hat (Zugriff rotieren oder entfernen), legt der nächste Plan es wieder an, und die Freigaben des Costfluent-Moduls gelten im selben Apply für es.

Die ID eines Workspace, einer Verbindung, eines Kostenberichts, eines Dashboards oder eines Budgets ist der letzte Teil der Adresse seiner Seite im Produkt: Die ID beginnt mit wsp_, prv_, crp_, dsh_ oder bud_. Die Datenquellen costfluent_workspaces und costfluent_providers listen Workspaces und Verbindungen mit ihren IDs, und die Listen-Endpunkte der Public API liefern die ID jedes anderen Objekts; siehe die API-Referenz.

Führen Sie nach einem Import terraform plan aus. Ein Unterschied, den der Plan zeigt, besteht zwischen Ihrer Konfiguration und dem Objekt, wie es ist; passen Sie die Konfiguration an, bis der Plan leer ist, es sei denn, Sie wollen das Objekt ändern.

Wie es sich verhält

  • Eine Änderung im Produkt an einem von Terraform verwalteten Objekt erscheint beim nächsten Plan als Drift. Ein im Produkt gelöschtes Objekt fällt aus dem State, und der nächste Plan legt es wieder an.
  • costfluent_provider versucht es bis zu drei Minuten erneut, während sich neuer Cloud-Zugriff verbreitet, etwa eine Rolle oder eine Dataset-Freigabe, die früher im selben Apply angelegt wurde. Eine Änderung am display_name einer Verbindung benennt sie an Ort und Stelle um: Die Verbindung behält ihre ID und die Kosten, die sie erfasst hat.
  • Ein costfluent_provider zu zerstören entfernt die Verbindung und löscht die von ihr importierten Kosten, wie das Entfernen im Produkt.
  • Eine Änderung der workspace_id eines Kostenberichts legt den Bericht im neuen Workspace neu an.
  • Ein costfluent_workspace_provider ohne account_ids oder mit einer leeren Menge liest die gesamte Verbindung, einschließlich später erkannter Konten. Eine Änderung von account_ids oder is_enabled aktualisiert ihn an Ort und Stelle; eine Änderung von workspace_id oder provider_id legt ihn neu an. Ihn anzulegen oder seine account_ids zu ändern entscheidet, welche Konten der Organisation der Workspace liest, deshalb braucht es ein Organisations-Token mit Integrationen verwalten, und terraform plan lehnt dafür ein Workspace-Token ab. Ein Workspace-Token kann is_enabled ändern und die Ressource zerstören. Mit is_enabled = false liest der Workspace die Kosten und Anomalien der Verbindung nicht mehr, und die Verbindung verlässt seinen automatischen Zeitplan; die Verknüpfung und ihre account_ids bleiben, und true stellt beides wieder her. Ihn zu zerstören beendet, dass dieser Workspace die Verbindung liest; die Verbindung, ihre Kosten und andere Workspaces bleiben unberührt.
  • Die API gibt die Zugangsdaten eines Kanals nie zurück: das Signatur-Secret eines Webhooks und die Webhook-Adresse eines Slack- oder Microsoft-Teams-Kanals werden als *** gelesen, die url eines Webhooks als Schema und Host mit /***, etwa https://hooks.example.com/***. Wird diese gekürzte url zurückgesendet, bleibt die gespeicherte erhalten. costfluent_app behält die angewendete config, deshalb erscheint ein im Produkt geänderter Zugangswert nicht als Drift, und ein importierter Kanal hält die gekürzten Werte, bis der nächste Apply die eigene Konfiguration schreibt. Wenn Sie secret aus der config eines Webhooks entfernen, wird er nicht mehr signiert: Der Provider sendet das Secret als null, weil die API das gespeicherte Secret behält, wenn eine Änderung es weglässt.
  • Der Terraform-State enthält die credentials einer Verbindung, die config eines Kanals und das signing_secret eines Webhooks im Klartext. Als sensibel markiert werden sie nur in der Plan-Ausgabe verborgen; legen Sie den State deshalb in einem verschlüsselten Backend mit eingeschränktem Zugriff ab.
  • Die Mitglieder eines Teams sind costfluent_team_member-Ressourcen; costfluent_team verwaltet nur seinen Namen.
  • Eine costfluent_savings_view hält einen Tab der Liste und seine Filter fest, wie eine gespeicherte Ansicht im Produkt. Jede Änderung ersetzt die Ansicht vollständig, daher fällt ein Filter, den Sie aus der Konfiguration entfernen, auch in der Ansicht weg. Potenziale liest Terraform nur: costfluent_savings_items listet sie, und im Produkt führen Sie ein Potenzial durch seine Status.

Verwandte Seiten