Fazer upgrade dos ambientes

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Esta página descreve como fazer upgrade do seu ambiente para uma nova versão do Cloud Composer ou do Airflow.

Sobre as operações de upgrade

É possível fazer upgrade das versões do Cloud Composer e do Airflow ou ambos ao mesmo tempo.

Ao mudar a versão do Airflow ou do Cloud Composer usada pelo seu ambiente:

  • O Cloud Composer reimplanta os componentes do ambiente usando novas versões de imagens do Cloud Composer.

  • O Cloud Composer aplica alterações de configuração do Airflow, como com substituições de pacotes PyPI personalizados ou opções de configuração do Airflow, que as tinham 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.

O upgrade não muda a maneira 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:

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

  • No console do Google Cloud, só é possível fazer upgrade para a versão com suporte mais recente diferentes do Cloud Composer.

  • Na CLI, API ou Terraform do Google Cloud, é possível fazer upgrade de um ambiente para as versões mais recentes com suporte, três versões anteriores do Cloud Composer, 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 Cloud Composer, mesmo que elas ainda tenham suporte e possam ser usadas para criar um novo ambiente.

  • A versão para a qual você vai fazer upgrade precisa oferecer suporte à 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 sendo alcançado, solicite a extensão de cota antes de prosseguir com a operação de upgrade.

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

  • Não será possível fazer upgrade do ambiente se o banco de dados do Airflow tiver mais de 16 GB de dados. Durante o upgrade, um aviso é mostrado 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 do banco de dados.

  • Se você usar o mecanismo XCom para transferir arquivos, certifique-se de usá-la de acordo com as diretrizes do Airflow. A transferência de arquivos grandes ou de um grande número de arquivos usando o XCom afeta a performance do banco de dados do Airflow e pode causar falhas ao carregar instantâneos ou fazer upgrade do ambiente. Considere usar alternativas como para transferir grandes volumes de dados.

Antes de começar

  • Recomendamos criar um novo snapshot do ambiente para poder recriar o ambiente, caso necessário.

  • Sua conta precisa ter um papel que acione 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 mostra avisos quando a imagem do seu ambiente estiver perto do fim da data de suporte total. Você pode usar esses avisos para sempre manter o ambiente com suporte.

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

O Cloud Composer monitora os Versão da imagem do Cloud Composer em que o ambiente é baseado. Quando a imagem estiver próxima do fim da data de suporte, você vai receber 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 na CLI do Google Cloud. Você pode Confira os upgrades disponíveis, que mostra as novas versões que estão disponíveis.

API

Essa funcionalidade não está disponível pela API. Você pode ver os upgrades disponíveis, que mostram 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 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 acessar a lista de versões disponíveis, clique no nome do Cloud Composer Menu suspenso Versão da imagem.

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 fazer isso, construa uma imageVersions.list.

Exemplo:

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

Verificar conflitos de pacote PyPI antes de fazer upgrade

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

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 do 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 Cloud Composer para a qual você 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 de imagem do Cloud Composer para a qual você quer fazer upgrade.

gcloud composer environments check-upgrade \
  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 Cloud Composer para o qual você quer fazer o upgrade, no objeto composer-a.b.c-airflow-x.y.z . Também é possível usar todos os aliases de versão.

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: 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, em o 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 Cloud Composer ou 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 seu 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 do Cloud Composer para os quais você quer fazer o 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 Cloud Composer para o qual você quer fazer o upgrade, no objeto composer-a.b.c-airflow-x.y.z . Também é possível usar todas 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 Máscara config.softwareConfig.imageVersion.

    2. No corpo da solicitação, no campo imageVersion, especifique um novo para a qual 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-1.20.12-airflow-1.10.15"
      }
    }
  }

Terraform

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

  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 da imagem do Cloud Composer para a qual você quer fazer upgrade, no formato composer-a.b.c-airflow-x.y.z. Também é possível usar todas aliases de versão.

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