Menginstal dependensi Python (original) (raw)

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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

Tentang paket di Cloud Composer

Bagian ini menjelaskan cara kerja paket PyPI di Cloud Composer.

Paket PyPI bawaan dan kustom di image Cloud Composer

Image Cloud Composer berisi paket PyPI bawaan dan kustom.

• Paket PyPI yang diinstal sebelumnya adalah paket yang disertakan dalam image Cloud Composer lingkungan Anda. Setiapimage Cloud Composer berisipaket PyPI yang khusus untuk versi Cloud Composer dan Airflow Anda.
• Paket PyPI kustom adalah paket yang dapat Anda instal di lingkungan, selain paket yang telah diinstal sebelumnya.

Opsi untuk mengelola paket PyPI untuk lingkungan Cloud Composer

Sebelum memulai

• Anda harus memiliki peran yang dapat memicu operasi update lingkungan. Selain itu, akun layanan lingkungan harus memilikiperan yang memiliki izin yang cukup untuk melakukan operasi update.
• Jika lingkungan Anda dilindungi oleh perimeter Kontrol Layanan VPC, sebelum menginstal dependensi PyPI, Anda harusmemberikan identitas pengguna tambahan dengan akses ke layanan yang dilindungi perimeter layanan dan mengaktifkan dukungan untuk repositori PyPI pribadi.
• Persyaratan harus mengikuti format yang ditentukan dalam PEP-508, dengan setiap persyaratan ditentukan dalam huruf kecil dan terdiri dari nama paket dengan tambahan opsional dan penentu versi.
• Jika konflik dependensi menyebabkan update gagal, lingkungan Anda akan terus berjalan dengan dependensi yang ada. Jika operasi berhasil, Anda dapat mulai menggunakan dependensi Python yang baru diinstal di DAG.
• PythonVirtualenvOperator tidak menggunakan konfigurasi dari file pip.conf lingkungan Anda. Jika Anda ingin menggunakan dependensi tertentu, termasuk menginstalnya dari indeks kustom, teruskan persyaratan dalam parameter requirements sebagai daftar string. Untuk informasi selengkapnya tentang format, lihatFormat File Persyaratan dalam dokumentasi pip.

Melihat daftar paket PyPI

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

Melihat paket yang telah diinstal sebelumnya

Untuk melihat daftar paket yang telah diinstal sebelumnya untuk lingkungan Anda, lihat daftar paket untukimage Cloud Composer lingkungan Anda.

Lihat semua paket

Untuk melihat semua paket (baik yang telah diinstal sebelumnya 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 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 tersebut berada.

Melihat paket PyPI kustom

Konsol

1. Di Google Cloud console, buka halaman Environments.
   Buka Lingkungan
2. Di daftar lingkungan, klik nama lingkungan Anda. Halaman Environment details akan terbuka.
3. Buka tab Paket PyPI.

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 tersebut berada.

Menginstal paket kustom di lingkungan Cloud Composer

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

Menginstal paket dari PyPI

Paket dapat diinstal dariPython Package Index jika tidak memiliki dependensi eksternal atau konflik dengan paket yang diinstal sebelumnya.

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

Konsol

1. Di Google Cloud console, buka halaman Environments.
   Buka Lingkungan
2. Di daftar lingkungan, klik nama lingkungan Anda. Halaman Environment details akan terbuka.
3. Buka tab Paket PyPI.
4. Klik Edit
5. Klik Tambahkan paket.
6. Di bagian Paket PyPI, tentukan nama paket, dengan penentu versi dan tambahan opsional.
   Contoh:
   • scikit-learn
   • scipy, >=0.13.3
   • nltk, [machine_learning]
7. Klik Simpan.

gcloud

gcloud CLI memiliki beberapa argumen untuk menggunakan 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.

Menginstal persyaratan dari file

File requirements.txt harus memiliki setiappenentu persyaratan di baris terpisah.

Contoh:

scipy>=0.13.3
scikit-learn
nltk[machine_learning]

Perbarui 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 tersebut berada.

Menginstal satu paket

Update lingkungan Anda, dan tentukan paket, versi, dan 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 tersebut berada.
• PACKAGE_NAME dengan nama paket.
• EXTRAS_AND_VERSION dengan versi opsional dan penentu tambahan. Untuk menghapus versi dan tambahan, tentukan nilai kosong.

Contoh:

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

Menghapus paket

Perbarui 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 tersebut 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 API environments.patch.

Dalam permintaan ini:

1. Di parameter updateMask, tentukan mask:
   • Gunakan 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 di 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 tersebut 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, sehingga alat pip default dapat menginstalnya.

Untuk menginstal dari repositori paket yang memiliki alamat publik:

1. Buat file pip.conf dan sertakan informasi berikut dalam file, jika ada:
   • URL repositori (dalam parameter index-url)
   • Kredensial akses untuk repositori
   • Opsi penginstalan pip non-default
     Contoh:

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

1. (Opsional) Dalam beberapa kasus, Anda mungkin ingin mengambil paket dari beberapa repositori, seperti saat 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 penelusuran pip pada repositori.
   3. Tentukan URL repositori virtual di parameter index-url.
2. Tentukan URI bucket lingkungan Anda.
3. Upload file pip.conf ke folder /config/pip/ di bucket lingkungan Anda.
4. Instal paket menggunakan salah satu metode yang tersedia.

Menginstal paket dari repositori Artifact Registry

Anda dapat menyimpan paket di repositori Artifact Registrydalam project, dan mengonfigurasi lingkungan untuk menginstal dari repositori tersebut.

Konfigurasi peran dan izin:

1. Pastikan akun layanan Cloud Build memilikiizin untuk membaca dari repositori Artifact Registry Anda.
2. Jika lingkungan Anda telah membatasi akses ke layanan lain dalam project, misalnya, jika Anda menggunakan Kontrol Layanan VPC:
   1. Tetapkan izin untuk mengakses repositori Artifact Registry Anda ke akun layanan lingkungan, bukan 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, jika ada:
   • URL repositori Artifact Registry (dalam parameter index-url)
   • Kredensial akses 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/  

1. (Opsional) Dalam beberapa kasus, Anda mungkin ingin mengambil paket dari beberapa repositori, seperti saat repositori Artifact Registry Anda 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 penelusuran pip pada repositori.
   3. Tentukan URL repositori virtual di parameter index-url.
2. Upload file pip.conf ini ke folder /config/pip/di bucket lingkungan Anda. Misalnya:gs://us-central1-example-bucket/config/pip/pip.conf.
3. 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 repositori tersebut.

Konfigurasi peran dan izin:

1. Jika Anda menginstal paket PyPI kustom dari repositori di jaringan project, 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 dalam 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, jika ada:
   • Alamat IP repositori di jaringan project Anda
   • Kredensial akses untuk repositori
   • Opsi penginstalan pip non-default
     Contoh:

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

1. (Opsional) Dalam beberapa kasus, Anda mungkin ingin mengambil paket dari beberapa repositori, seperti saat 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 penelusuran pip pada repositori.
   3. Tentukan URL repositori virtual di parameter index-url.
2. (Opsional) Anda dapat menggunakan sertifikat kustom saat menginstal paket dari repositori pribadi. Untuk melakukannya:
   1. Upload file sertifikat ke folder /config/pip/ di bucket lingkungan Anda.
   2. Di pip.conf, tentukan nama file sertifikat dalam parametercert. Jangan ubah folder /etc/pip/.
      Contoh:

   [global]  
   cert =/etc/pip/example-certificate.pem  

3. Upload file pip.conf ke folder /config/pip/ di bucket lingkungan Anda. Misalnya: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 lokal atau internal:

1. Tempatkan dependensi 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.
   Pada contoh berikut, dependensinya adalahcoin_module.py:

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

1. Impor dependensi dari file definisi DAG.
   Contoh:

Menggunakan paket yang bergantung pada library objek bersama

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

• Gunakan KubernetesPodOperator. Tetapkan image Operator ke image build kustom. Jika Anda mengalami paket yang gagal selama penginstalan karena dependensi sistem yang tidak terpenuhi, gunakan opsi ini.
• Upload library objek bersama ke bucket lingkungan Anda. Jika paket PyPI Anda telah 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

Menginstal paket di lingkungan IP pribadi

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

Secara default, lingkungan Cloud Composer 3 Anda dapat mengakses internet saat menginstal paket PyPI. Tindakan ini berfungsi di semua jenis jaringan lingkungan (IP Pribadi dan Publik). Misalnya, Anda dapat menginstal paket dariPython Package Index di lingkungan IP Pribadi.

Untuk mengetahui informasi selengkapnya, lihatMengonfigurasi akses ke internet saat menginstal paket PyPI.

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 dalamMenginstal paket dari PyPI.
• Instal dari repositori dengan alamat IP publik. Ikuti prosedur yang dijelaskan diMenginstal 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. Hal ini mungkin bukan opsi yang baik jika hierarki dependensi besar.

Menginstal ke lingkungan IP pribadi berdasarkan batasan lokasi resource

Agar project Anda 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 pribaditanpa akses internet.

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

Melindungi project Anda denganperimeter Kontrol Layanan VPCakan 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 untuk lingkungan IP pribadi di dalam perimeter, ikuti panduan untuk lingkungan IP pribaditanpa akses internet.

Langkah berikutnya

• Memecahkan masalah penginstalan paket
• Memecahkan masalah update dan upgrade