Membuat header kustom di peta URL

Halaman ini menjelaskan cara kerja header kustom di peta URL yang digunakan oleh Load Balancer Aplikasi internal regional dan Load Balancer Aplikasi internal lintas region.

Header permintaan dan respons kustom memungkinkan Anda menentukan header tambahan yang dapat ditambahkan load balancer ke permintaan dan respons HTTP(S). Bergantung pada informasi yang terdeteksi oleh load balancer, header ini dapat mencakup informasi berikut:

• Latensi ke klien
• Lokasi geografis alamat IP klien
• Parameter koneksi TLS

Sebelum memulai

Jika perlu, update ke Google Cloud CLI versi terbaru:

gcloud components update

Cara kerja header kustom

Header kustom berfungsi sebagai berikut:

• Saat load balancer membuat permintaan ke backend, load balancer akan menambahkan header permintaan.

  Load balancer menambahkan header permintaan kustom hanya ke permintaan klien, bukan ke pemeriksaan health check. Jika backend Anda memerlukan header tertentu untuk otorisasi yang tidak ada dalam paket health check, health check mungkin gagal.

• Load balancer menetapkan header respons sebelum menampilkan respons ke klien.

Untuk mengaktifkan header kustom bagi Load Balancer Aplikasi internal regional dan Load Balancer Aplikasi internal lintas region, Anda menentukan daftar nama header dan nilai header dalam file konfigurasi peta URL.

Nama header harus memiliki properti berikut:

• Nama header harus berupa definisi nama kolom header HTTP yang valid sesuai dengan RFC 7230.
• Nama header tidak boleh X-User-IP.
• Nama header tidak boleh diawali dengan X-Google, X-Goog-, X-GFE, atau X-Amz-.
• Header hop-by-hop berikut tidak boleh digunakan: Keep-Alive, Transfer-Encoding, TE, Connection, Trailer, dan Upgrade. Sesuai dengan RFC 2616, header ini tidak disimpan oleh cache atau dipropagasi oleh proxy target.
• Nama header tidak boleh Host atau authority. Host dan authority adalah kata kunci khusus yang dicadangkan oleh Google Cloud. Anda tidak dapat mengubah header ini untuk load balancer berbasis Envoy. Sebagai gantinya, sebaiknya buat header kustom lainnya (misalnya, MyHost) agar Anda tidak mengganggu nama header yang dicadangkan.
• Nama header tidak boleh muncul lebih dari sekali dalam daftar header.

Nama header tidak peka huruf besar/kecil. Saat nama header diteruskan ke backend HTTP/2, protokol HTTP/2 mengenkode nama header sebagai huruf kecil.

Nilai header harus memiliki properti berikut:

• Nilai header harus berupa definisi kolom header HTTP yang valid sesuai dengan RFC 7230, dengan bentuk yang sudah tidak digunakan tidak diizinkan.
• Nilai header tidak boleh kosong. Header kosong ditolak.
• Nilai header dapat mencakup satu atau beberapa variabel, yang diapit oleh tanda kurung kurawal, yang diperluas ke nilai yang disediakan load balancer. Untuk mengetahui daftar lengkap variabel yang diizinkan dalam nilai header, lihat Variabel yang dapat muncul dalam nilai header.

Dalam nilai header, spasi kosong di awal dan spasi kosong di akhir tidak signifikan dan tidak diteruskan ke backend. Untuk mengizinkan tanda kurung kurawal dalam nilai header, load balancer menafsirkan dua tanda kurung kurawal buka ({{) sebagai satu tanda kurung kurawal buka ({), dan dua tanda kurung kurawal tutup (}}) sebagai satu tanda kurung kurawal tutup (}).

Menambahkan header permintaan atau respons

Untuk menambahkan header permintaan atau respons, gunakan gcloud CLI untuk mengedit peta URL sebagai berikut:

    gcloud compute url-maps edit URL_MAP_NAME \
        --region=REGION
    

   defaultService: regions/REGION/backendServices/BACKEND_SERVICE_1
   name: regional-lb-map
   region: region/REGION
   hostRules:
   - hosts:
     - '*'
     pathMatcher: matcher1
   pathMatchers:
   - defaultService: regions/REGION/backendServices/BACKEND_SERVICE_1
     name: matcher1
     routeRules:
       - matchRules:
           - prefixMatch: /PREFIX
         priority: PRIORITY # 0 is highest
         routeAction:
           weightedBackendServices:
             - backendService: regions/REGION/backendServices/BACKEND_SERVICE_1
               weight: 100
               headerAction:
                 requestHeadersToAdd:
                 - headerName: X-header-1-client-region
                   headerValue: "{client_region}"
                 - headerName: X-header-2-client-ip-port
                   headerValue: "{client_ip_address}, {client_port}"
                   replace: True
                 requesteHeadersToRemove:
                 - header-3-name
                 responseHeadersToAdd:
                 - headerName: X-header-4-server-ip-port
                   headerValue: "{server_ip_address}, {server_port}"
                   replace: True
                 responseHeadersToRemove:
                 - header-5-name
                 - header-6-name
    

    gcloud compute url-maps edit URL_MAP_NAME \
        --global
    

   defaultService: global/backendServices/BACKEND_SERVICE_1
   name: global-lb-map
   hostRules:
   - hosts:
     - '*'
     pathMatcher: matcher1
   pathMatchers:
   - defaultService: global/backendServices/BACKEND_SERVICE_1
     name: matcher1
     routeRules:
       - matchRules:
           - prefixMatch: /PREFIX
         priority: PRIORITY # 0 is highest
         routeAction:
           weightedBackendServices:
             - backendService: global/backendServices/BACKEND_SERVICE_1
               weight: 100
               headerAction:
                 requestHeadersToAdd:
                 - headerName: X-header-1-client-region
                   headerValue: "{client_region}"
                 - headerName: X-header-2-client-ip-port
                   headerValue: "{client_ip_address}, {client_port}"
                   replace: True
                 requesteHeadersToRemove:
                 - header-3-name
                 responseHeadersToAdd:
                 - headerName: X-header-4-server-ip-port
                   headerValue: "{server_ip_address}, {server_port}"
                   replace: True
                 responseHeadersToRemove:
                 - header-5-name
                 - header-6-name
    

Perhatikan perilaku berikut:

• Jika header respons dengan variabel kustom diubah menjadi string kosong, header tersebut akan dihapus.
• Jika header permintaan dengan variabel kustom diselesaikan ke string kosong, header tersebut akan dipertahankan dengan placeholder string kosong.
• Jika header permintaan kustom menyertakan variabel kustom, dan permintaan klien masuk juga menyertakan header yang sama, nilai header permintaan klien akan diganti dengan nilai baru yang diberikan oleh header kustom load balancer.

Variabel yang dapat muncul di nilai header

Variabel berikut dapat muncul dalam nilai header kustom.

Load balancer memperluas variabel ke string kosong jika tidak dapat menentukan nilainya. Contoh:

• Variabel lokasi geografis saat lokasi alamat IP tidak diketahui
• Parameter TLS saat TLS tidak digunakan
• {origin_request_header} saat permintaan tidak menyertakan header Origin

Nilai geografis adalah perkiraan berdasarkan alamat IP klien. Dari waktu ke waktu, Google memperbarui data yang memberikan nilai ini untuk meningkatkan akurasi dan mencerminkan perubahan geografis dan politik. Meskipun header X-Forwarded-For asli berisi informasi lokasi yang valid, Google memperkirakan lokasi klien dengan menggunakan informasi alamat IP sumber yang terdapat dalam paket yang diterima oleh load balancer.

Header kustom TLS bersama

Variabel header tambahan berikut tersedia jika TLS bersama (mTLS) dikonfigurasi di TargetHttpsProxy load balancer.

Batasan

Batasan berikut berlaku:

• Anda tidak dapat mengonfigurasi header kustom pada layanan backend yang digunakan oleh Load Balancer Aplikasi internal regional dan Load Balancer Aplikasi internal lintas-region.