Creazione SSM del contenuto del documento - AWS Systems Manager

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Creazione SSM del contenuto del documento

Se i documenti AWS Systems Manager pubblici non eseguono tutte le azioni che desideri eseguire sulle tue AWS risorse, puoi creare SSM documenti personalizzati. Puoi anche clonare SSM documenti utilizzando la console. La clonazione di documenti consente di copiare il contenuto da un documento esistente in un nuovo documento che è possibile modificare. Quando si crea o si clona un documento, il contenuto non deve superare i 64 KB. Questa quota include anche il contenuto specificato per i parametri di input in runtime (fase di esecuzione). Quando si crea un nuovo documento Command o Policy, si consiglia di utilizzare lo schema versione 2.2 o successiva in modo da poter sfruttare le funzionalità più recenti, come la modifica dei documenti, il controllo automatico delle versioni, il sequenziamento e altro ancora.

Scrittura del contenuto del documento SSM

Per creare il contenuto del proprio SSM documento, è importante comprendere i diversi schemi, funzionalità, plugin e sintassi disponibili per i documenti. SSM Si consiglia di acquisire familiarità con le seguenti risorse.

AWS SSMi documenti predefiniti potrebbero eseguire alcune delle azioni richieste. È possibile richiamare questi documenti utilizzando i aws:runDocumentaws:runCommand, o i aws:executeAutomation plugin all'interno del SSM documento personalizzato, a seconda del tipo di documento. È inoltre possibile copiare parti di tali documenti in un SSM documento personalizzato e modificare il contenuto in base alle proprie esigenze.

Suggerimento

Durante la creazione SSM del contenuto di un documento, è possibile modificarlo e aggiornarlo più volte durante il SSM test. I seguenti comandi aggiornano il SSM documento con i contenuti più recenti e aggiornano la versione predefinita del documento alla versione più recente del documento.

Nota

I comandi Linux e Windows utilizzano lo strumento da riga di jq comando per filtrare i dati di JSON risposta.

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

Clonazione di un documento SSM

È possibile clonare AWS Systems Manager documenti utilizzando la console Systems Manager Documents per creare SSM documenti. La clonazione dei SSM documenti copia il contenuto di un documento esistente in un nuovo documento che è possibile modificare. Non puoi clonare un documento di dimensioni superiori a 64 KB.

Per clonare un documento SSM
  1. Apri la AWS Systems Manager console all'indirizzo https://console.aws.amazon.com/systems-manager/.

  2. Nel riquadro di navigazione, scegli Documenti.

  3. Nella casella di ricerca, inserire il nome del documento che si desidera clonare.

  4. Scegliere il nome del documento che si desidera clonare, quindi scegliere Clone document (Clona documento) nel menu a tendina Actions (Operazioni).

  5. Modificare il documento come si preferisce, quindi scegliereCreate document (Crea documento) per salvare il documento.

Dopo aver scritto il contenuto SSM del documento, è possibile utilizzarlo per creare un SSM documento utilizzando uno dei seguenti metodi.

Creazione di documenti compositi

Un documento composito AWS Systems Manager (SSM) è un documento personalizzato che esegue una serie di azioni eseguendo uno o più SSM documenti secondari. I documenti compositi promuovono l'infrastruttura come codice, in quanto consentono di creare un set standard di SSM documenti per attività comuni come l'avvio di software o le istanze di aggiunta al dominio. È quindi possibile condividere questi documenti all'interno Account AWS dello stesso documento per ridurre la manutenzione dei documenti e garantire la Regione AWS coerenza. SSM

Ad esempio, puoi creare un documento composito che esegue le seguenti operazioni:

  1. Installa tutte le patch nell'elenco Consenti.

  2. Installa il software antivirus.

  3. Scarica gli script GitHub e li esegue.

In questo esempio, il SSM documento personalizzato include i seguenti plugin per eseguire queste azioni:

  1. Il plug-in aws:runDocument per eseguire il documento AWS-RunPatchBaseline, che installa tutte le patch consentite elencate.

  2. Il plugin aws:runDocument per eseguire il documento AWS-InstallApplication, che installa il software antivirus.

  3. Il aws:downloadContent plugin da cui scaricare gli script GitHub ed eseguirli.

I documenti compositi e secondari possono essere archiviati in Systems Manager GitHub (repository pubblici e privati) o Amazon S3. I documenti compositi e i documenti secondari possono essere creati in JSON o. YAML

Nota

I documenti compositi possono essere eseguiti solo a una profondità massima di tre documenti. Ciò significa che un documento composito può chiamare un documento figlio e che questo documento figlio può chiamare un ultimo documento.

Per creare un documento composito, aggiungete il aws:runDocument plugin in un SSM documento personalizzato e specificate gli input richiesti. L'esempio qui sotto mostra un documento composito che effettua le seguenti operazioni:

  1. Esegue il aws:downloadContent plugin per scaricare un SSM documento da un archivio GitHub pubblico in una directory locale chiamata bootstrap. Il SSM documento si chiama StateManagerBootstrap .yml (un documento). YAML

  2. Esegue il aws:runDocument plugin per eseguire il StateManagerBootstrap documento.yml. Non è specificato alcun parametro.

  3. Esegue il aws:runDocument plugin per eseguire il AWS-ConfigureDocker pre-defined SSM documento. I parametri specificati installano Docker sull'istanza.

{ "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\"}" } } ] }
Ulteriori informazioni