{"id":7142,"date":"2023-06-22T12:47:41","date_gmt":"2023-06-22T10:47:41","guid":{"rendered":"http:\/\/blog.bart.sk\/en\/?p=7142"},"modified":"2024-01-25T14:03:06","modified_gmt":"2024-01-25T13:03:06","slug":"zero-downtime-deployments-using-supervisor-and-nginx-load-balancer-how-to-do-it","status":"publish","type":"post","link":"https:\/\/blog.bart.sk\/en\/zero-downtime-deployments-using-supervisor-and-nginx-load-balancer-how-to-do-it\/","title":{"rendered":"Zero-downtime Deployments Using Supervisor and Nginx Load Balancer: How to Do It?"},"content":{"rendered":"

When you run a web application in a production environment, you should strive for its 100% availability. If you often deploy new versions and cause outages while doing so, it’s perceived as a big mistake. A few minutes “off” can result in a significant loss for the client.<\/b><\/p>\n

We use the <\/span>Supervisor<\/span> tool to run and monitor processes on Unix and Unix-like systems. It has proven to be flexible, extensible and, moreover, it enables the automation and simplification of process management. Usually, it maintains Node.js and REST API services for us<\/span>. Under normal circumstances, when restarting such a service, a few seconds of downtime occur. <\/b>New source codes are uploaded to the server and the service must be reloaded.<\/span><\/p>\n

We’re able to fix this problem by setting up Nginx and Supervisor.<\/b> It should be noted that although it’s a quick, simple and relatively efficient solution, it isn’t a system that “thinks” of all the problems associated with deploying applications. That’s why it’s necessary to keep your eyes open and to fine-tune the deployment on the fly.<\/span><\/p>\n

Initial configuration with outages<\/b><\/h2>\n

Suppose we use the following command to run the REST API:<\/span><\/p>\n\n\n\n
\n
$<\/span> npm run production\u00a0<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
The simplified related Supervisor configuration is as follows: <\/span><\/p>\n\n\n\n
\n
[program:mojweb-api]<\/span>\r\n command=npm<\/span> run<\/span> production<\/span> \r\n directory=\/var\/www\/mojweb.sk\/www\/api<\/span>\r\n user=mojweb<\/span>\r\n stopasgroup=true<\/span>\r\n killasgroup=true<\/span>\r\n autostart=true<\/span>\r\n autorestart=true<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
This configuration results in the service being turned on as soon as the virtual machine is started. <\/b>At the same time, the Supervisor shall ensure that the process is started whenever a failure occurs.<\/span><\/p>\n
The Node.js itself “listens” to the process on the port or socket, which in our case was defined in the configuration file. So let’s assume that the API will listen on port 10000 when it starts.<\/span><\/p>\n
The simplified NGINX configuration is as follows: <\/span><\/p>\n\n\n\n
\n
\u00a0 \u00a0 \u00a0 \u00a0 <\/span>location<\/span> \/api-eshop<\/span> {<\/span>\r\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>rewrite<\/span> ^\/api-eshop\/(.*)<\/span> \/$1<\/span>\u00a0 <\/span>break;<\/span>\r\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>proxy_pass<\/span> http:\/\/localhost:10000;<\/span>\r\n \u00a0 \u00a0 \u00a0 \u00a0 <\/span>}<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Requests that arrive at the line \/api-eshop will be routed to port 10000.\u00a0<\/span><\/p>\n
To restart the service, we use the Supervisor:<\/span><\/p>\n\n\n\n
\n
$<\/span> supervisorctl restart mojweb-api\u00a0<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
New configuration<\/b><\/h2>\n
The principle of starting changes in the new configuration will work as follows.<\/b><\/p>\n
    \n
  1. An API instance is running on the server\u00a0<\/span><\/li>\n
  2. Changes to the source code will be uploaded to the web\u00a0<\/span><\/li>\n
  3. The second instance of the API will be turned on on the server with the new source code\u00a0<\/span><\/li>\n
  4. The old API instance will shut down\u00a0<\/span><\/li>\n
  5. There\u2019s only one updated application running on the server.<\/span><\/li>\n<\/ol>\n
    In order to achieve deployment of changes to the site without outages, we need to make a few minor adjustments.\u00a0<\/b><\/p>\n
    On the application side, we need to achieve the ability to configure the port on which we are listening directly when running from the command line.\u00a0<\/span><\/p>\n
    We’ll replace the original command with:<\/span><\/p>\n\n\n\n
    \n
    $<\/span> npm run production -p 10000<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    And we’ll modify the Supervisor configuration as follows:<\/span><\/p>\n\n\n\n
    \n
    [program:mojweb-api1]<\/span>\r\n command=npm<\/span> run<\/span> production<\/span> -p 10000<\/span>\r\n directory=\/var\/www\/mojweb.sk\/www\/api<\/span>\r\n user=mojweb<\/span>\r\n stopasgroup=true<\/span>\r\n killasgroup=true<\/span>\r\n autostart=true<\/span>\r\n autorestart=true<\/span>\r\n\r\n [program:mojweb-api2]<\/span>\r\n command=npm<\/span> run<\/span> production<\/span> -p 10001<\/span>\r\n directory=\/var\/www\/mojweb.sk\/www\/api<\/span>\r\n user=mojweb<\/span>\r\n stopasgroup=true<\/span>\r\n killasgroup=true<\/span>\r\n autostart=true<\/span>\r\n autorestart=true<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    In this way, we’re able to run 2 API instances on different ports.<\/span><\/p>\n
    Nginx load balancer<\/b><\/h2>\n
    If one instance is restarted, requests must be directed to the other. This step can be provided by NGINX load balancer.\u00a0<\/b><\/p>\n
    Modified configuration for NGINX:<\/span><\/p>\n\n\n\n
    \n
     \u00a0 <\/span>upstream<\/span> magazin-ssr<\/span> {<\/span>\r\n  server<\/span> localhost:10000;<\/span>\r\n  server<\/span> localhost:10001;<\/span>\r\n \u00a0 \u00a0 <\/span>}<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n
    \n
    location<\/span> \/api-eshop<\/span> {<\/span>\r\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>rewrite<\/span> ^\/api-eshop\/(.*)<\/span> \/$1<\/span>\u00a0 <\/span>break;<\/span>\r\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>proxy_pass<\/span> http:\/\/magazin-ssr;<\/span>\r\n \u00a0 \u00a0 \u00a0 \u00a0 <\/span>}<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Nginx therefore decides which API instance to use. If one is off, traffic is directed to the other, and vice versa.<\/span><\/p>\n
    We then use a simple SHELL script to restart the service<\/span>.<\/p>\n\n\n\n
    \n
    supervisorctl start ssr-edsi1<\/span>\r\n sleep 10s<\/span>\r\n supervisorctl restart ssr-edsi<\/span>\r\n sleep 10s<\/span>\r\n supervisorctl stop ssr-edsi1<\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    All done!<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"When you run a web application in a production environment, you should strive for its 100% availability. If…","protected":false},"author":13,"featured_media":7130,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","csco_display_header_overlay":false,"csco_singular_sidebar":"","csco_page_header_type":""},"categories":[199],"tags":[460,458,459,457,456],"_links":{"self":[{"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/posts\/7142"}],"collection":[{"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/comments?post=7142"}],"version-history":[{"count":1,"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/posts\/7142\/revisions"}],"predecessor-version":[{"id":7143,"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/posts\/7142\/revisions\/7143"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/media\/7130"}],"wp:attachment":[{"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/media?parent=7142"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/categories?post=7142"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.bart.sk\/en\/wp-json\/wp\/v2\/tags?post=7142"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}