cfn-hup
Beschreibung
Der cfn-hup Helper ist ein Demon, der Änderungen an Ressourcen-Metadaten erkennt und benutzerspezifische Aktionen ausführt, wenn eine Änderung erkannt wird. Hierdurch können Sie über die Aktion UpdateStack API Konfigurations-Aktualisierungen an laufenden Amazon EC2-Instances vornehmen.
Syntax
cfn-hup --config|-c config.dir \ --no-daemon \ --verbose|-v
Optionen
| Name | Beschreibung | Erforderlich |
|---|---|---|
|
|
Gibt den Pfad an, in dem das cfn-hup Script nach den Verzeichnissen |
Nein |
|
|
Wählen Sie diese Option, um das cfn-hup-Skript einmal auszuführen und zu beenden. |
Nein |
|
|
Wählen Sie diese Option, um den Verbose-Modus zu verwenden. |
Nein |
cfn-hup.conf Konfigurationsdatei
Die Datei cfn-hup.conf speichert den Namen des Stacks und die AWS-Anmeldeinformationen, die der cfn-hup-Demon anzielt.
Die Datei cfn-hup.conf verwendet das folgende Format:
[main] stack=<stack-name-or-id>
| Name | Beschreibung | Erforderlich |
|---|---|---|
|
|
Einen Stack-Namen oder eine ID. Type: String |
Ja |
|
|
Eine auf Besitzer beschränkte Anmeldeinformations-Datei im selben Format wie die Befehlszeilen-Tools. Type: String Bedingung: Der Parameter |
Nein |
|
|
Der Name einer IAM-Rolle, die mit dieser Instanz verknüpft ist. Type: String |
Nein |
|
|
Der Name der AWS-Region, die den Stack enthält. Beispiel: |
Nein |
|
|
Die umask, die vom cfn-hup-Daemon verwendet wird. Dieser Wert kann mit oder ohne führende 0 angegeben werden. In beiden Fällen wird
er es als Oktalzahl interpretiert (sehr ähnlich dem Linux-Befehl Typ: Oktale ganze Zahl zwischen Standard: |
Nein |
|
|
Das Intervall in Minuten zwischen Prüfungen von Änderungen an den Ressourcen-Metadaten Typ: Zahl Standard: |
Nein |
|
|
Gibt an, ob die ausführliche Protokollierung verwendet werden soll. Typ: Boolescher Wert Standard: |
Nein |
hooks.conf Konfigurationsdatei
Die Benutzeraktionen, die die cfn-hup Demon regelmäßig aufruft, sind in der Konfigurationsdatei hooks.conf festgelegt. Die Datei hooks.conf verwendet das folgende Format:
[hookname] triggers=post.addorpost.updateorpost.remove path=Resources.<logicalResourceId>(.Metadataor.PhysicalResourceId)(.<optionalMetadatapath>) action=<arbitrary shell command>runas=<runas user>
Die Aktion wird bei Ausführung in einer Kopie der aktuellen Umgebung (in der sich cfn-hup befindet) ausgeführt; CFN_OLD_METADATA ist hierbei auf den vorherigen Wert des Pfades gesetzt, CFN_NEW_METADATA auf den aktuellen Wert.
Die Hooks-Konfigurationsdatei wird nur beim Start des cfn-hup Demon geladen; für neue Hooks muss der Demon also neu gestartet werden. Ein Cache der vorherigen Metadaten wird unter /var/lib/cfn-hup/data/metadata_db gespeichert – Sie können diesen Cache löschen, um cfn-hup zu zwingen, alle post.add-Aktionen erneut auszuführen.
| Name | Beschreibung | Erforderlich |
|---|---|---|
|
|
Eine eindeutige Bezeichnung für diesen Hook Type: String |
Ja |
|
|
Eine durch Komma getrennte Liste der zu erkennenden Bedingungen. Gültige Werte: Beispiel: |
Ja |
|
|
Der Pfad zum Metadatenobjekt. Unterstützt einen willkürlich tiefen Pfad im Metadaten-Block. Pfad-Formatoptionen
|
Ja |
|
|
Ein frei wählbarer Shell-Befehl, der wie angegeben ausgeführt wird. |
Ja |
|
|
Ein Benutzer, als der die Befehle ausgeführt werden sollen. Cfn-hup verwendet den su-Befehl zum Wechseln des Benutzers. |
Ja |
hooks.d-Verzeichnis
Um die Zusammenfassung mehrerer Anwendungen mit Änderungsbenachrichtungs-Hooks zu unterstützen, unterstützt cfn-hup ein Verzeichnis namens hooks.d, das sich im Hooks-Konfigurationsverzeichnis befindet. Im hooks.d-Verzeichnis können Sie eine oder mehrere weitere Hook-Konfigurationsdateien ablegen. Diese zusätzlichen Hooks-Dateien müssen dasselbe Layout wie die Datei hooks.conf nutzen.
Der cfn-hup Demon verarbeitet und lädt jede Datei in dieses Verzeichnis. Wenn ein Hook im hooks.d-Verzeichnis denselben Namen wie ein Hook in hooks.conf aufweist, werden die Hooks zusammengeführt (das bedeutet, dass hooks.d bei Werten, die bei beiden Daten festgelegt sind, hooks.conf überschreibt).
Beispiel
Im folgenden Vorlagen-Ausschnitt löst AWS CloudFormation die cfn-auto-reloader.conf Hooks-Datei aus, wenn Sie die Ressource AWS::CloudFormation::Init ändern, die mit der Ressource LaunchConfig verknüpft ist.
JSON
... "LaunchConfig": { "Type" : "AWS::AutoScaling::LaunchConfiguration", "Metadata" : { "QBVersion": {"Ref": "paramQBVersion"}, "AWS::CloudFormation::Init" : { ... "/etc/cfn/hooks.d/cfn-auto-reloader.conf": { "content": { "Fn::Join": [ "", [ "[cfn-auto-reloader-hook]\n", "triggers=post.update\n", "path=Resources.LaunchConfig.Metadata.AWS::CloudFormation::Init\n", "action=/opt/aws/bin/cfn-init -v ", " --stack ", { "Ref" : "AWS::StackName" }, " --resource LaunchConfig ", " --configsets wordpress_install ", " --region ", { "Ref" : "AWS::Region" }, "\n", "runas=root\n" ]]}, "mode" : "000400", "owner" : "root", "group" : "root" } ...
YAML
... LaunchConfig: Type: "AWS::AutoScaling::LaunchConfiguration" Metadata: QBVersion: !Ref paramQBVersion AWS::CloudFormation::Init: ... /etc/cfn/hooks.d/cfn-auto-reloader.conf: content: !Sub | [cfn-auto-reloader-hook] triggers=post.update path=Resources.LaunchConfig.Metadata.AWS::CloudFormation::Init action=/opt/aws/bin/cfn-init -v --stack ${AWS::StackName} --resource LaunchConfig --configsets wordpress_install --region ${AWS::Region} runas=root mode: "000400" owner: "root" group: "root" ...
Weiteres Beispiel
Eine Beispielvorlage finden Sie hier: Bereitstellen von Anwendungen auf Amazon EC2 mit AWS CloudFormation.
