https://github.com/kumina/k8s-redirectory
Redirectory is a system for redirecting requests that would usually end in a 404 response to a new destination based on rules specified by the user with the help of a UI.
https://github.com/kumina/k8s-redirectory
404-errors kubernetes kubernetes-cluster python3 redirects requests
Last synced: 3 months ago
JSON representation
Redirectory is a system for redirecting requests that would usually end in a 404 response to a new destination based on rules specified by the user with the help of a UI.
- Host: GitHub
- URL: https://github.com/kumina/k8s-redirectory
- Owner: kumina
- License: bsd-3-clause
- Created: 2019-07-01T09:43:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T02:59:29.000Z (almost 3 years ago)
- Last Synced: 2025-06-01T18:08:30.542Z (4 months ago)
- Topics: 404-errors, kubernetes, kubernetes-cluster, python3, redirects, requests
- Language: Python
- Homepage: https://redirectory.readthedocs.io
- Size: 1.83 MB
- Stars: 4
- Watchers: 5
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Redirectory is a tool that manages redirects on a kubernetes cluster.
Requests that would usually end in a **404 PAGE NOT FOUND** can now be
redirected to new pages specified with custom rules. It binds itself as
the default backend (essential a wild card) of your ingress controller
and catches all the request that the cluster can't find an ingress rule
for. After that with the help of the
[Hyperscan](https://www.hyperscan.io) regex engine the request is
permanently redirected to the new destination based on the rules. If there is
no rule that matches the request you can specify a default redirecting
destination.
# Installation
The best installation experience is with [Helm](https://github.com/helm/helm).
Just run:
```shell
$ helm install --name=redirectory redirectory/conf/helm
```
More information about this can be found
[here](https://redirectory.readthedocs.io/en/latest/misc/install.html).
# Docker images
First we have to build the Hyperscan image because it is a base of the
other two images.
## Hyperscan image
Before we can use Redirectory you must have the Hyperscan library
installed. Here is a link to the
[getting started](https://github.com/intel/hyperscan/blob/master/doc/dev-reference/getting_started.rst)
documentation. But we also have prepaired a Docker image. You can find
the `Dockerfile` in: `redirectory/conf/hyperscan-docker` and run the
`./build.sh` file. The interaction between Python and Hyperscan is made
with this awesome library
[python-hyperscan](https://github.com/darvid/python-hyperscan).
## Redirectory images
There are two images. One for the management pod and one for the worker
pods. The two files are correspondingly `Dockerfile_Management` and
`Dockerfile_Worker`. You can run the `./build_redirectory_images.sh`
file to build them both.
# Documentation
The documentation is hosted on Read the Docs and can be found at
[redirectory.readthedocs.io](https://redirectory.readthedocs.io).
# License
Redirectory is licensed under the BSD 3-Clause License License. See the
[LICENSE](LICENSE) file in the project repository.