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/rabbitmq/Dockerfile.j2 b/docker/rabbitmq/Dockerfile.j2 index 970335f..93a79ea 100644 --- a/docker/rabbitmq/Dockerfile.j2 +++ b/docker/rabbitmq/Dockerfile.j2 @@ -1,15 +1,33 @@ FROM {{ image_spec("base-tools") }} MAINTAINER {{ maintainer }} -RUN apt-get install -y --no-install-recommends \ - rabbitmq-server \ - && apt-get clean \ - && rm -rf /var/lib/rabbitmq/* +# Choosing erlang version explicity, so we will not have a lot of GUI libraries +{% set erlang_deps = 'erlang-nox erlang-base-hipe' %} + +# Runtime deps of rabbitmq +{% set rabbit_run_deps = 'socat logrotate' %} + +# Manually managing dependencies, as we don't yet have APT repos with proper versions +# of rabbitmq and autocluster. +RUN apt-get install -t jessie-backports -y --no-install-recommends \ + {{ erlang_deps }} {{ rabbit_run_deps }} \ + && apt-get clean + +# We need at least 3.6.6, as it'll contain https://github.com/rabbitmq/rabbitmq-server/pull/892 +RUN curl -Lo /tmp/rabbitmq-server.deb https://github.com/rabbitmq/rabbitmq-server/releases/download/rabbitmq_v3_6_6_rc1/rabbitmq-server_3.6.5.906-1_all.deb \ + && dpkg -i /tmp/rabbitmq-server.deb \ + && rm -rf /tmp/rabbitmq-server.deb /var/lib/rabbitmq/* + +# `cp` is needed until https://github.com/rabbitmq/rabbitmq-server/pull/1016 is merged +RUN curl -Lo /tmp/rabbitmq-autocluster.deb https://github.com/Mirantis/rabbitmq-autocluster/releases/download/0.6.1.950/rabbitmq-autocluster_0.6.1.950-1_all.deb \ + && dpkg -i /tmp/rabbitmq-autocluster.deb \ + && cp -v /usr/lib/rabbitmq/plugins/*.ez /usr/lib/rabbitmq/lib/rabbitmq_server-*/plugins/ COPY rabbitmq_sudoers /etc/sudoers.d/rabbitmq_sudoers + RUN chmod 750 /etc/sudoers.d \ && chmod 440 /etc/sudoers.d/rabbitmq_sudoers \ && usermod -a -G microservices rabbitmq \ - && chown -R rabbitmq: /var/lib/rabbitmq /var/log/rabbitmq /etc/rabbitmq + && chown -R rabbitmq: /var/lib/rabbitmq /etc/rabbitmq USER rabbitmq diff --git a/service/files/defaults.yaml b/service/files/defaults.yaml index 481b969..be9e755 100644 --- a/service/files/defaults.yaml +++ b/service/files/defaults.yaml @@ -4,4 +4,9 @@ configs: cont: 5672 node: 32672 password: password + erlang_cookie: erlang_cookie user: rabbitmq + + # How many seconds we give a node before making liveness checks + # completely strict + node_startup_timeout: 180 diff --git a/service/files/enabled_plugins.j2 b/service/files/enabled_plugins.j2 new file mode 100644 index 0000000..096dcb1 --- /dev/null +++ b/service/files/enabled_plugins.j2 @@ -0,0 +1 @@ +[autocluster]. diff --git a/service/files/erlang.cookie b/service/files/erlang.cookie deleted file mode 100644 index 0dc3c1c..0000000 --- a/service/files/erlang.cookie +++ /dev/null @@ -1 +0,0 @@ -{{ rabbitmq.password }} diff --git a/service/files/erlang.cookie.j2 b/service/files/erlang.cookie.j2 new file mode 100644 index 0000000..ff79bef --- /dev/null +++ b/service/files/erlang.cookie.j2 @@ -0,0 +1 @@ +{{ rabbitmq.erlang_cookie }} diff --git a/service/files/rabbitmq-check-helpers.sh.j2 b/service/files/rabbitmq-check-helpers.sh.j2 new file mode 100755 index 0000000..84acf90 --- /dev/null +++ b/service/files/rabbitmq-check-helpers.sh.j2 @@ -0,0 +1,92 @@ +#!/usr/bin/env bash +MARKER_PATH=/tmp/rabbit-startup-marker + +# How many seconds we give a node before successfull liveness checks +# become mandatory. +FRESH_NODE_TIMEOUT={{ rabbitmq.node_startup_timeout }} + +LP="" + +set-log-prefix() { + LP="[${1:?}]" +} + +log-it() { + echo "$LP" "$@" +} + +prepend-log-prefix() { + awk -v lp="$LP" '{print lp " " $0}' +} + +marker-state() { + if [[ ! -f $MARKER_PATH ]]; then + echo "missing" + return 0 + fi + local marker_time + marker_time="$(cat $MARKER_PATH)" + + local end_of_fresh_time=$((FRESH_NODE_TIMEOUT + $marker_time)) + local now + now=$(date +%s) + if [[ $now -le $end_of_fresh_time ]]; then + echo "fresh" + return 0 + fi + echo "stale" + return 0 +} + +ping-node() { + local result + result="$(rabbitmqctl eval 'ok.' 2>&1)" + if [[ "$result" == "ok" ]]; then + return 0 + fi + log-it "ping-node error:" + echo "$result" | prepend-log-prefix + return 1 +} + +is-node-booting() { + local result + result="$(rabbitmqctl eval 'is_pid(erlang:whereis(rabbit_boot)).' 2>&1)" + + case "$result" in + true) + return 0 + ;; + false) + return 1 + ;; + *) + log-it "is-node-booting error:" + echo "$result" | prepend-log-prefix + return 1 + ;; + esac +} + +is-node-healthy() { + local result + result=$(rabbitmqctl node_health_check -t 30 2>&1) + if [[ "$result" =~ "Health check passed" ]]; then + return 0 + fi + echo "$result" | prepend-log-prefix + return 1 +} + +is-node-properly-clustered() { + result="$(rabbitmqctl eval 'autocluster:cluster_health_check().' 2>&1)" + if [[ $result =~ ^SUCCESS: ]]; then + return 0 + elif [[ $result =~ ^FAILURE: ]]; then + echo "$result" | prepend-log-prefix + return 1 + fi + log-it "Unexpected health-check output, giving the node the benefit of the doubt" + echo "$result" | prepend-log-prefix + return 0 +} diff --git a/service/files/rabbitmq-env.conf.j2 b/service/files/rabbitmq-env.conf.j2 index 6f28389..e08d1bc 100644 --- a/service/files/rabbitmq-env.conf.j2 +++ b/service/files/rabbitmq-env.conf.j2 @@ -1,2 +1,3 @@ -NODENAME=rabbitmq +NODENAME=rabbit@{{ network_topology["private"]["address"] }} +USE_LONGNAME=true RABBITMQ_LOG_BASE=/var/log/ccp/rabbitmq diff --git a/service/files/rabbitmq-liveness.sh.j2 b/service/files/rabbitmq-liveness.sh.j2 new file mode 100755 index 0000000..7e0af4f --- /dev/null +++ b/service/files/rabbitmq-liveness.sh.j2 @@ -0,0 +1,62 @@ +#!/usr/bin/env bash +set -eu +set -o pipefail +exec 1>/proc/1/fd/2 2>/proc/1/fd/2 + +source $(readlink -f $(dirname $0))/rabbitmq-check-helpers.sh +set-log-prefix "liveness:$$" +log-it "Starting liveness probe at $(date +'%Y-%m-%d %H:%M:%S')" + +main() { + local marker_state + marker_state="$(marker-state)" + case $marker_state in + missing) + log-it "Startup marker missing, probably probe was executed too early" + return 0 + ;; + fresh) # node has recently started - it can still be booting + if ! ping-node; then + log-it "Fresh node, erlang VM hasn't started yet - giving it another chance" + # Erlang VM hasn't started yet + return 0 + fi + if is-node-booting; then + log-it "Node is still booting, giving it some time to finish" + return 0 + fi + if ! is-node-healthy; then + log-it "Node is unhealthy" + return 1 + fi + if ! is-node-properly-clustered; then + log-it "Found clustering inconsistency, giving up" + return 1 + fi + return 0 + ;; + stale) # node has started long ago - it shoud be either ready or dead + if ! is-node-healthy; then + log-it "Long-running node become unhealthy" + return 1 + fi + if ! is-node-properly-clustered; then + echo "Long-running node became inconsistent with the rest of the cluster" + return 1 + fi + return 0 + ;; + *) + log-it "Unexpected marker-state '$marker-state'" + return 1 + ;; + esac +} + +if main; then + rc=0 +else + rc=$? +fi +log-it "Ready to return $rc" +exit $rc diff --git a/service/files/rabbitmq-readiness.sh.j2 b/service/files/rabbitmq-readiness.sh.j2 new file mode 100755 index 0000000..6522ed8 --- /dev/null +++ b/service/files/rabbitmq-readiness.sh.j2 @@ -0,0 +1,32 @@ +#!/usr/bin/env bash +set -eu +set -o pipefail +exec 1>/proc/1/fd/2 2>/proc/1/fd/2 + +source $(readlink -f $(dirname $0))/rabbitmq-check-helpers.sh +set-log-prefix "readiness:$$" +log-it "Starting readiness probe at $(date +'%Y-%m-%d %H:%M:%S')" + +main() { + if [[ "$(marker-state)" == missing ]]; then + log-it "Startup marker missing, probably probe was executed too early" + return 1 + fi + if ! is-node-healthy; then + log-it "Node is unhealthy" + return 1 + fi + if ! is-node-properly-clustered; then + log-it "Node is inconsistent with the rest of the cluster" + return 1 + fi + return 0 +} + +if main; then + rc=0 +else + rc=$? +fi +log-it "Ready to return $rc" +exit $rc diff --git a/service/files/rabbitmq.config.j2 b/service/files/rabbitmq.config.j2 index 97b5252..108bf13 100644 --- a/service/files/rabbitmq.config.j2 +++ b/service/files/rabbitmq.config.j2 @@ -1,11 +1,26 @@ [ - {rabbit, [ - {tcp_listeners, [ - {"0.0.0.0", {{ rabbitmq.port.cont }} } - ]}, - {default_user, <<"{{ rabbitmq.user }}">>}, - {default_pass, <<"{{ rabbitmq.password }}">>}, - {cluster_partition_handling, autoheal} - ]} + {rabbit, [ + {dummy_param_without_comma, true} + ,{tcp_listeners, [ + {"0.0.0.0", {{ rabbitmq.port.cont }} } + ]} + ,{default_user, <<"{{ rabbitmq.user }}">>} + ,{default_pass, <<"{{ rabbitmq.password }}">>} + ,{loopback_users, []} + ,{cluster_partition_handling, pause_minority} + ,{queue_master_locator, <<"random">>} + ]} + ,{autocluster, [ + {dummy_param_without_comma, true} + ,{backend, etcd} + ,{autocluster_failure, stop} + ,{cleanup_interval, 30} + ,{cluster_cleanup, true} + ,{cleanup_warn_only, false} + ,{etcd_ttl, 15} + ,{etcd_scheme, http} + ,{etcd_host, "etcd"} + ,{etcd_port, {{ etcd.client_port.cont }}} + ]} ]. % EOF diff --git a/service/rabbitmq.yaml b/service/rabbitmq.yaml index 94b1fdc..bc30d3f 100644 --- a/service/rabbitmq.yaml +++ b/service/rabbitmq.yaml @@ -1,14 +1,15 @@ service: name: rabbitmq + kind: DaemonSet ports: - {{ rabbitmq.port }} containers: - name: rabbitmq image: rabbitmq probes: - readiness: "true" + readiness: "/opt/ccp/bin/rabbitmq-readiness.sh" liveness: - command: "true" + command: "/opt/ccp/bin/rabbitmq-liveness.sh" type: "exec" volumes: - name: rabbitmq-logs @@ -19,19 +20,43 @@ service: - name: chown-logs-dir command: "sudo /bin/chown rabbitmq: /var/log/ccp/rabbitmq" daemon: + dependencies: + - etcd + command: /usr/lib/rabbitmq/bin/rabbitmq-server files: - rabbitmq-conf - - rabbitmq-env - erlang-cookie - command: rabbitmq-server + - rabbitmq-env-conf + - enabled-plugins + - rabbitmq-readiness + - rabbitmq-liveness + - rabbitmq-check-helpers + post: + - name: create-startup-marker + command: "date +%s > /tmp/rabbit-startup-marker" files: rabbitmq-conf: path: /etc/rabbitmq/rabbitmq.config content: rabbitmq.config.j2 - rabbitmq-env: + rabbitmq-env-conf: path: /etc/rabbitmq/rabbitmq-env.conf content: rabbitmq-env.conf.j2 + enabled-plugins: + path: /etc/rabbitmq/enabled_plugins + content: enabled_plugins.j2 erlang-cookie: path: /var/lib/rabbitmq/.erlang.cookie - content: erlang.cookie + content: erlang.cookie.j2 perm: "400" + rabbitmq-readiness: + path: /opt/ccp/bin/rabbitmq-readiness.sh + content: rabbitmq-readiness.sh.j2 + perm: "755" + rabbitmq-liveness: + path: /opt/ccp/bin/rabbitmq-liveness.sh + content: rabbitmq-liveness.sh.j2 + perm: "755" + rabbitmq-check-helpers: + path: /opt/ccp/bin/rabbitmq-check-helpers.sh + content: rabbitmq-check-helpers.sh.j2 + perm: "644"