Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
k8s-ingress
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
3
Merge Requests
3
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
uplex-varnish
k8s-ingress
Commits
806134de
Commit
806134de
authored
Nov 20, 2018
by
Geoff Simmons
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add some documentation (global README) -- WIP
parent
2318067d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
52 additions
and
4 deletions
+52
-4
README.md
README.md
+52
-4
No files found.
README.md
View file @
806134de
Varnish Ingress Controller
--------------------------
# Varnish Ingress Controller
This is an implementation of a
[
k
ubernetes Ingress controller
](
https://kubernetes.io/docs/concepts/services-networking/ingress/
)
This is an implementation of a
[
K
ubernetes Ingress controller
](
https://kubernetes.io/docs/concepts/services-networking/ingress/
)
based on
[
Varnish
](
http://www.varnish-cache.org
)
.
NOTE: WORK IN PROGRESS
The present documentation presupposes familiarity with both Kubernetes and
Varnish. For more information, see:
*
Kubernetes: https://kubernetes.io/
*
Varnish: http://www.varnish-cache.org
## WORK IN PROGRESS
The Ingress controller implementation is presently under development
as a minimum viable product (MVP) and is undergoing initial testing. It is
currently subject to a number of limitations, expected to be removed over
time, including:
*
No support for TLS connections
*
The controller only attends to definitions (Ingresses, Services and
Endpoints) in the namespace of the Pod in which it is deployed.
*
Only one Ingress definition is valid at a time. If more than one definition
is added to the namespace, then the most recent definition becomes valid.
*
A variety of elements in the Varnish implementation of Ingress are
hard-wired, as detailed of the following, and are expected to become
configurable in further development.
# Installation
The container image implementing the Ingress, including the Ingress
controller deployed in the same container, is created via a
multi-stage Docker build using the Dockerfile in the root of the
source repository. The build can be initiated with the
``container``
target for
``make``
:
```
$ make container
```
If you wish to add custom options for the Docker build, assign these
to the environment variable
``DOCKER_BUILD_OPTIONS``
:
```
$ DOCKER_BUILD_OPTIONS='--no-cache --pull' make container
```
The resulting image must then be pushed to a registry available to the
Kubernetes cluster.
The Ingress can then be deployed by any of the means that are
customary for Kubernetes. The
[
``deploy/``
](
deploy/
)
folder contains YAML
configurations for one of the ways to deploy an Ingress.
The
[
``example/``
](
example/
)
folder contains YAML configurations for
sample Services and an Ingress to test and demonstrate the Ingress
implementation (based on the "cafe" example from other projects).
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment