🥇कुबेरनेट्स टिप्स और ट्रिक्स: एनजीआईएनएक्स इनग्रेस में वैयक्तिकृत त्रुटि पृष्ठ

इस लेख में, मैं वैयक्तिकृत त्रुटि पृष्ठों को प्रदर्शित करने से संबंधित एनजीआईएनएक्स इनग्रेस की दो विशेषताओं के साथ-साथ उनमें मौजूद सीमाओं और उनके आसपास काम करने के तरीकों के बारे में बात करना चाहता हूं।

1. डिफ़ॉल्ट बैकएंड बदलना

डिफ़ॉल्ट रूप से, एनजीआईएनएक्स इनग्रेस डिफ़ॉल्ट बैकएंड का उपयोग करता है, जो संबंधित कार्य करता है। इसका मतलब यह है कि जब एक ऐसे होस्ट को निर्दिष्ट करते हुए इनग्रेस का अनुरोध किया जाता है जो इनग्रेस संसाधनों में नहीं है, तो हमें 404 प्रतिक्रिया कोड के साथ निम्नलिखित पृष्ठ प्राप्त होता है:

हालाँकि, अधिक से अधिक बार हमारे ग्राहक अपने पेज को मानक 404 के बजाय कॉर्पोरेट लोगो और अन्य सुविधाओं के साथ दिखाने का अनुरोध लेकर आते हैं। ऐसा करने के लिए, NGINX Ingress के पास है अंतर्निहित क्षमता फिर से परिभाषित default-backend-service. हम प्रारूप प्रविष्टि को उसी नाम के विकल्प के तर्क के रूप में पास करते हैं namespace/servicename. सेवा का पोर्ट 80 होना चाहिए.

ऐसा करने के लिए, आपको अपने एप्लिकेशन के साथ अपना स्वयं का पॉड (तैनाती) और सेवा बनानी होगी (YAML में उदाहरण कार्यान्वयन ingress-nginx रिपॉजिटरी से), जो डिफ़ॉल्ट बैकएंड के बजाय दिया जाएगा।

यहाँ एक छोटा सा चित्रण है:

~$ curl -i -XGET http://sadsdasdas.kube-cloud.my/
HTTP/1.1 404 Not Found
Date: Mon, 11 Mar 2019 05:38:15 GMT
Content-Type: */*
Transfer-Encoding: chunked
Connection: keep-alive

<span>The page you're looking for could not be found.</span>

तो सभी डोमेन जो स्पष्ट रूप से YAML के माध्यम से नहीं बनाए गए हैं kind: Ingress, डिफ़ॉल्ट-बैकएंड में आते हैं। उपरोक्त सूची में, यह डोमेन बन गया sadsdasdas.

2. डिफ़ॉल्ट बैकएंड का उपयोग करके एप्लिकेशन में HTTP त्रुटियों को संभालना

एक अन्य स्थिति एक एप्लिकेशन के लिए HTTP त्रुटियों (404, 500, 502...) में समाप्त होने वाले अनुरोधों की है जो ऐसी स्थितियों को संसाधित नहीं करती है (संबंधित सुंदर पृष्ठ उत्पन्न नहीं होते हैं)। यह कई अनुप्रयोगों में एक ही त्रुटि पृष्ठ परोसने की डेवलपर्स की इच्छा के कारण भी हो सकता है।

इस मामले को सर्वर साइड पर लागू करने के लिए हमें चाहिए:

डिफ़ॉल्ट बैकएंड के बारे में पैराग्राफ से ऊपर दिए गए निर्देशों का पालन करें;
nginx-ingress कॉन्फ़िगरेशन कॉन्फ़िग मैप में एक कुंजी जोड़ें custom-http-errors, उदाहरण के लिए, मूल्य के साथ 404,503 (स्पष्ट रूप से उन त्रुटि कोडों से मेल खाता है जो नए नियम द्वारा कवर किए गए हैं)।

अपेक्षित परिणाम प्राप्त हो गया है: जब क्लाइंट एप्लिकेशन चल रहा होता है और प्रतिक्रिया कोड 404 या 503 के साथ एक त्रुटि प्राप्त करता है, तो अनुरोध स्वचालित रूप से नए डिफ़ॉल्ट बैकएंड पर पुनर्निर्देशित हो जाएगा...

हालाँकि, डिफ़ॉल्ट बैकएंड और कस्टम-http-त्रुटियों के लिए एप्लिकेशन विकसित करते समय, आपको एक महत्वपूर्ण विशेषता को ध्यान में रखना होगा:

!!! Important The custom backend is expected to return the correct HTTP status code instead of 200. NGINX does not change the response from the custom default backend.

तथ्य यह है कि जब किसी अनुरोध को पुनर्निर्देशित किया जाता है, तो हेडर में पिछले प्रतिक्रिया कोड और अतिरिक्त जानकारी के साथ उपयोगी जानकारी होगी (उनकी पूरी सूची उपलब्ध है) यहां).

इसका मतलब यह है कि आपको स्वयं ऐसा करना होगा सही प्रतिक्रिया कोड का ध्यान रखें. यहाँ एक उदाहरण है। दस्तावेज़ से यह कैसे काम करता है।

अलग-अलग एप्लिकेशन के अलग-अलग डिफ़ॉल्ट बैकएंड होते हैं

यह सुनिश्चित करने के लिए कि समाधान पूरे क्लस्टर के लिए वैश्विक नहीं है, बल्कि केवल विशिष्ट अनुप्रयोगों पर लागू होता है, आपको सबसे पहले इनग्रेस संस्करण की जांच करनी होगी। यदि यह मेल खाता है 0.23 या उच्चतर, मूल इनग्रेस एनोटेशन का उपयोग करें:

हम ओवरराइड कर सकते हैं default-backend के लिए प्रत्येक के प्रवेश का एनोटेशन का उपयोग करना;
हम ओवरराइड कर सकते हैं custom-http-errors के लिए प्रत्येक के प्रवेश का एनोटेशन का उपयोग करना.

परिणामस्वरूप, इनग्रेस संसाधन कुछ इस तरह दिखेगा:

apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: {{ .Chart.Name }}-app2
  annotations:
    kubernetes.io/ingress.class: "nginx"
    nginx.ingress.kubernetes.io/custom-http-errors: "404,502"
    nginx.ingress.kubernetes.io/default-backend: error-pages
spec:
  tls:
  - hosts:
    - app2.example.com
    secretName: wildcard-tls
  rules:
  - host: app2.example.com
    http:
      paths:
      - path: /
        backend:
          serviceName: {{ .Chart.Name }}-app2
          servicePort: 80

इस मामले में, त्रुटियों 404 और 502 को सभी आवश्यक शीर्षलेखों के साथ त्रुटि-पृष्ठ सेवा पर पुनर्निर्देशित किया जाएगा।

В इनग्रेस के पिछले संस्करणों में यह सुविधा नहीं थी (0.23 पर घातक प्रतिबद्धता). और यदि आपके क्लस्टर में 2 पूरी तरह से अलग-अलग एप्लिकेशन चल रहे हैं और आप उनमें से प्रत्येक के लिए एक अलग डिफ़ॉल्ट-बैकएंड-सेवा और अलग-अलग त्रुटि कोड की प्रोसेसिंग निर्दिष्ट करना चाहते हैं, तो इसके लिए आपको वर्कअराउंड का उपयोग करना होगा, जिनमें से हमारे पास दो हैं।

प्रवेश <0.23: एक तक पहुंचें

यह विकल्प सरल है. एक एप्लिकेशन के रूप में जो अपने पृष्ठों की सेवा करता है, हमारे पास नियमित HTML है, जो हेडर को देखना और सही प्रतिक्रिया कोड वापस करना नहीं जानता है। इस तरह के एप्लिकेशन को यूआरएल से इनग्रेस के साथ रोल आउट किया जाता है /error-pages, और कैटलॉग में ws लौटाया गया HTML होगा.

YAML में चित्रण:

apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: {{ .Chart.Name }}-app2
  annotations:
    kubernetes.io/ingress.class: "nginx"
    ingress.kubernetes.io/server-snippet: |
      proxy_intercept_errors on;
      error_page 500 501 502 503 504 @error_pages;
      location @error_pages {
        rewrite ^ /error-pages/other/index.html break;
        proxy_pass http://error-pages.prod.svc.cluster.local;
      }
spec:
  tls:
  - hosts:
    - app2.example.com
    secretName: wildcard-tls
  rules:
  - host: app2.example.com
    http:
      paths:
      - path: /
        backend:
          serviceName: {{ .Chart.Name }}-app2
          servicePort: 80

इस परिनियोजन के लिए सेवा क्लस्टरआईपी प्रकार की होनी चाहिए।

उसी समय, एप्लिकेशन में जहां हम त्रुटि को संसाधित करेंगे, इनग्रेस में हम निम्नलिखित सामग्री के साथ एक सर्वर-स्निपेट या कॉन्फ़िगरेशन-स्निपेट जोड़ते हैं:

nginx.ingress.kubernetes.io    /server-snippet: |
      proxy_intercept_errors on;
      error_page 500 501 502 503 504 @error_pages;
      location @error_pages {
        rewrite ^ /error-pages/ws/index.html break;
        proxy_pass http://error-pages.prod.svc.cluster.local;
      }

प्रवेश <0.23: दूसरा दृष्टिकोण

एप्लिकेशन के लिए एक विकल्प जो हेडर को संसाधित कर सकता है... और सामान्य तौर पर यह एक अधिक सही तरीका है, जो कस्टम-http-त्रुटियों से उधार लिया गया है। इसे मैन्युअल रूप से उपयोग करना (कॉपी करना) आपको वैश्विक सेटिंग्स को बदलने की अनुमति नहीं देगा।

चरण इस प्रकार हैं. हम बनाते हैं समान तैनाती एक ऐसे एप्लिकेशन के साथ जो आवश्यक सुर्खियाँ सुन सकता है और सही ढंग से प्रतिक्रिया दे सकता है। निम्नलिखित सामग्री के साथ इनग्रेस एप्लिकेशन में एक सर्वर-स्निपेट जोड़ें:

nginx.ingress.kubernetes.io    /server-snippet: |
      proxy_intercept_errors off;
      error_page 404 = @custom_404;
      error_page 503 = @custom_503;
      location @custom_404 {
        internal;
        proxy_intercept_errors off;
        proxy_set_header       X-Code             404;
        proxy_set_header       X-Format           $http_accept;
        proxy_set_header       X-Original-URI     $request_uri;
        proxy_set_header       X-Namespace        $namespace;
        proxy_set_header       X-Ingress-Name     $ingress_name;
        proxy_set_header       X-Service-Name     $service_name;
        proxy_set_header       X-Service-Port     $service_port;
        proxy_set_header       Host               $best_http_host;
        rewrite ^ /error-pages/ws/index.html break;
        proxy_pass http://error-pages.prod.svc.cluster.local;
      }
      location @custom_503 {
        internal;
        proxy_intercept_errors off;
        proxy_set_header       X-Code             503;
        proxy_set_header       X-Format           $http_accept;
        proxy_set_header       X-Original-URI     $request_uri;
        proxy_set_header       X-Namespace        $namespace;
        proxy_set_header       X-Ingress-Name     $ingress_name;
        proxy_set_header       X-Service-Name     $service_name;
        proxy_set_header       X-Service-Port     $service_port;
        proxy_set_header       Host               $best_http_host;
        rewrite ^ /error-pages/ws/index.html break;
        proxy_pass http://error-pages.prod.svc.cluster.local;
      }

जैसा कि आप देख सकते हैं, प्रत्येक त्रुटि के लिए जिसे हम संसाधित करना चाहते हैं, हमें अपना स्वयं का स्थान बनाना होगा, जहां सभी आवश्यक हेडर डाले जाएंगे, जैसे कि "मूल" में। कस्टम-त्रुटि-पृष्ठ. इस तरह हम अलग-अलग स्थानों और सर्वरों के लिए भी अलग-अलग वैयक्तिकृत त्रुटि पृष्ठ बना सकते हैं।

पुनश्च

K8s टिप्स और ट्रिक्स श्रृंखला से अन्य:

हमारे ब्लॉग पर भी पढ़ें:

स्रोत: www.habr.com

कुबेरनेट्स युक्तियाँ और युक्तियाँ: एनजीआईएनएक्स इनग्रेस में कस्टम त्रुटि पृष्ठ