Fazer upgrade dos ambientes

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

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

Sobre as operações de upgrade

No Cloud Composer 3, você não gerencia a versão do Cloud Composer do seu ambiente:

  • O Cloud Composer faz o upgrade automático dos componentes de infraestrutura do seu ambiente. Esses componentes estão relacionados à funcionalidade do Cloud Composer e não alteram o funcionamento do Airflow ou a execução dos DAGs do Airflow.
  • O Cloud Composer não faz o upgrade automático da versão e do build do Airflow, dos componentes do Airflow ou relacionados às cargas de trabalho do Airflow. Eles não são alterados quando os componentes de infraestrutura são atualizados automaticamente.
  • É possível fazer upgrade manualmente para uma nova versão ou build do Airflow.

Por exemplo, é possível usar a mesma versão e build do Airflow por vários meses, sem fazer upgrades, e o ambiente ainda recebe as atualizações, correções e melhorias mais recentes do Cloud Composer dos componentes de infraestrutura do ambiente. Quando depois decidir mover para uma nova versão ou um build do Airflow, você faz upgrade da versão do Airflow em seu ambiente.

Sobre o upgrade da versão do Airflow

Seu ambiente altera a versão ou o build do Airflow da seguinte maneira:

  • Você controla a versão (e o build) do Airflow do ambiente. É possível realizar a operação de upgrade da versão do Airflow ao alternar seu ambiente para uma versão diferente do Airflow. Por exemplo, isso pode acontecer se a versão atual e o build do Airflow não forem mais compatíveis.

  • O Cloud Composer reimplanta os componentes do Airflow do ambiente usando a versão e o build especificados do Airflow.

  • O Cloud Composer aplicará alterações de configuração do Airflow, como pacotes PyPI personalizados ou substituições de opções de configuração do Airflow, se o ambiente as tiver antes do upgrade.

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

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

Sobre operações de upgrade automático de infraestrutura

O Cloud Composer executa periodicamente operações de upgrade automático de infraestrutura:

  • As operações de upgrade automático da infraestrutura são executadas periodicamente durante as janelas de manutenção especificadas para o ambiente.

  • Não é possível desativar os upgrades automáticos de infraestrutura no Cloud Composer 3. É possível controlar os períodos em que os upgrades automáticos podem ser executados especificando janelas de manutenção personalizadas para o ambiente.

  • Essa operação é visível no console do Google Cloud e nos registros do ambiente, como qualquer outra operação de longa duração. Enquanto a operação estiver em execução, não será possível iniciar outras operações no nível do ambiente, mas ainda será possível executar DAGs do Airflow.

  • Os upgrades automáticos de infraestrutura não interrompem os componentes do Airflow ou as tarefas já em execução do Airflow. Um upgrade pode resultar em um curto período de indisponibilidade dos componentes de infraestrutura do ambiente, como o monitoramento dele.

Limitações das operações de upgrade

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

  • não é possível fazer downgrade para uma versão ou um build anterior do Airflow.

  • Não será 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, realize a manutenção do banco de dados para reduzir o tamanho dele.

Antes de começar

  • Recomendamos criar um novo snapshot do ambiente para recriá-lo caso isso seja necessário.

  • Sua conta precisa ter um papel que possa acionar operações de upgrade do 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. Para mais informações, consulte Controle de acesso.

Verificar se o ambiente está atualizado

O Cloud Composer exibe avisos quando o build do Airflow do ambiente está próximo da data de término do suporte. Use esses avisos para sempre manter seu ambiente compatível.

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

O Cloud Composer monitora a versão do Airflow e o build em que seu ambiente é baseado. Quando a data de fim do suporte estiver próxima, 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 do Google Cloud, acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do 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 pela Google Cloud CLI. Em vez disso, você pode Ver os upgrades disponíveis, que mostra as novas versões disponíveis.

API

Essa funcionalidade não está disponível pela API. Em vez disso, você pode Ver os upgrades disponíveis, que mostra as novas versões disponíveis.

Mostrar upgrades disponíveis

Para ver para quais versões do Cloud Composer é possível fazer upgrade, siga estas etapas:

Console

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

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do 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 ver a lista de versões disponíveis, clique no menu suspenso Versão de imagem do Cloud Composer.

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 consultar 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

Verifique se há conflitos de pacotes PyPI antes de fazer upgrade

É possível verificar se os pacotes PyPI instalados no ambiente têm conflitos com os pré-instalados na nova versão ou compilação do Airflow.

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

Console

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

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

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do 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 ou build do Airflow para 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 seu ambiente, execute o comando environments check-upgrade com a versão ou o build do Airflow para que você quer fazer upgrade.

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

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado;
  • VERSION pela nova versão e build do Airflow para que você quer fazer upgrade, no formato airflow-x.y.z-build.t. Você também pode usar todos os aliases de versão.

Exemplo:

gcloud composer environments check-upgrade example-environment \
  --location us-central1 \
  --airflow-version airflow-2.7.3-build.6

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-3-airflow-2.7.3-build.6. Operation [projects/example-project/locations/
us-central1/operations/04d0e8b2-...]...done.
...

Response:
'@type': type.googleapis.com/
google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse
buildLogUri: https://console.cloud.google.com/cloud-build/builds/79738aa7-...
containsPypiModulesConflict: CONFLICT
pypiConflictBuildLogExtract: |-
The Cloud Build image build failed: Build failed; check build logs for
details. Full log can be found at https://console.cloud.google.com/
cloud-build/builds/79738aa7-...
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-3-airflow-x.y.z-build.t.

Fazer upgrade do ambiente

Para fazer upgrade do ambiente para uma nova versão ou build do Airflow:

Console

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

    Acessar "Ambientes"

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

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

  4. Localize o item Versão da imagem e clique em Fazer upgrade.

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

  6. Clique em Fazer upgrade.

gcloud 

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

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado;
  • VERSION pela nova versão e build do Airflow para que você quer fazer upgrade, no formato airflow-x.y.z-build.t. Você também pode usar todos os aliases de versão.

Exemplo:

gcloud composer environments update
  example-environment \
  --location us-central1 \
  --airflow-version airflow-2.7.3-build.6

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 que você quer 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-3-airflow-2.7.3-build.6"
      }
    }
  }

Terraform

O campo image_version no bloco config.software_config controla a versão do Airflow e o build do ambiente. Nesse campo, especifique uma nova versão e um build do Airflow. 

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

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

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado; a nova versão e build do Airflow para que você quer fazer upgrade, no formato airflow-x.y.z-build.t. Você também pode usar todos os aliases de versão.

Exemplo:

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

  config {
    software_config {
      image_version = "airflow-2.7.3-build.6"
    }
  }
}

A seguir