Skip to content
An HTTP router and reverse proxy for service composition, including use cases like Kubernetes Ingress
Branch: master
Clone or download
szuecs Fix/lifo self healing (#1054)
* add better logs for lifo filters

Signed-off-by: Sandor Szücs <sandor.szuecs@zalando.de>

* fix: if lifo filter response is not called, the proxy should execute done() to release the queue

Signed-off-by: Sandor Szücs <sandor.szuecs@zalando.de>

* fix successful retry should not be return an error

Signed-off-by: Sandor Szücs <sandor.szuecs@zalando.de>
Latest commit 0819a0b May 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates (#994) Mar 20, 2019
_test_plugins Multi plugins, plugin .conf filles (#598) Apr 18, 2018
_test_plugins_fail Multi plugins, plugin .conf filles (#598) Apr 18, 2018
circuit shortcheck: run with -race (#970) Mar 11, 2019
cmd chore(api-usage-monitoring filter): remove deprecated parameter (#949) ( Apr 24, 2019
dataclients fix memory spike in east west route creation, which drops memory usag… Apr 4, 2019
docs lifo filters, concept (#1030) May 3, 2019
eskip default filters as routing.PreProcessors (#1003) Mar 23, 2019
eskipfile Feature/redis based cluster ratelimit (#981) Mar 13, 2019
etcd gosec integration (#946) May 9, 2019
filters Fix/lifo self healing (#1054) May 14, 2019
fixtures Implemented TLS support May 18, 2016
img add scaled images Jan 19, 2018
innkeeper gosec integration (#946) May 9, 2019
loadbalancer Feature/lb algorithms (#1015) Apr 2, 2019
logging Fix logging regression after #752 (#806) Sep 25, 2018
metrics shortcheck: run with -race (#970) Mar 11, 2019
net Source predicate can be by passed in AWS (#533) Jan 17, 2018
oauth close test servers Jun 5, 2016
packaging Build opentracing tracers into main binary (#779) Sep 10, 2018
pathmux fix findings from staticcheck (#897) Jan 7, 2019
predicates fix findings from staticcheck (#897) Jan 7, 2019
proxy Fix/lifo self healing (#1054) May 14, 2019
ratelimit fix close-idle-conns-period flag (#998) Mar 21, 2019
routing Feature/lb algorithms (#1015) Apr 2, 2019
scheduler Fix/lifo self healing (#1054) May 14, 2019
script fix findings from staticcheck (#897) Jan 7, 2019
skptesting lifo filters, concept (#1030) May 3, 2019
swarm Feature/redis based cluster ratelimit (#981) Mar 13, 2019
tracing add tag= parameter for lightstep plugin (#1046) May 14, 2019
.catwatch.yaml added .catwatch.yaml Feb 11, 2016
.gitignore skptesting fix (#859) Nov 22, 2018
.travis.yml increase codecoverage to 80% required by silver cii bestpractices (#1025 Apr 10, 2019
.zappr.yaml make Zappr compliant Jun 19, 2017
CODE_OF_CONDUCT.md we have to define key roles in the project to achieve silver in CII b… Apr 7, 2019
CONTRIBUTING.md add some stuff to achieve silver badge (#940) Feb 4, 2019
LICENSE Move pathmux (#361) Jun 30, 2017
MAINTAINERS we have to define key roles in the project to achieve silver in CII b… Apr 7, 2019
Makefile gosec integration (#946) May 9, 2019
SECURITY.md Create SECURITY.md (#347) Jun 20, 2017
delivery.yaml gosec integration (#946) May 9, 2019
doc.go feature: support dynamic backends (#908) (#918) Jan 28, 2019
go.mod lifo filters, concept (#1030) May 3, 2019
go.sum lifo filters, concept (#1030) May 3, 2019
mkdocs.yml Use native Mkdocs page references (#955) Feb 19, 2019
plugins.go Multi plugins, plugin .conf filles (#598) Apr 18, 2018
plugins_test.go shortcheck: run with -race (#970) Mar 11, 2019
readme.md little update to the readme file concerning eskip check (#1020) Apr 4, 2019
skipper.go lifo filters, concept (#1030) May 3, 2019
skipper_test.go Fix/graceful shutdown (#988) Mar 13, 2019

readme.md

Build Status Doc GoDoc License Go Report Card codecov GitHub release CII Best Practices

Skipper

Skipper

Skipper is an HTTP router and reverse proxy for service composition. It's designed to handle >300k HTTP route definitions with detailed lookup conditions, and flexible augmentation of the request flow with filters. It can be used out of the box or extended with custom lookup, filter logic and configuration sources.

Main features:

An overview of deployments and data-clients shows some use cases to run skipper.

Skipper

  • identifies routes based on the requests' properties, such as path, method, host and headers
  • allows modification of the requests and responses with filters that are independently configured for each route
  • simultaneously streams incoming requests and backend responses
  • optionally acts as a final endpoint (shunt), e.g. as a static file server or a mock backend for diagnostics
  • updates routing rules without downtime, while supporting multiple types of data sources — including etcd, Kubernetes Ingress, Innkeeper (deprecated), static files, route string and custom configuration sources
  • can serve as a Kubernetes Ingress controller without reloads. You can use it in combination with a controller that will route public traffic to your skipper fleet; see AWS example
  • shipped with eskip: a descriptive configuration language designed for routing rules

Skipper provides a default executable command with a few built-in filters. However, its primary use case is to be extended with custom filters, predicates or data sources. Go here for additional documentation.

A few examples for extending Skipper:

Getting Started

Prerequisites/Requirements

In order to build and run Skipper, only the latest version of Go needs to be installed. Skipper can use Innkeeper or Etcd as data sources for routes, or for the simplest cases, a local configuration file. See more details in the documentation: https://godoc.org/github.com/zalando/skipper.

Installation

Skipper is 'go get' compatible. If needed, create a Go workspace first:

mkdir ws
cd ws
export GOPATH=$(pwd)
export PATH=$PATH:$GOPATH/bin

Get the Skipper packages:

GO111MODULE=on go get github.com/zalando/skipper/...

Running

Create a file with a route:

echo 'hello: Path("/hello") -> "https://www.example.org"' > example.eskip

Optionally, verify the file's syntax:

eskip check example.eskip

If no errors are detected nothing is logged, else a descriptive error is logged.

Start Skipper and make an HTTP request:

skipper -routes-file example.eskip &
curl localhost:9090/hello
Docker

To run the latest Docker container:

docker run registry.opensource.zalan.do/pathfinder/skipper:latest

To run eskip you first mount the .eskip file, into the container, and run the command

docker run \
  -v $(PWD)/doc-docker-intro.eskip:/doc-docker-intro.eskip \
  registry.opensource.zalan.do/pathfinder/skipper:latest eskip print doc-docker-intro.eskip

To run skipper you first mount the .eskip file, into the container, expose the ports and run the command

docker run -it \
    -v $(PWD)/doc-docker-intro.eskip:/doc-docker-intro.eskip \
    -p 9090:9090 \
    -p 9911:9911 \
    registry.opensource.zalan.do/pathfinder/skipper:latest skipper -routes-file doc-docker-intro.eskip

Skipper will then be available on http://localhost:9090

Authentication Proxy

Skipper can be used as an authentication proxy, to check incoming requests with Basic auth or an OAuth2 provider including audit logging. See the documentation at: https://godoc.org/github.com/zalando/skipper/filters/auth.

Working with the code

Working with the code requires Go1.11 or a higher version. Getting the code with the test dependencies (-t switch):

GO111MODULE=on go get -t github.com/zalando/skipper/...

Build and test all packages:

cd src/github.com/zalando/skipper
make deps
make install
make shortcheck

On Mac the tests may fail because of low max open file limit. Please make sure you have correct limits setup by following these instructions.

Working from IntelliJ / GoLand

To run or debug skipper from IntelliJ IDEA or GoLand, you need to create this configuration:

Parameter Value
Template Go Build
Run kind Directory
Directory skipper source dir + /cmd/skipper
Working directory skipper source dir (usually the default)

Kubernetes Ingress

Skipper can be used to run as an Kubernetes Ingress controller. Details with examples of Skipper's capabilities and an overview you will can be found in our ingress-controller deployment docs.

For AWS integration, we provide an ingress controller https://github.com/zalando-incubator/kube-ingress-aws-controller, that manage ALBs in front of your skipper deployment. A production example, can be found in our Kubernetes configuration https://github.com/zalando-incubator/kubernetes-on-aws.

Documentation

Skipper's Documentation and Godoc developer documentation, includes information about deployment use cases and detailed information on these topics:

1 Minute Skipper introduction

The following example shows a skipper routes file in eskip format, that has 3 named routes: baidu, google and yandex.

% cat doc-1min-intro.eskip
baidu:
        Path("/baidu")
        -> setRequestHeader("Host", "www.baidu.com")
        -> setPath("/s")
        -> setQuery("wd", "godoc skipper")
        -> "http://www.baidu.com";
google:
        *
        -> setPath("/search")
        -> setQuery("q", "godoc skipper")
        -> "https://www.google.com";
yandex:
        * && Cookie("yandex", "true")
        -> setPath("/search/")
        -> setQuery("text", "godoc skipper")
        -> tee("http://127.0.0.1:12345/")
        -> "https://yandex.ru";

Matching the route:

  • baidu is using Path() matching to differentiate the HTTP requests to select the route.
  • google is the default matching with wildcard '*'
  • yandex is the default matching with wildcard '*' if you have a cookie "yandex=true"

Request Filters:

  • If baidu is selected, skipper sets the Host header, changes the path and sets a query string to the http request to the backend "http://www.baidu.com".
  • If google is selected, skipper changes the path and sets a query string to the http request to the backend "https://www.google.com".
  • If yandex is selected, skipper changes the path and sets a query string to the http request to the backend "https://yandex.ru". The modified request will be copied to "http://127.0.0.1:12345/"

Run skipper with the routes file doc-1min-intro.eskip shown above

% skipper -routes-file doc-1min-intro.eskip

To test each route you can use curl:

% curl -v localhost:9090/baidu
% curl -v localhost:9090/
% curl -v --cookie "yandex=true" localhost:9090/

To see the request that is made by the tee() filter you can use nc:

[terminal1]% nc -l 12345
[terminal2]% curl -v --cookie "yandex=true" localhost:9090/

3 Minutes Skipper in Kubernetes introduction

This introduction was moved to ingress controller documentation.

For More details, please check out our Kubernetes ingress controller docs, our ingress usage and how to handle common backend problems in Kubernetes.

You should have a base understanding of Kubernetes and Ingress.

Packaging support

See https://github.com/zalando/skipper/blob/master/packaging/readme.md

In case you want to implement and link your own modules into your skipper for more advanced features like opentracing API support there is https://github.com/skipper-plugins organization to enable you to do so. In order to explain you the build process with custom Go modules there is https://github.com/skipper-plugins/skipper-tracing-build, that is used to build skipper's opentracing package.

Community

User or developer questions can be asked in our public Google Group

We also have a slack channel #skipper in gophers.slack.com. Get an invite at gophers official invite page.

Proposals

We do our proposals open in Skipper's Google drive. If you want to make a proposal feel free to create an issue and if it is a bigger change we will invite you to a document, such that we can work together.

Users

Zalando uses this project as shop frontend http router with 350000 routes, as Kubernetes ingress controller and runs several custom skipper instances that use skipper as library.

Sergio Ballesteros from spotahome

We also ran tests with several ingress controllers and skipper gave us the more reliable results. Currently we are running skipper since almost 2 years with like 20K Ingress rules. The fact that skipper is written in go let us understand the code, add features and fix bugs since all of our infra stack is golang.

In the media

Blog posts:

Conference/Meetups talks

You can’t perform that action at this time.