couchbaselabs.couchbase_server

Couchbase Server Ansible Rolle

Funktioniert mit Ansible Galaxy

Sie können diese Rolle mit dem Befehl ansible-galaxy installieren und direkt aus dem Git-Repository ausführen.

Installieren Sie es wie folgt:

ansible-galaxy install couchbaselabs.couchbase_server

Stellen Sie sicher, dass Sie Schreibzugriff auf /etc/ansible/roles/ haben, da dies der Standardinstallationspfad für Ansible-Rollen ist. Alternativ können Sie Ihren eigenen Ansible-Rollenpfad definieren, indem Sie eine Datei $HOME/.ansible.cfg mit folgendem Inhalt erstellen:

[defaults]
roles_path = <path_to_your_preferred_role_location>

Ändern Sie <path_to_your_preferred_role_location> in ein Verzeichnis, auf das Sie Schreibzugriff haben.

Siehe die ansible-galaxy Dokumentation für weitere Einzelheiten.

Rollendaten

In Fällen, in denen Sie einfache Cluster für die Entwicklung oder andere nicht-produktive Zwecke wünschen, sind die Werte für die Standardvariablen der Couchbase-Serverrolle gut. Die einzige erforderliche Variable ist couchbase_nodes:.

Sollten Sie spezifische Leistungsanforderungen haben oder diese für Ihren speziellen Zweck anpassen wollen, beschreibt dieser Abschnitt alle Rollendaten mit ihren Standardwerten im Detail.

couchbase_server_edition

Die Version des Couchbase Servers, dies kann enterprise oder community sein. Der Standardwert ist enterprise.

couchbase_server_version

Die Version und das Build, das Sie installieren möchten; standardmäßig ist der Wert latest. Wenn Sie eine bestimmte Version verwenden möchten, geben Sie 6.6.0-7909 an. Um die verfügbaren Versionen zu finden, führen Sie den Befehl aus:

yum list --showduplicates couchbase-server

couchbase_server_download_url

Eine vollständig qualifizierte URL zu einer *.rpm oder *.deb Datei, von der Sie den Couchbase Server installieren möchten.

couchbase_os

Alle Eigenschaften in der couchbase_os Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind.

Variable Standard Beschreibung
firewalld false Ob firewalld installiert und die Couchbase-Ports der öffentlichen Zone hinzugefügt werden sollen
disable_thp true Ob das disable-thp Script installiert werden soll. Dies erstellt ein neues Startskript in /etc/init.d/disable-thp
common_tools false Ob gängige Tools installiert werden sollen, dazu gehören: epel-release, git, jq, ntp, nmap, lshw, sysstat, lvm2, htop, iotop, wireshark, dstat, nmon
kernel_tunings true Ob die sysctl.conf Anpassungen angewendet werden sollen, z.B. vm.swappiness = 1 Diese erstellt eine neue Datei in /etc/sysctl.d/couchbase-server.conf
user_limits true Ob die Benutzerlimits für den couchbase Benutzer gesetzt werden sollen. Dies wird eine neue Datei in /etc/security/limits.d/couchbase-server.conf erstellen.
Beispiel
couchbase_os:
  firewalld: true
  disable_thp: true
  common_tools: true
  kernel_tunings: true
  user_limits: true

couchbase_nodes

Alle Eigenschaften in der couchbase_nodes Variable sind optional, außer der hostname Eigenschaft, die erforderlich ist. Wenn die services: Eigenschaft nicht angegeben ist, wird der Wert von couchbase_server.default_services verwendet, falls dieser definiert ist; andernfalls ist der Standardwert data,index,query. Zusätzliche Dokumentation

Variable Standard Beschreibung
*hostname null Der Hostname des hinzuzufügenden Knotens. Diese Eigenschaft ist erforderlich für jede Installation/Konfiguration
group null Der Gruppenname, dem der Knoten zugewiesen wird; falls nicht angegeben, wird der Knoten zur Standardgruppe hinzugefügt.
services - data
- index
- query
Die Dienste, die auf dem Knoten laufen sollen. Gültige Werte sind:
- data
- index
- query
- fts
- eventing
- analytics
Beispiel
couchbase_nodes:
  - hostname: host1.couchbase.example.com
    group: AZA
    services:
      - data
  - hostname: host2.couchbase.example.com
    group: AZA
    services:
      - data
  - hostname: host3.couchbase.example.com
    group: AZB
    services:
      - data
  - hostname: host4.couchbase.example.com
    group: AZB
    services:
      - data
  - hostname: host5.couchbase.example.com
    group: AZA
    services:
      - index
      - query
  - hostname: host6.couchbase.example.com
    group: AZB
    services:
      - index
      - query

couchbase_cluster

Alle Eigenschaften in der couchbase_cluster Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
name My Cluster Der Name des Couchbase Clusters
rest_protocol http Das REST-Protokoll, das verwendet werden soll
port 8091 Der Standardport, der für den Cluster verwendet wird
notifications true Ob Konsolenbenachrichtigungen aktiviert sein sollen
index_storage standard Gibt den Speicher-Modus für die Index-Dienste an. Akzeptierte Speicher-Modi sind "standard" für den normalen Index oder memopt für speicheroptimierte Indizes.
default_services - data
- index
- query
Die Standarddienste, die beim Initialisieren des Clusters oder beim Hinzufügen eines neuen Knotens verwendet werden sollen
Beispiel
couchbase_cluster:
  name: Demo
  rest_protocol: http
  port: 8091
  notifications: true
  index_storage: default
  default_services:
    - data
    - index
    - query

couchbase_memory_quotas

Alle Eigenschaften in der couchbase_memory_quotas Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
analytics 1024 Setzt die Speicherkapazität für den Analytics-Dienst (in MB). Diese Quote wird allen zukünftigen Knoten zugewiesen, die dem Cluster mit dem Analytics-Dienst hinzugefügt werden.
data 4098 Gibt die Speicherkapazität für den Datendienst (in MB) an. Diese Quote wird allen zukünftigen Knoten zugewiesen, die dem Cluster mit dem Datendienst hinzugefügt werden.
eventing 256 Setzt die Speicherkapazität für den Eventing-Dienst (in MB). Diese Quote wird allen zukünftigen Knoten zugewiesen, die dem Cluster mit dem Eventing-Dienst hinzugefügt werden.
fts 512 Setzt die Speicherkapazität für den Volltextdienst (in MB). Diese Quote wird allen zukünftigen Knoten zugewiesen, die dem Cluster mit dem Volltextdienst hinzugefügt werden.
index 512 Setzt die Speicherkapazität für den Indexdienst (in MB). Diese Quote wird allen zukünftigen Knoten zugewiesen, die dem Cluster mit dem Indexdienst hinzugefügt werden.
Beispiel
couchbase_memory_quotas:
  analytics: 1024
  data: 16000
  eventing: 256
  fts: 512
  index: 512

couchbase_security

Alle Eigenschaften in der couchbase_security Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
admin_user Administrator Der Benutzername des Clusteradministrators
admin_password password Das Passwort des Clusteradministrators
disable_http_ui false Gibt an, ob die Couchbase Web-Konsole über http zugänglich sein kann.
disable_www_authenticate false Gibt an, ob der Couchbase Server bei nicht authentifizierten Anfragen mit WWW-Authenticate antwortet.
cluster_encryption_level control Gibt das Verschlüsselungsniveau des Clusters an. Das Level wird verwendet, wenn die Cluster-Verschlüsselung eingeschaltet ist. Wenn das Level "all" ist, werden sowohl Daten- als auch Steuer-Nachrichten zwischen den Knoten im Cluster über verschlüsselte Verbindungen gesendet. Wenn das Level "control" ist, werden nur Steuer-Nachrichten verschlüsselt gesendet.
tls_min_version tlsv1 Gibt die minimale TLS-Protokollversion an, die über alle Couchbase-Dienste verwendet werden soll.
tls_honor_cipher_order true Gibt an, ob die Cipher-Reihenfolge über alle Dienste eingehalten werden muss. Wenn dies auf true gesetzt ist, können schwächere Cipher in die Cipher-Liste aufgenommen werden, um die Abwärtskompatibilität mit älteren Clients/Browsern zu gewährleisten, während neuere Clients gezwungen sind, stärkere Cipher zu verwenden.
Beispiel
couchbase_security:
  admin_user: Administrator
  admin_password: password
  disable_http_ui: false
  disable_www_authenticate: false
  cluster_encryption_level: control
  tls_min_version: tlsv1
  tls_honor_cipher_order: true

couchbase_paths

Alle Eigenschaften in der couchbase_paths Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
data /opt/couchbase/var/lib/couchbase/data Der Pfad, um die von Couchbase erstellten Datendateien zu speichern. Beachten Sie, dass dies auch der Pfad ist, an dem die Sichtindizes auf diesem Server geschrieben werden.
index /opt/couchbase/var/lib/couchbase/data Der Pfad, um die von Couchbase erstellten Dateien des Indexdienstes zu speichern.
analytics /opt/couchbase/var/lib/couchbase/data Der Pfad, um die von Couchbase erstellten Dateien des Analytics-Dienstes zu speichern.
eventing /opt/couchbase/var/lib/couchbase/data Der Pfad, um die von Couchbase erstellten Dateien des Eventing-Dienstes zu speichern.
Beispiel
couchbase_paths:
  data: /opt/couchbase/var/lib/couchbase/data
  index: /opt/couchbase/var/lib/couchbase/index
  analytics: /opt/couchbase/var/lib/couchbase/analytics
  eventing: /opt/couchbase/var/lib/couchbase/eventing

couchbase_rebalance_settings

Alle Eigenschaften in der couchbase_rebalance_settings Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
rebalance_retry false Automatische Rebalancing-Wiederholungsoption aktivieren oder deaktivieren
wait_for 300 Gibt die Wartezeit an, nach einem fehlgeschlagenen Rebalance bevor erneut versucht wird. Zeit muss ein Wert zwischen 5 und 3600 Sekunden sein
max_attempts 1 Gibt die Anzahl der Versuche an, die bei einem fehlgeschlagenen Rebalance wiederholt werden. Der angegebene Wert muss zwischen 1 und 3 liegen.
moves_per_node 4 Gibt die Anzahl der gleichzeitigen vBuckets an, die pro Knoten während eines Rebalance verschoben werden sollen. Der angegebene Wert muss zwischen 1 und 64 liegen. Eine höhere Einstellung kann die Rebalance-Leistung verbessern, auf Kosten eines höheren Ressourcenverbrauchs (CPU, Speicher, Festplatte und Bandbreite). Im Gegensatz dazu kann eine niedrigere Einstellung die Rebalance-Leistung verschlechtern, während solche Ressourcen freigegeben werden. Beachten Sie, dass die Rebalance-Leistung von vielen weiteren Faktoren beeinflusst werden kann; daher kann die Änderung dieses Parameters nicht immer die erwarteten Auswirkungen haben. Beachten Sie auch, dass eine höhere Einstellung aufgrund des zusätzlich verbrauchten Ressourcenverbrauchs die Leistung anderer Systeme, einschließlich des Datendienstes, beeinträchtigen kann.
Beispiel
couchbase_rebalance_settings:
  rebalance_retry: false
  wait_for: 300
  max_attempts: 1
  moves_per_node: 4

couchbase_audit

Alle Eigenschaften in der couchbase_audit Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
enabled true Gibt an, ob das Audit-Logging aktiviert ist.
log_path /opt/couchbase/var/lib/couchbase/logs Gibt den Pfad zum Audit-Log an. Dies sollte ein Pfad zu einem Ordner sein, in dem das Audit-Log aufbewahrt wird. Der Ordner muss auf allen Servern im Cluster existieren.
log_rotate_interval 86400 Gibt das Intervall an, in dem das aktuelle Audit-Log durch eine neue, leere Audit-Log-Datei ersetzt wird. Die Log-Datei wird rotiert, um sicherzustellen, dass das Audit-Log nicht zu viel Speicherplatz verbraucht. Das minimale Audit-Log-Rotationsintervall beträgt 15 Minuten (900 Sekunden).
log_rotate_size 20971520 Gibt die Größe für die Rotation des Audit-Logs an. Dies ist die Größe, bei der das aktuelle Audit-Log durch eine neue, leere Audit-Log-Datei ersetzt wird. Die Log-Datei wird rotiert, um sicherzustellen, dass das Audit-Log nicht zu viel Speicherplatz verbraucht. Die minimale Größe für die Rotation des Audit-Logs beträgt 0 Byte und maximal 524.288.000 (500 MB). Bei einer Einstellung von 0 wird das Log nicht aufgrund der Größe rotiert.
Beispiel
couchbase_audit:
  enabled: true
  log_path: /opt/couchbase/var/lib/couchbase/logs
  log_rotate_interval: 86400
  log_rotate_size: 20971520

couchbase_password_policy

Alle Eigenschaften in der couchbase_password_policy Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
min_length 6 Gibt die minimale Passwortlänge für neue Passwörter an.
uppercase false Gibt an, dass neue Passwörter mindestens einen Großbuchstaben enthalten müssen.
lowercase false Gibt an, dass neue Passwörter mindestens einen Kleinbuchstaben enthalten müssen.
digit false Gibt an, dass neue Passwörter mindestens eine Ziffer enthalten müssen.
special_char false Gibt an, dass neue Passwörter mindestens ein Sonderzeichen enthalten müssen.
Beispiel
couchbase_password_policy:
  min_length: 6
  uppercase: false
  lowercase: false
  digit: false
  special_char: false

couchbase_query_settings

Alle Eigenschaften in der couchbase_query_settings Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
pipeline_batch 16 Anzahl der Elemente, die die Ausführungsoperatoren bündeln können
pipeline_cap 512 Maximale Anzahl der Elemente, die jeder Ausführungsoperator zwischenspeichern kann
scan_cap 512 Maximale Pufferspeichergröße für Indexscans; verwenden Sie null oder einen negativen Wert, um zu deaktivieren
timeout 0 Serverausführungszeitüberschreitung; verwenden Sie null oder einen negativen Wert, um zu deaktivieren
prepared_limit 16384 Maximale Anzahl der vorbereiteten Anfragen
completed_limit 4000 Maximale Anzahl der abgeschlossenen Anfragen
completed_threshold 1000 Cache abgeschlossene Anfragen, die länger als dieser Schwellenwert dauern (in Millisekunden)
log_level info Setzt die Protokollebene für den Abfragedienst. Gültige Protokollebene sind "trace", "debug", "info", "warn", "error", "server" und "none"
max_parallelism 1 Maximaler Parallelismus pro Abfrage; verwenden Sie null oder einen negativen Wert, um zu deaktivieren
Beispiel
couchbase_query_settings:
  pipeline_batch: 16
  pipeline_cap: 512
  scan_cap: 512
  timeout: 0
  prepared_limit: 16384
  completed_limit: 4000
  completed_threshold: 1000
  log_level: info
  max_parallelism: 1

couchbase_index_settings

Alle Eigenschaften in der couchbase_index_settings Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
max_rollback_points 2 Die maximale Anzahl an Rollbackpunkten. Der Wert dieser Option muss größer oder gleich 1 sein.
stable_snapshot_interval 5000 Gibt die Häufigkeit der persistierten Snapshots für die Wiederherstellung in Sekunden an. Dies bedeutet, dass im Falle eines Ausfalls dies der weiteste Punkt ist, von dem wir den Index wiederherstellen müssen. Der Wert dieses Parameters muss größer als 1 sein.
memory_snapshot_interval 200 Gibt die Häufigkeit der in-memory Snapshots in Millisekunden an. Dies bestimmt den frühesten Zeitpunkt, an dem ein Scan eine gegebene KV-Änderung sehen kann. Der Wert dieses Parameters muss größer als 1 sein.
threads 0 Legt die Anzahl der CPUs fest, die vom Indexer verwendet werden können. Der Wert dieser Option muss zwischen 0 und 1024 liegen.
log_level info Setzt die Protokollebene für den Indexdienst. Gültige Protokollebene sind "debug", "silent", "fatal", "error", "warn", "info", "verbose", "timing" und "trace"
Beispiel
couchbase_index_settings:
  max_rollback_points: 2
  stable_snapshot_interval: 5000
  memory_snapshot_interval: 200
  threads: 0
  log_level: info

couchbase_autofailover

Alle Eigenschaften in der couchbase_autofailover Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
enabled true
failover_timeout 120 Gibt das Timeout für das automatisierte Failover an. Das ist die Zeit, die ein Knoten unresponsiv sein muss, bevor der Cluster-Manager den Knoten als ausgefallen betrachtet und ihn umschaltet. Das minimale Timeout für ein automatisiertes Failover beträgt 30 Sekunden in der Couchbase Community Edition und 5 Sekunden in der Couchbase Enterprise Edition
max_failovers 1 Gibt die Anzahl der automatisierten Failover-Ereignisse an, die behandelt werden, bevor ein Benutzer eingreifen muss. Ein einzelnes Ereignis könnte das Umschalten eines Knotens oder einer gesamten Servergruppe sein. Der maximal zulässige Wert ist drei. Dieses Feature ist nur in der Couchbase Enterprise Edition verfügbar.
failover_of_server_groups false Gibt an, ob ein automatisiertes Failover gesamte Servergruppen umschalten kann. Dieses Feature ist nur in der Couchbase Enterprise Edition verfügbar.
failover_on_data_disk_issues true Gibt an, ob das automatisierte Failover bei Problemen mit dem Datendienst aktiviert ist. Setzen Sie diese Option auf "1", um das Failover bei Problemen im Datendienst zu aktivieren oder "0", um es zu deaktivieren. "--failover-data-disk-period" muss gleichzeitig gesetzt werden, wenn diese Option aktiviert wird. Dieses Feature ist nur in der Couchbase Enterprise Edition verfügbar.
failover_data_disk_period 120 Gibt den Zeitraum für das Failover-Datenfestplatten-Intervall an. Dies ist der Zeitraum, über den der Datendienst auf potenzielle nachhaltige Festplatten-I/O-Fehler überprüft wird. Der Datendienst wird jede Sekunde auf Festplattenfehler überprüft. Wenn 60% der Prüfungen in diesem Zeitraum festlegen, dass ein Speicherfehler aufgetreten ist, kann der Knoten automatisch umgeschaltet werden. "--enable-failover-on-data-disk-issues" muss gesetzt sein, wenn diese Option verwendet wird. Der Zeitraum reicht von 5 bis 3600 Sekunden.
can_abort_rebalance true Ermöglicht es, das Rebalance abzubrechen und ein automatisiertes Failover durchzuführen. Dieses Feature ist nur in der Couchbase Enterprise Edition verfügbar.
Beispiel
couchbase_autofailover:
  enabled: true
  failover_timeout: 120
  max_failovers: 1
  failover_of_server_groups: false
  failover_on_data_disk_issues: true
  failover_data_disk_period: 120
  can_abort_rebalance: true

couchbase_email_alerts

Alle Eigenschaften in der couchbase_email_alerts Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
enabled false Aktiviert E-Mail-Benachrichtigungen für diesen Cluster.
username null Der Benutzername des E-Mail-Servers für die Absender-Email-Adresse. Dieses Feld ist erforderlich, wenn die angegebene E-Mail-Adresse eine Authentifizierung erfordert.
password null Das Passwort des E-Mail-Servers für die Absender-Email-Adresse. Dieses Feld ist erforderlich, wenn die angegebene E-Mail-Adresse eine Authentifizierung erfordert.
host localhost Der Hostname des E-Mail-Servers, der die vom Absender angegebene E-Mail-Adresse hostet
port 25 Die Portnummer des E-Mail-Servers, der die vom Absender angegebene E-Mail-Adresse hostet.
encrypt false Aktiviert die SSL-Verschlüsselung beim Verbinden mit dem E-Mail-Server.
sender couchbase@localhost Wenn E-Mail-Benachrichtigungen aktiviert sind, wird diese Option die Absender-Email-Adresse festlegen.
recipients [] Eine Liste von Benutzern, die bei einer Benachrichtigung auf dem Server eine E-Mail erhalten.
alerts - alert-auto-failover-node
- alert-auto-failover-max-reached
- alert-auto-failover-node-down
- alert-auto-failover-cluster-small
- alert-auto-failover-disable
- alert-ip-changed
- alert-disk-space
- alert-meta-overhead
- alert-meta-oom
- alert-write-failed
- alert-audit-msg-dropped
- alert-indexer-max-ram
- alert-timestamp-drift-exceeded
- alert-communication-issue
- alert-auto-failover-node: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn ein Knoten automatisch umgeschaltet wird.
- alert-auto-failover-max-reached: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn die maximale Anzahl an automatisierten Failovers erreicht wird.
- alert-auto-failover-node-down: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn das automatische Failover nicht abgeschlossen werden konnte, weil ein anderer Knoten im Cluster bereits ausgefallen war.
- alert-auto-failover-cluster-small: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn das automatische Failover nicht abgeschlossen werden konnte, weil der Cluster zu klein ist.
- alert-auto-failover-disable: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn das automatische Failover nicht abgeschlossen werden konnte, weil es auf diesem Cluster deaktiviert ist.
- alert-ip-changed: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn sich die IP-Adresse eines Knoten im Cluster ändert.
- alert-disk-space: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn der Speicherbedarf auf einem Knoten im Cluster 90% des verfügbaren Speichers erreicht.
- alert-meta-overhead: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn die Metadatenüberlastung im Datendienst mehr als 50% beträgt.
- alert-meta-oom: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn aller Speicher im Cache für einen Buckete durch Metadaten verwendet wird. Wenn diese Bedingung eintritt, wird der Buckete unbenutzbar, bis mehr Speicher dem Buckete-Cache hinzugefügt wird.
- alert-write-failed: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn das Schreiben von Daten auf die Festplatte im Datendienst fehlgeschlagen ist.
- alert-audit-msg-dropped: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn das Schreiben von Ereignissen ins Audit-Log fehl schlägt.
- alert-indexer-max-ram: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn der Speicherbedarf für den Indexdienst auf einem bestimmten Knoten das SPEICHERBEGRENZUNGS- лимит überschreitet. Diese Warnung wird nur angezeigt, wenn der Index-Speichertyp speicheroptimierte Indizes (MOI) ist.
- alert-timestamp-drift-exceeded: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn die Uhren zweier Maschinen im Cluster mehr als fünf Sekunden auseinander liegen.
- alert-communication-issue: Gibt an, dass eine E-Mail-Benachrichtigung gesendet werden sollte, wenn Knoten Kommunikationsprobleme haben.

Beispiel
couchbase_email_alerts:
  enabled: true
  host: localhost
  port: 25
  encrypt: false
  sender: couchbase@localhost
  recipients:
    - [email protected]
  alerts:
    - alert-auto-failover-node
    - alert-auto-failover-max-reached
    - alert-auto-failover-node-down
    - alert-auto-failover-cluster-small
    - alert-auto-failover-disable
    - alert-ip-changed
    - alert-disk-space
    - alert-meta-overhead
    - alert-meta-oom
    - alert-write-failed
    - alert-audit-msg-dropped
    - alert-indexer-max-ram
    - alert-timestamp-drift-exceeded
    - alert-communication-issue

couchbase_buckets[]

Die Variable couchbase_buckets ist standardmäßig eine leere Liste. Wenn angegeben, sind die folgenden Eigenschaften für jedes Element in der Liste verfügbar, die name Eigenschaft ist erforderlich, alle anderen Eigenschaften sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
*name null Der Name des zu erstellenden Buckets. Die einzigen zulässigen Zeichen für den Bucket-Namen sind die Buchstaben A-Z, a-z und 0-9 sowie der Unterstrich, Punkt, Bindestrich und Prozentzeichen. Der Name darf maximal 100 Zeichen lang sein.
type couchbase Der Typ des zu erstellenden Buckets. Akzeptierte Buckett-Typen sind "couchbase", "ephemeral" und "memcached". Der Couchbase-Bucket ist der Standard-Bucket-Typ. Er unterstützt Datenpersistenz, Replikation, Caching, Indizierung, Ansichten und N1QL-Abfragen. Der ephemeral-Bucket ist ein In-Memory-Bucket, der dem Couchbase-Bucket ähnlich ist, jedoch keine Datenpersistenz oder Ansichten unterstützt. Der Memcached-Bucket ist ein reiner Cache-Bucket, der keine Persistenz, Replikation, Indizierung, Ansichten oder N1QL-Abfragen unterstützt: dieser Buckett-Typ verhält sich wie der Memcached Server und ist veraltet. Ephemeral-Buckets sollten stattdessen verwendet werden.
storage_backend couchstore Der Speicher, der mit dem Bucket verwendet werden soll. Dies wird nur für "couchbase"-Buckets angegeben. Akzeptierte Werte sind "couchstore" oder "magma".
ram_size 100 Die Menge an Speicher, die für den Cache dieses Buckets zugewiesen wird, in Megabyte. Die Speicherkontingent dieses Buckets muss in das gesamte Cluster-Speicherkontingent passen. Die minimale Cache-Größe beträgt 100MB.
replicas 1 Die Anzahl der Server, auf die die Daten repliziert werden. Replikate bieten Schutz gegen Datenverlust, indem sie Kopien der Daten dieses Buckets auf mehreren Servern speichern. Standardmäßig beträgt die Anzahl der Replikate eins, auch wenn es nur einen einzigen Server im Cluster gibt. Die minimale Anzahl der Replikate ist null, maximal drei. Diese Option gilt nur für Couchbase und Ephemeral Buckets.
priority low Gibt die Priorität der Hintergrundaufgaben dieses Buckets an. Diese Option ist nur für Couchbase und Ephemeral Buckets gültig. Bei Couchbase Buckets umfassen Hintergrundaufgaben festplatten-IO, DCP-Stream-Verarbeitung und Element-Paging. Bei ephemeralen Buckets sind die Hintergrundaufgaben dieselben wie bei Couchbase Buckets, mit der Ausnahme von der Festplatten-IO, die nicht auf ephemere Buckets zutrifft. Der Wert dieser Option kann "high" oder "low" sein. Der Standardwert ist "low". Eine Angabe von "high" kann zu schnelleren Verarbeitungen führen; jedoch nur, wenn mehr als ein Bucket für das Cluster definiert ist und wenn verschiedene Prioritätseinstellungen unter den Buckets festgelegt sind. Wenn Couchbase und ephemeral Buckets unterschiedliche Prioritätseinstellungen haben, wirkt sich dies nur auf die Priorisierung von Aufgaben aus, die nicht mit Festplatten-IO zu tun haben.
eviction_policy valueOnly Die Speicher-Cache-Ausschlussrichtlinie für diesen Bucket. Diese Option ist nur für Couchbase und Ephemeral Buckets gültig.

Couchbase Buckets unterstützen entweder "valueOnly" oder "fullEviction". Die Angabe der "valueOnly" Richtlinie bedeutet, dass jedem Schlüssel, der in diesem Bucket gespeichert ist, im Speicher behalten werden muss. Dies ist die Standardrichtlinie: die Verwendung dieser Richtlinie verbessert die Leistung der Schlüssel-Werte-Operationen, behindert jedoch die maximale Größe des Buckets. Die Angabe der "fullEviction" Richtlinie bedeutet, dass die Leistung bei Schlüssel-Werte-Operationen beeinträchtigt wird, jedoch die maximale Größe des Buckets ungebunden ist.

Ephemeral Buckets unterstützen entweder "noEviction" oder "nruEviction". Die Angabe von "noEviction" bedeutet, dass der Bucket keine Elemente aus dem Cache ausschließen wird, wenn der Cache voll ist: dieser Ausschluss sollte bei In-Memory-Datenbank-Anwendungen verwendet werden. Die Angabe von "nruEviction" bedeutet, dass zuletzt nicht verwendete Elemente dann aus dem Speicher ausgeschlossen werden, wenn der gesamte Speicher im Bucket voll ist: diese Ausschlussrichtlinie sollte für Cache-Anwendungen verwendet werden.
conflict_resolution sequence Gibt die Konfliktlösungsmechanismen dieses Buckets an; die verwendet werden, wenn ein Konflikt während der Cross Data-Center-Replikation (XDCR) auftritt. Es werden sowohl sequenzbasierte als auch zeitstempelbasierte Mechanismen unterstützt.

Die sequenzbasierte Konfliktlösung wählt das Dokument aus, das seit der letzten Synchronisation die größte Anzahl an Aktualisierungen erhalten hat: zum Beispiel, wenn ein Cluster ein Dokument seit der letzten Synchronisation zwei Mal aktualisiert hat, und der andere Cluster hat das Dokument drei Mal aktualisiert, wird das Dokument ausgewählt, das drei Mal aktualisiert wurde; unabhängig davon, zu welchen spezifischen Zeiten die Aktualisierungen erfolgten.

Die zeitstempelbasierte Konfliktlösung wählt das Dokument mit dem aktuellsten Zeitstempel aus: dies wird nur unterstützt, wenn alle Uhren auf allen Knoten im Cluster vollständig synchronisiert sind.
flush false Gibt an, ob die Flush-Operation für diesen Bucket erlaubt ist.
durability_min_level none Das minimale Haltbarkeitsniveau für den Bucket. Akzeptierte Werte für "ephemeral" Buckets sind "none" oder "majority". Akzeptierte Werte für "couchbase" Buckets sind "none", "majority", "majorityAndPersistActive" oder "persistToMajority".

"none" gibt an, dass Änderungen am Bucket asynchron sind und keine Haltbarkeitsgarantien bieten. "majority" gibt an, dass Änderungen an einer Mehrzahl der Data-Service-Knoten repliziert werden müssen (d.h. im dem dem Bucket zugewiesenen Speicher gehalten werden). "majorityAndPersistActive" gibt an, dass Änderungen sowohl an einer Mehrheit der Data-Service-Knoten repliziert als auch auf der Festplatte des Knotens, der den aktiven vBucket für die Daten hostet, geschrieben werden müssen. "persistToMajority" gibt an, dass Änderungen an einer Mehrheit der Data-Service-Knoten persistiert werden müssen. Entsprechend wird es auf diesen Knoten auf die Festplatte geschrieben.
compression_mode passive Gibt den Komprimierungsmodus des Buckets an. Es gibt drei Optionen: aus, passiv und aktiv. Alle drei Modi sind rückwärtskompatibel mit älteren SDKs, bei denen der Couchbase Server Dokumente automatisch dekomprimiert, für Clients, die die verwendete Komprimierung nicht verstehen. Diese Option ist nur für Couchbase und Ephemeral Buckets in der Couchbase Enterprise Edition verfügbar.

Aus: Der Couchbase Server wird nur Dokumentenwerte komprimieren, wenn sie auf die Festplatte geschrieben werden. Dies ist für Anwendungsfälle geeignet, bei denen Komprimierung negative Auswirkungen auf die Leistung haben könnte. Bitte beachten Sie, dass in den meisten Anwendungsfällen die Komprimierung die Leistung erhöhen sollte.

Passiv: Dokumente, die vom Client komprimiert wurden oder komprimiert von der Festplatte gelesen wurden, werden im Speicher komprimiert. Der Couchbase Server wird keine zusätzlichen Versuche unternehmen, Dokumente zu komprimieren, die nicht bereits komprimiert sind.
<br Aktiv: Der Couchbase Server wird aktiv und aggressiv versuchen, Dokumente zu komprimieren, selbst wenn sie nicht in einem komprimierten Format empfangen wurden. Dies bringt die Vorteile der Komprimierung, selbst wenn die SDK-Clients nichts mit dem Prozess zu tun haben.
max_ttl 0 Gibt die maximale TTL (Time-to-Live) für alle Dokumente im Bucket in Sekunden an. Wenn sie aktiviert wird und ein Dokument ohne TTL oder mit einer TTL, die größer ist als die maximale wird, wird seine TTL auf die maximale TTL gesetzt. Wenn diese Option auf 0 gesetzt wird, wird die Verwendung von max-TTL deaktiviert und die größte erlaubte TTL ist 2147483647. Diese Option ist nur für Couchbase und Ephemeral Buckets in der Couchbase Enterprise Edition verfügbar.
enable_index_replica false Aktiviert die Replikation von View-Indizes für den aktuellen Bucket. Diese Option ist nur für Couchbase Buckets gültig.
Beispiel
couchbase_buckets:
  - name: baseball
    type: couchbase
    ram_size: 400
    replicas: 1
    compression_mode: active
  - name: ecommerce
    type: couchbase
    ram_size: 700
    replicas: 1
    compression_mode: active
  - name: movies
    type: couchbase
    ram_size: 450
    replicas: 1
    compression_mode: active

couchbase_sample_buckets[]

Die Variable couchbase_sample_buckets ist standardmäßig eine leere Liste. Nur die folgenden Werte sind unterstützt: "travel-sample", "beer-sample" oder "gamesim-sample".

Beispiel
couchbase_sample_buckets:
  - travel-sample

couchbase_xdcr_remotes[]

Die Variable couchbase_xdcr_remotes ist standardmäßig eine leere Liste. Wenn angegeben, sind die folgenden Eigenschaften für jedes Element in der Liste verfügbar; alle 4 Eigenschaften sind erforderlich, wenn Sie einen XDCR-Remote definieren. Zusätzliche Dokumentation

Variable Standard Beschreibung
*name null Der Name für die Referenz des Remote-Clusters.
*hostname null Der Hostname der Referenz des Remote-Clusters.
*username null Der Benutzername der Referenz des Remote-Clusters.
*password null Das Passwort der Referenz des Remote-Clusters.
Beispiel
couchbase_xdcr_remotes:
  - name: My Cluster
    hostname: remotehost.couchbase.example.com
    username: Administrator
    password: password

couchbase_xdcr_replications[]

Die Variable couchbase_xdcr_replications ist standardmäßig eine leere Liste. Wenn angegeben, sind die folgenden Eigenschaften für jedes Element in der Liste verfügbar; die from_bucket, to_bucket und cluster_name Eigenschaften sind erforderlich, alle anderen Eigenschaften sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
*from_bucket null Der Name des Buckets, von dem Daten repliziert werden sollen.
*to_bucket null Der Name des Buckets, in den Daten repliziert werden sollen.
*cluster_name null Der Name der Cluster-Referenz, zu der repliziert werden soll.
filter_expression null Ein regulärer Ausdruck, der verwendet wird, um den Replikationsstrom zu filtern.
checkpoint_interval 600 Das Intervall zwischen Überprüfungen in Sekunden. Der Wert dieser Option muss zwischen 60 und 14,400 liegen.
worker_batch_size 500 Die Batch-Größe für den Arbeiters. Der Wert dieser Option muss zwischen 500 und 10,000 liegen.
doc_batch_size 2048 Die Dokumenten-Batch-Größe in Kilobyte. Der Wert dieser Option muss zwischen 10 und 100,000 liegen.
failure_restart_interval 10 Intervall für den Neustart fehlgeschlagener XDCR-Verbindungen in Sekunden. Der Wert dieser Option muss zwischen 1 und 300 liegen.
optimistic_replication_threshold 256 Dokumentkörpersgröße-Schwellenwert in Bytes, die die optimistische Replikation auslösen.
source_nozzle_per_node 2 Die Anzahl der Quelldüsen pro Knoten im Zielcluster. Der Wert dieser Option muss zwischen 1 und 10 liegen.
target_nozzle_per_node 2 Die Anzahl der ausgehenden Düsen pro Knoten im Zielcluster. Der Wert dieser Option muss zwischen 1 und 10 liegen.
bandwidth_usage_limit 0 Das Bandbreitenlimit für XDCR-Replikationen in Megabyte pro Sekunde für diese Replikation.
enable_compression true Gibt an, ob die XDCR-Komprimierung aktiviert ist. Dieses Feature ist nur in der Couchbase Enterprise Edition verfügbar und kann nur verwendet werden, wenn der Zielcluster die Komprimierung unterstützt.
log_level Info Die XDCR-Protokollebene. Die folgenden Werte werden unterstützt: "Error", "Info", "Debug", "Trace".
stats_interval 1000 Das Intervall für Statistiken-Aktualisierungen in Millisekunden.
priority High Gibt die Priorität für die Replikation an. Die Optionen sind "High", "Medium" oder "Low".
reset_expiry false Wenn auf true gesetzt, wird allen Änderungen, die in den Zielcluster gesendet werden, die Ablaufzeit auf null gesetzt. Dies bedeutet, dass Dokumente im Zielcluster nicht ablaufen werden. Dies kann durch Setzen der max-ttl auf dem Zielbucket überschrieben werden.
filter_deletion false Wenn auf true gesetzt, werden Änderungen von Löschvorgängen nicht in den Zielcluster gesendet. Dies bedeutet, dass Dokumente im Zielcluster nicht durch Löschvorgänge im Quellcluster gelöscht werden.
filter_expiration false Wenn auf true gesetzt, werden Ablaufänderungen nicht in den Zielcluster gesendet. Dies bedeutet, dass Dokumente im Zielcluster nicht durch Ablauf im Quellcluster gelöscht werden.
Beispiel
couchbase_xdcr_replications:
  - from_bucket: beer
    to_bucket: demo
    cluster_name: My Cluster

couchbase_ldap

Alle Eigenschaften in der couchbase_ldap Variable sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
hosts [] Liste der LDAP-Hosts. Wenn diese leer ist, ist LDAP nicht konfiguriert.
port 389 LDAP-Port.
encryption none Sicherheit, die zur Kommunikation mit LDAP-Servern verwendet wird. Unterstützte Optionen sind: tls, startTLS, none.
cacert cacert Pfad zum CA-Zertifikat, das zur Validierung des Serverzertifikats verwendet wird, erforderlich, wenn die Validierung des Zertifikats nicht deaktiviert ist.
server_cert_validation false Aktiviert oder deaktiviert die Zertifikatüberprüfung, wenn eine Verbindung zum LDAP-Server hergestellt wird.
bind_dn null Der DN eines Benutzers, bei dem zur Ermöglichung der Benutzersuche und der Gruppensynchronisation authentifiziert wird. Wenn keine Bind-Daten oder ein Client-TLS-Zertifikat angegeben werden, wird stattdessen eine anonyme Bindung verwendet.
bind_password null Das Passwort des Bind-Benutzers.
client_cert null Das Client-TLS-Zertifikat, das zur Authentifizierung beim LDAP-Server verwendet werden soll, um Benutzersynchronisation und Gruppen zu ermöglichen. Wenn keine Bind-Daten oder ein Client-TLS-Zertifikat angegeben werden, wird stattdessen eine anonyme Bindung verwendet. '--client-cert' und '--client-key' müssen zusammen festgelegt werden.
client_key null Der Client-TLS-Schlüssel. Dieser wird zusammen mit dem '--client-cert'-Flag zur Zertifikatauthentifizierung verwendet. '--client-cert' und '--client-key' müssen zusammen festgelegt werden.
authentication_enabled false Aktiviert die Verwendung von LDAP zur Authentifizierung von Benutzern.
user_dn_query null LDAP-Abfrage zum Erhalten des DN des Benutzers. Muss mindestens eine Instanz von %u enthalten. Beispiel: ou=Users,dc=example??one?(uid=%u)
authorization_enabled false Aktiviert die Verwendung von LDAP zur Berechtigung von Benutzern.
group_query null LDAP-Abfrage, um die Gruppen von Benutzern anhand des Benutzernamens im RFC4516-Format zu erhalten. Die %u- und %D-Platzhalter können für Benutzernamen und den DN des Benutzers verwendet werden. Wenn das Attribut in der Abfrage vorhanden ist, wird die Liste der Attribut-Werte im Suchergebnis als Liste der Benutzergruppen betrachtet (einzelner Eintrag ist zu erwarten): z.B.: '%D?memberOf?base'. Wenn das Attribut in der Abfrage nicht vorhanden ist, wird jeder zurückgegebene Eintrag als Gruppe betrachtet, z.B.: 'ou=groups,dc=example,dc=com??one?(member=%D)'.
max_parallel_connections 100 Maximale Anzahl paralleler Verbindungen, die mit LDAP-Servern hergestellt werden können.
max_cache_size 10000 Maximale Anzahl an Anforderungen, die zwischengespeichert werden können, standardmäßig 10000.
cache_value_lifetime 300000 Lebensdauer der Werte im Cache in Millisekunden. Standard 300000 ms.
enable_nested_groups false Wenn aktiviert, wird der Couchbase-Server versuchen, rekursiv nach Gruppen für jede entdeckte LDAP-Gruppe zu suchen.
nested_groups_max_depth 10 Maximale Anzahl rekursiver Gruppennachfragen, die der Server durchführen darf. Diese Option ist nur gültig, wenn geschachtelte Gruppen aktiviert sind. Die Tiefe ist eine ganze Zahl zwischen 1 und 100, Standardwert 10.
request_timeout 1000 Das Timeout für LDAP-Anfragen in Millisekunden.
Beispiel
couchbase_ldap:
  hosts:
    - ldap.example.com
  port: 389
  encryption: none
  server_cert_validation: false
  bind_dn: uid=aaronb,ou=People,dc=example,dc=com
  bind_password: password
  authentication_enabled: true
  user_dn_query: ou=People,dc=example,dc=com??one?(uid=%u)
  authorization_enabled: true
  group_query: ou=People,dc=example,dc=com?(gidNumber=5000)?one
  max_parallel_connections: 100
  max_cache_size: 10000
  cache_value_lifetime: 300000
  enable_nested_groups: true
  enable_nested_groups: true
  nested_groups_max_depth: 10

couchbase_user_groups[]

Die Variable couchbase_user_groups ist standardmäßig eine leere Liste. Wenn angegeben, sind die folgenden Eigenschaften für jedes Element in der Liste verfügbar; die name Eigenschaft ist erforderlich, alle anderen Eigenschaften sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
*name null Gibt die Zielgruppe für die Gruppenoperationen an.
description null Gibt die Beschreibung der Gruppe an.
ldap_ref null Gibt den LDAP-Gruppen-DN an, um die Couchbase-Gruppe mit der LDAP-Gruppe zu verknüpfen.
roles [] Gibt die Rollen an, die einem RBAC-Benutzerprofil zugewiesen werden sollen. Weitere Details finden Sie im Abschnitt ROLLEN zu den verfügbaren Rollen in Couchbase.
Beispiel
couchbase_user_groups:
  - name: Demo
    description: test
    roles:
      - cluster_admin
      - replication_admin
  - name: Test
    description: test
    roles:
      - cluster_admin
      - replication_admin
  - name: admins
    description: test
    roles:
      - cluster_admin
      - replication_admin

couchbase_users[]

Die Variable couchbase_users ist standardmäßig eine leere Liste. Wenn angegeben, sind die folgenden Eigenschaften für jedes Element in der Liste verfügbar; die username Eigenschaft ist erforderlich, alle anderen Eigenschaften sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind. Zusätzliche Dokumentation

Variable Standard Beschreibung
username null Gibt den Benutzernamen des RBAC-Benutzers an, der geändert werden soll. Diese Option wird beim Löschen, Erstellen oder Aktualisieren eines RBAC-Benutzerprofils verwendet.
password null Gibt das Passwort an, das für ein RBAC-Benutzerprofil verwendet werden soll. Diese Option wird nur beim Erstellen oder Aktualisieren eines lokalen RBAC-Benutzerprofils verwendet. Couchbase speichert kein Passwort für externe RBAC-Rollen.
name null Gibt den Namen an, der für ein RBAC-Benutzerprofil verwendet werden soll, wobei empfohlen wird, diese Option auf den vollständigen Namen des Benutzers zu setzen.
roles [] Gibt die Rollen an, die einem RBAC-Benutzerprofil zugewiesen werden sollen. Weitere Details finden Sie im Abschnitt ROLLEN zu den verfügbaren Rollen in Couchbase.
groups null Gibt die Gruppen an, zu denen der Benutzer hinzugefügt werden soll.
domain local Gibt die auth_domain an, die für ein RBAC-Benutzerprofil verwendet werden soll, und kann auf entweder lokal oder extern gesetzt werden. Lokale Benutzer sind Benutzer, die direkt vom Couchbase-Cluster verwaltet werden. Externe Benutzer sind Benutzer, die von einer externen Quelle wie LDAP verwaltet werden.
Beispiel
couchbase_users:
  - username: aaronb
    name: Aaron B
    roles:
      - admin
      - cluster_admin
    groups:
      - Demo
    auth_domain: external
  - username: jadt
    password: password
    name: Jad Talbert
    roles:
      - admin
      - cluster_admin
    groups:
      - Demo
      - Test
    auth_domain: local

couchbase_indexes[]

Die Variable couchbase_indexes ist standardmäßig eine leere Liste. Wenn angegeben, sind die folgenden Eigenschaften für jedes Element in der Liste verfügbar; die bucket und definition Eigenschaften sind erforderlich, alle anderen Eigenschaften sind optional und erhalten den Standardwert, wenn sie nicht angegeben sind.

Variable Standard Beschreibung
*bucket null Der Name des Buckets, auf dem der Index erstellt werden soll.
*definition null Die Indexdefinition, die erstellt werden soll. Geben Sie nicht den WITH {...} Block an.
num_replicas null Die Anzahl der Replikate, die erstellt werden sollen.
num_partitions null Die Anzahl der Indexpartitionen, die erstellt werden sollen, wenn im Indexdefinition PARTITION BY verwendet wird.
nodes [] Eine Liste von Knoten, auf denen der Index bereitgestellt werden soll.
sec_key_size null Die durchschnittliche Länge der kombinierten Index-Schlüsselwerte.
doc_key_size null Die durchschnittliche Länge des Dokumentenschlüssels meta().id.
arr_size null Die durchschnittliche Länge des Arrayfeldes. Nicht-Arrayfelder werden ignoriert.
num_doc null Die Anzahl der Dokumente, die im Index erwartet wird.
resident_ratio null Das geschätzte Bewohnerverhältnis des Index.
Beispiel
couchbase_indexes:
  - bucket: demo
    definition: CREATE INDEX idx_test ON demo (username)
    replicas: 1
  - bucket: demo
    definition: CREATE INDEX idx_test2 ON demo (email)
    replicas: 1
  - bucket: ecommerce
    definition: CREATE INDEX idx_test3 ON demo (username)
    replicas: 1
Über das Projekt

Installs, initializes and configures Couchbase Server clusters

Installieren
ansible-galaxy install couchbaselabs.couchbase_server
Lizenz
apache-2.0
Downloads
9.2k
Besitzer