ડોકરમાં Nginx રિવર્સ પ્રોક્સી સાથે કીક્લોક v26 ને ગોઠવી રહ્યું છે: વિવિધ ક્ષેત્રોમાં કન્સોલ સમસ્યાઓનું નિરાકરણ

Nginx અને Docker સાથે કીક્લોક કન્સોલ ભૂલોને દૂર કરવી

Nginx રિવર્સ પ્રોક્સી સાથે ડોકર કન્ટેનરમાં કીક્લોક સેટ કરવું એ સુરક્ષિત ઍક્સેસને મેનેજ કરવા માટે એક શક્તિશાળી ગોઠવણી હોઈ શકે છે, પરંતુ તે પડકારો વિના આવતું નથી. 🐳 જ્યારે કીક્લોક ડેટાબેસેસ સ્થાનાંતરિત કરતી વખતે અથવા બહુવિધ ક્ષેત્રોને હેન્ડલ કરતી વખતે, અણધારી ભૂલો વારંવાર ઉભી થઈ શકે છે, જે સંચાલકો માટે મૂંઝવણ ઊભી કરે છે.

આ દૃશ્ય કીક્લોક v19.0.2 થી કીક્લોક v26 માં સ્થળાંતરનું વર્ણન કરે છે, જે દરમિયાન લોગિન પછી તમામ ક્ષેત્રોમાં "ભૂલનો સંદેશ નિર્ધારિત કરવામાં અસમર્થ" દેખાયો. Nginx લૉગ્સ અને Keycloak ભૂલ લૉગ દ્વારા સમસ્યાને ટ્રૅક કરવાથી નિષ્ફળ HTTP વિનંતી જોવા મળી.

સમાન સેટઅપ્સમાં, ખોટી રીતે ગોઠવેલ પ્રોક્સી અથવા નેટવર્કિંગ સ્તર "502 ખરાબ ગેટવે" ભૂલોને ટ્રિગર કરી શકે છે, સામાન્ય રીતે Nginx અથવા Docker કીક્લોકને કેવી રીતે વિનંતી કરે છે તે સમસ્યાઓને કારણે. કીક્લોક એકીકૃત રીતે કાર્ય કરે છે તેની ખાતરી કરવા માટે આ સમસ્યાને પ્રોક્સી સેટિંગ્સ, પર્યાવરણ ચલો અથવા SSL રૂપરેખાંકનોમાં ગોઠવણોની જરૂર પડી શકે છે.

આ માર્ગદર્શિકામાં, અમે કીક્લોકમાં આ સમસ્યાના નિવારણ માટે સંભવિત ઉકેલો પર જઈશું. અમે કી રૂપરેખાંકનોની સમીક્ષા કરીશું, ભૂલ લૉગ્સનું વિશ્લેષણ કરીશું અને વિશિષ્ટ સેટિંગ્સનું અન્વેષણ કરીશું જે Docker-Nginx સેટઅપમાં કીક્લોકને સ્થિર કરવામાં મદદ કરી શકે છે. અંત સુધીમાં, તમારી પાસે આવી સમસ્યાઓ ઉકેલવા અને એડમિન કન્સોલની સરળ, અવિરત ઍક્સેસ સુનિશ્ચિત કરવા માટે આંતરદૃષ્ટિ હશે.

કીક્લોક અને Nginx રૂપરેખાંકનનું વિગતવાર ભંગાણ

Nginx રિવર્સ પ્રોક્સી પાછળ કીક્લોકને ગોઠવવા માટે અમે જે સ્ક્રિપ્ટો વિકસાવી છે તે કીક્લોક એડમિન કન્સોલની સુરક્ષિત ઍક્સેસને રૂટીંગ અને મેનેજ કરવામાં મહત્વપૂર્ણ ભૂમિકા ભજવે છે. Nginx રૂપરેખાંકન ફાઇલ, દાખલા તરીકે, સ્પષ્ટ કરે છે અપસ્ટ્રીમ બ્લોક કે જે કીક્લોકના બેકએન્ડ આઈપી એડ્રેસ અને પોર્ટને વ્યાખ્યાયિત કરે છે, જે Nginx ને વિનંતીઓને ચોક્કસ રીતે નિર્દેશિત કરવાની મંજૂરી આપે છે. આ દૃશ્યો માટે આવશ્યક છે જ્યાં કીક્લોક સેવા અલગ નેટવર્ક સેગમેન્ટ અથવા ડોકર કન્ટેનરમાં કાર્ય કરે છે. પ્રોક્સી નિર્દેશોનો ઉપયોગ કરીને જેમ કે proxy_pass, અમે Nginx ને મધ્યસ્થી તરીકે કાર્ય કરવા, બાહ્ય વિનંતીઓનું સંચાલન કરવા અને તેમને કીક્લોકના આંતરિક સેવા અંતિમ બિંદુ પર ફોરવર્ડ કરવા સક્ષમ કરીએ છીએ. આ સેટઅપ સામાન્ય રીતે ઉત્પાદન વાતાવરણમાં જોવા મળે છે જ્યાં લોડ બેલેન્સિંગ અને સુરક્ષિત એક્સેસ માટે રિવર્સ પ્રોક્સી જરૂરી હોય છે.

Nginx રૂપરેખાંકનની અંદર, બહુવિધ હેડરો સાથે સેટ કરેલ છે proxy_set_header કીક્લોક તમામ ક્લાયન્ટ માહિતી ચોક્કસ રીતે મેળવે છે તેની ખાતરી કરવા માટે આદેશો. ઉદાહરણ તરીકે, એક્સ-રીઅલ-આઈપી અને એક્સ-ફોરવર્ડ-પ્રોટો ક્લાયંટના IP અને મૂળ વિનંતી પ્રોટોકોલને પસાર કરવા માટે વપરાય છે. આ માહિતી આવશ્યક છે કારણ કે કીક્લોક તેનો ઉપયોગ સચોટ રીડાયરેક્ટ URL જનરેટ કરવા અને સુરક્ષા નીતિઓનું સંચાલન કરવા માટે કરે છે. આવા સેટઅપ્સમાં એક સામાન્ય સમસ્યા હેડર ખૂટે છે, જે જ્યારે કીક્લોક વપરાશકર્તાઓને પ્રમાણિત કરવાનો અથવા ક્ષેત્રોને માન્ય કરવાનો પ્રયાસ કરે છે ત્યારે ભૂલો થઈ શકે છે. આ હેડરોને સ્પષ્ટ રીતે વ્યાખ્યાયિત કરીને, સંચાલકો ખાતરી કરે છે કે કીક્લોક વિનંતીઓને યોગ્ય રીતે પ્રક્રિયા કરવા માટે જરૂરી સંદર્ભ પ્રાપ્ત કરે છે. આ અભિગમ વિનંતીઓને કેવી રીતે સંચાલિત કરવામાં આવે છે તેમાં સુરક્ષા અને સુસંગતતા બંનેને વધારે છે.

અમે કીક્લોક માટે બનાવેલ ડોકર કમ્પોઝ ફાઇલનો ઉપયોગ કરીને જમાવટને સરળ બનાવે છે env_file તમામ પર્યાવરણ ચલો માટે. આ ડોકર કન્ટેનરને ડેટાબેઝ ઓળખપત્રો, કીક્લોક હોસ્ટનામ અને સંબંધિત પાથ જેવા રૂપરેખાંકનો લોડ કરવાની મંજૂરી આપે છે, તેને વધુ સુરક્ષિત અને સ્વીકાર્ય બનાવે છે. પર્યાવરણ ફાઇલનો ઉપયોગ કરવો એ પણ વ્યવહારુ છે કારણ કે તે હાર્ડ-કોડેડ મૂલ્યોને ટાળીને, ડોકર કમ્પોઝ ફાઇલમાંથી સંવેદનશીલ માહિતીને અલગ કરે છે. પરિણામે, ડેટાબેસેસ સ્વિચ કરવું અથવા એક્સેસ ઓળખપત્રોને સંશોધિત કરવું સીમલેસ બની જાય છે, જે ખાસ કરીને ગતિશીલ વાતાવરણમાં ઉપયોગી છે જ્યાં સેવાઓ વારંવાર અપડેટ કરવામાં આવે છે. ઉદાહરણમાં, પર્યાવરણ વેરીએબલ KC_PROXY_HEADERS "xforwarded" પર સેટ કરેલ છે તેની ખાતરી કરે છે કે Keycloak તે પ્રોક્સી પાછળ છે તે સમજે છે, તે મુજબ URL જનરેશન અને સત્ર સંચાલનમાં ગોઠવણો કરે છે.

રૂપરેખાંકન ઉપરાંત, અમે એ પ્રદાન કર્યું છે બાશ સ્ક્રિપ્ટ કે જે કીક્લોકની ઉપલબ્ધતા ચકાસવા માટે સરળ આરોગ્ય તપાસ તરીકે સેવા આપે છે. સ્ક્રિપ્ટ વાપરે છે કર્લ કીક્લોક એન્ડપોઇન્ટ પર HTTP વિનંતી કરવા માટે અને ચેક કરે છે કે શું સ્ટેટસ કોડ 200 બરાબર છે, જે દર્શાવે છે કે સેવા કાર્યરત છે. નિષ્ફળતાના કિસ્સામાં, સ્ક્રિપ્ટ Nginx કન્ટેનરને પુનઃપ્રારંભ કરે છે, સ્વયંસંચાલિત પુનઃપ્રાપ્તિનું સ્વરૂપ ઓફર કરે છે. આ સેટઅપ પ્રોડક્શન એન્વાયર્નમેન્ટ્સ માટે આદર્શ છે જ્યાં અપટાઇમ મહત્વપૂર્ણ છે, કારણ કે જો કનેક્શન સમસ્યાઓ આવે તો તે સેવાને સ્વ-હીલ કરવામાં સક્ષમ કરે છે. એન્ડપોઇન્ટ એક્સેસિબિલિટી માટે પાયથોન-આધારિત એકમ પરીક્ષણ સાથે, આના જેવી સ્ક્રિપ્ટનું પરીક્ષણ, સિસ્ટમની સ્થિરતાને મજબૂત બનાવે છે, એડમિનિસ્ટ્રેટર્સને માનસિક શાંતિ આપે છે તે જાણીને કે સેટઅપ સમસ્યાઓને સક્રિય રીતે સૂચિત કરશે અથવા સુધારશે. સંચાલન માટેનો આ સક્રિય અભિગમ ડાઉનટાઇમ ઘટાડવા અને કીક્લોકની સીમલેસ ઍક્સેસની ખાતરી કરવા માટે મહત્વપૂર્ણ છે એડમિન કન્સોલ.

upstream sso-mydomain-com {
    server 10.10.0.89:8080;
}
server {
    listen 443 ssl;
    server_name sso.mydomain.com;
    location / {
        proxy_pass http://sso-mydomain-com/;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-Port $server_port;
    }
    ssl_certificate /etc/nginx/ssl/sso.mydomain.com/fullchain.pem;
    ssl_certificate_key /etc/nginx/ssl/sso.mydomain.com/privkey.pem;
}
server {
    listen 8443 ssl;
    server_name sso.mydomain.com;
    error_log /usr/local/nginx/logs/sso_err.log debug;
    location / {
        proxy_pass http://sso-mydomain-com/;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-Port $server_port;
    }
    ssl_certificate /etc/nginx/ssl/sso.mydomain.com/fullchain.pem;
    ssl_certificate_key /etc/nginx/ssl/sso.mydomain.com/privkey.pem;
}

version: '3.9'
services:
  keycloak:
    container_name: keycloak
    image: quay.io/keycloak/keycloak:26.0
    env_file:
      - .env
    ports:
      - "8080:8080"
    volumes:
      - /opt/keycloak/themes:/opt/keycloak/themes
      - /etc/localtime:/etc/localtime
    privileged: true
    command: start

import requests
def test_whoami_endpoint():
    url = "https://sso.mydomain.com:8443/auth/admin/master/console/whoami?currentRealm=master"
    headers = {"Content-Type": "application/json"}
    try:
        response = requests.get(url, headers=headers, verify=True)
        assert response.status_code == 200, "Expected 200 OK, got {}".format(response.status_code)
        print("Test passed: whoami endpoint accessible")
    except requests.ConnectionError:
        print("Connection error: Check Nginx reverse proxy and Keycloak availability")
    except AssertionError as e:
        print("Assertion error:", e)
# Run the test
test_whoami_endpoint()

#!/bin/bash
# Check if Keycloak is reachable via the /whoami endpoint
URL="http://10.10.0.89:8080/auth/admin/master/console/whoami"
STATUS_CODE=$(curl -s -o /dev/null -w "%{http_code}" $URL)
if [ "$STATUS_CODE" -ne 200 ]; then
    echo "Keycloak endpoint unavailable, restarting Nginx..."
    docker restart nginx
else
    echo "Keycloak endpoint is healthy."
fi

સુરક્ષિત અને સીમલેસ રિવર્સ પ્રોક્સી ઓપરેશન્સ માટે કીક્લોકને ઑપ્ટિમાઇઝ કરી રહ્યું છે

જ્યારે વિપરીત પ્રોક્સી જેવા કીક્લોકને ગોઠવી રહ્યા હોય Nginx, ઘણી વધારાની વિચારણાઓ સુનિશ્ચિત કરવામાં મદદ કરી શકે છે કે સેટઅપ સુરક્ષિત, કાર્યક્ષમ અને સ્થિર છે. એક નિર્ણાયક પાસું SSL સમાપ્તિ છે - Nginx સ્તર પર HTTPS ને સંભાળવું. કીક્લોક સામાન્ય રીતે ડોકરની અંદર HTTP પર સાંભળે છે, Nginx એ SSL એન્ડપોઇન્ટ તરીકે કાર્ય કરી શકે છે, એન્ક્રિપ્શનને ઓફલોડ કરીને અને કીક્લોક પર સંસાધન લોડ ઘટાડે છે. આ સેટઅપ અંત-વપરાશકર્તાઓ માટે સુરક્ષિત HTTPS ઍક્સેસ જાળવી રાખીને Nginx ને HTTP પર કીક્લોક સાથે વાતચીત કરવાની મંજૂરી આપે છે. વધુમાં, SSL પ્રમાણપત્રો માત્ર Nginx પર સંગ્રહિત થાય છે, પ્રમાણપત્ર વ્યવસ્થાપનને સરળ બનાવે છે. લેટ્સ એન્ક્રિપ્ટ જેવા સ્વચાલિત ટૂલ્સ નવીકરણને સુવ્યવસ્થિત કરી શકે છે, ખાસ કરીને સ્ક્રિપ્ટ્સ સાથે જે Nginx ને પ્રમાણપત્ર અપડેટ તરીકે ફરીથી લોડ કરે છે.

બીજું મહત્વનું પરિબળ લોડ બેલેન્સિંગ અને સ્કેલિંગ છે. દાખલા તરીકે, ડોકરના નેટવર્ક રૂપરેખાંકનોનો ઉપયોગ કરીને, સંચાલકો Nginx માં અપસ્ટ્રીમ સર્વર પૂલ બનાવી શકે છે જેમાં બહુવિધ કીક્લોક કન્ટેનરનો સમાવેશ થાય છે, લોડ વિતરણ અને ઉપલબ્ધતામાં વધારો કરે છે. આ proxy_pass ડાયરેક્ટિવ આ પૂલ તરફ નિર્દેશ કરે છે, Nginx ને બહુવિધ કીક્લોક ઉદાહરણોમાં રૂટ વિનંતીઓ માટે સક્રિય કરે છે. આ અભિગમ ઉચ્ચ-ટ્રાફિક વાતાવરણમાં ફાયદાકારક છે, કારણ કે તે કોઈપણ એક ઉદાહરણને ભરાઈ જવાથી અટકાવે છે. વધુમાં, સત્રની દ્રઢતા, જેને સ્ટીકી સત્રો પણ કહેવાય છે, તે ખાતરી કરે છે કે વપરાશકર્તાઓ પ્રમાણીકરણની સમસ્યાઓને ટાળીને સમાન ઉદાહરણ સાથે જોડાયેલા રહે છે. Nginx અથવા Docker સ્ક્રિપ્ટ્સનો ઉપયોગ કરીને આરોગ્ય તપાસ સ્વચાલિત કરી શકાય છે, કીક્લોકની ઉપલબ્ધતા પર દેખરેખ રાખી શકાય છે અને જો નિષ્ફળતા આવે તો દાખલાઓ પુનઃપ્રારંભ કરી શકાય છે. 🛠️

છેલ્લે, કીક્લોકના બિલ્ટ-ઇન મેટ્રિક્સ અને લૉગ્સનો લાભ લેવો એ સિસ્ટમની જાળવણી અને મુશ્કેલીનિવારણ માટે મહત્વપૂર્ણ છે. કીક્લોક દરેક વિનંતી માટે વિગતવાર લૉગ્સ જનરેટ કરી શકે છે, જે, જ્યારે Nginx ના એક્સેસ લૉગ્સ સાથે જોડી બનાવવામાં આવે છે, ત્યારે સંપૂર્ણ ઑડિટ ટ્રેલ બનાવે છે. પ્રોમિથિયસ અને ગ્રાફના જેવા મોનિટરિંગ ટૂલ્સ કીક્લોકના પ્રદર્શન મેટ્રિક્સને વિઝ્યુઅલાઈઝ કરી શકે છે, વપરાશકર્તાઓને અસર કરે તે પહેલાં વિસંગતતાઓના સંચાલકોને ચેતવણી આપી શકે છે. Nginx માં, સેટિંગ ભૂલ_લોગ થી debug સેટઅપ દરમિયાનનું સ્તર રૂપરેખાંકન અથવા નેટવર્ક સમસ્યાઓના નિદાન માટે વિગતવાર માહિતી મેળવે છે. એકસાથે, આ વ્યૂહરચનાઓ વધુ સ્થિતિસ્થાપક અને સુરક્ષિત કીક્લોક જમાવટને સુનિશ્ચિત કરે છે, જે તેને રિવર્સ પ્રોક્સી પાછળ એન્ટરપ્રાઇઝ-ગ્રેડ પ્રમાણીકરણ માટે એક આદર્શ ઉકેલ બનાવે છે.