Mengonfigurasi variabel lingkungan untuk layanan

Halaman ini menjelaskan cara mengonfigurasi variabel lingkungan untuk layanan Cloud Run Anda.

Anda dapat menggunakan variabel lingkungan untuk konfigurasi layanan, tetapi kami tidak menyarankan variabel tersebut sebagai cara untuk menyimpan rahasia seperti kredensial database atau kunci API. Nilai sensitif harus disimpan di luar kode sumber dan di luar variabel lingkungan. Untuk menyimpan secret, sebaiknya Anda menggunakan Secret Manager. Untuk mengonfigurasi layanan agar dapat mengakses secret yang disimpan di Secret Manager, lihat Mengonfigurasi secret.

Setiap perubahan konfigurasi akan menghasilkan revisi baru. Revisi selanjutnya juga akan otomatis mendapatkan setelan konfigurasi ini, kecuali jika Anda melakukan pembaruan eksplisit untuk mengubahnya.

Peran yang diperlukan

Untuk mendapatkan izin yang Anda perlukan untuk mengonfigurasi dan men-deploy layanan Cloud Run, minta administrator untuk memberi Anda peran IAM berikut:

• Cloud Run Developer (roles/run.developer) di layanan Cloud Run
• Service Account User (roles/iam.serviceAccountUser) di identitas layanan

Untuk mengetahui daftar peran dan izin IAM yang terkait dengan Cloud Run, lihat Peran IAM Cloud Run dan Izin IAM Cloud Run. Jika layanan Cloud Run Anda berinteraksi dengan Google Cloud API, seperti Library Klien Cloud, lihat panduan konfigurasi identitas layanan. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat izin deployment dan mengelola akses.

Batas dan jumlah maksimum variabel lingkungan

Anda dapat menetapkan maksimum 1.000 variabel lingkungan untuk layanan Cloud Run.

Panjang variabel maksimum adalah 32 Kb.

Menetapkan variabel lingkungan

Anda dapat menetapkan variabel lingkungan untuk layanan baru dan yang sudah ada. Perhatikan bahwa tanda --set-env-vars adalah tindakan destruktif yang menghapus variabel lingkungan yang ditetapkan sebelumnya dan tidak disertakan dalam daftar variabel lingkungan baru.

Variabel lingkungan terikat pada revisi layanan tertentu dan tidak dapat dilihat oleh layanan lain dalam project Google Cloud Anda.

Anda dapat menetapkan variabel lingkungan menggunakan konsol Google Cloud , gcloud CLI, atau file YAML saat membuat layanan baru atau men-deploy revisi baru:

gcloud run deploy SERVICE --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2

gcloud run services update SERVICE --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2

   [...]
   --set-env-vars "KEY1=VALUE1" \
   --set-env-vars "KEY2=VALUE2" \
   --set-env-vars "KEY3=VALUE3"

--set-env-vars "^@^KEY1=value1,value2,value3@KEY2=..."

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-env-var"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      # Environment variables
      env {
        name  = "foo"
        value = "bar"
      }
      env {
        name  = "baz"
        value = "quux"
      }
    }
  }
}

Menetapkan variabel lingkungan default dalam container

Anda dapat menggunakan statement ENV dalam Dockerfile untuk menetapkan nilai default dari variabel lingkungan:

ENV KEY1=VALUE1,KEY2=VALUE2

Urutan prioritas: variabel container versus layanan

Jika Anda menetapkan variabel lingkungan default di dalam penampung dan juga menetapkan variabel lingkungan dengan nama yang sama pada layanan Cloud Run, nilai yang ditetapkan pada layanan akan diutamakan.

Memperbarui variabel lingkungan

Anda dapat memperbarui variabel lingkungan untuk layanan yang ada. Ini adalah pendekatan non-destruktif yang mengubah atau menambahkan variabel lingkungan, tetapi tidak menghapus variabel lingkungan yang ditetapkan sebelumnya.

gcloud run services update SERVICE --update-env-vars KEY1=VALUE1,KEY2=VALUE2

Lihat setelan variabel lingkungan

Untuk melihat setelan variabel lingkungan saat ini pada tugas Cloud Run Anda:

Menghapus variabel lingkungan

Anda dapat menghapus variabel lingkungan untuk layanan yang ada.

gcloud run services update SERVICE --remove-env-vars KEY1,KEY2

gcloud run services update SERVICE --clear-env-vars

Praktik terbaik

Bagian berikut menyoroti beberapa praktik terbaik untuk mengonfigurasi variabel lingkungan.

Variabel lingkungan yang dicadangkan untuk layanan

Variabel lingkungan yang didefinisikan di dalam container runtime contract terkategorikan sebagai "dilindungi" dan tidak boleh diubah. Secara khusus, Cloud Run akan memasukkan variabel lingkungan PORT ke dalam container Anda. Anda sebaiknya tidak menetapkannya sendiri.

Variabel lingkungan tambahan yang dicadangkan saat men-deploy fungsi

Cloud Run menetapkan variabel lingkungan runtime berikut secara otomatis saat men-deploy fungsi:

• FUNCTION_TARGET: Fungsi yang akan dieksekusi.
• FUNCTION_SIGNATURE_TYPE: Jenis fungsi: http untuk fungsi HTTP, dan event untuk fungsi berbasis peristiwa.

Beberapa variabel lingkungan tambahan ditetapkan secara otomatis bergantung pada runtime yang digunakan fungsi Anda. Hal ini didasarkan pada sistem operasi runtime, misalnya, DEBIAN_FRONTEND, SHLVL, atau PATH dan runtime bahasa misalnya, NODE_ENV, VIRTUAL_ENV, atau GOPATH.

Variabel lingkungan yang disediakan oleh lingkungan, selain yang ditetapkan secara otomatis, dapat berubah pada versi runtime mendatang. Sebagai praktik terbaik, sebaiknya Anda tidak bergantung pada atau mengubah variabel lingkungan yang belum ditetapkan secara eksplisit.

Mengubah variabel lingkungan yang disediakan oleh lingkungan dapat menyebabkan hasil yang tidak dapat diprediksi. Upaya untuk mengubah variabel lingkungan tersebut dapat diblokir atau, lebih buruk lagi, menyebabkan konsekuensi yang tidak diinginkan seperti fungsi yang tidak dapat dimulai. Sebagai praktik terbaik, pertimbangkan untuk memberi awalan pada variabel lingkungan apa pun dengan kunci unik untuk menghindari konflik.

Variabel lingkungan tidak valid

Anda tidak dapat menggunakan variabel lingkungan berikut:

Kode contoh

Untuk mengetahui contoh kode yang menunjukkan cara mengakses variabel lingkungan dalam kode Anda, lihat halaman tentang Menangani konfigurasi sensitif dengan Secret Manager di tutorial autentikasi Pengguna akhir.

Langkah berikutnya

Anda dapat menggunakan variabel lingkungan untuk menetapkan konfigurasi buildpack. Untuk mengetahui detail dalam bahasa tertentu, lihat dokumentasi buildpack dalam bahasa:

• Node.js
• Python
• Go
• Ruby
• PHP
• Java

Jika Anda men-deploy dari sumber dan perlu menyesuaikan variabel pada waktu build, lihat Menetapkan variabel lingkungan build.