├── Dockerfile ├── LICENSE.txt ├── README.md └── src ├── boot.sh └── confd ├── conf.d └── myconfig.toml ├── confd.toml └── templates └── nginx.tmpl /Dockerfile: -------------------------------------------------------------------------------- 1 | # 2 | # Reverse proxy for kubernetes 3 | # 4 | FROM ubuntu:latest 5 | 6 | ENV DEBIAN_FRONTEND noninteractive 7 | 8 | # Prepare requirements 9 | RUN apt-get update -qy && \ 10 | apt-get install --no-install-recommends -qy software-properties-common 11 | 12 | # setup confd 13 | ADD https://github.com/kelseyhightower/confd/releases/download/v0.6.3/confd-0.6.3-linux-amd64 /usr/local/bin/confd 14 | RUN chmod u+x /usr/local/bin/confd && \ 15 | mkdir -p /etc/confd/conf.d && \ 16 | mkdir -p /etc/confd/templates 17 | 18 | ADD ./src/confd/conf.d/myconfig.toml /etc/confd/conf.d/myconfig.toml 19 | ADD ./src/confd/templates/nginx.tmpl /etc/confd/templates/nginx.tmpl 20 | ADD ./src/confd/confd.toml /etc/confd/confd.toml 21 | 22 | # Install Nginx. 23 | RUN add-apt-repository -y ppa:nginx/stable && \ 24 | apt-get update -q && \ 25 | apt-get install --no-install-recommends -qy nginx && \ 26 | chown -R www-data:www-data /var/lib/nginx && \ 27 | rm -f /etc/nginx/sites-available/default 28 | 29 | ADD ./src/boot.sh /opt/boot.sh 30 | RUN chmod +x /opt/boot.sh 31 | 32 | EXPOSE 80 443 33 | 34 | # Run the boot script 35 | CMD /opt/boot.sh 36 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | kubernetes-reverseproxy Docker file 2 | ======================= 3 | 4 | 5 | This repository contains **Dockerfile** that acts as reverse proxy for [Kubernetes](https://github.com/GoogleCloudPlatform/kubernetes) allowing you to route http traffic to kubernetes pods which are sharing the same host port. Requests are proxied based on the hostname. 6 | 7 | This is useful in situations where you might want to run numerous websites on the same node ( with same public ip ). 8 | 9 | This docker image (Dockerfile) uses [nginx](http://nginx.org/) as reverse proxy and [confd](https://github.com/kelseyhightower/confd) as a way to pull the kubernetes 'service' settings and build nginx configuration. 10 | 11 | ### Requirements 12 | * This Dockerfile requires the latest kubernetes code which provides support for annotations and ip-per-service capabilities. 13 | * Docker container must have access to the same Etcd cluster on which kubernetes is installed 14 | 15 | ### Base Docker Image 16 | 17 | * [ubuntu](https://registry.hub.docker.com/_/ubuntu/) 18 | 19 | 20 | ### Installation 21 | 22 | 1. Install [Docker](https://www.docker.com/). 23 | 24 | 2. Download [automated build](https://registry.hub.docker.com/u/darkgaro/kubernetes-reverseproxy/) from public [Docker Hub Registry](https://registry.hub.docker.com/): 25 | 26 | ```docker pull darkgaro/kubernetes-reverseproxy``` 27 | 28 | (alternatively, you can build an image from Dockerfile: 29 | 30 | `docker build -t="darkgaro/kubernetes-reverseproxy" github.com/darkgaro/kubernetes-reverseproxy`) 31 | 32 | 33 | ### Usage 34 | 35 | docker run -d -e CONFD_ETCD_NODE=: -t -p 80:80 darkgaro/kubernetes-reverseproxy 36 | 37 | **ETCD-IP** = IP/hostname of the etcd server, this is the IP that is accessible from wihtin the container 38 | 39 | **ETCD-PORT** = Etcd port, usually : 4001 40 | 41 | Example: 42 | 43 | docker run -d -e CONFD_ETCD_NODE=172.17.8.101:4001 -t -p 80:80 darkgaro/kubernetes-reverseproxy 44 | 45 | #### Configure kubernetes service 46 | 47 | This dockerfile is using kubernetes "Annotations" property to provide instructions to the proxy on how to setup the routing. 48 | 49 | The key used is kubernetesReverseproxy containing a json representation of the reverseProxy configuration. 50 | A full configuration can looks like : 51 | ```json 52 | { 53 | "hosts": [ 54 | {"host": "sub1.example.com", "port": 80, "path": ["/test1", "/test2"], "defaultPath": "test1"}, 55 | {"host": "sub2.example.com", "port": 443, "ssl": 1, "sslCrt": "cert.crt", "sslKey": "key.key", "path": ["/test3"], "defaultPath": "test3"}, 56 | {"host": "sub3.example.com", "port": 80, "webSocket": 1}, 57 | ] 58 | } 59 | ``` 60 | Then it must be converted to string and set into the kubernetesReverseproxy parameter in the annotation section of your service: 61 | 62 | ```json 63 | "annotations":{ 64 | "kubernetesReverseproxy":"{\"hosts\": [{\"host\": \"some.host.name\", \"port\": \"port number\"}]}" 65 | } 66 | ``` 67 | **host** = This is the hostname for which proxy will listen to and forward traffic to the kubernetes service/ 68 | It is used to fill in the nginx "server_name" property. 69 | 70 | **port** = This is the port number for which proxy will listen to. 71 | 72 | **webSocket** = 1 | 0 [default 0] This enables websocket support in nginx, it adds to nginx : 73 | ``` 74 | proxy_http_version 1.1; 75 | proxy_set_header Upgrade $http_upgrade; 76 | proxy_set_header Connection "upgrade"; 77 | ``` 78 | 79 | **ssl** = 1 | 0 [default 0] This enables ssl support in nginx 80 | **sslCrt** = The SSL certificate file for this service (must be located in /etc/nginx/ssl) 81 | **sslKey** = The SSL private key file for this service (must be located in /etc/nginx/ssl) 82 | 83 | Theses 3 properties adds to nginx : 84 | 85 | ``` 86 | ssl_certificate /etc/nginx/ssl/cert.crt; 87 | ssl_certificate_key /etc/nginx/ssl/key.key; 88 | 89 | ssl on; 90 | ssl_session_cache builtin:1000 shared:SSL:10m; 91 | ssl_protocols TLSv1 TLSv1.1 TLSv1.2; 92 | ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4; 93 | ssl_prefer_server_ciphers on; 94 | ``` 95 | 96 | **path** = The path(s) to expose to proxy (ex: /frontend, /backend) 97 | **defaultPath** = The default path to redirect to 98 | 99 | Example kubernetes service: 100 | 101 | ```json 102 | { 103 | "id": "wordpress-site", 104 | "kind": "Service", 105 | "apiVersion": "v1beta1", 106 | "port": 80, 107 | "containerPort": 80, 108 | "selector": { 109 | "name": "app-instance" 110 | }, 111 | "annotations": { 112 | "kubernetesReverseproxy":"{\"hosts\": [{\"host\": \"some.host.name\", \"port\": \"port number\"}]}" 113 | } 114 | } 115 | ``` 116 | -------------------------------------------------------------------------------- /src/boot.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Fail hard and fast 4 | set -eo pipefail 5 | 6 | export ETCD=$CONFD_ETCD_NODE 7 | 8 | echo "[nginx] booting container. ETCD: $ETCD" 9 | 10 | # Loop until confd has updated the nginx config 11 | until confd -onetime -node $ETCD -config-file /etc/confd/conf.d/myconfig.toml; do 12 | echo "[nginx] waiting for confd to refresh nginx.conf" 13 | sleep 5 14 | done 15 | 16 | # Run confd in the background to watch the upstream servers 17 | confd -interval 10 -node $ETCD -config-file /etc/confd/conf.d/myconfig.toml & 18 | echo "[nginx] confd is listening for changes on etcd..." 19 | 20 | # Start nginx 21 | echo "[nginx] starting nginx service..." 22 | service nginx start 23 | 24 | 25 | -------------------------------------------------------------------------------- /src/confd/conf.d/myconfig.toml: -------------------------------------------------------------------------------- 1 | [template] 2 | 3 | # The name of the template that will be used to render the application's configuration file 4 | # Confd will look in `/etc/conf.d/templates` for these files by default 5 | src = "nginx.tmpl" 6 | 7 | # The location to place the rendered configuration file 8 | dest = "/etc/nginx/nginx.conf" 9 | 10 | # The etcd keys or directory to watch. This is where the information to fill in 11 | # the template will come from. 12 | keys = [ "/registry/services/specs/" ] 13 | 14 | # File ownership and mode information 15 | owner = "root" 16 | mode = "0644" 17 | 18 | # These are the commands that will be used to check whether the rendered config is 19 | # valid and to reload the actual service once the new config is in place 20 | check_cmd = "/usr/sbin/nginx -t -c {{.src}}" 21 | reload_cmd = "/usr/sbin/service nginx reload" 22 | -------------------------------------------------------------------------------- /src/confd/confd.toml: -------------------------------------------------------------------------------- 1 | backend = "etcd" 2 | confdir = "/etc/confd" 3 | debug = false 4 | interval = 10 5 | nodes = [ 6 | "http://127.0.0.1:4001", 7 | ] 8 | watch = true 9 | quiet = true 10 | verbose = false -------------------------------------------------------------------------------- /src/confd/templates/nginx.tmpl: -------------------------------------------------------------------------------- 1 | daemon off; 2 | user www-data; 3 | worker_processes 4; 4 | pid /run/nginx.pid; 5 | 6 | events { 7 | worker_connections 768; 8 | # multi_accept on; 9 | } 10 | 11 | http { 12 | 13 | ## 14 | # Basic Settings 15 | ## 16 | 17 | sendfile on; 18 | tcp_nopush on; 19 | tcp_nodelay on; 20 | keepalive_timeout 65; 21 | types_hash_max_size 2048; 22 | # server_tokens off; 23 | 24 | # server_names_hash_bucket_size 64; 25 | # server_name_in_redirect off; 26 | 27 | include /etc/nginx/mime.types; 28 | default_type application/octet-stream; 29 | 30 | ## 31 | # Logging Settings 32 | ## 33 | 34 | # access_log /var/log/nginx/access.log; 35 | access_log off; 36 | error_log /var/log/nginx/error.log; 37 | 38 | ## 39 | # Gzip Settings 40 | ## 41 | 42 | gzip on; 43 | gzip_disable "msie6"; 44 | 45 | # gzip_vary on; 46 | # gzip_proxied any; 47 | # gzip_comp_level 6; 48 | # gzip_buffers 16 8k; 49 | # gzip_http_version 1.1; 50 | # gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; 51 | 52 | ## 53 | # Virtual Host Configs 54 | ## 55 | 56 | include /etc/nginx/conf.d/*.conf; 57 | 58 | {{range $spec := getvs "/registry/services/specs/*/*"}} 59 | {{$data := json $spec}} 60 | {{ if $data.annotations.kubernetesReverseproxy }} 61 | {{$p := json $data.annotations.kubernetesReverseproxy }} 62 | {{range $proxy := $p.hosts}} 63 | {{if $proxy.host }} 64 | server { 65 | 66 | {{if $proxy.port }} listen {{$proxy.port}}; {{end}} 67 | server_name {{$proxy.host}}; 68 | 69 | {{if $proxy.ssl }} 70 | ssl_certificate /etc/nginx/ssl/{{$proxy.sslCrt}}; 71 | ssl_certificate_key /etc/nginx/ssl/{{$proxy.sslKey}}; 72 | 73 | ssl on; 74 | ssl_session_cache builtin:1000 shared:SSL:10m; 75 | ssl_protocols TLSv1 TLSv1.1 TLSv1.2; 76 | ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4; 77 | ssl_prefer_server_ciphers on; 78 | {{ end }} 79 | 80 | {{if $proxy.path }} 81 | {{range $path := $proxy.path}} 82 | location {{$path}}/ { 83 | 84 | proxy_set_header X-Real-IP $remote_addr; 85 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 86 | proxy_set_header Host $http_host; 87 | proxy_set_header X-NginX-Proxy true; 88 | 89 | {{if $proxy.ssl }} 90 | proxy_redirect http:// https://; 91 | {{ else }} 92 | proxy_redirect off; 93 | {{ end }} 94 | 95 | {{if $proxy.webSocket }} 96 | proxy_http_version 1.1; 97 | proxy_set_header Upgrade $http_upgrade; 98 | proxy_set_header Connection "upgrade"; 99 | {{ end }} 100 | 101 | proxy_pass http://{{$data.portalIP}}:{{$data.port}}; 102 | } 103 | {{ end }} 104 | 105 | {{ if $proxy.defaultPath}} 106 | location / { 107 | rewrite ^/$ {{$proxy.defaultPath}}/ permanent; 108 | } 109 | {{ end }} 110 | {{ else }} 111 | location / { 112 | 113 | proxy_set_header X-Real-IP $remote_addr; 114 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 115 | proxy_set_header Host $http_host; 116 | proxy_set_header X-NginX-Proxy true; 117 | 118 | {{if $proxy.ssl }} 119 | proxy_redirect http:// https://; 120 | {{ else }} 121 | proxy_redirect off; 122 | {{ end }} 123 | 124 | {{if $proxy.webSocket }} 125 | proxy_http_version 1.1; 126 | proxy_set_header Upgrade $http_upgrade; 127 | proxy_set_header Connection "upgrade"; 128 | {{ end }} 129 | 130 | proxy_pass http://{{$data.portalIP}}:{{$data.port}}; 131 | } 132 | {{ end }} 133 | 134 | } 135 | {{ end }} 136 | {{ end }} 137 | {{ end }} 138 | {{ end }} 139 | } 140 | --------------------------------------------------------------------------------