wso2 / wso2/docs-apim

Missing Load Balancer Configuration

Open
#6,191 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-4.0.0 API-M-4.1.0 API-M-Master help wanted Severity/Major Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

The Configuring the Proxy Server and the Load Balancer doc needs more ngnix.conf configurations

Under HA for Gateway all these configs are required. The doc is missing a few:

upstream sslgw1.am.wso2.com {
    server 192.xxx.xxx.xx:9443;
    server 192.xxx.xxx.xx:9444;
    #ip_hash;
    sticky learn create=$upstream_cookie_jsessionid
        lookup=$cookie_jsessionid
    zone=client_sessions:1m;
}

upstream <lb_hostname> {
    server 192.xxx.xxx.xx:8243;
    server 192.xxx.xxx.xx:8244;
}

server {
    listen 80;
    server_name sslgw1.am.wso2.com;
    rewrite ^/(.*) https://sslgw1.am.wso2.com/$1 permanent;
}

server {
    listen 443 ssl;
    server_name <server_name>;
    proxy_set_header X-Forwarded-Port 443;
    ssl_certificate /etc/nginx/ssl/server.crt;
    ssl_certificate_key /etc/nginx/ssl/server.key;
    large_client_header_buffers 4 32k;
    location / {
            proxy_set_header X-Forwarded-Host $host;
            proxy_set_header X-Forwarded-Server $host;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header Host $http_host;
            proxy_read_timeout 5m;
            proxy_send_timeout 5m;
            fastcgi_buffers 16 16k;
            fastcgi_buffer_size 38k;
            proxy_buffer_size   128k;
            proxy_buffers     4 256k;
            proxy_busy_buffers_size     256k;
            proxy_pass https://<lb_hostname>;
            proxy_redirect https://192.xxx.xxx.xx:9443 https://<lb_hostname>;
            proxy_redirect https://192.xxx.xxx.xx:9444 https://<lb_hostname>;
        }
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked “Configuring the Proxy Server and the Load Balancer” documentation page and compare its HA for Gateway section with point 6.4 of the referenced document. Add the missing nginx configurations and clarify the access_log and error_log paths and related file-missing issue. Done means the page contains the required configuration examples and sufficient log guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.