SSMDokumentinhalte erstellen - AWS Systems Manager

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

SSMDokumentinhalte erstellen

Wenn die AWS Systems Manager öffentlichen Dokumente nicht alle Aktionen ausführen, die Sie für Ihre AWS Ressourcen ausführen möchten, können Sie Ihre eigenen SSM Dokumente erstellen. Sie können SSM Dokumente auch mithilfe der Konsole klonen. Beim Klonen von Dokumenten werden Inhalte aus einem vorhandenen Dokument in ein neues Dokument kopiert, das Sie ändern können. Beim Erstellen oder Klonen eines Dokuments darf der Inhalt des Dokuments 64 KB nicht überschreiten. Dieses Kontingent beinhaltet auch den zur Laufzeit für Eingabeparameter angegebenen Inhalt. Wenn Sie ein neues Command- oder Policy-Dokument erstellen, wird empfohlen, Schemaversion 2.2 oder höher zu verwenden, damit Sie die neuesten Features wie Dokumentbearbeitung, automatisches Versioning, Sequenzierung usw. nutzen können.

Schreiben von SSM-Dokumentinhalt

Um Ihren eigenen SSM Dokumentinhalt zu erstellen, ist es wichtig, die verschiedenen Schemas, Funktionen, Plug-ins und Syntax zu verstehen, die für SSM Dokumente verfügbar sind. Wir empfehlen Ihnen, sich mit den folgenden Ressourcen vertraut zu machen.

AWS Mit vordefinierten SSM Dokumenten können einige der von Ihnen benötigten Aktionen ausgeführt werden. Sie können diese Dokumente aufrufen, indem Sie die aws:executeAutomation Plug-ins aws:runDocumentaws:runCommand, oder in Ihrem benutzerdefinierten SSM Dokument verwenden, je nach Dokumenttyp. Sie können auch Teile dieser Dokumente in ein benutzerdefiniertes SSM Dokument kopieren und den Inhalt nach Ihren Anforderungen bearbeiten.

Tipp

Beim Erstellen von SSM Dokumentinhalten können Sie den Inhalt während des Tests mehrmals ändern und Ihr SSM Dokument aktualisieren. Mit den folgenden Befehlen wird das SSM Dokument mit Ihrem neuesten Inhalt aktualisiert und die Standardversion des Dokuments auf die neueste Version des Dokuments aktualisiert.

Anmerkung

Die Linux- und Windows-Befehle verwenden das jq Befehlszeilentool, um die JSON Antwortdaten zu filtern.

Linux & macOS
latestDocVersion=$(aws ssm update-document \ --content file://path/to/file/documentContent.json \ --name "ExampleDocument" \ --document-format JSON \ --document-version '$LATEST' \ | jq -r '.DocumentDescription.LatestVersion') aws ssm update-document-default-version \ --name "ExampleDocument" \ --document-version $latestDocVersion
Windows
latestDocVersion=$(aws ssm update-document ^ --content file://C:\path\to\file\documentContent.json ^ --name "ExampleDocument" ^ --document-format JSON ^ --document-version "$LATEST" ^ | jq -r '.DocumentDescription.LatestVersion') aws ssm update-document-default-version ^ --name "ExampleDocument" ^ --document-version $latestDocVersion
PowerShell
$content = Get-Content -Path "C:\path\to\file\documentContent.json" | Out-String $latestDocVersion = Update-SSMDocument ` -Content $content ` -Name "ExampleDocument" ` -DocumentFormat "JSON" ` -DocumentVersion '$LATEST' ` | Select-Object -ExpandProperty LatestVersion Update-SSMDocumentDefaultVersion ` -Name "ExampleDocument" ` -DocumentVersion $latestDocVersion

Ein SSM Dokument klonen

Sie können AWS Systems Manager Dokumente mithilfe der Systems Manager Documents Console klonen, um SSM Dokumente zu erstellen. Beim Klonen von SSM Dokumenten werden Inhalte aus einem vorhandenen Dokument in ein neues Dokument kopiert, das Sie ändern können. Sie können kein Dokument klonen, das größer als 64 KB ist.

Um ein Dokument zu klonen SSM
  1. Öffnen Sie die AWS Systems Manager Konsole unter https://console.aws.amazon.com/systems-manager/.

  2. Wählen Sie im Navigationsbereich die Option Documents (Dokumente) aus.

  3. Geben Sie in das Suchfeld den Namen des Dokuments ein, das Sie klonen möchten.

  4. Wählen Sie den Namen des Dokuments aus, das Sie klonen möchten. Wählen Sie anschließend die Option Clone document (Dokument klonen) im Dropdownmenü Aktionen.

  5. Ändern Sie das Dokument nach Belieben und wählen Sie dann Create document (Dokument erstellen), um das Dokument zu speichern.

Nachdem Sie Ihren SSM Dokumentinhalt geschrieben haben, können Sie Ihren Inhalt verwenden, um mithilfe einer der folgenden Methoden ein SSM Dokument zu erstellen.

Erstellen von zusammengesetzten Dokumenten

Ein Verbunddokument AWS Systems Manager (SSM) ist ein benutzerdefiniertes Dokument, das eine Reihe von Aktionen ausführt, indem es ein oder mehrere SSM Sekundärdokumente ausführt. Bei zusammengesetzten Dokumenten wird Infrastruktur als Code dargestellt, indem Sie SSM Standarddokumente für allgemeine Aufgaben wie Boot-Strapping-Software oder Domänenbeitritt erstellen können. Sie können diese Dokumente dann gemeinsam nutzen, um den AWS-Konten Wartungsaufwand AWS-Region zu reduzieren und die Konsistenz zu gewährleistenSSM.

Sie können beispielsweise ein zusammengesetztes Dokument erstellen, das die folgenden Aktionen ausführt:

  1. Installiert alle Patches in der Zulassungsliste.

  2. Installieren von Antivirensoftware

  3. Lädt Skripts von herunter GitHub und führt sie aus.

In diesem Beispiel enthält Ihr benutzerdefiniertes SSM Dokument die folgenden Plugins, um diese Aktionen auszuführen:

  1. Das aws:runDocument-Plugin zum Ausführen des AWS-RunPatchBaseline-Dokuments, das alle aufgeführten Patches installiert.

  2. Das Plug-In aws:runDocument zum Ausführen des Dokuments AWS-InstallApplication, das die Antivirensoftware installiert

  3. Das aws:downloadContent Plugin zum Herunterladen GitHub und Ausführen von Skripten.

Zusammengesetzte und sekundäre Dokumente können in Systems Manager GitHub (öffentliche und private Repositorys) oder Amazon S3 gespeichert werden. Zusammengesetzte Dokumente und Sekundärdokumente können in JSON oder YAML erstellt werden.

Anmerkung

Zusammengesetzte Dokumente können maximal drei Dokumente tief ausgeführt werden. Dies bedeutet, dass ein zusammengesetztes Dokument ein untergeordnetes Dokument aufrufen kann, das wiederum ein letztes Dokument aufrufen kann.

Um ein zusammengesetztes Dokument zu erstellen, fügen Sie das aws:runDocument Plugin in ein benutzerdefiniertes SSM Dokument ein und geben Sie die erforderlichen Eingaben an. Folgendes ist ein Beispiel eines zusammengesetzten Dokuments, das die folgenden Aktionen ausführt:

  1. Führt das aws:downloadContent Plug-In aus, um ein SSM Dokument aus einem GitHub öffentlichen Repository in ein lokales Verzeichnis namens Bootstrap herunterzuladen. Das SSM Dokument heißt StateManagerBootstrap .yml (ein YAML Dokument).

  2. Führt das aws:runDocument Plugin aus, um das StateManagerBootstrap .yml-Dokument auszuführen. Es wurden keine Parameter angegeben.

  3. Führt das aws:runDocument Plugin aus, um das AWS-ConfigureDocker pre-defined SSM Dokument auszuführen. Die angegebenen Parameter installieren Docker in der Instance.

{ "schemaVersion": "2.2", "description": "My composite document for bootstrapping software and installing Docker.", "parameters": { }, "mainSteps": [ { "action": "aws:downloadContent", "name": "downloadContent", "inputs": { "sourceType": "GitHub", "sourceInfo": "{\"owner\":\"TestUser1\",\"repository\":\"TestPublic\", \"path\":\"documents/bootstrap/StateManagerBootstrap.yml\"}", "destinationPath": "bootstrap" } }, { "action": "aws:runDocument", "name": "runDocument", "inputs": { "documentType": "LocalPath", "documentPath": "bootstrap", "documentParameters": "{}" } }, { "action": "aws:runDocument", "name": "configureDocker", "inputs": { "documentType": "SSMDocument", "documentPath": "AWS-ConfigureDocker", "documentParameters": "{\"action\":\"Install\"}" } } ] }
Weitere Informationen