Création du contenu d'SSMun document - AWS Systems Manager

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création du contenu d'SSMun document

Si les documents AWS Systems Manager publics n'exécutent pas toutes les actions que vous souhaitez effectuer sur vos AWS ressources, vous pouvez créer vos propres SSM documents. Vous pouvez également cloner SSM des documents à l'aide de la console. Le clonage de documents copie le contenu d'un document existant vers un nouveau document que vous pouvez modifier. Lors de la création ou du clonage d'un document, le contenu du document ne doit pas dépasser 64 Ko. Ce quota inclut également le contenu spécifié pour les paramètres d'entrée lors de l'exécution. Lorsque vous créez un nouveau Command ou document Policy, nous vous recommandons d'utiliser la version 2.2 ou ultérieure du schéma afin de tirer parti des fonctionnalités les plus récentes, telles que la mise à jour de documents, le contrôle de version automatique, le séquençage, etc.

Rédaction du contenu du document SSM

Pour créer votre propre contenu de SSM document, il est important de comprendre les différents schémas, fonctionnalités, plug-ins et syntaxes disponibles pour les SSM documents. Nous vous recommandons de vous familiariser avec les ressources suivantes.

AWS SSMles documents prédéfinis peuvent effectuer certaines des actions dont vous avez besoin. Vous pouvez appeler ces documents en utilisant le aws:runDocument ou aws:runCommand les aws:executeAutomation plug-ins de votre SSM document personnalisé, selon le type de document. Vous pouvez également copier des parties de ces documents dans un SSM document personnalisé et modifier le contenu en fonction de vos besoins.

Astuce

Lorsque vous créez SSM le contenu d'un document, vous pouvez le modifier et le mettre SSM à jour plusieurs fois pendant le test. Les commandes suivantes mettent à jour le SSM document avec votre contenu le plus récent et mettent à jour la version par défaut du document avec la dernière version du document.

Note

Les commandes Linux et Windows utilisent l'outil de ligne de jq commande pour filtrer les données de JSON réponse.

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

Clonage d'un document SSM

Vous pouvez cloner AWS Systems Manager des documents à l'aide de la console Systems Manager Documents pour créer SSM des documents. Le clonage de SSM documents copie le contenu d'un document existant vers un nouveau document que vous pouvez modifier. Vous ne pouvez pas cloner un document dont la taille est supérieure à 64 Ko.

Pour cloner un SSM document
  1. Ouvrez la AWS Systems Manager console à l'adresse https://console.aws.amazon.com/systems-manager/.

  2. Dans le panneau de navigation, cliquez sur Documents.

  3. Dans la zone de recherche, saisissez le nom du document que vous voulez cloner.

  4. Sélectionnez le nom du document à cloner, puis sélectionnez Clone document (Cloner un document) dans le menu déroulant Actions.

  5. Modifiez le document selon vos préférences, puis sélectionnez Create document (Créer un document) pour enregistrer le document.

Après avoir rédigé SSM le contenu de votre document, vous pouvez l'utiliser pour créer un SSM document à l'aide de l'une des méthodes suivantes.

Création de SSM documents

Création de documents composites

Un document composite AWS Systems Manager (SSM) est un document personnalisé qui exécute une série d'actions en exécutant un ou plusieurs SSM documents secondaires. Les documents composites font la promotion de l'infrastructure sous forme de code en vous permettant de créer un ensemble standard de SSM documents pour des tâches courantes telles que les logiciels de démarrage ou les instances de jonction de domaines. Vous pouvez ensuite partager ces documents Comptes AWS dans un même document Région AWS afin de réduire la maintenance des SSM documents et de garantir leur cohérence.

Par exemple, vous pouvez créer un document composite qui effectue les actions suivantes :

  1. Installe tous les correctifs de la liste autorisée.

  2. Installer un logiciel antivirus.

  3. Télécharge des scripts depuis GitHub et les exécute.

Dans cet exemple, votre SSM document personnalisé inclut les plug-ins suivants pour effectuer ces actions :

  1. Le plugin aws:runDocument pour exécuter le document AWS-RunPatchBaseline, qui installe tous les correctifs autorisés répertoriés.

  2. Le plugin aws:runDocument pour exécuter le document AWS-InstallApplication, qui installe le logiciel antivirus.

  3. Le aws:downloadContent plugin depuis lequel télécharger des scripts GitHub et les exécuter.

Les documents composites et secondaires peuvent être stockés dans Systems Manager GitHub (référentiels publics et privés) ou Amazon S3. Les documents composites et les documents secondaires peuvent être créés dans JSON ouYAML.

Note

Les documents composites peuvent exécuter une profondeur maximale de trois documents. Cela signifie qu'un document composite peut appeler un document enfant, et que celui-ci peut appeler un dernier document.

Pour créer un document composite, ajoutez le aws:runDocument plugin dans un SSM document personnalisé et spécifiez les entrées requises. L'exemple suivant présente un document composite qui effectue les actions suivantes :

  1. Exécute le aws:downloadContent plugin pour télécharger un SSM document depuis un dépôt GitHub public vers un répertoire local appelé bootstrap. Le SSM document s'appelle StateManagerBootstrap .yml (un YAML document).

  2. Exécute le aws:runDocument plugin pour exécuter le document StateManagerBootstrap .yml. Aucun paramètre n'est spécifié.

  3. Exécute le aws:runDocument plugin pour exécuter le AWS-ConfigureDocker pre-defined SSM document. Les paramètres spécifiés installent Docker sur l'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\"}" } } ] }
Plus d'informations