Memecahkan masalah penginstalan paket PyPI

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

Halaman ini menjelaskan cara memecahkan masalah konflik dependensi saat menginstal paket PyPI kustom.

Masalah paling umum pada paket PyPI yang mungkin Anda temui di Cloud Composer adalah konflik dependensi.

Saat Anda menentukan paket PyPI kustom baru untuk diinstal, paket ini atau versinya dapat menyebabkan konflik dependensi dengan paket PyPI kustom lainnya atau paket yang sudah diinstal sebelumnya di lingkungan Anda. Dalam hal ini, operasi pembaruan lingkungan gagal dengan error.

Error build dalam cluster dan Cloud Build

Jika terjadi masalah dengan paket, Anda akan mendapatkan pesan error tentang masalah tersebut dengan dua cara, bergantung pada cara lingkungan Anda di-deploy:

  • Cloud Build. Pesan error dan link ke log Cloud Build. Contoh:

    UPDATE operation on this environment failed 25 minutes ago with the
    following error message:
    Failed to install PyPI packages.  Check the Cloud Build log at ...
    
  • Build dalam cluster. Pesan error dan lokasi log build. Misalnya:

    UPDATE operation on this environment failed 17 minutes ago with the
    following error message:
    Failed to install PyPI packages.  Check the in-cluster build logs for
    details. They can be found in the Environment logs under the build-log-*
    log name.
    

Lihat pesan error mendetail

Jika penginstalan paket gagal, pip akan melaporkan pesan error mendetail. Anda dapat menemukan pesan error ini di log build.

Temukan error pip di log Cloud Build

Anda dapat mengikuti link dari pesan error Cloud Build, atau menemukan log build:

  1. Temukan log build:

    1. Di konsol Google Cloud , buka halaman Build history.

      Buka Histori build

    2. Pilih build yang gagal untuk melihat log-nya.

  2. Dalam log build, temukan pesan error dari pip. Contoh:

    ERROR: apache-airflow-backport-providers-google 2021.2.5 has requirement
    google-cloud-logging<3.0.0,>=2.1.1, but you'll have google-cloud-logging
    1.15.0 which is incompatible.
    

Temukan error pip di log build dalam cluster

  1. Temukan log build:

    1. Di Google Cloud console, buka halaman Environments.

      Buka Lingkungan

    2. Pilih lingkungan Anda.

    3. Buka tab Logs.

    4. Pilih Semua log > Log Composer > Build > Gambar Worker & Scheduler.

    5. Di menu drop-down Severity, pilih Info.

  2. Di log yang ditampilkan:

    1. Temukan pesan error installer.sh. Misalnya:

      The command '/bin/sh -c bash installer.sh $COMPOSER_PYTHON_VERSION
      fail' returned a non-zero code: 1
      
    2. Pesan info sebelumnya memiliki error pip yang mendetail. Misalnya:

      apache-airflow-backport-providers-google 2021.2.5 has requirement
      google-cloud-logging<3.0.0,>=2.1.1, but you have
      google-cloud-logging 1.15.0.
      

Waktu tunggu habis selama penginstalan paket Python

Pada versi terbaru, utilitas pip mengubah perilakunya saat mencoba memenuhi dependensi. Jika dependensi yang ditentukan tidak dapat dipenuhi, pip akan menelusuri semua versi paket yang tersedia.

Saat Anda menginstal paket, hal berikut akan terjadi:

  1. Jika paket sudah diinstal sebelumnya di lingkungan Anda dan dependensi Python yang Anda tentukan tidak memerlukan perubahan apa pun, paket akan tetap seperti apa adanya.

    Contoh: aiodebug==2.3.0 diinstal dan Anda menentukan aiodebug atau aiodebug>=2.

  2. Jika paket belum diinstal di lingkungan Anda atau tidak memenuhi dependensi Python yang Anda tentukan, pip akan mencoba menggunakan versi terbaru yang memenuhi dependensi. Ini adalah versi paket terbaru jika Anda tidak menentukan versi, atau versi paket terbaru yang memenuhi batasan yang ditentukan.

    Contoh: Jika Anda menentukan aiodebug, versi terbaru akan diinstal (2.*.*). Jika Anda menentukan aiodebug<2, maka 1.*.* akan diinstal.

    Jika versi ini menyebabkan konflik dependensi dengan paket yang sudah diinstal sebelumnya, pip akan memeriksa semua versi paket yang tersedia untuk mencoba memenuhi dependensi yang ditentukan. Jika hal ini terjadi, pesan berikut akan terlihat di log build:

    INFO: pip is looking at multiple versions of PYTHON_PACKAGE_NAME
    to determine which version is compatible with other requirements.
    This could take a while.
    

    Sebelum perubahan, pip gagal karena konflik dependensi tanpa memeriksa versi lain.

Menjelajahi semua versi yang tersedia dapat memakan waktu yang cukup lama dan menyebabkan downgrade paket atau waktu tunggu habis selama penginstalan paket Python.

Paket yang sudah diinstal di Cloud Composer diupdate secara rutin ke versi terbaru karena alasan keamanan. Oleh karena itu, waktu tunggu juga dapat terjadi saat Anda mengupgrade lingkungan ke versi Cloud Composer yang lebih baru.

Kemungkinan solusi:

  • Perbarui dependensi Python kustom secara rutin.

  • Gunakan PythonVirtualenvOperator untuk mengisolasi cuplikan kode yang memerlukan paket yang bertentangan.

Konflik dengan paket PyPI bawaan

Beberapa konflik paket terjadi antara paket PyPI kustom yang Anda instal dan paket yang sudah diinstal sebelumnya.

Anda dapat melihat daftar lengkap paket yang telah diinstal sebelumnya untuk versi Cloud Composer di halaman Versi Cloud Composer.

Untuk mengatasi masalah ini, Anda dapat:

  • Instal versi lain dari paket PyPI kustom.

  • Instal versi lain dari paket yang sudah diinstal sebelumnya. Untuk melakukannya, instal paket PyPI kustom dengan nama paket yang sudah diinstal sebelumnya dan tentukan versi yang diperlukan. Sebaiknya jangan melakukan downgrade paket yang sudah diinstal sebelumnya.

  • Periksa apakah versi Cloud Composer yang lebih baru menggunakan versi paket yang telah diinstal sebelumnya yang berbeda. Anda dapat memeriksa potensi konflik paket PyPI sebelum mengupgrade lingkungan ke Cloud Composer versi yang lebih baru.

  • Gunakan PythonVirtualenvOperator untuk mengisolasi cuplikan kode yang memerlukan paket yang bertentangan.

Server metadata tidak tersedia saat menginstal paket PyPI

Jika lingkungan Anda menggunakan file pip.conf kustom, maka Anda mungkin menghadapi masalah saat tidak ada paket PyPI baru yang dapat diinstal di lingkungan Anda. Dalam log Cloud Build yang terkait dengan error penginstalan paket, Anda dapat melihat pesan peringatan berikut:

WARNING: Compute Engine Metadata server unavailable on attempt 3 of 3. Reason:
timed out
WARNING: Authentication failed using Compute Engine authentication due to
unavailable metadata server.

Masalah ini disebabkan oleh file pip.conf yang tidak mengizinkan akses ke indeks paket default di https://pypi.org/simple. Misalnya, jika file pip.conf Anda hanya mengizinkan penginstalan paket dari repositori Artifact Registry kustom karena parameter index-url yang didefinisikan ulang, penginstalan paket dari indeks paket default tidak tersedia.

Untuk mengatasi masalah ini, pastikan indeks paket https://pypi.org/simple ditambahkan ke file pip.conf Anda. Misalnya, jika indeks paket utama Anda ditentukan dalam parameter index-url, tambahkan indeks https://pypi.org/simple dalam parameter extra-index-url.

Langkah berikutnya