Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
      Docs Contribution Guidelines
      Want to help out, or found an issue in the docs and want to let us know?
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
3.0.x
  • Home icon
  • Kong Gateway
  • Production Deployment
  • Blue-green Deployments
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
You are browsing documentation for an outdated version. See the latest documentation here.

Blue-green Deployments

Using the ring-balancer, a blue-green deployment can be easily orchestrated for a service. Switching target infrastructure only requires a PATCH request on a service to change its host value.

Set up the “blue” environment, running version one of the address service:

  1. Create an upstream:
     curl -X POST http://localhost:8001/upstreams \
         --data "name=address.v1.service"
    
  2. Add two targets to the upstream:
     curl -X POST http://localhost:8001/upstreams/address.v1.service/targets \
         --data "target=192.168.34.15:80"
         --data "weight=100"
     curl -X POST http://localhost:8001/upstreams/address.v1.service/targets \
         --data "target=192.168.34.16:80"
         --data "weight=50"
    
  3. Create a service targeting the Blue upstream:
     curl -X POST http://localhost:8001/services/ \
         --data "name=address-service" \
         --data "host=address.v1.service" \
         --data "path=/address"
    
  4. Finally, add a route as an entry-point into the service:
     curl -X POST http://localhost:8001/services/address-service/routes/ \
         --data "hosts[]=address.mydomain.com"
    

Requests with host header set to address.mydomain.com will now be proxied by Kong Gateway to the two defined targets. Two-thirds of the requests will go to http://192.168.34.15:80/address (weight=100), and one-third will go to http://192.168.34.16:80/address (weight=50).

Before deploying version two of the address service, set up the “Green” environment:

  1. Create a new Green upstream for address service v2:
     curl -X POST http://localhost:8001/upstreams \
         --data "name=address.v2.service"
    
  2. Add targets to the upstream:
     curl -X POST http://localhost:8001/upstreams/address.v2.service/targets \
         --data "target=192.168.34.17:80"
         --data "weight=100"
     curl -X POST http://localhost:8001/upstreams/address.v2.service/targets \
         --data "target=192.168.34.18:80"
         --data "weight=100"
    
  3. To activate the blue/green switch, we now only need to update the service. Switch the Service from Blue to Green upstream, v1 -> v2:

     curl -X PATCH http://localhost:8001/services/address-service \
       --data "host=address.v2.service"
    

Incoming requests with host header set to address.mydomain.com are now proxied by Kong to the new targets. Half of the requests will go to http://192.168.34.17:80/address (weight=100), and the other half will go to http://192.168.34.18:80/address (weight=100).

As always, the changes through the Kong Gateway Admin API are dynamic and take effect immediately. No reload or restart is required, and no in-progress requests are dropped.

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023