Membangun, menguji, dan menyimpan aplikasi Python dalam container

Halaman ini menjelaskan cara mengonfigurasi Cloud Build untuk membangun, menguji, menyimpan dalam container, dan men-deploy aplikasi Python.

Cloud Build memungkinkan Anda menggunakan image container yang tersedia secara publik untuk menjalankan tugas pengembangan, termasuk membangun, menguji, membuat container, mengupload ke Artifact Registry, men-deploy, dan menyimpan log build. Image python publik dari Docker Hub sudah diinstal sebelumnya dengan alat python dan pip. Anda dapat mengonfigurasi Cloud Build agar menggunakan alat ini untuk menginstal dependensi, mem-build, dan menjalankan pengujian unit menggunakan alat ini.

Sebelum memulai

Petunjuk di halaman ini mengasumsikan bahwa Anda sudah memahami Python. Selain itu:

• Enable the Cloud Build, Cloud Run, Cloud Storage and Artifact Registry APIs.

  Roles required to enable APIs

  To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

  Enable the APIs

• Untuk menjalankan perintah gcloud di halaman ini, instal Google Cloud CLI.
• Siapkan project Python Anda, termasuk file requirements.txt. Anda memerlukan Dockerfile beserta kode sumber Anda.
• Jika Anda ingin menyimpan container yang di-build di Artifact Registry, buat repositori Docker di Artifact Registry.
• Jika Anda ingin menyimpan log pengujian di Cloud Storage, buat bucket di Cloud Storage.

Izin IAM yang diperlukan

• Untuk menyimpan log pengujian di Logging, berikan peran Storage Object Creator (roles/storage.objectCreator) untuk bucket Cloud Storage ke akun layanan build Anda.

• Untuk menyimpan image yang dibuat di Artifact Registry, berikan peran Penulis Artifact Registry (roles/artifactregistry.writer) ke akun layanan build Anda.

Untuk mengetahui petunjuk tentang cara memberikan peran ini, lihat Memberikan peran menggunakan halaman IAM.

Mengonfigurasi build Python

Bagian ini membahas contoh file konfigurasi build untuk aplikasi Python. File ini memiliki langkah-langkah build untuk menginstal persyaratan, menambahkan pengujian unit, dan setelah pengujian berhasil, membangun, dan men-deploy aplikasi.

1. Di direktori root project Anda, buat file konfigurasi Cloud Build bernama cloudbuild.yaml.

2. Persyaratan penginstalan: Image python dari Docker Hub sudah diinstal sebelumnya dengan pip. Untuk menginstal dependensi dari pip, tambahkan langkah build dengan kolom berikut:

   • name: Tetapkan nilai kolom ini ke python untuk menggunakan image python dari Docker Hub untuk tugas ini.
   • entrypoint: Menetapkan kolom ini akan menggantikan titik entri default gambar yang dirujuk di name. Tetapkan nilai kolom ini ke pip untuk memanggil pip sebagai titik entri langkah build dan menjalankan perintah pip.
   • args: Kolom args dari langkah build mengambil daftar argumen dan meneruskannya ke image yang dirujuk oleh kolom name. Teruskan argumen untuk menjalankan perintah pip install di kolom ini. Flag --user dalam perintah pip install memastikan bahwa langkah-langkah build berikutnya dapat mengakses modul yang diinstal dalam langkah build ini.

   Langkah build berikut menambahkan argumen untuk menginstal persyaratan dari file requirements.txt:

   steps:
     # Install dependencies
     - name: python
       entrypoint: pip
       args: ["install", "-r", "requirements.txt", "--user"]

3. Menambahkan pengujian unit: Jika telah menentukan pengujian unit di aplikasi menggunakan framework pengujian seperti pytest, Anda dapat mengonfigurasi Cloud Build untuk menjalankan pengujian dengan menambahkan kolom berikut dalam langkah build:

   • name: Tetapkan nilai kolom ini ke python untuk menggunakan image python dari Docker Hub untuk tugas Anda.
   • entrypoint: Tetapkan nilai kolom ini ke python untuk menjalankan perintah python.
   • args: Tambahkan argumen untuk menjalankan perintah python pytest.

   Langkah build berikut menyimpan output log pytest ke file XML JUNIT. Nama file ini dibuat menggunakan versi singkat ID commit yang terkait dengan build Anda. Langkah build berikutnya akan menyimpan log dalam file ini ke Cloud Storage.

   # Run unit tests
   - name: python
     entrypoint: python
     args: ["-m", "pytest", "--junitxml=${SHORT_SHA}_test_log.xml"] 

4. Mengemas aplikasi dalam container: Setelah menambahkan langkah build untuk memastikan bahwa pengujian telah lulus, Anda dapat membuat aplikasi. Cloud Build menyediakan image Docker yang telah dibuat sebelumnya yang dapat Anda gunakan untuk memasukkan aplikasi Python ke dalam container. Untuk membuat container aplikasi, tambahkan kolom berikut dalam langkah build:

   • name: Tetapkan nilai kolom ini ke gcr.io/cloud-builders/docker untuk menggunakan image Docker bawaan untuk tugas Anda.
   • args: Tambahkan argumen untuk perintah docker build sebagai nilai untuk kolom ini.

   Langkah build berikut membangun image myimage dan memberi tag dengan versi singkat ID commit Anda. Langkah build menggunakan penggantian default untuk project ID, nama repositori, dan nilai SHA pendek, sehingga nilai-nilai ini diganti secara otomatis pada waktu build.

   # Docker Build
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 
            'us-central1-docker.pkg.dev/${PROJECT_ID}/${_ARTIFACT_REGISTRY_REPO}/myimage:${SHORT_SHA}', '.']

5. Kirim container ke Artifact Registry: Anda dapat menyimpan container yang dibangun di Artifact Registry, yang merupakan layanan yang dapat Anda gunakan untuk menyimpan, mengelola, dan mengamankan artefak build. Google Cloud Untuk melakukannya, Anda harus memiliki repositori Docker yang sudah ada di Artifact Registry. Untuk mengonfigurasi Cloud Build guna menyimpan image di repositori Docker Artifact Registry, tambahkan langkah build dengan kolom berikut:

   • name: Tetapkan nilai kolom ini ke gcr.io/cloud-builders/docker untuk menggunakan image builder docker resmi untuk tugas Anda.
   • args: Tambahkan argumen untuk perintah docker push sebagai nilai kolom ini. Untuk URL tujuan, masukkan repositori Docker Artifact Registry tempat Anda ingin menyimpan image.

   Langkah build berikut akan mengirim image yang Anda buat pada langkah sebelumnya ke Artifact Registry:

   # Docker push to Google Artifact Registry
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push',  'us-central1-docker.pkg.dev/${PROJECT_ID}/${_ARTIFACT_REGISTRY_REPO}/myimage:${SHORT_SHA}']

   Opsional: Jika Anda ingin Cloud Build membuat informasi asal build Supply chain Levels for Software Artifacts (SLSA), selesaikan langkah-langkah berikut:

   • Gunakan kolom images di langkah build, bukan menggunakan langkah build Docker push terpisah.
   • Tambahkan requestedVerifyOption: VERIFIED ke bagian options pada file konfigurasi build Anda.

6. Deploy container ke Cloud Run: Untuk men-deploy image di Cloud Run, tambahkan langkah build dengan kolom berikut:

   • name: Tetapkan nilai kolom ini ke google/cloud-sdk untuk menggunakan image gcloud CLI guna memanggil perintah gcloud untuk men-deploy image di Cloud Run.
   • args: Tambahkan argumen untuk perintah gcloud run deploy sebagai nilai kolom ini.

   Langkah build berikut men-deploy image yang dibangun sebelumnya ke Cloud Run:

   # Deploy to Cloud Run
   - name: google/cloud-sdk
     args: ['gcloud', 'run', 'deploy', 'helloworld-${SHORT_SHA}', 
            '--image=us-central1-docker.pkg.dev/${PROJECT_ID}/${_ARTIFACT_REGISTRY_REPO}/myimage:${SHORT_SHA}', 
            '--region', 'us-central1', '--platform', 'managed', 
            '--allow-unauthenticated']

7. Menyimpan log pengujian ke Cloud Storage: Anda dapat mengonfigurasi Cloud Build untuk menyimpan log pengujian apa pun di Cloud Storage dengan menentukan lokasi bucket dan jalur yang ada ke log pengujian. Langkah build berikut menyimpan log pengujian yang Anda simpan dalam file JUNIT XML ke bucket Cloud Storage:

   # Save test logs to Google Cloud Storage
   artifacts:
     objects:
       location: gs://${_BUCKET_NAME}/
       paths:
         - ${SHORT_SHA}_test_log.xml

   Cuplikan berikut menunjukkan file konfigurasi build lengkap untuk semua langkah yang dijelaskan di atas:

   steps:
     # Install dependencies
     - name: python
       entrypoint: pip
       args: ["install", "-r", "requirements.txt", "--user"]
   
     # Run unit tests
     - name: python
       entrypoint: python
       args: ["-m", "pytest", "--junitxml=${SHORT_SHA}_test_log.xml"] 
   
     # Docker Build
     - name: 'gcr.io/cloud-builders/docker'
       args: ['build', '-t', 
              'us-central1-docker.pkg.dev/${PROJECT_ID}/${_ARTIFACT_REGISTRY_REPO}/myimage:${SHORT_SHA}', '.']
   
     # Docker push to Google Artifact Registry
     - name: 'gcr.io/cloud-builders/docker'
       args: ['push',  'us-central1-docker.pkg.dev/${PROJECT_ID}/${_ARTIFACT_REGISTRY_REPO}/myimage:${SHORT_SHA}']
   
     # Deploy to Cloud Run
     - name: google/cloud-sdk
       args: ['gcloud', 'run', 'deploy', 'helloworld-${SHORT_SHA}', 
              '--image=us-central1-docker.pkg.dev/${PROJECT_ID}/${_ARTIFACT_REGISTRY_REPO}/myimage:${SHORT_SHA}', 
              '--region', 'us-central1', '--platform', 'managed', 
              '--allow-unauthenticated']
   
   # Save test logs to Google Cloud Storage
   artifacts:
     objects:
       location: gs://${_BUCKET_NAME}/
       paths:
         - ${SHORT_SHA}_test_log.xml
   # Store images in Google Artifact Registry 
   images:
     - us-central1-docker.pkg.dev/${PROJECT_ID}/${_ARTIFACT_REGISTRY_REPO}/myimage:${SHORT_SHA}

8. Mulai build: secara manual atau menggunakan pemicu build.

   Setelah build selesai, Anda dapat melihat detail repositori di Artifact Registry.

   Anda juga dapat melihat metadata asal build dan memvalidasi asal.

Langkah berikutnya

• Pelajari cara melihat hasil build.
• Pelajari cara mengamankan build.
• Pelajari cara membuat aplikasi Python mandiri.
• Pelajari cara menggunakan dependensi pribadi.
• Pelajari cara memecahkan masalah error build.