AWS OpsWorks CM exemplos usando AWS CLI - AWS SDKExemplos de código
Ações

Há mais AWS SDK exemplos disponíveis no GitHub repositório AWS Doc SDK Examples.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AWS OpsWorks CM exemplos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with AWS OpsWorks CM.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, é possível ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar associate-node.

AWS CLI

Para associar nós

O associate-node comando a seguir associa um nó nomeado i-44de882p a um servidor Chef Automate chamadoautomate-06, o que significa que o automate-06 servidor gerencia o nó e comunica comandos de receita ao nó por meio do software chef-client agente que é instalado no nó pelo comando associate-node. Os nomes de nós válidos são EC2 instânciasIDs. :

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'"

A saída retornada pelo comando é semelhante à seguinte. Saída:

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

Mais informações

Para obter mais informações, consulte Adicionando nós automaticamente ao Chef Automate no Guia do AWS OpsWorks usuário. AWS OpsWorks

  • Para API obter detalhes, consulte AssociateNodena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-backup.

AWS CLI

Para criar backups

O create-backup comando a seguir inicia um backup manual de um servidor Chef Automate nomeado automate-06 na us-east-1 região. O comando adiciona uma mensagem descritiva ao backup no --description parâmetro.

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

A saída mostra informações semelhantes às seguintes sobre o novo backup.

Saída:

{
    "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"
        }
    ],
}

Para obter mais informações, consulte Fazer backup e restaurar um AWS OpsWorks para o Chef Automate Server no Guia do AWS OpsWorks usuário.

  • Para API obter detalhes, consulte CreateBackupna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-server.

AWS CLI

Para criar um servidor

O create-server exemplo a seguir cria um novo servidor Chef Automate chamado automate-06 em sua região padrão. Observe que os padrões são usados para a maioria das outras configurações, como o número de backups a serem retidos e os horários de início da manutenção e do backup. Antes de executar um create-server comando, preencha os pré-requisitos em Introdução ao Chef Automate no Guia do usuário do AWS Opsworks 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"

A saída mostra informações semelhantes às seguintes sobre o novo servidor:

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

Para obter mais informações, consulte UpdateServera APIReferência do AWS OpsWorks Chef Automate.

  • Para API obter detalhes, consulte CreateServerna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-backup.

AWS CLI

Para excluir backups

O delete-backup comando a seguir exclui um backup manual ou automatizado de um servidor Chef Automate, identificado pelo ID de backup. Esse comando é útil quando você está se aproximando do número máximo de backups que você pode salvar ou deseja minimizar os custos de armazenamento do Amazon S3. :

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

A saída mostra se a exclusão do backup foi bem-sucedida.

Mais informações

Para obter mais informações, consulte Fazer backup e restaurar um AWS OpsWorks para o Chef Automate Server no Guia do AWS OpsWorks usuário.

  • Para API obter detalhes, consulte DeleteBackupna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-server.

AWS CLI

Para excluir servidores

O delete-server comando a seguir exclui um servidor Chef Automate, identificado pelo nome do servidor. Depois que o servidor é excluído, ele não é mais retornado pelas DescribeServer solicitações. :

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

A saída mostra se a exclusão do servidor foi bem-sucedida.

Mais informações

Para obter mais informações, consulte Excluir um AWS OpsWorks para o Chef Automate Server no Guia do AWS OpsWorks Usuário.

  • Para API obter detalhes, consulte DeleteServerna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-account-attributes.

AWS CLI

Como descrever os atributos da conta

O describe-account-attributes comando a seguir retorna informações sobre o uso de recursos do Chef Automate AWS OpsWorks pela sua conta. :

aws opsworks-cm describe-account-attributes

A saída para cada entrada de atributo de conta retornada pelo comando é semelhante à seguinte. Saída:

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

Mais informações

Para obter mais informações, consulte DescribeAccountAttributes a APIReferência do AWS OpsWorks Chef Automate.

O código de exemplo a seguir mostra como usar describe-backups.

AWS CLI

Para descrever os backups

O describe-backups comando a seguir retorna informações sobre todos os backups associados à sua conta na sua região padrão.

aws opsworks-cm describe-backups

A saída de cada entrada de backup retornada pelo comando é semelhante à seguinte.

Saída:

{
    "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"
        }
    ],
}

Para obter mais informações, consulte Fazer backup e restaurar um AWS OpsWorks para o Chef Automate Server no Guia do AWS OpsWorks usuário.

  • Para API obter detalhes, consulte DescribeBackupsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-events.

AWS CLI

Para descrever eventos

O describe-events exemplo a seguir retorna informações sobre todos os eventos associados ao servidor Chef Automate especificado.

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

A saída para cada entrada de evento retornada pelo comando é semelhante ao exemplo a seguir:

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

Para obter mais informações, consulte Dicas gerais de solução de problemas no Guia AWS OpsWorks do usuário.

  • Para API obter detalhes, consulte DescribeEventsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-node-association-status.

AWS CLI

Para descrever o status da associação de nós

O describe-node-association-status comando a seguir retorna o status de uma solicitação para associar um nó a um servidor Chef Automate chamadoautomate-06. :

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

A saída para cada entrada de atributo de conta retornada pelo comando é semelhante à seguinte. Saída:

{
 "NodeAssociationStatus": "IN_PROGRESS"
}

Mais informações

Para obter mais informações, consulte DescribeNodeAssociationStatus a APIReferência do AWS OpsWorks Chef Automate.

O código de exemplo a seguir mostra como usar describe-servers.

AWS CLI

Para descrever servidores

O describe-servers comando a seguir retorna informações sobre todos os servidores associados à sua conta e em sua região padrão. :

aws opsworks-cm describe-servers

A saída para cada entrada do servidor retornada pelo comando é semelhante à seguinte. Saída:

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

Mais informações

Para obter mais informações, consulte DescribeServers o AWS OpsWorks APIGuia do Chef Automate.

  • Para API obter detalhes, consulte DescribeServersna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar disassociate-node.

AWS CLI

Para desassociar nós

O disassociate-node comando a seguir desassocia um nó chamadoi-44de882p, removendo o nó do gerenciamento por um servidor Chef Automate chamado. automate-06 Os nomes de nós válidos são EC2 instânciasIDs. :

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'"

A saída retornada pelo comando é semelhante à seguinte. Saída:

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

Mais informações

Para obter mais informações, consulte Excluir um AWS OpsWorks para o Chef Automate Server no Guia do AWS OpsWorks Usuário.

  • Para API obter detalhes, consulte DisassociateNodena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar restore-server.

AWS CLI

Para restaurar um servidor

O restore-server comando a seguir executa uma restauração local de um servidor Chef Automate nomeado automate-06 em sua região padrão a partir de um backup com um ID de. automate-06-2016-11-22T16:13:27.998Z A restauração de um servidor restaura as conexões com os nós que o servidor Chef Automate estava gerenciando no momento em que o backup especificado foi executado.

aws opsworks-cm restore-server --backup-id “Automate-06-2016-11-22T 16:13:27.998 Z” --nome do servidor “automate-06"

A saída é somente o ID do comando. Saída:

(None)

Mais informações

Para obter mais informações, consulte Restaurar uma falha AWS OpsWorks para o Chef Automate Server no Guia do AWS OpsWorks usuário.

  • Para API obter detalhes, consulte RestoreServerna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar start-maintenance.

AWS CLI

Para iniciar a manutenção

O start-maintenance exemplo a seguir inicia manualmente a manutenção no servidor Chef Automate ou Puppet Enterprise especificado em sua região padrão. Esse comando é útil se uma tentativa anterior de manutenção automatizada falhar e a causa subjacente da falha de manutenção tiver sido resolvida.

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

Saída:

{
    "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"
    }
}

Para obter mais informações, consulte Manutenção do sistema (servidores Puppet Enterprise) ou Manutenção do sistema (servidores Chef Automate) no Guia do AWS OpsWorks usuário.

  • Para API obter detalhes, consulte StartMaintenancena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-server-engine-attributes.

AWS CLI

Para atualizar os atributos do mecanismo do servidor

O update-server-engine-attributes comando a seguir atualiza o valor do atributo CHEF_PIVOTAL_KEY do mecanismo para um servidor Chef Automate chamadoautomate-06. Atualmente, não é possível alterar o valor de outros atributos do mecanismo.

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

A saída mostra informações semelhantes às seguintes sobre o servidor atualizado.

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

Para obter mais informações, consulte UpdateServerEngineAttributesa APIReferência do AWS OpsWorks Chef Automate.

O código de exemplo a seguir mostra como usar update-server.

AWS CLI

Para atualizar um servidor

O update-server comando a seguir atualiza a hora de início da manutenção do servidor Chef Automate especificado em sua região padrão. O --preferred-maintenance-window parâmetro é adicionado para alterar o dia e a hora de início da manutenção do servidor para segundas-feiras às 9h15. UTC. :

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

A saída mostra informações semelhantes às seguintes sobre o servidor atualizado.

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

Para obter mais informações, consulte UpdateServera APIReferência do AWS OpsWorks Chef Automate.

  • Para API obter detalhes, consulte UpdateServerna Referência de AWS CLI Comandos.