AWS::CloudFormation::Init

Verwenden Sie den AWS::CloudFormation::Init Typ, um Metadaten auf einer EC2 Amazon-Instance für das cfn-init Hilfsskript einzuschließen. Wenn Ihre Vorlage das Skript cfn-init aufruft, sucht das Skript nach Ressourcen-Metadaten, die im Metadatenschlüssel AWS::CloudFormation::Init verankert sind. Weitere Informationen finden Sie unter cfn-init.

cfn-init unterstützt alle Metadatentypen für Linux-Systeme. Es unterstützt die Metadatentypen für Windows mit Bedingungen, die in den folgenden Abschnitten beschrieben werden.

Syntax

Die Konfiguration ist in Abschnitte unterteilt. Der folgende Vorlagenausschnitt zeigt, wie Sie Metadaten für cfn-init an eine EC2 Instance-Ressource innerhalb der Vorlage anhängen können.

Die Metadaten sind in Konfigurationsschlüssel organisiert, die Sie in Konfigurationssätze gruppieren können. Sie können ein Configset angeben, wenn Sie cfn-init in Ihrer Vorlage aufrufen. Wenn Sie kein Konfigset angeben, sucht cfn-init nach einem einzelnen Konfigurationsschlüssel namens config.

"Resources": {
  "MyInstance": {
    "Type": "AWS::EC2::Instance",
    "Metadata" : {
      "AWS::CloudFormation::Init" : {
        "config" : {
          "packages" : {
            :
          },
          "groups" : {
            :
          },
          "users" : {
            :
          },
          "sources" : {
            :
          },
          "files" : {
            :
          },
          "commands" : {
            :
          },
          "services" : {
            :
          }
        }
      }
    },
    "Properties": {
      :
    }
  }
}

Resources: 
  MyInstance: 
    Type: AWS::EC2::Instance
    Metadata: 
      AWS::CloudFormation::Init: 
        config: 
          packages: 
            :
          groups: 
            :
          users: 
            :
          sources: 
            :
          files: 
            :
          commands: 
            :
          services: 
            :
    Properties: 
      :

Konfigurationssätze

Wenn Sie mehr als einen Konfigurationsschlüssel erstellen und cfn-init diese in einer bestimmten Reihenfolge verarbeiten lassen möchten, erstellen Sie ein Configset, das die Konfigurationsschlüssel in der gewünschten Reihenfolge enthält.

Einzelner Konfigurationssatz

Der folgende Vorlagenausschnitt erstellt die Konfigurationssätze ascending und descending, die jeweils zwei Konfigurationsschlüssel enthalten.

"AWS::CloudFormation::Init" : {
    "configSets" : {
        "ascending" : [ "config1" , "config2" ],
        "descending" : [ "config2" , "config1" ]
    },
    "config1" : {
        "commands" : {
            "test" : {
                "command" : "echo \"$CFNTEST\" > test.txt",
                "env" : { "CFNTEST" : "I come from config1." },
                "cwd" : "~"
            }
        }
    },
    "config2" : {
        "commands" : {
            "test" : {
                "command" : "echo \"$CFNTEST\" > test.txt",
                "env" : { "CFNTEST" : "I come from config2" },
                "cwd" : "~"
            }
        }
    }
}     

AWS::CloudFormation::Init: 
  configSets: 
    ascending: 
      - "config1"
      - "config2"
    descending: 
      - "config2"
      - "config1"
  config1: 
    commands: 
      test: 
        command: "echo \"$CFNTEST\" > test.txt"
        env: 
          CFNTEST: "I come from config1."
        cwd: "~"
  config2: 
    commands: 
      test: 
        command: "echo \"$CFNTEST\" > test.txt"
        env: 
          CFNTEST: "I come from config2"
        cwd: "~"

Verwandte cfn-init-Aufrufe

Die folgenden Beispielaufrufe von cfn-init beziehen sich auf die vorangegangenen Beispielkonfigurationen. Die Beispielaufrufe sind der Übersichtlichkeit halber abgekürzt. Siehe cfn-init für die vollständige Syntax.

Mehrere Konfigurationssätze

Sie können mehrere Configsets erstellen und eine Reihe von ihnen mit Ihrem Skript cfn-init aufrufen. Jeder Konfigurationssatz kann eine Liste von Konfigurationsschlüsseln oder Verweisen auf andere Konfigurationssätze enthalten. Der folgende Vorlagenausschnitt erstellt z. B. drei Konfigurationssätze. Der erste Konfigurationssatz test1enthält einen Konfigurationsschlüssel mit dem Namen 1. Der zweite Konfigurationssatz, test2, enthält einen Verweis auf den test1-Konfigurationssatz und einen Konfigurationsschlüssel mit dem Namen 2. Der dritte Konfigurationssatz, „default“, enthält einen Verweis auf den Konfigurationssatz test2.

"AWS::CloudFormation::Init" : {
    "configSets" : {
        "test1" : [ "1" ],
        "test2" : [ { "ConfigSet" : "test1" }, "2" ],
        "default" : [ { "ConfigSet" : "test2" } ]
    },
    "1" : {
        "commands" : {
            "test" : {
                "command" : "echo \"$MAGIC\" > test.txt",
                "env" : { "MAGIC" : "I come from the environment!" },
                "cwd" : "~"
            }
        }
    },
    "2" : {
        "commands" : {
            "test" : {
                "command" : "echo \"$MAGIC\" >> test.txt",
                "env" : { "MAGIC" : "I am test 2!" },
                "cwd" : "~"
            }
        }
    }
}

AWS::CloudFormation::Init:
  1:
    commands:
      test:
        command: "echo \"$MAGIC\" > test.txt"
        env:
          MAGIC: "I come from the environment!"
        cwd: "~"
  2:
    commands:
      test:
        command: "echo \"$MAGIC\" >> test.txt"
        env:
          MAGIC: "I am test 2!"
        cwd: "~"
  configSets: 
    test1:
      - "1"
    test2:
      - ConfigSet: "test1"
      - "2"
    default:
      - ConfigSet: "test2"

Verwandte cfn-init-Aufrufe

Die folgenden Aufrufe von cfn-init beziehen sich auf das im vorangegangenen Template-Schnipsel deklarierte configSets . Die Beispielaufrufe sind der Übersichtlichkeit halber abgekürzt. Siehe cfn-init für die vollständige Syntax.

Befehle

Sie können die Befehlstaste verwenden, um Befehle auf der Instanz auszuführen. EC2 Die Befehle werden in alphabetischer Reihenfolge nach Name verarbeitet.

Beispiel

Mit dem folgenden Beispiel wird der Echo-Befehl aufgerufen, wenn die ~/test.txt-Datei nicht vorhanden ist.

"commands" : {
    "test" : {
        "command" : "echo \"$MAGIC\" > test.txt",
        "env" : { "MAGIC" : "I come from the environment!" },
        "cwd" : "~",
        "test" : "test ! -e ~/test.txt",
        "ignoreErrors" : "false"
    },
    "test2" : {
        "command" : "echo \"$MAGIC2\" > test2.txt",
        "env" : { "MAGIC2" : "I come from the environment!" },
        "cwd" : "~",
        "test" : "test ! -e ~/test2.txt",
        "ignoreErrors" : "false"
    }
}

commands:
  test:
    command: "echo \"$MAGIC\" > test.txt"
    env:
      MAGIC: "I come from the environment!"
    cwd: "~"
    test: "test ! -e ~/test.txt"
    ignoreErrors: "false"
  test2:
    command: "echo \"$MAGIC2\" > test2.txt"
    env:
      MAGIC2: "I come from the environment!"
    cwd: "~"
    test: "test ! -e ~/test2.txt"
    ignoreErrors: "false"

Dateien

Sie können den files Schlüssel verwenden, um Dateien auf der EC2 Instanz zu erstellen. Der Inhalt kann entweder in die Vorlage eingebettet sein oder von einer URL abgerufen werden. Die Dateien werden in lexikalischer Reihenfolge auf den Datenträger geschrieben. In der folgenden Tabelle sind die unterstützten Schlüssel aufgeführt.

Beispiele

Das folgende Beispiel erstellt eine Datei mit dem Namen setup.mysql als Teil einer größeren Installation.

"files" : {
  "/tmp/setup.mysql" : {
    "content" : { "Fn::Join" : ["", [
      "CREATE DATABASE ", { "Ref" : "DBName" }, ";\n",
      "CREATE USER '", { "Ref" : "DBUsername" }, "'@'localhost' IDENTIFIED BY '",
                       { "Ref" : "DBPassword" }, "';\n",
      "GRANT ALL ON ", { "Ref" : "DBName" }, ".* TO '", { "Ref" : "DBUsername" },
                       "'@'localhost';\n",
      "FLUSH PRIVILEGES;\n"
      ]]},
    "mode"  : "000644",
    "owner" : "root",
    "group" : "root"
  }
}

files: 
  /tmp/setup.mysql: 
    content: !Sub |
      CREATE DATABASE ${DBName};
      CREATE USER '${DBUsername}'@'localhost' IDENTIFIED BY '${DBPassword}';
      GRANT ALL ON ${DBName}.* TO '${DBUsername}'@'localhost';
      FLUSH PRIVILEGES;
    mode: "000644"
    owner: "root"
    group: "root"

Die vollständige Vorlage ist verfügbar unter: https://s3.amazonaws.com/cloudformation-templates-us-east-1/Drupal_Single_Instance.template.

Mit dem folgenden Beispiel-Codeausschnitt wird eine Symlink-/tmp/myfile2.txt erstellt, die auf die vorhandene Datei /tmp/myfile1.txt verweist. Die Berechtigungen der Zieldatei /tmp/myfile1.txt werden durch den Moduswert 644 erstellt.

"files" : {
  "/tmp/myfile2.txt" : {
    "content" : "/tmp/myfile1.txt",
    "mode" : "120644"
  }
}

files:
  /tmp/myfile2.txt:
    content: "/tmp/myfile1.txt"
    mode: "120644"

Mustache-Vorlagen werden in erster Linie zum Erstellen von Konfigurationsdateien verwendet. Sie können beispielsweise eine Konfigurationsdatei in einem S3-Bucket speichern und Refs und aus der Vorlage interpolieren, anstatt sie zu verwenden. GetAtts Fn::Join Das folgende Beispiel gibt Content for test9 bis /tmp/test9.txtaus.

"files" : {
    "/tmp/test9.txt" : {
        "content" : "Content for {{name}}",
        "context" : { "name" : "test9" }
    }
} 

files:
  /tmp/test9.txt:
    content: "Content for {{name}}"
    context:
      name: "test9"

Beachten Sie beim Arbeiten mit Mustache-Vorlagen Folgendes:

Gruppen

Sie können den Gruppenschlüssel verwenden, um Gruppen zu erstellen und Linux/UNIX Gruppen zuzuweisen. IDs Der Gruppenschlüssel wird für Windows-Systeme nicht unterstützt.

Um eine Gruppe zu erstellen, fügen Sie ein neues Schlüssel-Wert-Paar hinzu, das einer optionalen Gruppen-ID einen neuen Gruppennamen zuordnet. Der Gruppenschlüssel kann einen oder mehrere Gruppennamen enthalten. In der folgenden Tabelle werden die verfügbaren Schlüssel aufgeführt.

Beispielausschnitt

Der folgende Codeausschnitt gibt eine Gruppe mit dem Namen groupOne an, ohne eine Gruppen-ID zuzuweisen, und eine Gruppe mit dem Namen groupTwo, die den Gruppen-ID-Wert 45 angegeben hat.

"groups" : {
    "groupOne" : {},
    "groupTwo" : { "gid" : "45" }
}

groups:
  groupOne: {}
  groupTwo:
    gid: "45"

Pakete

Sie können den Paketeschlüssel verwenden, um vorkonfigurierte Anwendungen und Komponenten herunterzuladen und zu installieren. Auf Windows-Systemen unterstützt der Paketeschlüssel nur das MSI-Installationsprogramm.

Unterstützte Paketformate

Das Skript cfn-init unterstützt derzeit die folgenden Paketformate: apt, msi, python, rpm, rubygems, yum und Zypper. Pakete werden in der folgenden Reihenfolge verarbeitet: rpmyum/apt/zypper, und dann rubygems und python. Bei rubygems und python gibt es keine Reihenfolge und es ist nicht gewährleistet, dass Pakete innerhalb jedes Paketmanagers in einer Reihenfolge installiert werden.

Angeben von Versionen

Innerhalb jedes Paketmanagers ist jedes Paket als ein Paketname und eine Liste der Versionen angegeben. Die Version kann eine Zeichenfolge, eine Liste von Versionen oder eine leere Zeichenfolge oder Liste sein. Eine leere Zeichenfolge oder Liste gibt an, dass Sie die neueste Version verwenden möchten. Bei RPM-Manager wird die Version als ein Pfad zu einer Datei auf einem Datenträger oder eine URL angegeben.

Wenn Sie eine Version eines Pakets angeben, versucht cfn-init, diese Version zu installieren, auch wenn eine neuere Version des Pakets bereits auf der Instance installiert ist. Einige Paketmanager unterstützen mehrere Versionen, andere wiederum nicht. In der Dokumentation zu Ihrem Paketmanager finden Sie weitere Informationen. Wenn Sie keine Version angeben und bereits eine Version des Pakets installiert ist, installiert das Skript cfn-init keine neue Version, sondern geht davon aus, dass Sie die bestehende Version behalten und verwenden möchten.

Beispielausschnitte

RPM, yum, Rubygems und Zypper

Der folgende Codeausschnitt gibt eine Versions-URL für RPM an, fordert die neuesten Versionen von yum und Zypper und Version 0.10.2 von chef von rubygems an:

"rpm" : {
  "epel" : "http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm"
},
"yum" : {
  "httpd" : [],
  "php" : [],
  "wordpress" : []
},
"rubygems" : {
  "chef" : [ "0.10.2" ]
},
"zypper" : {
  "git" : []
}

rpm:
  epel: "http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm"
yum:
  httpd: []
  php: []
  wordpress: []
rubygems:
  chef:
    - "0.10.2"
zypper:
  git: []

MSI-Paket

Der folgende Codeausschnitt gibt eine URL für ein MSI-Paket an:

"msi" : {
  "awscli" : "https://s3.amazonaws.com/aws-cli/AWSCLI64.msi"
}

msi:
  awscli: "https://s3.amazonaws.com/aws-cli/AWSCLI64.msi"

Dienstleistungen

Sie können den Services-Schlüssel verwenden, um zu definieren, welche Services aktiviert oder deaktiviert werden sollen, wenn die Instance gestartet wird. Amazon Linux 2 Systeme und höher mit aws-cfn-bootstrap Version 2.0-29+ unterstützen diesen Schlüssel durch die Verwendung von systemd. Andere Linux-Systeme unterstützen diesen Schlüssel mit sysvinit (standardmäßig) oder systemd (durch Hinzufügen der erforderlichen Konfigurationen unten). Windows-Systeme unterstützen diesen Schlüssel über den Windows Service Manager.

Mit dem Schlüssel services können Sie auch Abhängigkeiten von Quellen, Paketen und Dateien angeben, so dass, wenn ein Neustart aufgrund der Installation von Dateien erforderlich ist, cfn-init den Neustart des Dienstes übernimmt. Wenn Sie beispielsweise das Apache-HTTP-Server-Paket herunterladen, startet die Paketinstallation während der Stack-Erstellung automatisch den Apache-HTTP-Server. Wenn die Konfiguration des Apache-HTTP Servers allerdings später im Stack-Erstellungsprozess aktualisiert wird, wird die Aktualisierung erst wirksam, wenn der Apache-Server neu gestartet wird. Sie können mithilfe des Services-Schlüssels sicherstellen, dass der Apache-HTTP-Service neu gestartet wird.

In der folgenden Tabelle sind die unterstützten Schlüssel aufgeführt.

Beispiele

Linux

Der folgende Linux-Ausschnitt konfiguriert die Services wie folgt:

"services" : {
  "sysvinit" : {
    "nginx" : {
      "enabled" : "true",
      "ensureRunning" : "true",
      "files" : ["/etc/nginx/nginx.conf"],
      "sources" : ["/var/www/html"]
    },
    "php-fastcgi" : {
      "enabled" : "true",
      "ensureRunning" : "true",
      "packages" : { "yum" : ["php", "spawn-fcgi"] }
    }
  },
  "systemd": {
    "sendmail" : {
      "enabled" : "false",
      "ensureRunning" : "false"
    }
  }
}

services:
  sysvinit:
    nginx:
      enabled: "true"
      ensureRunning: "true"
      files:
        - "/etc/nginx/nginx.conf"
      sources:
        - "/var/www/html"
    php-fastcgi:
      enabled: "true"
      ensureRunning: "true"
      packages:
        yum:
          - "php"
          - "spawn-fcgi"
  systemd:
    sendmail:
      enabled: "false"
      ensureRunning: "false"

[Unit]
Description=cfn-hup daemon
[Service]
ExecStart=/usr/bin/cfn-hup -v
PIDFile=/var/run/cfn-hup.pid
[Install]
WantedBy=multi-user.target

# In this example, cfn-hup executable is available under /usr/local/bin
[Service]
ExecStart=
ExecStart=/usr/local/bin/cfn-hup -v

Windows

Der folgende Windows-Ausschnitt startet den cfn-hup-Service, legt ihn auf automatisch fest und startet den Service neu, wenn cfn-init die angegebenen Konfigurationsdateien ändert:

"services" : {
  "windows" : {
    "cfn-hup" : {
      "enabled" : "true",
      "ensureRunning" : "true",
      "files" : ["c:\\cfn\\cfn-hup.conf", "c:\\cfn\\hooks.d\\cfn-auto-reloader.conf"]
    }
  }
}

services:
  windows:
    cfn-hup:
      enabled: "true"
      ensureRunning: "true"
      files:
        - "c:\\cfn\\cfn-hup.conf"
        - "c:\\cfn\\hooks.d\\cfn-auto-reloader.conf"

Quellen

Sie können den Quellschlüssel verwenden, um eine Archivdatei herunterzuladen und sie in ein Zielverzeichnis auf der EC2 Instanz zu entpacken. Dieser Schlüssel wird sowohl für Linux- als auch Windows-Systeme vollständig unterstützt.

Unterstützte Formate

Unterstützte Formate sind:

Beispiele

GitHub

Wenn Sie es GitHub als Quellcodeverwaltungssystem verwendencfn-init, können Sie den Quellpaketmechanismus verwenden, um eine bestimmte Version Ihrer Anwendung abzurufen. GitHub ermöglicht es Ihnen, eine ZIP-Datei oder eine TAR-Datei aus einer bestimmten Version über eine URL wie folgt zu erstellen:

https://github.com/<your directory>/(zipball|tarball)/<version>

Das folgende Beispiel zeigt die Version main als .tar-Datei an.

"sources" : {
  "/etc/puppet" : "https://github.com/user1/cfn-demo/tarball/main"
  }

sources:
  /etc/puppet: "https://github.com/user1/cfn-demo/tarball/main"

S3 Bucket

Das folgende Beispiel lädt einen Tarball aus einem S3-Bucket herunter und entpackt ihn in /etc/myapp:

"sources" : {
  "/etc/myapp" : "https://s3.amazonaws.com/amzn-s3-demo-bucket/myapp.tar.gz"
  }

sources:
  /etc/myapp: "https://s3.amazonaws.com/amzn-s3-demo-bucket/myapp.tar.gz"

Benutzer

Sie können den Benutzerschlüssel verwenden, um Benutzer auf der Instanz zu erstellen Linux/UNIX . EC2 Der Schlüssel users wird für Windows-Systeme nicht unterstützt.

In der folgenden Tabelle sind die unterstützten Schlüssel aufgeführt.

Beispiel

Benutzer werden als nicht interaktive Systembenutzer mit der Shell /sbin/nologin erstellt. Dies ist beabsichtigt und kann nicht geändert werden.

"users" : {
    "myUser" : {
        "groups" : ["groupOne", "groupTwo"],
        "uid" : "50",
        "homeDir" : "/tmp"
    }
}

users:
  myUser:
    groups:
      - "groupOne"
      - "groupTwo"
    uid: "50"
    homeDir: "/tmp"