Plataformas personalizadas do Elastic Beanstalk (retirado)

Uma plataforma personalizada é uma personalização mais avançada do que uma imagem personalizada de várias maneiras. Uma plataforma personalizada permite que você desenvolva toda uma nova plataforma do zero, personalizando o sistema operacional, software adicional e scripts executados pelo Elastic Beanstalk em instâncias de plataforma. Essa flexibilidade permite que você crie uma plataforma para uma aplicação que usa uma linguagem ou outro software de infraestrutura para o qual o Elastic Beanstalk não oferece uma plataforma gerenciada. Compare isso a imagens personalizadas, em que você modifica uma imagem de máquina da Amazon (AMI) para uso com uma plataforma existente do Elastic Beanstalk, e o Elastic Beanstalk ainda oferece os scripts de plataforma e controla a pilha de software. Além disso, com plataformas personalizadas você usa uma maneira automatizada e com scripts de criar e manter a personalização, enquanto com imagens personalizadas você faz as alterações manualmente em uma instância em execução.

Para criar uma plataforma personalizada, crie uma AMI de um dos sistemas operacionais compatíveis: Ubuntu, RHEL ou Amazon Linux (consulte a entrada flavor em Formato do arquivo platform.yaml para ver os números de versão exatos), e inclua outras personalizações. Você cria sua própria plataforma Elastic Beanstalk usando o Packer, que é uma ferramenta de código aberto para criar imagens de máquina para várias plataformas, AMIs inclusive para uso com o Amazon Elastic Compute Cloud (Amazon). EC2 Uma plataforma do Elastic Beanstalk consiste em uma AMI configurada para executar um conjunto de software compatível com uma aplicação e metadados que podem incluir opções de configuração personalizadas e opções de configuração padrão.

O Elastic Beanstalk gerencia o Packer como uma plataforma integrada separada, e não é necessário se preocupar com a configuração e as versões do Packer.

Crie uma plataforma fornecendo ao Elastic Beanstalk um modelo do Packer, e os scripts e arquivos que o modelo invoca para criar uma AMI. Esses componentes são empacotados com um arquivo de definição de plataforma, que especifica o modelo e os metadados, em um arquivo ZIP, conhecido como arquivo de definição de plataforma.

Quando você cria uma plataforma personalizada, inicia um ambiente de uma única instância sem um IP elástico que executa o Packer. O Packer executa outra instância para criar uma imagem. Você pode reutilizar esse ambiente para várias plataformas e várias versões de cada plataforma.

Os usuários em sua conta podem utilizar suas Plataformas personalizadas especificando um Nome de região da Amazon (ARN) da Plataforma durante a criação do ambiente. Eles ARNs são retornados pelo eb platform create comando que você usou para criar a plataforma personalizada.

Cada vez que você cria sua plataforma personalizada, o Elastic Beanstalk cria uma nova versão dela. Os usuários podem especificar uma plataforma por nome para obter apenas a versão mais recente dela ou incluir um número de versão para obter uma versão específica.

Por exemplo, para implantar a versão mais recente da plataforma personalizada com o ARN MyCustomPlatformARN, que pode ser a versão 3.0, a linha de comando da CLI do EB seria assim:

eb create -p MyCustomPlatformARN

Para implantar a versão 2.1, a linha de comando da CLI do EB seria assim:

eb create -p MyCustomPlatformARN --version 2.1

Você pode aplicar tags a uma versão da plataforma personalizada ao criá-la e editar tags de versões existentes da plataforma personalizada. Para obter detalhes, consulte Atribuir tags em versões de plataforma personalizada.

Criar uma plataforma personalizada

Para criar uma plataforma personalizada, a raiz da sua aplicação deve incluir um arquivo de definição de plataforma platform.yaml, que define o tipo de criador usado para criar a plataforma personalizada. O formato desse arquivo está descrito no tópico Formato do arquivo platform.yaml. Você pode criar sua Plataforma personalizada do zero ou usar uma das Plataformas personalizadas de exemplo como ponto de partida.

Usar uma plataforma personalizada de exemplo

Uma alternativa para criar sua própria plataforma personalizada é usar um dos arquivos demonstrativos de definição de plataforma para inicializá-la. Os únicos itens que você precisa configurar nos exemplos para que você possa usá-las são uma AMI de origem e uma região.

Faça download do arquivo demonstrativo de definição da plataforma: NodePlatform_Ubuntu.zip. Esse arquivo contém um arquivo de definição de plataforma, um modelo do Packer, scripts executados pelo Packer durante a criação de imagens e scripts e arquivos de configuração copiados pelo Packer na instância do criador durante a criação da plataforma.

|-- builder                 Contains files used by Packer to create the custom platform
|-- custom_platform.json    Packer template
|-- platform.yaml           Platform definition file
|-- ReadMe.txt              Briefly describes the sample

O arquivo de definição da plataforma platform.yaml, informa ao Elastic Beanstalk o nome do modelo do Packer custom_platform.json.

version: "1.0"

provisioner:
  type: packer
  template: custom_platform.json
  flavor: ubuntu1604

O modelo do Packer explica ao Packer como criar o AMIs para a plataforma, usando uma AMI do Ubuntu como base para a imagem da plataforma para tipos de instância HVM. A seção provisioners instrui o Packer a copiar todos os arquivos na pasta builder dentro do arquivo para a instância e a executar o script builder.sh na instância. Quando os scripts são concluídos, o Packer cria uma imagem da instância modificada.

O Elastic Beanstalk cria três variáveis de ambiente que podem ser usadas para marcar no Packer: AMIs

O arquivo custom_platform.json de exemplo usa essas variáveis para definir os seguintes valores que ele utiliza nos scripts:

O arquivo custom_platform.json contém duas propriedades para as quais você precisa fornecer valores: source_ami e region. Para obter detalhes sobre como escolher os valores corretos de AMI e região, consulte Atualização do modelo do Packer no eb-custom-platforms-samples GitHub repositório.

{
  "variables": {
    "platform_name": "{{env `AWS_EB_PLATFORM_NAME`}}",
    "platform_version": "{{env `AWS_EB_PLATFORM_VERSION`}}",
    "platform_arn": "{{env `AWS_EB_PLATFORM_ARN`}}"
  },
  "builders": [
    {
      ...
      "region": "",
      "source_ami": "",
      ...
    }
  ],
  "provisioners": [
    {...},
    {
      "type": "shell",
      "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo {{ .Path }}",
      "scripts": [
        "builder/builder.sh"
      ]
    }
  ]
}

Os scripts e outros arquivos incluídos no arquivo de definição de plataforma variam muito de acordo com as modificações que você deseja fazer na instância. A plataforma de exemplo inclui os seguintes scripts:

Use a CLI do EB para criar sua primeira plataforma personalizada com o arquivo demonstrativo de definição de plataforma.

Quando a operação for concluída, você terá uma plataforma que poderá ser usada para executar um ambiente do Elastic Beanstalk.

Você pode usar a plataforma personalizada ao criar um ambiente do console. Consulte O assistente de criação de novo ambiente.

Conteúdo do arquivamento de definição da plataforma

Um arquivo de definição de plataforma é a plataforma equivalente a um pacote de origem de aplicação. O arquivo de definição de plataforma é um arquivo ZIP que contém um arquivo de definição de plataforma, um modelo do Packer e os scripts e arquivos usados pelo modelo do Packer para criar a plataforma.

O arquivo de definição de plataforma é um arquivo formatado em YAML que deve ser denominado platform.yaml e estar na raiz do arquivo de definição de plataforma. Consulte Criar uma plataforma personalizada para obter uma lista das chaves obrigatórias e opcionais compatíveis com um arquivo de definição de plataforma.

Você não precisa fornecer um nome específico ao modelo do Packer, mas o nome do arquivo deve corresponder ao modelo do provisionador especificado no arquivo de definição de plataforma. Consulte a documentação oficial do Packer para obter instruções sobre a criação de modelos.

Os outros arquivos no arquivo de definição de plataforma são scripts e arquivos usados pelo modelo para personalizar uma instância antes de criar uma AMI.

Hooks de plataforma personalizada

O Elastic Beanstalk usa uma estrutura de diretórios padronizada para hooks em plataformas personalizadas. Esses scripts são executados durante eventos de ciclo de vida e em resposta a operações de gerenciamento: quando as instâncias são executadas em seu ambiente ou quando um usuário inicia uma implantação ou usa o recurso de reinicialização do servidor de aplicativos.

Coloque os scripts que você deseja que os hooks acionem em uma das subpastas da pasta /opt/elasticbeanstalk/hooks/.

Os hooks são organizados nas seguintes pastas:

As pastas appdeploy, configdeploy e restartappserver contêm as subpastas pre, enact e post. Em cada fase de uma operação, todos os scripts na pasta pre são executados em ordem alfabética, em seguida os da pasta enact e depois os da pasta post.

Quando uma instância é iniciada, o Elastic Beanstalk executa preinit, appdeploy e postinit, nessa ordem. Nas implantações subsequentes às instâncias em execução, o Elastic Beanstalk executa hooks appdeploy. Os hooks configdeploy são executados quando um usuário atualiza as definições de configuração de software da instância. Os hooks restartappserver são executados somente quando o usuário inicia uma reinicialização do servidor de aplicativos.

Quando os scripts encontram erros, eles podem sair com um status diferente de zero e gravar no arquivo stderr para falhar a operação. A mensagem que você gravar no stderr é exibida no evento que é gerado quando a operação falha. O Elastic Beanstalk também captura essas informações no arquivo de log /var/log/eb-activity.log. Se você não deseja que a operação falhe, retorne 0. As mensagens que você gravar no stderr ou no stdout aparecerão nos logs de implantação, mas não aparecerão no stream de eventos, a menos que a operação falhe.

Limpeza da instância do Packer

Em determinadas circunstâncias, como interrupção do processo do construtor Packer antes de ser concluído, as instâncias executadas pelo Packer não serão limpas. Essas instâncias não fazem parte do ambiente do Elastic Beanstalk e só podem ser visualizadas e encerradas usando o serviço da Amazon. EC2

Formato do arquivo platform.yaml

O arquivo platform.yaml tem o seguinte formato.

version: "version-number"

provisioner:
   type: provisioner-type
   template: provisioner-template
   flavor: provisioner-flavor
        
metadata:
   maintainer: metadata-maintainer
   description: metadata-description
   operating_system_name: metadata-operating_system_name
   operating_system_version: metadata-operating_system_version
   programming_language_name: metadata-programming_language_name
   programming_language_version: metadata-programming_language_version
   framework_name: metadata-framework_name
   framework_version: metadata-framework_version

option_definitions:
   - namespace: option-def-namespace
     option_name: option-def-option_name
     description: option-def-description
     default_value: option-def-default_value

option_settings:
   - namespace: "option-setting-namespace"
     option_name: "option-setting-option_name"
     value: "option-setting-value"

Substitua os espaços reservados por esses valores:

Atribuir tags em versões de plataforma personalizada

Você pode aplicar tags às versões AWS Elastic Beanstalk personalizadas da sua plataforma. As tags são pares de valores-chave associados AWS aos recursos. Para obter informações sobre a atribuição de tags do recurso do Elastic Beanstalk, casos de uso, restrições de chave e valor de tag, além de tipos de recursos compatíveis, consulte Marcar recursos da aplicação do Elastic Beanstalk.

Você pode especificar tags quando criar uma versão da plataforma personalizada. Em uma versão da plataforma personalizada existente, você pode adicionar ou remover tags e atualizar os valores de tags existentes. Você pode adicionar até 50 tags para cada versão da plataforma personalizada.

Adicionar tags durante a criação da versão da plataforma personalizada

Se você usar a CLI do EB para criar a versão da plataforma personalizada, use a opção --tags com eb platform create para adicionar tags.

~/workspace/my-app$ eb platform create --tags mytag1=value1,mytag2=value2

Com o AWS CLI ou outros clientes baseados em API, adicione tags usando o --tags parâmetro no create-platform-version comando.

$ aws elasticbeanstalk create-platform-version \
      --tags Key=mytag1,Value=value1 Key=mytag2,Value=value2 \
      --platform-name my-platform --platform-version 1.0.0 --platform-definition-bundle S3Bucket=amzn-s3-demo-bucket,S3Key=sample.zip

Gerenciar tags de uma versão da plataforma personalizada existente

É possível adicionar, atualizar e excluir tags em uma versão da plataforma personalizada existente do Elastic Beanstalk.

Se você usar a CLI do EB para atualizar a versão da plataforma personalizada, use eb tags para adicionar, atualizar, excluir ou listar tags.

Por exemplo, o comando a seguir lista as tags em uma versão da plataforma personalizada.

~/workspace/my-app$ eb tags --list --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

O comando a seguir atualiza a tag mytag1 e exclui a tag mytag2.

~/workspace/my-app$ eb tags --update mytag1=newvalue --delete mytag2 \
      --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

Para obter uma lista de opções e mais exemplos, consulte eb tags.

Com o AWS CLI ou outros clientes baseados em API, use o list-tags-for-resource comando para listar as tags de uma versão personalizada da plataforma.

$ aws elasticbeanstalk list-tags-for-resource --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

Use o comando update-tags-for-resource para adicionar, atualizar ou excluir tags em uma versão da plataforma personalizada.

$ aws elasticbeanstalk update-tags-for-resource \
      --tags-to-add Key=mytag1,Value=newvalue --tags-to-remove mytag2 \
      --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

Especifique as tags a serem adicionadas e atualizadas no parâmetro --tags-to-add do update-tags-for-resource. Uma tag não existente é adicionada, e o valor de uma tag existente é atualizado.

$ aws elasticbeanstalk list-platform-versions

eb create -p MyCustomPlatformARN

eb create -p MyCustomPlatformARN --version 2.1

|-- builder                 Contains files used by Packer to create the custom platform
|-- custom_platform.json    Packer template
|-- platform.yaml           Platform definition file
|-- ReadMe.txt              Briefly describes the sample

version: "1.0"

provisioner:
  type: packer
  template: custom_platform.json
  flavor: ubuntu1604

{
  "variables": {
    "platform_name": "{{env `AWS_EB_PLATFORM_NAME`}}",
    "platform_version": "{{env `AWS_EB_PLATFORM_VERSION`}}",
    "platform_arn": "{{env `AWS_EB_PLATFORM_ARN`}}"
  },
  "builders": [
    {
      ...
      "region": "",
      "source_ami": "",
      ...
    }
  ],
  "provisioners": [
    {...},
    {
      "type": "shell",
      "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo {{ .Path }}",
      "scripts": [
        "builder/builder.sh"
      ]
    }
  ]
}

version: "version-number"

provisioner:
   type: provisioner-type
   template: provisioner-template
   flavor: provisioner-flavor
        
metadata:
   maintainer: metadata-maintainer
   description: metadata-description
   operating_system_name: metadata-operating_system_name
   operating_system_version: metadata-operating_system_version
   programming_language_name: metadata-programming_language_name
   programming_language_version: metadata-programming_language_version
   framework_name: metadata-framework_name
   framework_version: metadata-framework_version

option_definitions:
   - namespace: option-def-namespace
     option_name: option-def-option_name
     description: option-def-description
     default_value: option-def-default_value

option_settings:
   - namespace: "option-setting-namespace"
     option_name: "option-setting-option_name"
     value: "option-setting-value"

~/workspace/my-app$ eb platform create --tags mytag1=value1,mytag2=value2

$ aws elasticbeanstalk create-platform-version \
      --tags Key=mytag1,Value=value1 Key=mytag2,Value=value2 \
      --platform-name my-platform --platform-version 1.0.0 --platform-definition-bundle S3Bucket=amzn-s3-demo-bucket,S3Key=sample.zip

~/workspace/my-app$ eb tags --list --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

~/workspace/my-app$ eb tags --update mytag1=newvalue --delete mytag2 \
      --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

$ aws elasticbeanstalk list-tags-for-resource --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

$ aws elasticbeanstalk update-tags-for-resource \
      --tags-to-add Key=mytag1,Value=newvalue --tags-to-remove mytag2 \
      --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

$ aws elasticbeanstalk list-platform-versions