> For the complete documentation index, see [llms.txt](https://docs.verge.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verge.io/run-the-platform/de/systemadministration/cluster-settings.md).

# Cluster-Einstellungen

Referenz für alle Clusterkonfigurationseinstellungen in VergeOS, einschließlich CPU-Typ, RAM-Zuweisung, Sicherheitsminderungen, Richtlinien für Rechenressourcen, Swap und Knoten-Temperaturüberwachung.

Die *Cluster-Einstellungen* Das Formular ermöglicht es Ihnen, wichtige Parameter für Leistung, Sicherheit, Zuweisung, thermische Überwachung und Swap zu konfigurieren. Obwohl die meisten Standardeinstellungen für die meisten Umgebungen geeignet sind, wird empfohlen, sie bei der Erstellung eines neuen Clusters und regelmäßig danach zu überprüfen, um die Übereinstimmung mit den Richtlinien und betrieblichen Anforderungen Ihrer Organisation sicherzustellen.

{% hint style="success" %}
**Die meisten Änderungen an den Cluster-Einstellungen erfordern einen Neustart jedes Cluster-Knotens. Oben im Cluster-Dashboard erscheint eine Meldung, wenn ein Neustart erforderlich ist. Wählen Sie die&#x20;*****Neustart erforderlich*****&#x20;Option (in der Neustart-/Neustartmeldung oben im Cluster-Dashboard oder als Menüoption links), um Neustarts der Cluster-Knoten zu verwalten. Befolgen Sie beim Neustart von Knoten immer die korrekten** [**Verfahren für den Wartungsmodus**](/run-the-platform/de/betrieb/maintenance-mode.md) **um Workload-Unterbrechungen zu vermeiden.**
{% endhint %}

## Aufrufen der Clustereinstellungen

* Navigieren Sie im oberen Menü zu **Infrastruktur** > **Cluster** > **doppelklicken Sie auf das gewünschte Cluster**
* Klicken Sie auf **Bearbeiten** im linken Menü.

## Cluster

Dieser Abschnitt definiert die grundlegenden Eigenschaften Ihres Clusters.

1. **Aktiviert:** Standardmäßig ist der Cluster aktiviert. In der Regel gibt es keinen Grund, ihn zu deaktivieren; dies kann jedoch in bestimmten Situationen nützlich sein, etwa bei einer vollständigen Neukonfiguration des Clusters.
2. **Name:** Ein Cluster wird in der Regel bei der Installation benannt, kann aber problemlos umbenannt werden.
3. **Beschreibung:** Optionales Textfeld für eine kurze Beschreibung des Zwecks oder der Eigenschaften des Clusters.
4. **Standard-CPU-Typ:** Legt den standardmäßigen/empfohlenen CPU-Typ für virtuelle Maschinen fest, für die dieser Cluster zugewiesen ist. Diese Einstellung wird während der Cluster-Installation automatisch anhand der erkannten CPU-Hardware ausgewählt. Überprüfen Sie bei der Erstkonfiguration die Einstellung, um sicherzustellen, dass der richtige CPU-Typ erkannt wurde.

{% hint style="success" %}
**Um die Migration/den Failover von virtuellen Maschinen zu einem anderen Cluster mit einer CPU geringerer Klasse zu ermöglichen,&#x20;*****Standard-CPU-Typ*****&#x20;kann auf den Typ der niedrigeren Klasse geändert werden, damit virtuelle Maschinen problemlos auf die ältere Chip-Hardware verschoben werden können.**
{% endhint %}

{% hint style="warning" %}
**Alle Knoten innerhalb eines Clusters sollten dieselbe CPU-Hardware enthalten; gemischte CPU-Typen innerhalb desselben Clusters können zu Leistungs- und Workload-Migrationsproblemen führen.**
{% endhint %}

5. **Speicherpuffer pro Knoten (Standard 2 GB):** Die pro Knoten zusätzlich zuzuweisende RAM-Menge für das vSAN-Performance-Caching.

{% hint style="info" %}
**Überlegungen**

* Wenn über den Bedarf von System und virtuellen Workloads hinaus noch RAM verfügbar ist, sollten Sie diese Einstellung erhöhen
* Das Erhöhen des *Speicherpuffers pro Knoten* kann die Lese-/Schreibleistung erheblich verbessern
* Als grobe Richtlinie sollten Sie im normalen Betrieb eine RAM-Auslastung von höchstens 80 % anstreben
  {% endhint %}

### Cluster-Sicherheit/Leistung

Dieser Unterabschnitt ermöglicht es Ihnen, verschiedene leistungs- und sicherheitsbezogene Funktionen und Schutzmaßnahmen für alle Knoten im Cluster zu aktivieren/deaktivieren.

1. **Hugepages für Speicher zuweisen (standardmäßig aktiviert):** Die Aktivierung von Hugepages wird in den meisten Fällen dringend empfohlen, da sie die Speicherleistung für Workloads verbessert. Das Deaktivieren dieser Einstellung wird im Allgemeinen nicht empfohlen, außer in seltenen Szenarien, etwa wenn nur sehr kleine virtuelle Maschinen oder ältere Gastbetriebssysteme mit eingeschränkter Hugepage-Unterstützung ausgeführt werden.
2. **CPU-Sicherheitsmaßnahmen deaktivieren:** Wenn ausgewählt, werden CPU-Sicherheitsmaßnahmen auf Kernel-Ebene für den Cluster deaktiviert.

{% hint style="warning" %}
**WICHTIG: Obwohl das Deaktivieren von CPU-Sicherheitsmaßnahmen die Leistung verbessern kann, ist dies riskant. Wählen Sie diese Option nur aus, wenn Sie allen in diesem Cluster laufenden Gästen vollständig vertrauen und sicher sein können, dass die Workloads keine externen Schwachstellen aufweisen (z. B. Air-Gap-Systeme).**
{% endhint %}

3. **Speculative Store Bypass deaktivieren:** Wenn ausgewählt, wird Speculative Store Bypass (SSB) zur Laufzeit deaktiviert. Das Deaktivieren von SSB kann je nach System-Workloads zu einem leichten bis mäßigen Leistungsabfall führen.
4. **SMT deaktivieren:** Wenn ausgewählt, wird Simultaneous Multithreading (SMT) zur Laufzeit deaktiviert.

{% hint style="info" %}

* Das Deaktivieren von SMT beeinträchtigt die Leistung erheblich, da dadurch Hyper-Threading deaktiviert wird
* Während moderne Software- und Microcode-Updates in der Regel viele der mit SMT verbundenen Schwachstellen mindern, können sich einige besonders sensible Umgebungen dafür entscheiden, SMT zu deaktivieren, selbst wenn dies Leistungseinbußen mit sich bringt
* Die empfohlene Methode zum Deaktivieren von SMT ist im BIOS. Der genaue Name der Einstellung kann je nach Hersteller variieren; ziehen Sie bei Unsicherheit die Hardware-Dokumentation zu Rate
  {% endhint %}

5. **CPU-Schlafzustände deaktivieren:** Wenn ausgewählt, deaktiviert VergeOS automatisch niedrige Schlafzustände. Dadurch können unnötige Übergänge in Schlafzustände aufgrund kurzer Leerlaufphasen vermieden werden, die sonst trotz minimalem Nutzen für die Energieeffizienz zu einem spürbaren Leistungsabfall führen würden.

{% hint style="info" %}

* Das Deaktivieren von CPU-Schlafzuständen kann besonders bei neu bereitgestellten Systemen von Vorteil sein, bei denen Workloads schrittweise hinzugefügt werden. In diesen Fällen müssen inaktive Knoten schnell reagieren, wenn die Nachfrage steigt
* Die Auswahl dieser Option kann je nach System-Workloads zu höheren Temperaturen und einem höheren Stromverbrauch führen
  {% endhint %}

6. **Split-Lock-Erkennung aktivieren:** Erkennt Split-Lock-Ereignisse innerhalb von Workloads und meldet sie im Systemprotokoll. Das Aktivieren dieser Option kann sich auf die Leistung von virtuellen Maschinen auswirken, die einen Split Lock auslösen.
7. **Energie-Leistungs-Richtlinie (Standard=*****Leistung*****):** Richtlinieneinstellung, die die interne Logik des Prozessors anleitet, Leistung gegenüber Energieeffizienz auszubalancieren. Diese Einstellung sollte in der Regel auf dem Standardwert belassen werden, damit das System die Leistung zur Laufzeit dynamisch optimieren kann. Alternative Optionen für Energie versus Leistung stehen zur Unterstützung von Nicht-Unternehmensumgebungen wie Consumer-Systemen, Heimlaboren oder Proof-of-Concept-(PoC)-Bereitstellungen zur Verfügung.
8. **CPU-Skalierungs-Governor (Standard=*****Leistung*****):** Richtlinie für die dynamische CPU-Frequenzanpassung auf Kernel-Ebene basierend auf der Systemlast. Diese Einstellung sollte in der Regel auf dem Standardwert belassen werden, damit das System die Leistung zur Laufzeit dynamisch optimieren kann. Alternative Optionen für Energie versus Leistung stehen zur Unterstützung von Nicht-Unternehmensumgebungen wie Consumer-Systemen, Heimlaboren oder Proof-of-Concept-(PoC)-Bereitstellungen zur Verfügung.

### Systemprotokollfilter

1. **Systemprotokollfilter (Standard `*:3,ipmievd:5,rasdaemon,!ntpd,!postfix`):** Eine durch Kommas getrennte Liste von Filtern in rsyslog-Syntax, die festlegt, welche Protokolleinträge in der Benutzeroberfläche angezeigt werden. Einträge, die diesen Filtern entsprechen, werden angezeigt; alle anderen werden aus der UI-Ansicht ausgeschlossen. Diese Syntax unterstützt Facility- und Prioritätsfilter sowie programmspezifische Ein- oder Ausschlüsse.

{% hint style="success" %}
**Nicht gefilterte Protokolle bleiben zugänglich über&#x20;*****Knotendiagnose*****&#x20;(Navigieren Sie zu&#x20;*****Knoten*****&#x20;> doppelklicken Sie auf den gewünschten Knoten > wählen Sie&#x20;*****Diagnose*****&#x20;aus dem linken Menü.)**
{% endhint %}

## Berechnung

Dieser Abschnitt konfiguriert Richtlinien für Rechenressourcen Ihres Clusters. Diese Einstellungen gelten nicht für Speicher-only-Cluster.

1. **Maximaler RAM pro Maschine:** Gibt die maximale Menge an RAM an, die einem einzelnen Workload (z. B. einer virtuellen Maschine, einem Tenant-Knoten oder einem NAS-Dienst) zugewiesen werden kann.

{% hint style="success" %}
**Überlegungen**

* Wenn laufende Workloads (z. B. VMs) mehr RAM verwenden als dieser Grenzwert zulässt, können sie nach dem Herabsetzen der Einstellung nicht mehr migriert werden.
* Der Grenzwert beeinflusst den Start und die Migration von Workloads (d. h. den Start auf einem neuen Knoten). Er verbietet nicht die Erstellung eines Workloads mit mehr RAM, verhindert aber dessen Start, wenn der Grenzwert überschritten wird.
* Als allgemeine Regel sollten Sie den niedrigsten RAM-Wert wählen, der die Anforderungen Ihres größten erwarteten Workloads noch erfüllt. Niedrigere RAM-Zuweisungen für einzelne Workloads maximieren die Flexibilität für Migrationen, Failovers und die Portierbarkeit von Workloads und ermöglichen schnellere Failover-Zeiten.
* **Seien Sie vorsichtig, wenn Sie diesen Grenzwert nahe an die physische RAM-Kapazität eines Knotens setzen**. Wenn Sie diesen Grenzwert auf den gesamten RAM eines Knotens setzen (z. B. 128 GB) und dann eine VM erstellen, die diese gesamte Menge nutzt, kann die VM nicht gestartet oder migriert werden, weil:
  * VergeOS reserviert RAM für Systemoperationen und vSAN-Funktionalität
  * Während Wartung oder Failover müssen Workloads auf andere verfügbare Knoten migrieren
  * Eine VM, die nahezu den gesamten verfügbaren RAM verbraucht, kann nicht erfolgreich auf einen anderen Knoten migrieren
* **Empfohlener Ansatz:** Setzen Sie diesen Grenzwert auf höchstens 70–80 % des physischen RAM Ihres kleinsten Knotens, damit VMs während Wartungs- oder Failover-Szenarien immer migrieren können.
  {% endhint %}

2. **Maximale Kerne pro Maschine:** Gibt die maximale Anzahl an CPU-Kernen an, die einem einzelnen Workload (z. B. einer virtuellen Maschine, einem Tenant-Knoten oder einem NAS-Dienst) zugewiesen werden können

{% hint style="success" %}
**Überlegungen**

* Wenn laufende Workloads (z. B. VMs) mehr Kerne verwenden als dieser Grenzwert zulässt, können sie nach dem Herabsetzen der Einstellung nicht mehr migriert werden.
* In nahezu allen Fällen **sollte dieser Wert nicht höher sein als** die Anzahl der Kerne, die innerhalb eines **einzelnen CPU-Sockets**.
* **Dieser Wert sollte niemals die Gesamtzahl der physischen Kerne in einem einzelnen Knoten überschreiten**
  {% endhint %}

3. **Zielwert für max. RAM in % (Standard 80):** Gibt den maximalen Prozentsatz des physischen RAM an, den ein Cluster-Knoten unter normalen Bedingungen verwenden soll. Diese Schwelle hilft, eine Überzuweisung durch neue Workloads zu verhindern. In besonderen Umständen wie Failover oder Workload-Migration kann sie jedoch überschritten werden, um die Servicekontinuität zu gewährleisten.

{% hint style="info" %}
**Beispiel für&#x20;*****Zielwert für max. RAM in %***

* Ein Cluster-Knoten hat **252 GB physischen RAM verfügbar** (256 GB, davon 252 GB nach BIOS-/Grafikkarten-Overhead)
* ***Zielwert für max. RAM in %*** ist auf den Standardwert von **80**
* 252 GB \* 80 % = **etwa 200 GB** unter normalen Bedingungen nutzbar
* **System-/vSAN-RAM-Overhead 16 GB** (Hinweis: Der vSAN-Overhead variiert je nach Menge des Clusterspeichers)
* **Verfügbar für neue Workloads:** 184 GB (nutzbar abzüglich Overhead) und damit innerhalb des 80 %-Nutzungsziels
* **Während Failover oder Migration:** RAM-Nutzung des Workloads **kann vorübergehend 184 GB überschreiten** um verlegte Workloads zu unterstützen
  {% endhint %}

4. **% des Reserve-RAMs, der für Maschinen verwendet werden soll:** legt einen Anteil (in Prozent) des Swaps fest, der speziell reserviert wird, um zusätzlichen Workload-RAM zu simulieren, wenn der physische RAM erschöpft ist. Dieser virtuelle RAM kann als Fallback für RAM-Überprovisionierung konfiguriert werden.

{% hint style="warning" %}
**Warnhinweise zur RAM-Überprovisionierung**

* Die Verwendung dieser Reserve-RAM-Funktion ist typischerweise nur als Fallback für RAM-Überprovisionierung vorgesehen
* Vermeiden Sie Überprovisionierung in Clustern mit hoher Speicherauslastung durch Workloads oder kritischen Workloads
* Erwägen Sie ein Right-Sizing von VMs, indem Sie RAM-Zuweisungen reduzieren, wenn die Nutzung durchgehend niedrig ist
* Wenn zu viele VMs gleichzeitig ihre volle Speicherzuweisung anfordern, kann die Leistung der Workloads beeinträchtigt werden, da virtueller RAM um Größenordnungen langsamer ist als physischer RAM (Millisekunden statt Nanosekunden)
  {% endhint %}

5. **Verschachtelte Virtualisierung:** Ermöglicht die Verwendung einer virtuellen Maschine innerhalb einer anderen virtuellen Maschine unter Nutzung der Hardwarebeschleunigung des Hosts.

{% hint style="info" %}
**Verschachtelte Virtualisierung kann Sicherheitsauswirkungen und Probleme mit fairer Warteschlangenplanung/Messung mit sich bringen.**
{% endhint %}

6. *Live-Migration für verschachtelte Virtualisierung zulassen:*\* Ermöglicht die Live-Migration von virtuellen Maschinen mit verschachtelter Virtualisierung.
7. *Live-Migration für VGPU zulassen:*\* Ermöglicht die Live-Migration virtueller Maschinen mit vGPU-Geräten (experimentell). Obwohl dies in Tests nicht vollständig verifiziert wurde, hat sich gezeigt, dass die Live-Migration von vGPU-Workloads im Allgemeinen zuverlässig funktioniert, wenn auf Host und Gast die neuesten NVIDIA-Treiber verwendet werden.

{% hint style="info" %}
**Wenn nicht genügend vGPU-Geräte verfügbar sind, können Workloads während der Wartung vorübergehend ausgeschaltet werden.**
{% endhint %}

{% hint style="success" %}
\***Live-Migrationen**

Die Einstellung der virtuellen Maschine: *Migrationsmethode* ermöglicht die Definition des Migrationsverhaltens pro VM (z. B. manuelles Herunterfahren erforderlich, Live-Migration versuchen)
{% endhint %}

### Aktivieren der verschachtelten Virtualisierung

Verschachtelte Virtualisierung erfordert zwei Einstellungen; sie muss auf Cluster-Ebene und auf VM-Ebene aktiviert sein:

1. **Auf Cluster-Ebene:** Aktivieren Sie die **Verschachtelte Virtualisierung** Einstellung in der obigen Liste. Wenn oben im Cluster-Dashboard eine Neustartmeldung erscheint, starten Sie die Cluster-Knoten mit den geeigneten [Verfahren für den Wartungsmodus](/run-the-platform/de/betrieb/maintenance-mode.md).
2. **Auf VM-Ebene:** Klicken Sie im VM-Dashboard auf **Bearbeiten** und aktivieren Sie **Verschachtelte Virtualisierung** in den VM-Einstellungen.

Starten Sie die VM neu, nachdem Sie beide Einstellungen aktiviert haben. Das CPU-Feature wird angewendet, wenn die VM startet.

{% hint style="info" %}
Die **Live-Migration für verschachtelte Virtualisierung zulassen** Die Einstellung ist separat. Sie steuert nur, ob VMs mit verschachtelter Virtualisierung zwischen Knoten live migrieren können; sie ist nicht erforderlich, um verschachtelte Virtualisierung auszuführen.
{% endhint %}

{% hint style="success" %}
**Hyper-V-Anwendungsfall**

Die Ausführung von Hyper-V innerhalb eines Windows-Gasts ist ein häufiger Grund, verschachtelte Virtualisierung zu aktivieren. Wenn verschachtelte Virtualisierung nicht auf beiden Ebenen aktiviert ist, kann die Hyper-V-Rolle dazu führen, dass der Gast kurz nach dem Erscheinen des Windows-Logos in eine Boot-Schleife gerät. Falls die Hyper-V-Rolle nach einem Neustart weiterhin fehlschlägt, schalten Sie die VM vollständig aus und wieder ein. Der Betrieb von Hyper-V als verschachtelter Gast eignet sich für Labor- und Testszenarien; es ist keine für den Produktionseinsatz zertifizierte Konfiguration.
{% endhint %}

## Speicher (Swap-Einstellungen)

{% hint style="warning" %}
**Swap-Einstellungen werden während der Cluster-Installation festgelegt. Änderungen an den Swap-Einstellungen gelten nur für neu formatierte Festplatten.**
{% endhint %}

1. **Für Swap verwendete Stufe:** Speicher-Tier, der für den Swap-Speicher verwendet werden soll. Swap ist deaktiviert, wenn der Wert 0 ist
2. **Swap pro Laufwerk:** Menge des pro Laufwerk zuzuweisenden Swap-Speichers

## Knotentemperatur

Dieser Abschnitt ermöglicht es Ihnen, Einstellungen für das VergeOS-Warnverhalten in Bezug auf höhere CPU-Temperaturwerte auf Cluster-Knoten zu definieren. Rechtzeitige Benachrichtigungen, bevor die maximale CPU-Temperatur erreicht wird, können Maßnahmen ermöglichen, um Ausfälle und Schäden an physischer Ausrüstung zu vermeiden; wenn CPU-Hardware ihre maximalen Temperaturgrenzen erreicht, kann die CPU sich automatisch abschalten oder es können Hard-Locks und potenzielle Hardwareschäden auftreten.

1. **Maximale Kerntemperatur (Celsius)** Legt eine Spitzentemperatur fest, die für die Temperaturüberwachung von VergeOS verwendet wird (in Kombination mit der nächsten Einstellung: *Warnschwellenwert für maximale Kerntemperatur %*).

   * ***Abfrage von Hardware*****&#x20;(Standard)** - ruft die vom Hardwarehersteller definierte Maximaltemperatur von der CPU ab

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Nicht-Server-Hardware und einige ältere Server unterstützen diese Abfrage möglicherweise nicht; in solchen Fällen kann die </strong><em><strong>benutzerdefiniert</strong></em><strong> Einstellung ausgewählt werden, um eine maximale Temperatur festzulegen, auf deren Basis VergeOS-Warnungen erstellt werden.</strong></p></div>

   * ***benutzerdefiniert*** - ermöglicht die manuelle Festlegung einer bestimmten Spitzentemperatur. Ziehen Sie Ihre Hardware-Dokumentation zu Rate, um die maximale CPU-Temperatur zu verifizieren.
   * ***deaktivieren*** - diese Auswahl kann verwendet werden, wenn Sie die Temperatur in VergeOS nicht überwachen möchten (wenn Sie nicht für die Überwachung der Hardware verantwortlich sind, z. B. beim Bare-Metal-Anbieter, oder wenn VergeOS in einer virtuellen Umgebung läuft)
2. **Warnschwellenwert für maximale Kerntemperatur %** Legt eine prozentuale Schwelle relativ zur maximalen Kerntemperatur (oben) fest, bei der ein Warnzustand ausgelöst wird. Ein Warnzustand führt zu einem gelben Knotenstatus und es wird ein Warneintrag im Systemprotokoll erstellt. Typischerweise wird ein Schwellenwert von mindestens 10 % oder höher empfohlen, um Zeit für geeignete Maßnahmen als Reaktion auf ein thermisches Problem zu haben.

{% hint style="info" %}
**Beispiel**

Wenn *Maximale Kerntemperatur (Celsius)* auf 80 Grad gesetzt ist und *Warnschwellenwert für maximale Kerntemperatur %* auf 10 gesetzt ist, wird der Warnstatus ausgelöst, wenn die CPU-Hardware 72 Grad meldet.
{% endhint %}

3. **Kritische Kerntemperatur (Celsius):** Definiert die Temperatur, bei der in VergeOS ein Fehlerzustand ausgelöst wird. Wenn gemeldete Hardwaretemperaturen diese Temperatur erreichen, wechselt der Knotenstatus auf Rot und im Systemprotokoll erscheint ein Fehlereintrag.

   * ***Abfrage von Hardware*****&#x20;(Standard)** - ruft die vom Hardwarehersteller definierte kritische Temperatur von der CPU ab

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Nicht-Server-Hardware und einige ältere Server unterstützen diese Abfrage möglicherweise nicht; in solchen Fällen kann die </strong><em><strong>benutzerdefiniert</strong></em><strong> Einstellung ausgewählt werden, um eine maximale Temperatur festzulegen, auf deren Basis VergeOS-Warnungen erstellt werden.</strong></p></div>

   * ***benutzerdefiniert*** - ermöglicht die manuelle Festlegung einer kritischen Temperatur. Ziehen Sie Ihre Hardware-Dokumentation zu Rate, um die maximale CPU-Temperatur zu verifizieren.
   * ***deaktivieren*** - diese Auswahl kann verwendet werden, wenn Sie die Temperatur in VergeOS nicht überwachen möchten (wenn Sie nicht für die Überwachung der Hardware verantwortlich sind, z. B. beim Bare-Metal-Anbieter, oder wenn VergeOS in einer virtuellen Umgebung läuft)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.verge.io/run-the-platform/de/systemadministration/cluster-settings.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
