Skip to content

Latest commit

 

History

History
125 lines (73 loc) · 5.34 KB

README.md

File metadata and controls

125 lines (73 loc) · 5.34 KB
Raw

Help us to improve the NGINX Ingress controller completing the survey

Gladly Fork

Purpose of the fork

We forked the upstream repo to apply the following patch to nginx: http://mailman.nginx.org/pipermail/nginx-devel/2018-January/010761.html

How to build

The fork hardcodes a few environment variables that can be changed in the upstream, including:

DOCKER     # we're only going to use docker
REGISTRY   # we're only going to use our own registry - 'sagan'
BASEIMAGE  # fixed to our base nginx image - sagan/gladly-nginx

Directory Structure - IMPORTANT

This repo must be cloned into a directory structure like the following:

${GOROOT}/src/github.com/sagansystems/io.k8s.ingress-nginx/src/k8s.io

Building the container

We deploy a container called sagan/nginx-ingress-controller - https://hub.docker.com/r/sagan/nginx-ingress-controller/

To build this container:

- clone repo (SEE ABOVE)
- cd images/nginx
- make container
- cd ../..
- make container

Updating the fork

Find a release to update to here: https://github.com/kubernetes/ingress-nginx/releases

ingress-nginx> git checkout -b merge-upstream-x.y.x
ingress-nginx> git merge nginx-x.y.z
<resolve conflicts>
<push>

NGINX Ingress Controller

Build Status Coverage Status Go Report Card GitHub license GitHub stars GitHub stars

Get Involved

  • Contributing: Pull requests are welcome!
    • Read CONTRIBUTING.md and check out help-wanted issues
    • Submit github issues for any feature enhancements, bugs or documentation problems
  • Support: Join to Kubernetes Slack to ask questions to get support from the maintainers and other developers
  • Discuss: Tweet using the #IngressNginx hashtag

Description

This repository contains the NGINX controller built around the Kubernetes Ingress resource that uses ConfigMap to store the NGINX configuration. Make Ingress-Nginx Work for you, and the Community from KubeCon Europe 2018 is a great video to get you started!!

Learn more about using Ingress on k8s.io

What is an Ingress Controller?

Configuring a webserver or loadbalancer is harder than it should be. Most webserver configuration files are very similar. There are some applications that have weird little quirks that tend to throw a wrench in things, but for the most part you can apply the same logic to them and achieve a desired result.

The Ingress resource embodies this idea, and an Ingress controller is meant to handle all the quirks associated with a specific "class" of Ingress.

An Ingress Controller is a daemon, deployed as a Kubernetes Pod, that watches the apiserver's /ingresses endpoint for updates to the Ingress resource. Its job is to satisfy requests for Ingresses.

Documentation

To check out Live Docs

Questions

For questions and support please use the kubernetes-users room in the Kubernetes Slack or kubernetes-users mailing list. The issue list of this repo is exclusively for bug reports and feature requests.

Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Changelog

Detailed changes for each release are documented in the CHANGELOG.md

Contribution

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to NGINX Ingress Controller!

Code of Conduct

This project adheres to the Kubernetes Community Code of Conduct. By participating in this project you agree to abide by its terms.

License

Apache License 2.0