Menggunakan Nginx sebagai proxy frontend

Halaman ini menunjukkan cara menggunakan NGINX sebagai suatu proxy frontend untuk container aplikasi Anda. Hal ini berguna apabila Anda ingin memproses sejumlah permintaan ataupun respons. Anda dapat menambahkan kompresi gzip, atau menerjemahkan HTTP/2 menjadi HTTP/1 jika container aplikasi hanya mendukung HTTP/1 dan Anda perlu menggunakan HTTP/2 end-to-end untuk alasan performa.

Dalam contoh yang diberikan di halaman ini, container Nginx berjalan pada setiap instance Cloud Run sebagai container penayangan utama, dan ia dikonfigurasi untuk meneruskan permintaan ke container aplikasi, yang berjalan sebagai container file bantuan, sebagaimana yang ditampilkan dalam diagram berikut:

Cara paling efektif untuk melakukan proxy frontend di Cloud Run adalah dengan men-deploy container server proxy server Nginx dan container aplikasi web sebagai layanan Cloud Run tunggal:

Layanan Cloud Run tunggal ini menerima permintaan dan mengirimkannya ke container ingress (penayangan), yang dalam hal ini adalah server proxy. Selanjutnya, server proxy mengirimkan permintaan ke aplikasi web melalui localhost antarmuka jaringan , yang menghindari jaringan eksternal apa pun.

Deploying sebagai layanan Cloud Run tunggal akan mengurangi latensi, beban pengelolaan layanan, dan menghilangkan paparan pada jaringan eksternal. Cloud Run tidak berinteraksi secara langsung dengan container file bantuan, selain untuk memulai atau menghentikannya kapan pun layanan dimulai atau dihentikan.

Container aplikasi web serta container sidecar dapat ditulis dalam beberapa bahasa pemrograman yang berbeda-beda. Untuk contoh yang ditulis dalam PHP, lihat contoh nginx PHP di GitHub.

Sebelum memulai

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. Enable the Cloud Run and Secret Manager 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

2. Instal dan lakukan inisialisasi gcloud CLI.
3. Perbarui Google Cloud CLI: gcloud components update
4. Konfigurasi Google Cloud CLI: gcloud init
5. Autentikasi dengan Google Cloud CLI: gcloud auth login

Izin yang dibutuhkan untuk men-deploy

Anda harus memiliki salah satu dari hal berikut:

• Baik itu peran Admin Cloud Run dan Pengguna Akun Layanan
• Peran khusus apa pun yang menyertakan daftar izin spesifik ini

Ringkasan konfigurasi

Petunjuk-petunjuk tersebut menggunakan image container bawaan, sehingga satu-satunya hal yang dibutuhkan untuk proxy frontend adalah mengonfigurasi container dan layanan itu sendiri.

Konfigurasikan container ingress Nginx

Adapun image container nginx tersedia di Docker Hub. Sebagian besar telah siap untuk digunakan sebagaimana adanya, terkecuali ini perlu dikonfigurasi untuk dijalankan sebagai suatu layanan proxy, mengirimkan permintaan proxy ke port dimana container file bantuan sedang diproses di localhost. Contoh yang ada pada halaman ini juga dapat mengaktifkan kompresi gzip untuk permintaan dan respons.

Konfigurasi diberikan menggunakan file teks yang terpasang di /etc/nginx/conf.d/nginx.conf. Dikarenakan Anda tidak dapat mengedit file tersebut secara langsung dalam container, sehingga Anda harus memasang volume di /etc/nginx/conf.d/ yang berisikan file konfigurasi. Salah satu cara untuk memasang file di lokasi tertentu dalam container yang berjalan di Cloud Run adalah dengan menyimpan konten file dalam rahasia Secret Manager, lalu memasang rahasia tersebut di lokasi yang dipilih.

Salin kode berikut dalam sebuah file yang bernama nginx.conf di direktori saat ini pada mesin lokal Anda.

server {
    # Listen at port 8080
    listen 8080; 
    # Server at localhost
    server_name _;
    # Enables gzip compression to make our app faster
    gzip on;

    location / {
        # Passes initial requests to port 8080 to `hello` container at port 8888
        proxy_pass   http://127.0.0.1:8888;
    }
}

Dalam konfigurasi, lakukan hal berikut:

• Tetapkan nginx untuk memproses pada port default Cloud Run 8080 yang sama, yang terletak di localhost.
• Terapkan kompresi gzip untuk peningkatan performa.
• Instruksikan proxy_pass untuk mengirimkan permintaan apa pun ke container ingress ini ke container file bantuan aplikasi web di port localhost 8888.

Buat rahasia dengan konten file nginx.conf.

Konsol

1. Buka halaman Secret Manager di konsol Google Cloud :

   Buka Secret Manager

2. Klik Create secret.

3. Di kolom formulir name, masukkan nginx_config.

4. Upload file nginx.conf yang berada di multi-container/hello-nginx-sample/nginx.conf sebagai nilai rahasia.

5. Pertahankan setelan default (Google-owned and Google-managed encryption key, etc).

6. Klik Create secret.

7. Beri akun layanan komputasi project akses ke secret baru ini. Untuk melakukannya, buka halaman IAM di konsol Google Cloud :

   Buka IAM

8. Temukan akun layanan utama dengan nama: Compute Engine default service account, lalu klik Edit principal.

9. Klik Tambahkan peran lain, lalu pilih Secret Manager Secret Accessor.

10. Klik Simpan.

gcloud

1. Di terminal, gunakan perintah berikut untuk membuat secret nginx_config baru di Secret Manager:

   gcloud secrets create nginx_config --replication-policy='automatic' --data-file='./nginx.conf'

2. Beri akun layanan komputasi project akses ke secret baru ini menggunakan perintah

   export PROJECT_NUMBER=$(gcloud projects describe $(gcloud config get-value project) --format='value(projectNumber)')
   gcloud secrets add-iam-policy-binding nginx_config --member=serviceAccount:$[e-mail] --role='roles/secretmanager.secretAccessor'

3. Verifikasi bahwa rahasia Anda telah dibuat dengan menjalankan gcloud secrets list.

Tentang contoh image sidecar aplikasi web

Petunjuk ini akan menggunakan contoh image container di us-docker.pkg.dev/cloudrun/container/hello. Anda perlu menentukan nomor port yang akan diproses oleh container dan localhost sebagai host, seperti yang dijelaskan di bagian Menentukan konfigurasi container pendamping, seperti yang dijelaskan di bagian berikut.

Mengonfigurasi layanan multi-container

Anda dapat menggunakan konsol Google Cloud atau file YAML Cloud Run untuk mengonfigurasi layanan Cloud Run dengan lebih dari satu container.

Dalam konfigurasi layanan, tentukan server proxy Nginx sebagai container ingress (penayangan), port yang akan diproses, apakah server menerima permintaan HTTP 1 atau HTTP 2, dan urutan awal container. Container ingress (server proxy) bergantung pada file bantuan aplikasi web, sehingga file bantuan aplikasi web harus dimulai terlebih dahulu.

Konfigurasi ini ditampilkan di beberapa bagian berikutnya.

Menambahkan metadata YAML

Konsol

Buka Deploy layanan untuk melihat petunjuk konsol lengkap.

YAML

1. Jika Anda membuat layanan baru, lewati langkah ini. Jika Anda mengupdate layanan yang sudah ada, download konfigurasi YAML-nya:

   gcloud run services describe SERVICE --format export > service.yaml

2. Di service.yaml, tambahkan kode berikut:

   metadata:
     name: "MC_SERVICE_NAME"
     labels:
       cloud.googleapis.com/location: "REGION"
     annotations:
       # Required to use Cloud Run multi-containers (preview feature)
       run.googleapis.com/launch-stage: BETA
       run.googleapis.com/description: sample tutorial service
       # Externally available
       run.googleapis.com/ingress: all

Bagian ini menjelaskan revisi layanan, yang mencakup beberapa properti yang dapat bervariasi dari revisi ke revisi.

Menentukan urutan mulai container

Konsol

Buka Deploy layanan untuk melihat petunjuk konsol lengkap.

YAML

Di service.yaml, tambahkan kode berikut:

spec:
  template:
    metadata:
      annotations:
        # Defines container startup order within multi-container service.
        # Below requires hello container to spin up before nginx container,
        # which depends on the hello container.
        # https://cloud.google.com/run/docs/configuring/containers#container-ordering
        run.googleapis.com/container-dependencies: "{nginx: [hello]}"

Perhatikan container-dependencies anotasi yang memberi tahu Cloud Run untuk menunggu container hello dimulai sebelum memulai container nginx. Sebaliknya, jika container nginx dimulai terlebih dahulu, dapat mencoba untuk mem-proxy permintaan web ke container aplikasi web yang belum siap, yang akan menghasilkan respons kesalahan web.

Setiap container secara opsional memiliki properti nama yang ditentukan untuknya, yang dapat digunakan untuk merujuknya di pedoman lainnya. Container penayangan menjalankan server proxy, yang dinamakan nginx. Ini adalah container yang menjadi tujuan pengiriman permintaan masuk oleh Cloud Run , sehingga Anda harus menentukan versi HTTP dan port container yang menjadi tujuan pengirimannya.

Menentukan konfigurasi container penyajian

Konsol

Buka Deploy layanan untuk melihat petunjuk konsol lengkap.

YAML

Di file service.yaml, tambahkan kode berikut:

spec:
  containers:
    # A) Serving ingress container "nginx" listening at PORT 8080
    # Main entrypoint of multi-container service.
    # Source is stored in nginx_config secret in Secret Manager.
    # Any pings to this container will proxy over to hello container at PORT 8888.
    # https://cloud.google.com/run/docs/container-contract#port
    - image: nginx
      name: nginx
      ports:
        - name: http1
          containerPort: 8080
      resources:
        limits:
          cpu: 500m
          memory: 256Mi
      # Referencing declared volume below,
      # Declaring volume to mount in current ingress container's filesystem
      # https://cloud.google.com/run/docs/reference/rest/v2/Container#volumemount
      volumeMounts:
        - name: nginx-conf-secret
          readOnly: true
          mountPath: /etc/nginx/conf.d/
      startupProbe:
        timeoutSeconds: 240
        periodSeconds: 240
        failureThreshold: 1
        tcpSocket:
          port: 8080

Server nginx memerlukan file konfigurasi di direktori /etc/nginx/conf.d/. Untuk melakukannya, pasang volume yang berisi file di lokasi tersebut. Bagian volumeMount menentukan volume bernama configuration yang akan ditempatkan di sana. Volume itu sendiri nantinya ditentukan di bagiannya sendiri dalam file tersebut.

Menentukan konfigurasi container sidecar

Konsol

Buka Deploy layanan untuk melihat petunjuk konsol lengkap.

YAML

Di service.yaml, tambahkan kode berikut:

- image: us-docker.pkg.dev/cloudrun/container/hello
  name: hello
  env:
    - name: PORT
      value: "8888"
  resources:
    limits:
      cpu: 1000m
      memory: 512Mi
  startupProbe:
    timeoutSeconds: 240
    periodSeconds: 240
    failureThreshold: 1
    tcpSocket:
      port: 8888

Aplikasi hello juga memerlukan adanya informasi konfigurasi. Fungsi ini memproses permintaan yang masuk pada port yang ditentukan dalam variabel lingkungan PORT. Nama dan nilai tersebut ditentukan dalam bagian env.

Tentukan volume secret

Konsol

Buka Deploy layanan untuk melihat petunjuk konsol lengkap.

YAML

Di file service.yaml, tambahkan kode berikut:

volumes:
  - name: nginx-conf-secret
    secret:
      secretName: nginx_config
      items:
        - key: latest
          path: default.conf

Tentukan konfigurasi volume yang terpasang di bagian volumeMount. Hal ini berisikan satu file bernama nginx.conf yang mana isinya ditentukan sebagai nilai rahasia bernama nginx-conf-secret.

Catatan: Untuk contoh lain yang men-deploy beberapa container, lihat bagian file bantuan pada halaman deployment.

Men-deploy layanan

Konsol

1. Buka halaman Cloud Run di konsol Google Cloud :

   Buka Cloud Run

2. Pilih Services dari menu, lalu klik Deploy container untuk menampilkan formulir Create service.

   1. Pilih Deploy one revision from an existing container image dan masukkan nginx sebagai Container image URL.
   2. Di kolom Service name, berikan nama untuk layanan Anda, misalnya, hello-mc.
   3. Dari daftar Region, pilih lokasi untuk men-deploy, misalnya, us-west1.
   4. Di bagian Authentication, pilih Allow public access. Jika Anda tidak memiliki izin (peran Admin Cloud Run) untuk memilih opsi ini, layanan akan di-deploy dan memerlukan autentikasi.

3. Klik Container(s), Volumes, Networking, Security untuk meluaskan formulir konfigurasi.

   1. Klik tab Volume.
   2. Klik Tambahkan volume.
   3. Dari daftar Volume type, pilih Secret.
   4. Di kolom Nama volume, masukkan nginx-conf-secret.
   5. Di kolom Secret, masukkan nginx_config.
   6. Di bagian Lokasi spesifik untuk versi secret, tentukan default.conf sebagai jalur dan latest sebagai versi.
   7. Klik Buat untuk membuat volume secret.

4. Klik tab Containers untuk menampilkan formulir Edit container.

   1. Klik Settings, lalu di bagian Resources, ubah memori menjadi 256 MiB dan CPU menjadi 1 CPU.
   2. Klik Volume mounts.
   3. Klik Mount volume.
   4. Pilih nginx-conf-secret dari daftar nama.
   5. Untuk Mount path, masukkan etc/nginx/conf.d.
   6. Klik Selesai untuk menyelesaikan konfigurasi bagi penampung pertama.

5. Klik Tambahkan penampung untuk menambahkan penampung sidecar dan menampilkan formulir Penampung baru.

   1. Pilih URL image container default us-docker.pkg.dev/cloudrun/container/hello
   2. Klik tab Setelan, lalu di bagian Sumber Daya, ubah memori menjadi 256 MiB dan CPU menjadi 1 CPU.
   3. Klik Variabel & Secret.
   4. Klik Tambahkan variabel.
   5. Masukkan PORT sebagai nama variabel lingkungan baru dan 8888 sebagai nilai.
   6. Klik Done.

6. Buka formulir Edit penampung untuk penampung pertama (nginx).

   1. Klik tab Setelan.
   2. Di bagian Urutan mulai container, pilih nginx dari daftar Bergantung pada. Artinya, container nginx hanya dimulai setelah container hello berhasil dimulai.
   3. Klik Create dan tunggu hingga layanan Anda di-deploy.

YAML

Untuk men-deploy container server proxy dan container aplikasi web sebagai suatu layanan tunggal:

gcloud run services replace service.yaml

Verifikasi layanan yang di-deploy

Untuk memverifikasi deployment yang berhasil, salin URL Cloud Run yang dihasilkan dan buka di browser, atau gunakan perintah ini untuk mengirimkan permintaan yang terautentikasi:

curl --header "Authorization: Bearer $(gcloud auth print-identity-token)" SERVICE_URL

Anda akan disambut dengan proxy nginx yang telah berhasil di-porting ke container file bantuan hello dengan status respons 200.

Coba lakukan ini sendiri

Untuk mengikuti tutorial ini:

gcloud

1. Di terminal, clone repositori aplikasi contoh ke komputer lokal Anda:

   git clone https://github.com/GoogleCloudPlatform/cloud-run-samples

2. Ubah ke direktori yang berisikan kode contoh Cloud Run:

   cd cloud-run-samples/multi-container/hello-nginx-sample/

Langkah berikutnya

Untuk mempelajari lebih lanjut tentang cara menggunakan file bantuan di layanan Cloud Run:

• File bantuan Cloud Run akan mengaktifkan sejumlah pola multi-container lanjutan
• Men-deploy ke Cloud Run