Menginstal dependensi Python untuk Cloud Composer

Cloud Composer 1 | Cloud Composer 2

Halaman ini menjelaskan cara menginstal paket Python untuk lingkungan Cloud Composer Anda.

Tentang paket PyPI kustom dan bawaan pada image Cloud Composer

Image Cloud Composer berisi paket PyPI kustom dan yang telah diinstal sebelumnya.

• Paket PyPI bawaan adalah paket yang disertakan dalam image Cloud Composer lingkungan Anda. Setiap image Cloud Composer berisi paket PyPI yang dikhususkan untuk versi Cloud Composer dan Airflow Anda.

• Paket PyPI kustom adalah paket yang dapat diinstal di lingkungan Anda selain paket yang telah diinstal sebelumnya.

Catatan: Jika berencana mengupgrade ke versi Cloud Composer yang lebih baru, Anda dapat melakukan pemeriksaan upgrade. Pemeriksaan ini melaporkan apakah paket PyPI kustom di lingkungan Anda memiliki konflik dengan paket yang telah diinstal sebelumnya di image Cloud Composer baru.

Opsi untuk mengelola paket PyPI untuk lingkungan Cloud Composer

Opsi	Gunakan jika
Menginstal dari PyPI	Cara default untuk menginstal paket di lingkungan Anda
Menginstal dari repositori dengan alamat IP publik	Paket tersebut dihosting di repositori paket selain PyPI. Repositori ini memiliki alamat IP publik
Menginstal dari repositori Artifact Registry	Paket dihosting di repositori Artifact Registry
Menginstal dari repositori di jaringan project Anda	Lingkungan Anda tidak memiliki akses ke internet publik. Paket ini dihosting dalam repositori paket di jaringan project Anda.
Menginstal sebagai library Python lokal	Paket ini tidak dapat ditemukan di PyPI, dan library tidak memiliki dependensi eksternal, seperti dist-packages.
Menginstal plugin	Paket ini menyediakan fungsi khusus plugin, seperti memodifikasi antarmuka web Airflow.
PythonVirtualenvOperator	Anda tidak ingin paket diinstal untuk semua pekerja Airflow, atau dependensi bertentangan dengan paket yang telah diinstal sebelumnya. Paket ini dapat ditemukan di PyPI dan tidak memiliki dependensi eksternal.
KubernetesPodOperator dan operator GKE	Anda memerlukan dependensi eksternal yang tidak dapat diinstal dari pip, seperti dist-packages, atau yang ada di server pip internal. Opsi ini memerlukan lebih banyak penyiapan dan pemeliharaan. Pertimbangkan hanya jika opsi lain tidak berhasil.

Sebelum memulai

• Anda harus memiliki peran yang dapat memicu operasi update lingkungan. Selain itu, akun layanan lingkungan harus memiliki peran yang memiliki izin yang cukup untuk melakukan operasi update. Untuk mengetahui informasi selengkapnya, lihat Kontrol akses.
• Jika lingkungan Anda dilindungi oleh perimeter Kontrol Layanan VPC, maka sebelum menginstal dependensi PyPI, Anda harus memberikan identitas pengguna tambahan dengan akses ke layanan yang dilindungi oleh perimeter layanan dan mengaktifkan dukungan untuk repositori PyPI pribadi.
• Persyaratan harus mengikuti format yang ditentukan dalam PEP-508, yang setiap persyaratannya ditentukan dalam huruf kecil dan terdiri dari nama paket dengan tambahan opsional dan penentu versi.

• Update dependensi PyPI menghasilkan image Docker di Artifact Registry.

  Peringatan: Jangan mengubah atau menghapus image yang dibuat oleh Cloud Composer di Artifact Registry atau repositori itu sendiri. Jangan mengupload image Anda sendiri ke repositori. Sebagai gantinya, buat dan kelola repositori Anda sendiri untuk image Anda (misalnya, untuk image yang digunakan oleh KubernetesPodOperator). Jangan hapus sendiri repositori ini. Repositori akan dihapus setelah Anda menghapus lingkungan Anda.

• Jika konflik dependensi menyebabkan update gagal, lingkungan Anda akan terus berjalan dengan dependensi yang sudah ada. Jika operasi berhasil, Anda dapat mulai menggunakan dependensi Python yang baru diinstal di DAG Anda.

Lihat daftar paket PyPI

Anda bisa mendapatkan daftar paket untuk lingkungan Anda dalam beberapa format.

Lihat paket bawaan

Guna melihat daftar paket bawaan untuk lingkungan Anda, lihat daftar paket untuk image Cloud Composer lingkungan Anda.

Lihat semua paket

Untuk melihat semua paket (baik bawaan maupun kustom) di lingkungan Anda:

gcloud

Perintah gcloud CLI berikut menampilkan hasil perintah python -m pip list untuk pekerja Airflow di lingkungan Anda. Anda dapat menggunakan argumen --tree untuk mendapatkan hasil dari perintah python -m pipdeptree --warn.

gcloud beta composer environments list-packages \
    ENVIRONMENT_NAME \
    --location LOCATION

Ganti:

• ENVIRONMENT_NAME dengan nama lingkungan.
• LOCATION dengan region tempat lingkungan berada.

Lihat paket PyPI kustom

Konsol

1. Di konsol Google Cloud, buka halaman Environments.

   Buka Lingkungan

2. Pada daftar lingkungan, klik nama lingkungan Anda. Halaman Detail lingkungan akan terbuka.

3. Buka tab PyPI Packages.

gcloud

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION \
  --format="value(config.softwareConfig.pypiPackages)"

Ganti:

• ENVIRONMENT_NAME dengan nama lingkungan.
• LOCATION dengan region tempat lingkungan berada.

Menginstal paket kustom di lingkungan Cloud Composer

Bagian ini menjelaskan berbagai metode untuk menginstal paket kustom di lingkungan Anda.

Menginstal paket dari PyPI

Sebuah paket dapat diinstal dari Indeks Paket Python jika tidak memiliki dependensi eksternal atau mengalami konflik dengan paket yang telah diinstal sebelumnya.

Catatan: Anda dapat melonggarkan batasan versi untuk paket PyPI kustom yang diinstal. Misalnya, daripada menetapkan versi sebagai ==1.0.1, tentukan sebagai >=1.0.1.

Untuk menambahkan, mengupdate, atau menghapus dependensi Python untuk lingkungan Anda:

Konsol

1. Di konsol Google Cloud, buka halaman Environments.

   Buka Lingkungan

2. Pada daftar lingkungan, klik nama lingkungan Anda. Halaman Detail lingkungan akan terbuka.

3. Buka tab Paket PyPI.

4. Klik Edit.

5. Klik Tambahkan paket.

6. Di bagian Paket PyPI, tentukan nama paket, dengan tambahan dan penentu versi opsional.

   Contoh:

   • scikit-learn
   • scipy, >=0.13.3
   • nltk, [machine_learning]

7. Klik Save.

gcloud

gcloud CLI memiliki beberapa agrumen untuk menangani paket PyPI kustom:

• --update-pypi-packages-from-file mengganti semua paket PyPI kustom yang ada dengan paket yang ditentukan. Paket yang tidak Anda tentukan akan dihapus.
• --update-pypi-package mengupdate atau menginstal satu paket.
• --remove-pypi-packages menghapus paket yang ditentukan.
• --clear-pypi-packages menghapus semua paket.

Persyaratan penginstalan dari file

File requirements.txt harus memiliki setiap penentu persyaratan di baris terpisah.

Contoh:

scipy>=0.13.3
scikit-learn
nltk[machine_learning]

Update lingkungan Anda, dan tentukan file requirements.txt dalam argumen --update-pypi-packages-from-file.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-packages-from-file requirements.txt

Ganti:

• ENVIRONMENT_NAME dengan nama lingkungan.
• LOCATION dengan region tempat lingkungan berada.

Menginstal satu paket

Update lingkungan Anda, dan tentukan paket, versi, serta tambahan dalam argumen --update-pypi-package.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-package PACKAGE_NAMEEXTRAS_AND_VERSION

Ganti:

• ENVIRONMENT_NAME dengan nama lingkungan.
• LOCATION dengan region tempat lingkungan berada.
• PACKAGE_NAME dengan nama paket.
• EXTRAS_AND_VERSION dengan versi opsional dan penentu tambahan. Untuk menghapus versi dan tambahan, tentukan nilai kosong.

Catatan: Bergantung pada lingkungan eksekusi, Anda mungkin perlu meng-escape karakter khusus seperti >. Untuk menghindari kemungkinan masalah, beri tanda kutip nama dan versi paket, misalnya: "scipy>=0.13.0".

Contoh:

gcloud composer environments update example-environment \
    --location us-central1 \
    --update-pypi-package "scipy>=0.13.3"

Menghapus paket

Update lingkungan Anda, dan tentukan paket yang ingin dihapus dalam argumen --remove-pypi-packages:

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --remove-pypi-packages PACKAGE_NAMES

Ganti:

• ENVIRONMENT_NAME dengan nama lingkungan.
• LOCATION dengan region tempat lingkungan berada.
• PACKAGE_NAMES dengan daftar paket yang dipisahkan koma.

Contoh:

gcloud composer environments update example-environment \
    --location us-central1 \
    --remove-pypi-packages scipy,scikit-learn

API

Buat permintaan environments.patch API.

Dalam permintaan ini:

1. Dalam parameter updateMask, tentukan mask:

   • Menggunakan mask config.softwareConfig.pypiPackages untuk mengganti semua paket yang ada dengan paket yang ditentukan. Paket yang tidak Anda tentukan akan dihapus.
   • Gunakan config.softwareConfig.envVariables.PACKAGE_NAME untuk menambahkan atau memperbarui paket tertentu. Untuk menambahkan atau memperbarui beberapa paket, tentukan beberapa mask dengan koma.

2. Dalam isi permintaan, tentukan paket dan nilai untuk versi dan tambahan:

   {
     "config": {
       "softwareConfig": {
         "pypiPackages": {
           "PACKAGE_NAME": "EXTRAS_AND_VERSION"
         }
       }
     }
   }
   

   Ganti:

   • PACKAGE_NAME dengan nama paket.
   • EXTRAS_AND_VERSION dengan versi opsional dan penentu tambahan. Untuk menghapus versi dan tambahan, tentukan nilai kosong.
   • Untuk menambahkan lebih dari satu paket, tambahkan entri tambahan untuk paket ke pypiPackages.

Contoh:

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.softwareConfig.pypiPackages.EXAMPLE_PACKAGE,
// config.softwareConfig.pypiPackages.ANOTHER_PACKAGE
{
  "config": {
    "softwareConfig": {
      "pypiPackages": {
        "EXAMPLE_PACKAGE": "",
        "ANOTHER_PACKAGE": ">=1.10.3"
      }
    }
  }
}

Terraform

Blok pypi_packages dalam blok software_config menentukan paket.

resource "google_composer_environment" "example" {
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {

    software_config {

      pypi_packages = {
          PACKAGE_NAME = "EXTRAS_AND_VERSION"
      }

    }
  }
}

Ganti:

• ENVIRONMENT_NAME dengan nama lingkungan.
• LOCATION dengan region tempat lingkungan berada.
• PACKAGE_NAME dengan nama paket.
• EXTRAS_AND_VERSION dengan versi opsional dan penentu tambahan. Untuk menghapus versi dan tambahan, tentukan nilai kosong.
• Untuk menambahkan lebih dari satu paket, tambahkan entri tambahan untuk paket ke pypi_packages.

Contoh:

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

  config {

    software_config {
      pypi_packages = {
          scipy = ">=1.10.3"
          scikit-learn = ""
          nltk = "[machine_learning]"
      }
    }
  }
}

Menginstal paket dari repositori publik

Anda dapat menginstal paket yang dihosting di repositori lain yang memiliki alamat IP publik.

Paket harus dikonfigurasi dengan benar agar alat pip default dapat menginstalnya.

Catatan: Cloud Composer tidak mendukung penyesuaian pip serta tidak menyelesaikan dependensi dan konflik paket di luar mekanisme resolusi yang disediakan alat pip default.

Untuk menginstal dari repositori paket yang memiliki alamat publik:

1. Buat file pip.conf dan sertakan informasi berikut dalam file tersebut, jika ada:

   • URL repositori (di parameter index-url)
   • Mengakses kredensial untuk repositori
   • Opsi penginstalan pip non-default

   Contoh:

   [global]
   index-url=https://example.com/
   

2. (Opsional) Dalam beberapa kasus, Anda mungkin ingin mengambil paket dari beberapa repositori, seperti ketika repositori publik berisi beberapa paket tertentu yang ingin Anda instal, dan Anda ingin menginstal semua paket lainnya dari PyPI:

   1. Konfigurasikan repositori virtual Artifact Registry.
   2. Tambahkan konfigurasi untuk beberapa repositori (termasuk PyPI, jika diperlukan) dan tentukan urutan pip yang menelusuri repositori.
   3. Tentukan URL repositori virtual di parameter index-url.

3. Tentukan URI bucket lingkungan Anda.

4. Upload file pip.conf ke folder /config/pip/ di bucket lingkungan Anda.

5. Instal paket menggunakan salah satu metode yang tersedia.

Menginstal paket dari repositori Artifact Registry

Anda dapat menyimpan paket di repositori Artifact Registry dalam project, dan mengonfigurasi lingkungan untuk diinstal dari sana.

Catatan: Jika menggunakan Kontrol Layanan VPC, Anda dapat membuat repositori PyPI Artifact Registry dalam mode VPC. Dalam hal ini, ikuti prosedur untuk repositori pribadi saat menetapkan izin.

Mengonfigurasi peran dan izin:

1. Akun layanan lingkungan Anda harus memiliki peran iam.serviceAccountUser.

2. Pastikan akun layanan Cloud Build memiliki izin untuk membaca dari repositori Artifact Registry.

3. Jika lingkungan Anda membatasi akses ke layanan lain dalam project, misalnya, jika Anda menggunakan Kontrol Layanan VPC:

   1. Tetapkan izin untuk mengakses repositori Artifact Registry ke akun layanan lingkungan, bukan ke akun layanan Cloud Build.

   2. Pastikan konektivitas ke repositori Artifact Registry dikonfigurasi di project Anda.

Untuk menginstal paket PyPI kustom dari repositori Artifact Registry:

1. Buat file pip.conf dan sertakan informasi berikut dalam file tersebut, jika ada:

   • URL repositori Artifact Registry (di parameter index-url)
   • Mengakses kredensial untuk repositori
   • Opsi penginstalan pip non-default

   Untuk repositori Artifact Registry, tambahkan /simple/ ke URL repositori:

   [global]
   index-url = https://us-central1-python.pkg.dev/example-project/example-repository/simple/
   

2. (Opsional) Dalam beberapa kasus, Anda mungkin ingin mengambil paket dari beberapa repositori, seperti ketika repositori Artifact Registry berisi beberapa paket tertentu yang ingin diinstal, dan Anda ingin menginstal semua paket lainnya dari PyPI:

   1. Konfigurasikan repositori virtual Artifact Registry.
   2. Tambahkan konfigurasi untuk beberapa repositori (termasuk PyPI, jika diperlukan) dan tentukan urutan pip yang menelusuri repositori.
   3. Tentukan URL repositori virtual di parameter index-url.

3. Upload file pip.conf ini ke folder /config/pip/ di bucket lingkungan Anda. Contoh: gs://us-central1-example-bucket/config/pip/pip.conf.

4. Instal paket menggunakan salah satu metode yang tersedia.

Menginstal paket dari repositori pribadi

Anda dapat menghosting repositori pribadi di jaringan project dan mengonfigurasi lingkungan untuk menginstal paket Python dari jaringan tersebut.

Mengonfigurasi peran dan izin:

1. Akun layanan untuk lingkungan Cloud Composer Anda harus memiliki peran iam.serviceAccountUser.

2. Jika Anda menginstal paket PyPI kustom dari repositori di jaringan project Anda, dan repositori ini tidak memiliki alamat IP publik:

   1. Tetapkan izin untuk mengakses repositori ini ke akun layanan lingkungan.

   2. Pastikan konektivitas ke repositori ini dikonfigurasi di project Anda.

Untuk menginstal paket dari repositori pribadi yang dihosting di jaringan project Anda:

1. Buat file pip.conf dan sertakan informasi berikut dalam file tersebut, jika ada:

   • Alamat IP repositori di jaringan project Anda
   • Mengakses kredensial untuk repositori
   • Opsi penginstalan pip non-default

   Contoh:

   [global]
   index-url=https://192.0.2.10/
   

2. (Opsional) Dalam beberapa kasus, Anda mungkin ingin mengambil paket dari beberapa repositori, seperti ketika repositori pribadi berisi beberapa paket tertentu yang ingin Anda instal, dan Anda ingin menginstal semua paket lainnya dari PyPI:

   1. Konfigurasikan repositori virtual Artifact Registry.
   2. Tambahkan konfigurasi untuk beberapa repositori (termasuk PyPI, jika diperlukan) dan tentukan urutan pip yang menelusuri repositori.
   3. Tentukan URL repositori virtual di parameter index-url.

3. Upload file pip.conf ke folder /config/pip/ di bucket lingkungan Anda. Contoh: gs://us-central1-example-bucket/config/pip/pip.conf.

4. Instal paket menggunakan salah satu metode yang tersedia.

Menginstal library Python lokal

Untuk menginstal library Python internal atau lokal:

1. Tempatkan dependensi di dalam subdirektori di folder dags/ di bucket lingkungan Anda. Untuk mengimpor modul dari subdirektori, setiap subdirektori di jalur modul harus berisi file penanda paket __init__.py.

   Dalam contoh berikut, dependensinya adalah coin_module.py:

   dags/
     use_local_deps.py  # A DAG file.
     dependencies/
       __init__.py
       coin_module.py
   

2. Impor dependensi dari file definisi DAG.

   Contoh:

from dependencies import coin_module

Catatan: Error impor terjadi jika file __init__.py tidak ada. Direktori dan nama file harus berupa ID Python yang valid.

Menggunakan paket yang bergantung pada library objek bersama

Paket PyPI tertentu bergantung pada library level sistem. Meskipun Cloud Composer tidak mendukung library sistem, Anda dapat menggunakan opsi berikut:

• Menggunakan KubernetesPodOperator. Setel image Operator ke image build kustom. Jika mengalami paket yang gagal selama penginstalan karena dependensi sistem yang belum terpenuhi, gunakan opsi ini.

• Mengupload library objek bersama ke bucket lingkungan Anda. Jika paket PyPI Anda berhasil diinstal tetapi gagal saat runtime, gunakan opsi ini.

  1. Temukan library objek bersama secara manual untuk dependensi PyPI (file .so).
  2. Upload library objek bersama ke folder /plugins di bucket lingkungan Anda.
  3. Tetapkan variabel lingkungan berikut: LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/airflow/gcs/plugins

Catatan: File dalam folder plugins/ disinkronkan ke sistem file lokal. Mengupload file .so yang besar dapat memengaruhi performa lingkungan Anda dan server web Airflow.

Menginstal paket di lingkungan IP pribadi

Bagian ini menjelaskan cara menginstal paket di lingkungan IP pribadi.

Bergantung pada cara mengonfigurasi project, lingkungan Anda mungkin tidak memiliki akses ke internet publik.

Lingkungan IP pribadi dengan akses internet publik

Jika lingkungan IP pribadi Anda dapat mengakses internet publik, Anda dapat menginstal paket menggunakan opsi untuk lingkungan IP publik:

• Instal dari PyPI. Dalam hal ini, tidak diperlukan konfigurasi khusus. Ikuti prosedur yang dijelaskan dalam Menginstal paket dari PyPI.
• Menginstal dari repositori dengan alamat IP publik. Ikuti prosedur yang dijelaskan dalam Menginstal paket dari repositori pribadi.
• Instal dari repositori PyPI pribadi yang dihosting di jaringan project Anda.

Lingkungan IP pribadi tanpa akses internet

Jika lingkungan IP pribadi Anda tidak memiliki akses ke internet publik, Anda dapat menginstal paket menggunakan salah satu cara berikut:

• Gunakan repositori PyPI pribadi yang dihosting di jaringan project Anda.
• Gunakan VM server proxy di jaringan project Anda untuk terhubung ke repositori PyPI di internet publik. Tentukan alamat proxy dalam file /config/pip/pip.conf di bucket lingkungan Anda.
• Gunakan repositori Artifact Registry sebagai satu-satunya sumber paket. Untuk melakukannya, tentukan ulang parameter index-url, seperti yang dijelaskan.
• Jika kebijakan keamanan Anda mengizinkan akses ke alamat IP eksternal dari jaringan VPC, Anda dapat mengaktifkan penginstalan paket dari repositori di internet publik dengan mengonfigurasi Cloud NAT.
• Masukkan dependensi Python ke folder /dags di bucket lingkungan Anda untuk menginstalnya sebagai library lokal. Ini mungkin bukan opsi yang baik jika hierarki dependensinya besar.

Menginstal ke lingkungan IP pribadi berdasarkan pembatasan lokasi resource

Agar project Anda tetap sesuai dengan persyaratan Pembatasan Lokasi Resource, penggunaan beberapa alat akan dilarang. Secara khusus, Cloud Build tidak dapat digunakan untuk penginstalan paket, sehingga mencegah akses langsung ke repositori di internet publik.

Untuk menginstal dependensi Python di lingkungan tersebut, ikuti panduan untuk lingkungan IP pribadi tanpa akses internet.

Menginstal dependensi Python ke lingkungan IP pribadi di perimeter Kontrol Layanan VPC

Melindungi project Anda dengan perimeter Kontrol Layanan VPC akan menghasilkan pembatasan keamanan lebih lanjut. Secara khusus, Cloud Build tidak dapat digunakan untuk penginstalan paket, sehingga mencegah akses langsung ke repositori di internet publik.

Untuk menginstal dependensi Python bagi lingkungan IP pribadi di dalam perimeter, ikuti panduan untuk lingkungan IP pribadi tanpa akses internet.

Langkah selanjutnya

• Memecahkan masalah penginstalan paket
• Pemecahan masalah terkait update dan upgrade