AWS OpsWorks CM exemples utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with AWS OpsWorks CM.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Les actions vous indiquent comment appeler des fonctions de service individuelles, mais vous pouvez les visualiser dans leur contexte dans les scénarios correspondants.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

Actions

L'exemple de code suivant montre comment utiliserassociate-node.

AWS CLI

Pour associer des nœuds

La associate-node commande suivante associe un nœud nommé i-44de882p à un serveur Chef Automate nomméautomate-06, ce qui signifie que le automate-06 serveur gère le nœud et communique des commandes de recette au nœud via chef-client un logiciel agent installé sur le nœud par la commande associate-node. Les noms de nœuds valides sont des EC2 instancesIDs. :


aws opsworks-cm associate-node --server-name "automate-06" --node-name "i-43de882p" --engine-attributes "Name=CHEF_ORGANIZATION,Value='MyOrganization' Name=CHEF_NODE_PUBLIC_KEY,Value='Public_key_contents'"

Le résultat renvoyé par la commande ressemble à ce qui suit. Sortie :


{
 "NodeAssociationStatusToken": "AHUY8wFe4pdXtZC5DiJa5SOLp5o14DH//rHRqHDWXxwVoNBxcEy4V7R0NOFymh7E/1HumOBPsemPQFE6dcGaiFk"
}

Plus d'informations

Pour plus d'informations, voir Ajouter automatiquement des nœuds dans AWS OpsWorks Chef Automate dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir AssociateNodela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-backup.

AWS CLI

Pour créer des sauvegardes

La create-backup commande suivante lance une sauvegarde manuelle d'un serveur Chef Automate nommé automate-06 dans la us-east-1 région. La commande ajoute un message descriptif à la sauvegarde dans le --description paramètre.


aws opsworks-cm create-backup \
    --server-name 'automate-06' \
    --description "state of my infrastructure at launch"

La sortie affiche des informations similaires aux suivantes concernant la nouvelle sauvegarde.

Sortie :


{
    "Backups": [
        {
            "BackupArn": "string",
            "BackupId": "automate-06-20160729133847520",
            "BackupType": "MANUAL",
            "CreatedAt": 2016-07-29T13:38:47.520Z,
            "Description": "state of my infrastructure at launch",
            "Engine": "Chef",
            "EngineModel": "Single",
            "EngineVersion": "12",
            "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
            "InstanceType": "m4.large",
            "KeyPair": "",
            "PreferredBackupWindow": "",
            "PreferredMaintenanceWindow": "",
            "S3LogUrl": "https://s3.amazonaws.com/<bucket-name>/automate-06-20160729133847520",
            "SecurityGroupIds": [ "sg-1a24c270" ],
            "ServerName": "automate-06",
            "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
            "Status": "OK",
            "StatusDescription": "",
            "SubnetIds": [ "subnet-49436a18" ],
            "ToolsVersion": "string",
            "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user"
        }
    ],
}

Pour plus d'informations, voir Sauvegarder et restaurer un serveur AWS OpsWorks pour Chef Automate dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir CreateBackupla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-server.

AWS CLI

Pour créer un serveur

L'create-serverexemple suivant crée un nouveau serveur Chef Automate nommé automate-06 dans votre région par défaut. Notez que les valeurs par défaut sont utilisées pour la plupart des autres paramètres, tels que le nombre de sauvegardes à conserver et les heures de début de maintenance et de sauvegarde. Avant d'exécuter une create-server commande, remplissez les conditions requises dans Getting Started with AWS OpsWorks for Chef Automate dans le guide de l'utilisateur d'AWS Opsworks for Chef Automate.


aws opsworks-cm create-server \
    --engine "Chef" \
    --engine-model "Single" \
    --engine-version "12" \
    --server-name "automate-06" \
    --instance-profile-arn "arn:aws:iam::1019881987024:instance-profile/aws-opsworks-cm-ec2-role" \
    --instance-type "t2.medium" \
    --key-pair "amazon-test" \
    --service-role-arn "arn:aws:iam::044726508045:role/aws-opsworks-cm-service-role"

Le résultat affiche des informations similaires aux suivantes concernant le nouveau serveur :


{
    "Server": {
        "BackupRetentionCount": 10,
        "CreatedAt": 2016-07-29T13:38:47.520Z,
        "DisableAutomatedBackup": FALSE,
        "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com",
        "Engine": "Chef",
        "EngineAttributes": [
            {
                "Name": "CHEF_DELIVERY_ADMIN_PASSWORD",
                "Value": "1Password1"
            }
        ],
        "EngineModel": "Single",
        "EngineVersion": "12",
        "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/aws-opsworks-cm-ec2-role",
        "InstanceType": "t2.medium",
        "KeyPair": "amazon-test",
        "MaintenanceStatus": "",
        "PreferredBackupWindow": "Sun:02:00",
        "PreferredMaintenanceWindow": "00:00",
        "SecurityGroupIds": [ "sg-1a24c270" ],
        "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2",
        "ServerName": "automate-06",
        "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role",
        "Status": "CREATING",
        "StatusReason": "",
        "SubnetIds": [ "subnet-49436a18" ]
    }
}

Pour plus d'informations, consultez UpdateServerla APIréférence AWS OpsWorks for Chef Automate.

Pour API plus de détails, voir CreateServerla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-backup.

AWS CLI

Pour supprimer des sauvegardes

La delete-backup commande suivante supprime une sauvegarde manuelle ou automatique d'un serveur Chef Automate, identifiée par l'ID de sauvegarde. Cette commande est utile lorsque vous approchez du nombre maximum de sauvegardes que vous pouvez enregistrer ou que vous souhaitez minimiser vos coûts de stockage Amazon S3. :


aws opsworks-cm delete-backup --backup-id "automate-06-2016-11-19T23:42:40.240Z"

Le résultat indique si la suppression de la sauvegarde a réussi.

Plus d'informations

Pour plus d'informations, voir Sauvegarder et restaurer un serveur AWS OpsWorks pour Chef Automate dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir DeleteBackupla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-server.

AWS CLI

Pour supprimer des serveurs

La delete-server commande suivante supprime un serveur Chef Automate, identifié par le nom du serveur. Une fois le serveur supprimé, il n'est plus renvoyé par les DescribeServer requêtes. :


aws opsworks-cm delete-server --server-name "automate-06"

Le résultat indique si la suppression du serveur a réussi.

Plus d'informations

Pour plus d'informations, voir Supprimer un serveur AWS OpsWorks pour Chef Automate dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir DeleteServerla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-account-attributes.

AWS CLI

Pour décrire les attributs du compte

La describe-account-attributes commande suivante renvoie des informations sur l'utilisation par votre compte des ressources AWS OpsWorks pour Chef Automate. :


aws opsworks-cm describe-account-attributes

La sortie pour chaque entrée d'attribut de compte renvoyée par la commande ressemble à ce qui suit. Sortie :


{
 "Attributes": [
    {
       "Maximum": 5,
       "Name": "ServerLimit",
       "Used": 2
    }
 ]
}

Plus d'informations

Pour plus d'informations, consultez DescribeAccountAttributes la APIréférence AWS OpsWorks for Chef Automate.

Pour API plus de détails, voir DescribeAccountAttributesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-backups.

AWS CLI

Pour décrire les sauvegardes

La describe-backups commande suivante renvoie des informations sur toutes les sauvegardes associées à votre compte dans votre région par défaut.


aws opsworks-cm describe-backups

La sortie de chaque entrée de sauvegarde renvoyée par la commande ressemble à la suivante.

Sortie :


{
    "Backups": [
        {
            "BackupArn": "string",
            "BackupId": "automate-06-20160729133847520",
            "BackupType": "MANUAL",
            "CreatedAt": 2016-07-29T13:38:47.520Z,
            "Description": "state of my infrastructure at launch",
            "Engine": "Chef",
            "EngineModel": "Single",
            "EngineVersion": "12",
            "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
            "InstanceType": "m4.large",
            "KeyPair": "",
            "PreferredBackupWindow": "",
            "PreferredMaintenanceWindow": "",
            "S3LogUrl": "https://s3.amazonaws.com/<bucket-name>/automate-06-20160729133847520",
            "SecurityGroupIds": [ "sg-1a24c270" ],
            "ServerName": "automate-06",
            "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
            "Status": "Successful",
            "StatusDescription": "",
            "SubnetIds": [ "subnet-49436a18" ],
            "ToolsVersion": "string",
            "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user"
        }
    ],
}

Pour plus d'informations, voir Sauvegarder et restaurer un serveur AWS OpsWorks pour Chef Automate dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir DescribeBackupsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-events.

AWS CLI

Pour décrire les événements

L'describe-eventsexemple suivant renvoie des informations sur tous les événements associés au serveur Chef Automate spécifié.


aws opsworks-cm describe-events \
    --server-name 'automate-06'

Le résultat pour chaque entrée d'événement renvoyée par la commande ressemble à l'exemple suivant :


{
    "ServerEvents": [
        {
            "CreatedAt": 2016-07-29T13:38:47.520Z,
            "LogUrl": "https://s3.amazonaws.com/<bucket-name>/automate-06-20160729133847520",
            "Message": "Updates successfully installed.",
            "ServerName": "automate-06"
        }
    ]
}

Pour plus d'informations, consultez les conseils généraux de résolution des problèmes dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir DescribeEventsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-node-association-status.

AWS CLI

Pour décrire l'état de l'association des nœuds

La describe-node-association-status commande suivante renvoie l'état d'une demande d'association d'un nœud à un serveur Chef Automate nomméautomate-06. :


aws opsworks-cm describe-node-association-status --server-name "automate-06" --node-association-status-token "AflJKl+/GoKLZJBdDQEx0O65CDi57blQe9nKM8joSok0pQ9xr8DqApBN9/1O6sLdSvlfDEKkEx+eoCHvjoWHaOs="

La sortie pour chaque entrée d'attribut de compte renvoyée par la commande ressemble à ce qui suit. Sortie :


{
 "NodeAssociationStatus": "IN_PROGRESS"
}

Plus d'informations

Pour plus d'informations, consultez DescribeNodeAssociationStatus la APIréférence AWS OpsWorks for Chef Automate.

Pour API plus de détails, voir DescribeNodeAssociationStatusla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-servers.

AWS CLI

Pour décrire les serveurs

La describe-servers commande suivante renvoie des informations sur tous les serveurs associés à votre compte et dans votre région par défaut. :


aws opsworks-cm describe-servers

La sortie pour chaque entrée de serveur renvoyée par la commande ressemble à la suivante. Sortie :


{
 "Servers": [
    {
       "BackupRetentionCount": 8,
       "CreatedAt": 2016-07-29T13:38:47.520Z,
       "DisableAutomatedBackup": FALSE,
       "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com",
       "Engine": "Chef",
       "EngineAttributes": [
          {
             "Name": "CHEF_DELIVERY_ADMIN_PASSWORD",
             "Value": "1Password1"
          }
       ],
       "EngineModel": "Single",
       "EngineVersion": "12",
       "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
       "InstanceType": "m4.large",
       "KeyPair": "",
       "MaintenanceStatus": "SUCCESS",
       "PreferredBackupWindow": "03:00",
       "PreferredMaintenanceWindow": "Mon:09:00",
       "SecurityGroupIds": [ "sg-1a24c270" ],
       "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2",
       "ServerName": "automate-06",
       "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
       "Status": "HEALTHY",
       "StatusReason": "",
       "SubnetIds": [ "subnet-49436a18" ]
    }
 ]
}

Plus d'informations

Pour plus d'informations, consultez DescribeServers le APIguide AWS OpsWorks for Chef Automate.

Pour API plus de détails, voir DescribeServersla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdisassociate-node.

AWS CLI

Pour dissocier les nœuds

La disassociate-node commande suivante dissocie un nœud nomméi-44de882p, le retirant de la gestion du nœud par un serveur Chef Automate nomméautomate-06. Les noms de nœuds valides sont des EC2 instancesIDs. :


aws opsworks-cm disassociate-node --server-name "automate-06" --node-name "i-43de882p" --engine-attributes "Name=CHEF_ORGANIZATION,Value='MyOrganization' Name=CHEF_NODE_PUBLIC_KEY,Value='Public_key_contents'"

Le résultat renvoyé par la commande ressemble à ce qui suit. Sortie :


{
 "NodeAssociationStatusToken": "AHUY8wFe4pdXtZC5DiJa5SOLp5o14DH//rHRqHDWXxwVoNBxcEy4V7R0NOFymh7E/1HumOBPsemPQFE6dcGaiFk"
}

Plus d'informations

Pour plus d'informations, voir Supprimer un serveur AWS OpsWorks pour Chef Automate dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir DisassociateNodela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserrestore-server.

AWS CLI

Pour restaurer un serveur

La restore-server commande suivante effectue une restauration sur place d'un serveur Chef Automate nommé automate-06 dans votre région par défaut à partir d'une sauvegarde avec un ID deautomate-06-2016-11-22T16:13:27.998Z. La restauration d'un serveur rétablit les connexions aux nœuds que le serveur Chef Automate gérait au moment où la sauvegarde spécifiée a été effectuée.

aws opsworks-cm restore-server --backup-id « Automate-06-2016-11-22t 16:13:27.998 Z » --nom-serveur « automate-06 »

Le résultat est uniquement l'ID de commande. Sortie :


(None)

Plus d'informations

Pour plus d'informations, voir Restaurer un serveur AWS OpsWorks défaillant pour Chef Automate dans le guide de AWS OpsWorks l'utilisateur.

Pour API plus de détails, voir RestoreServerla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-maintenance.

AWS CLI

Pour démarrer la maintenance

L'start-maintenanceexemple suivant démarre manuellement la maintenance sur le serveur Chef Automate ou Puppet Enterprise spécifié dans votre région par défaut. Cette commande est utile si une tentative de maintenance automatique antérieure a échoué et que la cause sous-jacente de l'échec de maintenance a été résolue.


aws opsworks-cm start-maintenance \
    --server-name 'automate-06'

Sortie :


{
    "Server": {
        "AssociatePublicIpAddress": true,
        "BackupRetentionCount": 10,
        "ServerName": "automate-06",
        "CreatedAt": 1569229584.842,
        "CloudFormationStackArn": "arn:aws:cloudformation:us-west-2:123456789012:stack/aws-opsworks-cm-instance-automate-06-1606611794746/EXAMPLE0-31de-11eb-bdb0-0a5b0a1353b8",
        "DisableAutomatedBackup": false,
        "Endpoint": "automate-06-EXAMPLEvr8gjfk5f.us-west-2.opsworks-cm.io",
        "Engine": "ChefAutomate",
        "EngineModel": "Single",
        "EngineAttributes": [],
        "EngineVersion": "2020-07",
        "InstanceProfileArn": "arn:aws:iam::123456789012:instance-profile/aws-opsworks-cm-ec2-role",
        "InstanceType": "m5.large",
        "PreferredMaintenanceWindow": "Sun:01:00",
        "PreferredBackupWindow": "Sun:15:00",
        "SecurityGroupIds": [
            "sg-EXAMPLE"
        ],
        "ServiceRoleArn": "arn:aws:iam::123456789012:role/service-role/aws-opsworks-cm-service-role",
        "Status": "UNDER_MAINTENANCE",
        "SubnetIds": [
            "subnet-EXAMPLE"
        ],
        "ServerArn": "arn:aws:opsworks-cm:us-west-2:123456789012:server/automate-06/0148382d-66b0-4196-8274-d1a2b6dff8d1"
    }
}

Pour plus d'informations, voir Maintenance du système (serveurs Puppet Enterprise) ou Maintenance du système (serveurs Chef Automate) dans le guide de l'AWS OpsWorks utilisateur.

Pour API plus de détails, voir StartMaintenancela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-server-engine-attributes.

AWS CLI

Pour mettre à jour les attributs du moteur de serveur

La update-server-engine-attributes commande suivante met à jour la valeur de l'attribut CHEF_PIVOTAL_KEY du moteur pour un serveur Chef Automate nomméautomate-06. Il n'est actuellement pas possible de modifier la valeur des autres attributs du moteur.


aws opsworks-cm update-server-engine-attributes \
    --attribute-name CHEF_PIVOTAL_KEY \
    --attribute-value "new key value" \
    --server-name "automate-06"

Le résultat affiche des informations similaires aux suivantes concernant le serveur mis à jour.


{
    "Server": {
        "BackupRetentionCount": 2,
        "CreatedAt": 2016-07-29T13:38:47.520Z,
        "DisableAutomatedBackup": FALSE,
        "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com",
        "Engine": "Chef",
        "EngineAttributes": [
            {
                "Name": "CHEF_PIVOTAL_KEY",
                "Value": "new key value"
            }
        ],
        "EngineModel": "Single",
        "EngineVersion": "12",
        "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
        "InstanceType": "m4.large",
        "KeyPair": "",
        "MaintenanceStatus": "SUCCESS",
        "PreferredBackupWindow": "Mon:09:15",
        "PreferredMaintenanceWindow": "03:00",
        "SecurityGroupIds": [ "sg-1a24c270" ],
        "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2",
        "ServerName": "automate-06",
        "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
        "Status": "HEALTHY",
        "StatusReason": "",
        "SubnetIds": [ "subnet-49436a18" ]
    }
}

Pour plus d'informations, consultez UpdateServerEngineAttributesla APIréférence AWS OpsWorks for Chef Automate.

Pour API plus de détails, voir UpdateServerEngineAttributesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-server.

AWS CLI

Pour mettre à jour un serveur

La update-server commande suivante met à jour l'heure de début de la maintenance du serveur Chef Automate spécifié dans votre région par défaut. Le --preferred-maintenance-window paramètre est ajouté pour modifier le jour et l'heure de début de la maintenance du serveur au lundi à 9 h 15. UTC. :


aws opsworks-cm update-server \
    --server-name "automate-06" \
    --preferred-maintenance-window "Mon:09:15"

Le résultat affiche des informations similaires aux suivantes concernant le serveur mis à jour.


{
    "Server": {
        "BackupRetentionCount": 8,
        "CreatedAt": 2016-07-29T13:38:47.520Z,
        "DisableAutomatedBackup": TRUE,
        "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com",
        "Engine": "Chef",
        "EngineAttributes": [
            {
                "Name": "CHEF_DELIVERY_ADMIN_PASSWORD",
                "Value": "1Password1"
            }
        ],
        "EngineModel": "Single",
        "EngineVersion": "12",
        "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
        "InstanceType": "m4.large",
        "KeyPair": "",
        "MaintenanceStatus": "OK",
        "PreferredBackupWindow": "Mon:09:15",
        "PreferredMaintenanceWindow": "03:00",
        "SecurityGroupIds": [ "sg-1a24c270" ],
        "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2",
        "ServerName": "automate-06",
        "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
        "Status": "HEALTHY",
        "StatusReason": "",
        "SubnetIds": [ "subnet-49436a18" ]
    }
}

Pour plus d'informations, consultez UpdateServerla APIréférence AWS OpsWorks for Chef Automate.

Pour API plus de détails, voir UpdateServerla section Référence des AWS CLI commandes.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

AWS OpsWorks

Organizations