From da5b4493a060e3b6bdcdc7d9442db77eb5c73ded Mon Sep 17 00:00:00 2001 From: Sergey Kraynev Date: Thu, 26 Jan 2017 06:28:56 +0000 Subject: [PATCH] Add base stuff for nginx support in ccp - Add docker file for building custom image - Add yamllint checks - Add service definition - Configs for nginx were splitted Co-Authored-By: Artur Zarzycki Change-Id: I0660cc3ca2723bc06871b61f859adfed42c0d807 --- LICENSE | 176 +++++++++++++++++++++++++++++++ docker/nginx/Dockerfile.j2 | 8 ++ docker/nginx/nginx.conf | 9 ++ examples/README.rst | 7 ++ examples/servers.conf.j2 | 19 ++++ examples/upstreams.conf.j2 | 3 + service/files/ca-cert.pem.j2 | 1 + service/files/defaults.yaml | 8 ++ service/files/server-cert.pem.j2 | 1 + service/files/server-key.pem.j2 | 1 + service/nginx.yaml | 31 ++++++ tools/yamllint.sh | 5 + tools/yamllint.yaml | 21 ++++ tox.ini | 17 +++ 14 files changed, 307 insertions(+) create mode 100644 LICENSE create mode 100644 docker/nginx/Dockerfile.j2 create mode 100644 docker/nginx/nginx.conf create mode 100644 examples/README.rst create mode 100644 examples/servers.conf.j2 create mode 100644 examples/upstreams.conf.j2 create mode 100644 service/files/ca-cert.pem.j2 create mode 100644 service/files/defaults.yaml create mode 100644 service/files/server-cert.pem.j2 create mode 100644 service/files/server-key.pem.j2 create mode 100644 service/nginx.yaml create mode 100755 tools/yamllint.sh create mode 100644 tools/yamllint.yaml create mode 100644 tox.ini diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + diff --git a/docker/nginx/Dockerfile.j2 b/docker/nginx/Dockerfile.j2 new file mode 100644 index 0000000..489650a --- /dev/null +++ b/docker/nginx/Dockerfile.j2 @@ -0,0 +1,8 @@ +FROM {{ image_spec("base-tools") }} +MAINTAINER {{ maintainer }} + +RUN apt-get update \ + && apt-get install -y nginx \ + && usermod -a -G microservices www-data + +COPY nginx.conf /etc/nginx/nginx.conf diff --git a/docker/nginx/nginx.conf b/docker/nginx/nginx.conf new file mode 100644 index 0000000..68c0108 --- /dev/null +++ b/docker/nginx/nginx.conf @@ -0,0 +1,9 @@ +daemon off; +user www-data; + +events { +} + +http { + include conf.d/*.conf; +} diff --git a/examples/README.rst b/examples/README.rst new file mode 100644 index 0000000..d35e015 --- /dev/null +++ b/examples/README.rst @@ -0,0 +1,7 @@ +These files demonstrate the architecture of nginx proxy, which is used in +other services with enabled TLS. + +- upstreams.conf.j2 contains information about all endpoint behind nginx proxy. + There is one instance of this file should be each repository. +- servers.conf.j2 contains proxy configuration, i.e. which address:port + should be listen, options for SSL, HTTP headers and destination endpoint. diff --git a/examples/servers.conf.j2 b/examples/servers.conf.j2 new file mode 100644 index 0000000..a0d6d5c --- /dev/null +++ b/examples/servers.conf.j2 @@ -0,0 +1,19 @@ +server { + listen {{ nginx.port.cont }}; + ssl on; + ssl_protocols TLSv1 TLSv1.1 TLSv1.2; + ssl_session_cache shared:SSL:10m; + ssl_ciphers {{ nginx.ciphers }}; + ssl_prefer_server_ciphers on; + ssl_certificate /opt/ccp/etc/tls/server-cert.pem; + ssl_certificate_key /opt/ccp/etc/tls/server-key.pem; + ssl_trusted_certificate /opt/ccp/etc/tls/ca-cert.pem; + location / { + proxy_pass http://osservice; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } +} + diff --git a/examples/upstreams.conf.j2 b/examples/upstreams.conf.j2 new file mode 100644 index 0000000..c4fe334 --- /dev/null +++ b/examples/upstreams.conf.j2 @@ -0,0 +1,3 @@ +upstream osservice { + server 127.0.0.1:{{ nginx.service_internal_port }}; +} diff --git a/service/files/ca-cert.pem.j2 b/service/files/ca-cert.pem.j2 new file mode 100644 index 0000000..d52069b --- /dev/null +++ b/service/files/ca-cert.pem.j2 @@ -0,0 +1 @@ +{{ security.tls.ca_cert }} diff --git a/service/files/defaults.yaml b/service/files/defaults.yaml new file mode 100644 index 0000000..90f0fc1 --- /dev/null +++ b/service/files/defaults.yaml @@ -0,0 +1,8 @@ +configs: + nginx: + address: 0.0.0.0 + port: + cont: 80 + service: null + service_internal_port: 8080 + ciphers: "EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH" diff --git a/service/files/server-cert.pem.j2 b/service/files/server-cert.pem.j2 new file mode 100644 index 0000000..8abc152 --- /dev/null +++ b/service/files/server-cert.pem.j2 @@ -0,0 +1 @@ +{{ security.tls.server_cert }} diff --git a/service/files/server-key.pem.j2 b/service/files/server-key.pem.j2 new file mode 100644 index 0000000..70cf751 --- /dev/null +++ b/service/files/server-key.pem.j2 @@ -0,0 +1 @@ +{{ security.tls.server_key }} diff --git a/service/nginx.yaml b/service/nginx.yaml new file mode 100644 index 0000000..37865d1 --- /dev/null +++ b/service/nginx.yaml @@ -0,0 +1,31 @@ +dsl_version: 0.4.0 +service: + name: nginx + ports: + - {{ nginx.port}} + containers: + - name: nginx + image: nginx + daemon: + files: + - ca_cert + - server-cert + - server-key + command: nginx + +files: + ca_cert: + path: /opt/ccp/etc/tls/ca-cert.pem + content: ca-cert.pem.j2 + perm: "0400" + user: www-data + server-cert: + path: /opt/ccp/etc/tls/server-cert.pem + content: server-cert.pem.j2 + perm: "0400" + user: www-data + server-key: + path: /opt/ccp/etc/tls/server-key.pem + content: server-key.pem.j2 + perm: "0400" + user: www-data diff --git a/tools/yamllint.sh b/tools/yamllint.sh new file mode 100755 index 0000000..6e84445 --- /dev/null +++ b/tools/yamllint.sh @@ -0,0 +1,5 @@ +#!/bin/bash +set -ex + +workdir=$(dirname $0) +yamllint -c $workdir/yamllint.yaml $(find . -not -path '*/\.*' -type f -name '*.yaml') diff --git a/tools/yamllint.yaml b/tools/yamllint.yaml new file mode 100644 index 0000000..6c2e4a7 --- /dev/null +++ b/tools/yamllint.yaml @@ -0,0 +1,21 @@ +extends: default + +rules: + braces: + max-spaces-inside: 1 + comments: + level: error + comments-indentation: + level: warning + document-end: + present: no + document-start: + level: error + present: no + empty-lines: + max: 1 + max-start: 0 + max-end: 0 + line-length: + level: warning + max: 120 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..8b6a5b9 --- /dev/null +++ b/tox.ini @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = linters,bashate +skipsdist = True + +[testenv:linters] +deps = yamllint +commands = + {toxinidir}/tools/yamllint.sh + +[testenv:bashate] +deps = bashate>=0.2 +whitelist_externals = bash +commands = bash -c "find {toxinidir} -type f -name '*.sh' -not -path '*/.tox/*' -print0 | xargs -0 bashate -v" + +[testenv:venv] +commands = {posargs}