zuul README

The project's README from github.com/Netflix/zuul. As one markdown file: README.md.

Snapshot

Zuul

Zuul is an L7 application gateway that provides capabilities for dynamic routing, monitoring, resiliency, security, and more. Please view the wiki for usage, information, HOWTO, etc https://github.com/Netflix/zuul/wiki

Here are some links to help you learn more about the Zuul Project. Feel free to PR to add any other info, presentations, etc.


Articles from Netflix:

Zuul 1: http://techblog.netflix.com/2013/06/announcing-zuul-edge-service-in-cloud.html

Zuul 2:

https://netflixtechblog.com/open-sourcing-zuul-2-82ea476cb2b3

https://netflixtechblog.com/zuul-2-the-netflix-journey-to-asynchronous-non-blocking-systems-45947377fb5c

https://netflixtechblog.com/the-show-must-go-on-securing-netflix-studios-at-scale-19b801c86479


Netflix presentations about Zuul:

Strange Loop 2017 - Zuul 2: https://youtu.be/2oXqbLhMS_A

AWS re:Invent 2018 - Scaling push messaging for millions of Netflix devices: https://youtu.be/IdR6N9B-S1E


Slides from Netflix presentations about Zuul:

http://www.slideshare.net/MikeyCohen1/zuul-netflix-springone-platform

http://www.slideshare.net/MikeyCohen1/rethinking-cloud-proxies-54923218

https://github.com/strangeloop/StrangeLoop2017/blob/master/slides/ArthurGonigberg-ZuulsJourneyToNonBlocking.pdf

https://www.slideshare.net/SusheelAroskar/scaling-push-messaging-for-millions-of-netflix-devices


Projects Using Zuul:

https://cloud.spring.io/

https://jhipster.github.io/


Info and examples from various projects:

https://cloud.spring.io/spring-cloud-netflix/multi/multi__router_and_filter_zuul

http://www.baeldung.com/spring-rest-with-zuul-proxy

https://blog.heroku.com/using_netflix_zuul_to_proxy_your_microservices

http://blog.ippon.tech/jhipster-3-0-introducing-microservices/


Other blog posts about Zuul:

https://engineering.riotgames.com/news/riot-games-api-fulfilling-zuuls-destiny

https://engineering.riotgames.com/news/riot-games-api-deep-dive

http://instea.sk/2015/04/netflix-zuul-vs-nginx-performance/


How to release Zuul

This project uses a GitHub Action workflow for publishing a new release. The workflow is triggered by following these steps:

  1. Go to the Releases page here
  2. Draft a new release
  3. Click Select tag, then Create new tag (ex. `vX.Y.Z)
  4. Select Generate release notes and Click Publish release
  5. Approve the new release in the Actions tab

zuul (Netflix/zuul)

Searching Database…

14.1K ·GitHub
What is this?Zuul is Netflix's L7 (application-layer) gateway service that handles dynamic routing, monitoring, resiliency, and security for traffic flowing into a set of backend services.
Is this a ready-to-run application, or a framework I build my own gateway with?Zuul is a gateway framework/service you embed and configure in your own Java codebase, not a pre-built app with a UI you just launch.
How do I get started using it?The README itself has no quickstart or code samples - it tells you to go to the project wiki for usage information and HOWTOs.
Do I need Java to build and run it?Yes, Zuul is a Java project (its CI workflows build it with Gradle), so you need a JVM toolchain to use it.
Will this README actually teach me how to use Zuul?Not really - the README is mostly links to external articles, conference talks, and the wiki; real usage docs and HOWTOs live outside this repo.
What capabilities does Zuul provide out of the box?According to the README, it provides dynamic routing, monitoring, resiliency, and security capabilities for the traffic it gateways.
What does the 'L7' in 'L7 application gateway' mean?L7 refers to Layer 7 (the application layer), meaning Zuul makes routing and policy decisions based on the actual content of HTTP requests rather than just IP/port.
Where can I see Zuul used in real production systems?The README links out to Netflix engineering articles, conference talks (like the Strange Loop 2017 Zuul 2 talk), and a list of other projects that use Zuul.
What are similar projects?apisix, eureka, istio, nginx, spring-cloud-alibaba, kong, consul, linkerd2
Creator
Netflix
Size
6.9 MB
Stars
14.1K
Age
13y
Commits · 90 Days