Skip to content

Commit

Permalink
Add nginx-ldapauth-proxy (helm#3013)
Browse files Browse the repository at this point in the history
* Add nginx-ldapauth-proxy

We created this as an authentication layer on top of our ELK stack.
We thought it might be useful for other people as well.

* Add sources and github usernames

* Fix API version for deployment

Add spec.selector matchlabels

* Add release to selector matchLabels

* Update metadata to nre release

* Use new template for chart label

* Fix app matchlabels for deployment

* Move nginx-ldapauth-proxy to stable

* Change default proxy service to kubernetes.default

* Only enable ldap auth if ldapHost and ldapBindPassword are set

* Make sure / is available

* Add stub_status to status location in nginx

* Remove superfluous $
  • Loading branch information
rendhalver authored and k8s-ci-robot committed May 25, 2018
1 parent c7d5f29 commit af218b0
Show file tree
Hide file tree
Showing 10 changed files with 356 additions and 0 deletions.
21 changes: 21 additions & 0 deletions stable/nginx-ldapauth-proxy/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*~
# Various IDEs
.project
.idea/
*.tmproj
14 changes: 14 additions & 0 deletions stable/nginx-ldapauth-proxy/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
apiVersion: v1
description: nginx proxy with ldapauth
name: nginx-ldapauth-proxy
icon: https://upload.wikimedia.org/wikipedia/commons/thumb/c/c5/Nginx_logo.svg/500px-Nginx_logo.svg.png
version: 0.1.2
appVersion: 1.13.5
sources:
- https://github.com/dweomer/dockerfiles-nginx-auth-ldap
- https://github.com/kvspb/nginx-auth-ldap
maintainers:
- name: rendhalver
email: [email protected]
- name: jar361
email: [email protected]
19 changes: 19 additions & 0 deletions stable/nginx-ldapauth-proxy/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
1. Get the application URL by running these commands:
{{- if .Values.ingress.enabled }}
{{- range .Values.ingress.hosts }}
http://{{ . }}
{{- end }}
{{- else if contains "NodePort" .Values.service.type }}
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "nginx-ldapauth-proxy.fullname" . }})
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
echo http://$NODE_IP:$NODE_PORT
{{- else if contains "LoadBalancer" .Values.service.type }}
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
You can watch the status of by running 'kubectl get svc -w {{ template "nginx-ldapauth-proxy.fullname" . }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "nginx-ldapauth-proxy.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
echo http://$SERVICE_IP:{{ .Values.service.externalPort }}
{{- else if contains "ClusterIP" .Values.service.type }}
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "nginx-ldapauth-proxy.name" . }},release={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:8080 to use your application"
kubectl port-forward $POD_NAME 8080:{{ .Values.service.internalPort }}
{{- end }}
32 changes: 32 additions & 0 deletions stable/nginx-ldapauth-proxy/templates/_helpers.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{{/* vim: set filetype=mustache: */}}
{{/*
Expand the name of the chart.
*/}}
{{- define "nginx-ldapauth-proxy.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
{{- end -}}

{{/*
Create a default fully qualified app name.
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
If release name contains chart name it will be used as a full name.
*/}}
{{- define "nginx-ldapauth-proxy.fullname" -}}
{{- if .Values.fullnameOverride -}}
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
{{- else -}}
{{- $name := default .Chart.Name .Values.nameOverride -}}
{{- if contains $name .Release.Name -}}
{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
{{- else -}}
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
{{- end -}}
{{- end -}}
{{- end -}}

{{/*
Create chart name and version as used by the chart label.
*/}}
{{- define "nginx-ldapauth-proxy.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
{{- end -}}
71 changes: 71 additions & 0 deletions stable/nginx-ldapauth-proxy/templates/configmap.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ template "nginx-ldapauth-proxy.fullname" . }}
labels:
app: {{ template "nginx-ldapauth-proxy.name" . }}
chart: {{ template "nginx-ldapauth-proxy.chart" . }}
heritage: {{ .Release.Service }}
release: {{ .Release.Name }}
data:
nginx.conf: |-
worker_processes 10;
worker_rlimit_nofile 16384;
events {
worker_connections 1024;
}
http {
upstream backend-server {
server {{ .Values.proxy.host}}:{{ .Values.proxy.port }};
}
{{- if and .Values.proxy.ldapHost .Values.secrets.ldapBindPassword }}
ldap_server ldapserver {
url ldap://{{ .Values.proxy.ldapHost }}:{{ .Values.proxy.ldapPort }}/{{ .Values.proxy.ldapDN }}?uid?sub?(&({{ .Values.proxy.ldapFilter}}));
binddn "{{ .Values.proxy.ldapBindDN }}";
binddn_passwd {{ .Values.secrets.ldapBindPassword }};
group_attribute {{ .Values.proxy.ldapGroup }};
group_attribute_is_dn on;
{{- range $require := .Values.proxy.requires }}
require group {{ $require.filter | quote }};
{{- end }}
require valid_user;
satisfy all;
}
{{- end }}

server {

listen {{ .Values.service.internalPort }};
server_name ldapauth-proxy;

error_log /var/log/nginx/error.log debug;
access_log /var/log/nginx/access.log;

client_max_body_size 0;

chunked_transfer_encoding on;

location / {
{{- if and .Values.proxy.ldapHost .Values.secrets.ldapBindPassword }}
auth_ldap "{{ .Values.proxy.authName }}";
auth_ldap_servers ldapserver;
proxy_pass http://backend-server;
proxy_set_header Host $http_host; # required for docker client's sake
proxy_set_header X-Real-IP $remote_addr; # pass on real client's IP
proxy_set_header Authorization ""; # see https://github.com/dotcloud/docker-registry/issues/170
proxy_read_timeout 900;
{{- end }}
}

location /_ping {
auth_basic off;
root /usr/share/nginx/html;
stub_status on;
}
}

}
73 changes: 73 additions & 0 deletions stable/nginx-ldapauth-proxy/templates/deployment.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: {{ template "nginx-ldapauth-proxy.fullname" . }}
labels:
app: {{ template "nginx-ldapauth-proxy.name" . }}
chart: {{ template "nginx-ldapauth-proxy.chart" . }}
release: {{ .Release.Name }}
heritage: {{ .Release.Service }}
spec:
selector:
matchLabels:
app: {{ template "nginx-ldapauth-proxy.name" . }}
release: {{ .Release.Name }}
replicas: {{ .Values.replicaCount }}
template:
metadata:
labels:
app: {{ template "nginx-ldapauth-proxy.name" . }}
release: {{ .Release.Name }}
annotations:
checksum/config: {{ include (print .Template.BasePath "/configmap.yaml") . | sha256sum }}
spec:
{{- if .Values.image.pullSecrets }}
{{- range $pullSecret := .Values.image.pullSecrets }}
imagePullSecrets:
- name: {{ $pullSecret }}
{{- end }}
{{- end }}
containers:
- name: {{ .Chart.Name }}
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
{{- if and .Values.proxy.ldapHost .Values.secrets.ldapBindPassword }}
env:
- name: LDAP_BIND_PASSWORD
valueFrom:
secretKeyRef:
name: {{ template "nginx-ldapauth-proxy.fullname" . }}
key: ldapBindPassword
{{- end }}
ports:
- containerPort: {{ .Values.service.internalPort }}
livenessProbe:
httpGet:
path: /_ping
port: {{ .Values.service.internalPort }}
readinessProbe:
httpGet:
path: /_ping
port: {{ .Values.service.internalPort }}
volumeMounts:
- mountPath: /etc/nginx/nginx.conf
name: config
subPath: nginx.conf
resources:
{{ toYaml .Values.resources | indent 12 }}
volumes:
- name: config
configMap:
name: {{ template "nginx-ldapauth-proxy.fullname" . }}
{{- if .Values.nodeSelector }}
nodeSelector:
{{ toYaml .Values.nodeSelector | indent 8 }}
{{- end }}
{{- with .Values.affinity }}
affinity:
{{ toYaml . | indent 8 }}
{{- end }}
{{- with .Values.tolerations }}
tolerations:
{{ toYaml . | indent 8 }}
{{- end }}
32 changes: 32 additions & 0 deletions stable/nginx-ldapauth-proxy/templates/ingress.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{{- if .Values.ingress.enabled -}}
{{- $serviceName := include "nginx-ldapauth-proxy.fullname" . -}}
{{- $servicePort := .Values.service.externalPort -}}
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
name: {{ template "nginx-ldapauth-proxy.fullname" . }}
labels:
app: {{ template "nginx-ldapauth-proxy.name" . }}
chart: {{ template "nginx-ldapauth-proxy.chart" . }}
release: {{ .Release.Name }}
heritage: {{ .Release.Service }}
annotations:
{{- range $key, $value := .Values.ingress.annotations }}
{{ $key }}: {{ $value | quote }}
{{- end }}
spec:
rules:
{{- range $host := .Values.ingress.hosts }}
- host: {{ $host }}
http:
paths:
- path: /
backend:
serviceName: {{ $serviceName }}
servicePort: {{ $servicePort }}
{{- end -}}
{{- if .Values.ingress.tls }}
tls:
{{ toYaml .Values.ingress.tls | indent 4 }}
{{- end -}}
{{- end -}}
14 changes: 14 additions & 0 deletions stable/nginx-ldapauth-proxy/templates/secrets.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{{- if .Values.secrets.ldapBindPassword }}
apiVersion: v1
kind: Secret
metadata:
name: {{ template "nginx-ldapauth-proxy.fullname" . }}
labels:
app: {{ template "nginx-ldapauth-proxy.name" . }}
chart: {{ template "nginx-ldapauth-proxy.chart" . }}
release: {{ .Release.Name }}
heritage: {{ .Release.Service }}
type: Opaque
data:
ldapBindPassword: {{ .Values.secrets.ldapBindPassword | b64enc | quote }}
{{- end }}
19 changes: 19 additions & 0 deletions stable/nginx-ldapauth-proxy/templates/service.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
apiVersion: v1
kind: Service
metadata:
name: {{ template "nginx-ldapauth-proxy.fullname" . }}
labels:
app: {{ template "nginx-ldapauth-proxy.name" . }}
chart: {{ template "nginx-ldapauth-proxy.chart" . }}
release: {{ .Release.Name }}
heritage: {{ .Release.Service }}
spec:
type: {{ .Values.service.type }}
ports:
- port: {{ .Values.service.externalPort }}
targetPort: {{ .Values.service.internalPort }}
protocol: TCP
name: {{ .Values.service.name }}
selector:
app: {{ template "nginx-ldapauth-proxy.name" . }}
release: {{ .Release.Name }}
61 changes: 61 additions & 0 deletions stable/nginx-ldapauth-proxy/values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Default values for nginx-ldapauth-proxy.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
replicaCount: 1
image:
repository: dweomer/nginx-auth-ldap
tag: 1.13.5-on-alpine-3.5
pullPolicy: IfNotPresent
# pullSecrets:
# - docker-secret
service:
name: nginx-ldapauth
type: ClusterIP
externalPort: 443
internalPort: 80
proxy:
port: 443
host: "kubernetes.default.svc.cluster.local"
authName: "Auth Required"
ldapHost: ""
ldapPort: 389
ldapGroup: "memberUid"
ldapDN: "dc=example,dc=com"
ldapFilter: "objectClass=organizationalPerson"
ldapBindDN: "cn=auth,dc=example,dc=com"
requires:
- name: "authGroup"
filter: "cn=secret,ou=groups,dc=example,dc=com"
secrets:
ldapBindPassword: ""

ingress:
enabled: false
# Used to create an Ingress record.
hosts:
- ldapauth-service.local
annotations:
# kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true"
tls:
# Secrets must be manually created in the namespace.
# - secretName: chart-example-tls
# hosts:
# - chart-example.local
resources: {}
# We usually recommend not to specify default resources and to leave this as a conscious
# choice for the user. This also increases chances charts run on environments with little
# resources, such as Minikube. If you do want to specify resources, uncomment the following
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
# limits:
# cpu: 100m
# memory: 128Mi
# requests:
# cpu: 100m
# memory: 128Mi

nodeSelector: {}

tolerations: []

affinity: {}

0 comments on commit af218b0

Please sign in to comment.