Zum Inhalt springen

Dies ist die mehrseitige Druckansicht dieses Abschnitts. .

Zur normalen Ansicht dieser Seite zurückkehren.

Aufgaben für Entwickler

Schrittweise Anleitungen für Entwickler, die etcd als Schlüssel-Wert-Speicher in ihren Anwendungen verwenden.

1 - Aus etcd lesen

Einen Wert aus einem etcd-Cluster lesen

Voraussetzungen

  • etcdctl installieren

Vorgehensweise

Mit dem Unterbefehl get aus etcd lesen:

$ etcdctl --endpoints=$ENDPOINTS get foo
foo
Hello World!
$

Dabei gilt:

  • foo ist der angeforderte Schlüssel
  • Hello World! ist der abgerufene Wert

Für eine formatierte Ausgabe:

$ etcdctl --endpoints=$ENDPOINTS --write-out="json" get foo
{"header":{"cluster_id":289318470931837780,"member_id":14947050114012957595,"revision":3,"raft_term":4,
"kvs":[{"key":"Zm9v","create_revision":2,"mod_revision":3,"version":2,"value":"SGVsbG8gV29ybGQh"}]}}
$

Dabei gibt write-out="json" JSON aus, in dem sowohl der Schlüssel als auch der Wert base64-kodiert sind.

2 - In etcd schreiben

Ein KV-Paar zu einem etcd-Cluster hinzufügen

Voraussetzungen

  • etcdctl installieren

Vorgehensweise

Mit dem Unterbefehl put ein Schlüssel-Wert-Paar schreiben:

etcdctl --endpoints=$ENDPOINTS put foo "Hello World!"

Dabei gilt:

  • foo ist der Schlüsselname
  • "Hello World!" ist der in Anführungszeichen eingeschlossene Wert

3 - Schlüssel anhand eines Präfixes abrufen

Anleitung zum Abrufen von etcd-Schlüsseln anhand ihres Präfixes

Voraussetzungen

Schlüssel anhand eines Präfixes abrufen

$ etcdctl --endpoints=$ENDPOINTS get PREFIX --prefix

Globale Optionen

--endpoints=[127.0.0.1:2379], gRPC endpoints

Optionen

--prefix, get a range of keys with matching prefix

Beispiel

03_etcdctl_get_by_prefix_2016050501
etcdctl --endpoints=$ENDPOINTS put web1 value1
etcdctl --endpoints=$ENDPOINTS put web2 value2
etcdctl --endpoints=$ENDPOINTS put web3 value3

etcdctl --endpoints=$ENDPOINTS get web --prefix

4 - Schlüssel löschen

Eine Möglichkeit zum Löschen von etcd-Schlüsseln

Voraussetzungen

Schlüssel hinzufügen oder löschen

del zum Entfernen des angegebenen Schlüssels oder Schlüsselbereichs:

etcdctl del $KEY [$END_KEY]

Optionen

--prefix[=false]: delete keys with matching prefix
--prev-kv[=false]: return deleted key-value pairs
--from-key[=false]: delete keys that are greater than or equal to the given key using byte compare
--range[=false]: delete range of keys without delay

Von übergeordneten Befehlen geerbte Optionen

--endpoints="127.0.0.1:2379": gRPC endpoints

Beispiele

04_etcdctl_delete_2016050601
etcdctl --endpoints=$ENDPOINTS put key myvalue
etcdctl --endpoints=$ENDPOINTS del key

etcdctl --endpoints=$ENDPOINTS put k1 value1
etcdctl --endpoints=$ENDPOINTS put k2 value2
etcdctl --endpoints=$ENDPOINTS del k --prefix

5 - Mehrere Schreibvorgänge in einer Transaktion ausführen

Anleitung zu transaktionalen Schreibvorgängen

Voraussetzungen

Begriffe

Im Folgenden werden wichtige Begriffe aus dem unten stehenden Beispiel definiert.

Begriffe Definition
etcdctl Das Befehlszeilenwerkzeug zur Interaktion mit dem etcd-Server.
Befehl txn Der Befehl txn ist eine Abkürzung für „transaction“ (Transaktion). Er liest mehrere etcd-Anfragen von der Standardeingabe und wendet sie als eine einzige atomare Transaktion an. Eine Transaktion besteht aus einer Liste von Bedingungen, einer Liste von Anfragen für den Fall, dass alle Bedingungen erfüllt sind, und einer Liste von Anfragen für den Fall, dass mindestens eine Bedingung nicht erfüllt ist. Weitere Informationen unter etcdctl-Befehle für Schlüssel-Wert-Paare .
compare Die Klausel compare innerhalb einer Transaktion (txn) prüft eine Bedingung und entscheidet dadurch, ob die Operationen der Transaktion ausgeführt werden sollen. Änderungen werden nur angewendet, wenn der aktuelle Zustand des Schlüssel-Wert-Speichers den erwarteten Bedingungen entspricht. Dies erhält die Datenkonsistenz und verhindert Konflikte bei nebenläufigen Zugriffen. Der Aufbau des Befehls wird im folgenden Abschnitt Eine Transaktion ausführen gezeigt.

Transaktionen

txn zum Verarbeiten aller Anfragen in einer Transaktion:

etcdctl txn --help

Mit Transaktionen in etcd lassen sich mehrere Operationen atomar ausführen: Entweder werden alle Operationen angewendet oder keine. Das ist entscheidend, um bei zusammengehörigen Aktualisierungen die Datenkonsistenz zu wahren. Weitere Informationen zu Transaktionen enthält die API-Dokumentation .

Beispiel

Angenommen, die E-Mail-Adresse und Telefonnummer eines Benutzers sollen in einer einzigen Transaktion aktualisiert werden. So werden beide Änderungen gemeinsam angewendet.

05_etcdctl_transaction_2024101213

0. Verwendete Variablen und Optionen

Variablen
/users/{<user_id>/email : etcd-Schlüssel für die E-Mail-Adresse eines Benutzers.
/users/<user_id>/phone : etcd-Schlüssel für die Telefonnummer eines Benutzers.
Optionen
--interactive : Option zur manuellen Eingabe von Transaktionsdaten

1. Anfangsdaten einrichten

Zunächst einen Benutzer mit einigen Anfangsdaten erstellen.

etcdctl put /users/12345/email "old.address@johndoe.com"
etcdctl put /users/12345/phone "123-456-7890"

2. Eine Transaktion ausführen

Die E-Mail-Adresse und Telefonnummer des Benutzers in einer einzigen Transaktion aktualisieren.

etcdctl txn --interactive

compares:
value("/users/12345/email") = "old.address@johndoe.com"

success requests (get, put, delete):
put /users/12345/email "new.address@johndoe.com"
put /users/12345/phone "098-765-4321"

failure requests (get, put, delete):
get /users/12345/email
  • Vergleich: Prüfen, ob die aktuelle E-Mail-Adresse “old.address@johndoe.com ” lautet. So wird die Transaktion nur fortgesetzt, wenn die Daten dem erwarteten Zustand entsprechen.
  • Erfolg: Bei erfolgreichem Vergleich sowohl die E-Mail-Adresse als auch die Telefonnummer aktualisieren.
  • Fehlschlag: Schlägt der Vergleich fehl, die aktuelle E-Mail-Adresse abrufen, um zu verstehen, warum die Transaktion nicht fortgesetzt wurde.

Wichtige Hinweise

  • Atomarität: Die Transaktion stellt sicher, dass E-Mail-Adresse und Telefonnummer gemeinsam aktualisiert werden. Ist die Anfangsbedingung (der Vergleich) nicht erfüllt, wird keine der beiden Änderungen angewendet.
  • Konsistenz: Transaktionen erhalten die Datenkonsistenz, insbesondere bei mehreren zusammengehörigen Aktualisierungen.
  • Mehrere put-Operationen für denselben Schlüssel vermeiden: Innerhalb einer einzigen Transaktion nicht mehrere Werte für denselben Schlüssel schreiben, da dies zu unerwarteten Ergebnissen führen kann. Jeder Schlüssel sollte pro Transaktion nur einmal aktualisiert werden.

6 - Schlüssel überwachen

Anleitung zum Überwachen von etcd-Schlüsseln

Voraussetzungen

Schlüssel überwachen

watch für Benachrichtigungen über künftige Änderungen:

etcdctl watch $KEY [$END_KEY]

Optionen

-i, --interactive[=false]: interactive mode
--prefix[=false]: watch on a prefix if prefix is set
--rev=0: Revision to start watching
--prev-kv[=false]: get the previous key-value pair before the event happens
--progress-notify[=false]: get periodic watch progress notification from server

Von übergeordneten Befehlen geerbte Optionen

--endpoints="127.0.0.1:2379": gRPC endpoints

Beispiele

06_etcdctl_watch_2016050501
etcdctl --endpoints=$ENDPOINTS watch stock1
etcdctl --endpoints=$ENDPOINTS put stock1 1000

etcdctl --endpoints=$ENDPOINTS watch stock --prefix
etcdctl --endpoints=$ENDPOINTS put stock1 10
etcdctl --endpoints=$ENDPOINTS put stock2 20

7 - Eine Lease erstellen

Anleitung zum Erstellen einer Lease in etcd

lease zum Schreiben mit TTL:

07_etcdctl_lease_2016050501
etcdctl --endpoints=$ENDPOINTS lease grant 300
# lease 2be7547fbc6a5afa granted with TTL(300s)

etcdctl --endpoints=$ENDPOINTS put sample value --lease=2be7547fbc6a5afa
etcdctl --endpoints=$ENDPOINTS get sample

etcdctl --endpoints=$ENDPOINTS lease keep-alive 2be7547fbc6a5afa
etcdctl --endpoints=$ENDPOINTS lease revoke 2be7547fbc6a5afa
# or after 300 seconds
etcdctl --endpoints=$ENDPOINTS get sample

8 - Sperren erstellen

Anleitung zum Erstellen verteilter Sperren in etcd

LOCK erwirbt einen verteilten Mutex mit einem bestimmten Namen. Sobald die Sperre erworben wurde, bleibt sie bis zum Beenden von etcdctl bestehen.

Voraussetzungen

Eine Sperre erstellen

lock für eine verteilte Sperre:

08_etcdctl_lock_2016050501
etcdctl --endpoints=$ENDPOINTS lock mutex1

Optionen

  • endpoints – definiert eine durch Kommas getrennte Liste der Rechneradressen im Cluster.
  • ttl – Zeitüberschreitung der Sperrsitzung in Sekunden.