Fazer upgrade dos ambientes

Airflow gerenciado (Geração 3) | Airflow gerenciado (Geração 2) | Airflow gerenciado (Geração 1 legada)

Nesta página, descrevemos como fazer upgrade do seu ambiente para uma nova versão do Airflow Gerenciado ou do Airflow.

Sobre as operações de upgrade

É possível fazer upgrade da versão do Airflow Gerenciado, da versão do Airflow ou de ambos ao mesmo tempo.

Quando você muda a versão do Airflow ou do Airflow Gerenciado usada pelo seu ambiente:

  • O Airflow Gerenciado reimplanta os componentes do ambiente usando novas versões das imagens do Airflow Gerenciado.

  • O Airflow Gerenciado aplica mudanças de configuração do Airflow, como pacotes PyPI personalizados ou substituições de opções de configuração do Airflow, se o ambiente os tinha antes do upgrade.

  • O Airflow Gerenciado atualiza a conexão airflow_db do Airflow para apontar para o novo banco de dados do Cloud SQL.

O upgrade não muda a forma como você se conecta aos recursos do seu ambiente, como o URL do bucket do ambiente ou o servidor da Web do Airflow.

Limitações das operações de upgrade

As operações de upgrade têm as seguintes limitações:

  • Os lançamentos do Airflow Gerenciado são lançados gradualmente em todas as regiões compatíveis com o Airflow Gerenciado ao longo de vários dias. A versão mais recente de um lançamento em andamento pode ainda não estar disponível na sua região.

  • Não é possível fazer downgrade para uma versão anterior do Airflow Gerenciado ou do Airflow.

  • No console Google Cloud , só é possível fazer upgrade para as versões mais recentes compatíveis do Airflow Gerenciado (Geração 2).

  • Na CLI do Google Cloud, na API ou no Terraform, é possível fazer upgrade de um ambiente para as versões mais recentes compatíveis, três versões anteriores do Airflow Gerenciado (Geração 2), a última versão de patch da versão secundária anterior e para versões com um cronograma de upgrade estendido. Não é possível fazer upgrade para outras versões do Airflow gerenciado (Geração 2), mesmo que elas ainda tenham suporte e possam ser usadas para criar um novo ambiente.

    Exemplo de opções de upgrade para a Google Cloud CLI, a API e o Terraform:

    • Versões mais recentes: composer-2.11.5-airflow-*
    • Três versões anteriores do Airflow gerenciado (Geração 2): composer-2.11.4-airflow-*, composer-2.11.3-airflow-*, composer-2.11.2-airflow-*.
    • Último patch da versão secundária anterior do Airflow gerenciado (Geração 2): composer-2.10.2-airflow-*
    • Versões do Airflow gerenciado (Geração 2) com um cronograma de upgrade estendido: composer-2.10.2-airflow-*, composer-2.10.1-ariflow-*, composer-2.9.7-airflow-* e outras versões com um cronograma de upgrade estendido.

  • A versão para a qual você vai fazer upgrade precisa ser compatível com a versão atual do Python do seu ambiente.

  • Os limites de cota da API Compute Engine podem impedir upgrades. No console do Google Cloud , acesse a página IAM e administrador > Cotas e limites do sistema e verifique se a cota da API Compute Engine para CPU não foi excedida. Se o limite de cota estiver se aproximando, solicite uma extensão antes de prosseguir com a operação de upgrade.

  • Não é possível fazer upgrade para uma versão principal diferente do Airflow Gerenciado ou do Airflow no local. É possível transferir manualmente DAGs e configurações entre ambientes. Para mais informações, consulte:

  • Não é possível fazer upgrade do ambiente se o banco de dados do Airflow tiver mais de 16 GB de dados. Durante um upgrade, um aviso será exibido se o tamanho do banco de dados do Airflow for maior que 16 GB. Nesse caso, faça a manutenção do banco de dados para reduzir o tamanho dele.

  • Se você usar o mecanismo XCom para transferir arquivos, use-o de acordo com as diretrizes do Airflow. A transferência de arquivos grandes ou de um grande número de arquivos usando XCom afeta o desempenho do banco de dados do Airflow e pode causar falhas ao carregar snapshots ou fazer upgrade do ambiente. Considere usar alternativas como o Cloud Storage para transferir grandes volumes de dados.

Antes de começar

  • Recomendamos criar um novo snapshot do ambiente para poder recriá-lo, se necessário.

  • Sua conta precisa ter um papel que acione operações de upgrade de ambiente. Além disso, a conta de serviço do ambiente precisa ter um papel com permissões suficientes para executar operações de upgrade. Consulte Controle de acesso para mais informações.

Verificar se o ambiente está atualizado

O Airflow gerenciado mostra avisos quando a imagem do ambiente se aproxima da data de término do suporte completo. Você pode usar esses avisos para sempre manter seu ambiente compatível.

Uma mensagem de suspensão de uso é exibida na página de detalhes do ambiente.
Figura 1. Uma mensagem de suspensão de uso é exibida na página de detalhes do ambiente.

O Airflow Gerenciado monitora a versão da imagem do Airflow Gerenciado em que seu ambiente se baseia. Quando estiver próxima do fim da data de suporte, você verá um aviso na lista de ambientes e na página Detalhes do ambiente.

Para verificar se o ambiente está atualizado:

Console

  1. No console Google Cloud , acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do seu ambiente. A página Detalhes do ambiente é aberta.

  3. Acesse a guia Configuração do ambiente.

  4. No campo Versão da imagem, uma das seguintes mensagens será exibida:

    • Versão mais nova disponível. A imagem do ambiente é totalmente compatível.

    • Nova versão disponível. A imagem do ambiente é totalmente compatível e é possível fazer upgrade dela para uma versão posterior.

    • O suporte para esta versão de imagem termina em... A imagem do ambiente se aproxima do final do período de suporte completo.

    • Esta versão não é compatível desde... Seu ambiente já passou do período de suporte completo.

gcloud

Essa funcionalidade não está disponível na Google Cloud CLI. Você pode conferir os upgrades sugeridos, que mostram as novas versões disponíveis.

API

Essa funcionalidade não está disponível por API. Você pode conferir os upgrades sugeridos, que mostram as novas versões disponíveis.

Ver upgrades sugeridos

O Airflow Gerenciado oferece uma lista de versões do Airflow Gerenciado para as quais é possível fazer upgrade do seu ambiente.

Para conferir as versões do Airflow Gerenciado sugeridas para um upgrade:

Console

  1. No console Google Cloud , acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do seu ambiente. A página Detalhes do ambiente é aberta.

  3. Acesse a guia Configuração do ambiente e clique em Fazer upgrade da versão da imagem.

  4. Para conferir a lista de versões sugeridas, clique no menu suspenso versão de imagem do Airflow Gerenciado.

gcloud 

gcloud composer environments list-upgrades \
  ENVIRONMENT_NAME \
  --location LOCATION

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado;

Exemplo:

gcloud composer environments list-upgrades example-environment \
  --location us-central1

API

É possível conferir as versões disponíveis para um local. Para isso, crie uma solicitação de API imageVersions.list.

Exemplo:

// GET https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/imageVersions

Verificar conflitos de pacotes PyPI

É possível verificar se os pacotes PyPI instalados no ambiente têm conflitos com pacotes pré-instalados na nova imagem do Airflow Gerenciado.

Uma verificação bem-sucedida significa que não há conflitos nas dependências de pacote PyPI entre a versão atual e a especificada. No entanto, uma operação de upgrade ainda pode não ser bem-sucedida devido a outros motivos.

Console

Para executar uma verificação de upgrade no ambiente:

  1. No console Google Cloud , acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do seu ambiente. A página Detalhes do ambiente é aberta.

  3. Acesse a guia Configuração do ambiente, localize a entrada Versão da imagem e clique em Fazer upgrade.

  4. Na caixa de diálogo Upgrade da versão do ambiente, na lista suspensa Nova versão, selecione uma versão do Airflow Gerenciado para a qual quer fazer upgrade.

  5. Na seção Compatibilidade de pacotes PyPI, clique em Verificar conflitos.

  6. Aguarde a conclusão da verificação. Se houver conflitos de dependência de pacote PyPI, as mensagens de erro exibidas conterão detalhes sobre pacotes conflitantes e versões de pacotes.

gcloud

Para executar uma verificação de upgrade no ambiente, execute o comando environments check-upgrade com a versão da imagem do Airflow Gerenciado para a qual você quer fazer upgrade.

gcloud composer environments check-upgrade \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --image-version VERSION

Substitua:

Exemplo:

gcloud composer environments check-upgrade example-environment \
  --location us-central1 \
  --image-version composer-1.20.12-airflow-1.10.15

Exemplo de saída:

Waiting for [projects/example-project/locations/us-central1/environments/
example-environment] to be checked for PyPI package conflicts when upgrading
to composer-1.20.12-airflow-1.10.15. Operation [projects/example-project/locations/
us-central1/operations/04d0e8b2-...]...done.
...

Response:
'@type': type.googleapis.com/
google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse
buildLogUri: ...
containsPypiModulesConflict: CONFLICT
pypiConflictBuildLogExtract: |-
The Cloud Build image build failed: Build failed; check build logs for
details. Full log can be found at ...
Error details: tensorboard 2.2.2 has requirement
setuptools>=41.0.0, but you have setuptools 40.3.0.

Como alternativa, é possível executar uma verificação de upgrade de forma assíncrona. Use o argumento --async para fazer uma chamada assíncrona e verifique o resultado com o comando gcloud composer operations describe.

API

Crie uma solicitação de API environments.checkUpgrade.

Especifique a versão da imagem no campo imageVersion:

{
  "imageVersion": "VERSION"
}

Substitua VERSION pela nova versão para a qual você quer fazer upgrade, no formato composer-a.b.c-airflow-x.y.z.

Fazer upgrade do ambiente

Para fazer upgrade do seu ambiente para uma versão mais recente do Airflow Gerenciado ou do Airflow:

Console

  1. No console Google Cloud , acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do seu ambiente. A página Detalhes do ambiente é aberta.

  3. Acesse a guia Configuração do ambiente.

  4. Localize o item versão de imagem e clique em Fazer upgrade.

  5. No menu suspenso Versão da imagem, selecione uma versão do Airflow Gerenciado para fazer upgrade.

  6. Clique em Fazer upgrade.

gcloud 

gcloud composer environments update \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --image-version VERSION

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado;
  • VERSION com a nova versão de imagem do Airflow Gerenciado para a qual você quer fazer upgrade, no formato composer-a.b.c-airflow-x.y.z. Também é possível usar todos os aliases de versão.

Exemplo:

gcloud composer environments update
  example-environment \
  --location us-central1 \
  --image-version composer-1.20.12-airflow-1.10.15

API

  1. Crie uma solicitação de API environments.patch.

  2. Nesta solicitação:

    1. No parâmetro updateMask, especifique a máscara config.softwareConfig.imageVersion.

    2. No corpo da solicitação, no campo imageVersion, especifique uma nova versão para fazer upgrade.

Exemplo:

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.softwareConfig.imageVersion

  {
    "config": {
      "softwareConfig": {
        "imageVersion": "composer-1.20.12-airflow-1.10.15"
      }
    }
  }

Terraform

O campo image_version no bloco config.software_config controla a imagem do Airflow Gerenciado do seu ambiente. Nesse campo, especifique uma nova imagem do Airflow Gerenciado. 

  resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {
    software_config {
      image_version = "VERSION"
    }
  }
}

Substitua:

Exemplo:

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {
    software_config {
      image_version = "composer-1.20.12-airflow-1.10.15"
    }
  }
}

A seguir