├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── .travis.yml ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── LICENSE-MPL-RabbitMQ ├── Makefile ├── README.md ├── erlang.mk ├── examples ├── README.md ├── gke │ └── README.md ├── kind │ └── README.md └── minikube │ └── README.md ├── include └── rabbit_peer_discovery_k8s.hrl ├── priv └── schema │ └── rabbitmq_peer_discovery_k8s.schema ├── rabbitmq-components.mk ├── src ├── rabbit_peer_discovery_k8s.erl ├── rabbitmq_peer_discovery_k8s.erl ├── rabbitmq_peer_discovery_k8s_app.erl ├── rabbitmq_peer_discovery_k8s_node_monitor.erl └── rabbitmq_peer_discovery_k8s_sup.erl └── test ├── config_schema_SUITE.erl ├── config_schema_SUITE_data └── rabbitmq_peer_discovery_k8s.snippets └── rabbitmq_peer_discovery_k8s_SUITE.erl /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Thank you for using RabbitMQ. 2 | 3 | **STOP NOW AND READ THIS** BEFORE OPENING A NEW ISSUE ON GITHUB 4 | 5 | Unless you are CERTAIN you have found a reproducible problem in RabbitMQ or 6 | have a **specific, actionable** suggestion for our team, you must first ask 7 | your question or discuss your suspected issue on the mailing list: 8 | 9 | https://groups.google.com/forum/#!forum/rabbitmq-users 10 | 11 | Team RabbitMQ does not use GitHub issues for discussions, investigations, root 12 | cause analysis and so on. 13 | 14 | Please take the time to read the CONTRIBUTING.md document for instructions on 15 | how to effectively ask a question or report a suspected issue: 16 | 17 | https://github.com/rabbitmq/rabbitmq-server/blob/master/CONTRIBUTING.md#github-issues 18 | 19 | Following these rules **will save time** for both you and RabbitMQ's maintainers. 20 | 21 | Thank you. 22 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Proposed Changes 2 | 3 | Please describe the big picture of your changes here to communicate to the 4 | RabbitMQ team why we should accept this pull request. If it fixes a bug or 5 | resolves a feature request, be sure to link to that issue. 6 | 7 | A pull request that doesn't explain **why** the change was made has a much 8 | lower chance of being accepted. 9 | 10 | If English isn't your first language, don't worry about it and try to 11 | communicate the problem you are trying to solve to the best of your abilities. 12 | As long as we can understand the intent, it's all good. 13 | 14 | ## Types of Changes 15 | 16 | What types of changes does your code introduce to this project? 17 | _Put an `x` in the boxes that apply_ 18 | 19 | - [ ] Bug fix (non-breaking change which fixes issue #NNNN) 20 | - [ ] New feature (non-breaking change which adds functionality) 21 | - [ ] Breaking change (fix or feature that would cause an observable behavior change in existing systems) 22 | - [ ] Documentation improvements (corrections, new content, etc) 23 | - [ ] Cosmetic change (whitespace, formatting, etc) 24 | 25 | ## Checklist 26 | 27 | _Put an `x` in the boxes that apply. You can also fill these out after creating 28 | the PR. If you're unsure about any of them, don't hesitate to ask on the 29 | mailing list. We're here to help! This is simply a reminder of what we are 30 | going to look for before merging your code._ 31 | 32 | - [ ] I have read the `CONTRIBUTING.md` document 33 | - [ ] I have signed the CA (see https://cla.pivotal.io/sign/rabbitmq) 34 | - [ ] All tests pass locally with my changes 35 | - [ ] I have added tests that prove my fix is effective or that my feature works 36 | - [ ] I have added necessary documentation (if appropriate) 37 | - [ ] Any dependent changes have been merged and published in related repositories 38 | 39 | ## Further Comments 40 | 41 | If this is a relatively large or complex change, kick off the discussion by 42 | explaining why you chose the solution you did and what alternatives you 43 | considered, etc. 44 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | .sw? 3 | .*.sw? 4 | *.beam 5 | *.coverdata 6 | /.erlang.mk/ 7 | /cover/ 8 | /deps/ 9 | /doc/ 10 | /ebin/ 11 | /escript/ 12 | /escript.lock 13 | /git-revisions.txt 14 | /logs/ 15 | /plugins/ 16 | /plugins.lock 17 | /rebar.config 18 | /rebar.lock 19 | /sbin/ 20 | /sbin.lock 21 | /test/config_schema_SUITE_data/schema/ 22 | /test/ct.cover.spec 23 | /xrefr 24 | 25 | /rabbitmq_peer_discovery_k8s.d 26 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # vim:sw=2:et: 2 | 3 | os: linux 4 | dist: xenial 5 | language: elixir 6 | notifications: 7 | email: 8 | recipients: 9 | - alerts@rabbitmq.com 10 | on_success: never 11 | on_failure: always 12 | addons: 13 | apt: 14 | packages: 15 | - awscli 16 | cache: 17 | apt: true 18 | env: 19 | global: 20 | - secure: aeHv/XU16cTsiZznWmAr5qi0mYDihao/wpNJ5QTdef+dSXmr66AKn+7HoRKO+K7itt1GhOBpnfEGZagocPPbPyYX/u1FGsCeE3nRvg24aNCdxNnZ+uPa8Vs6kPQokNzYMSvUH5y75zdnBH2zwEihro92fSG3aTzK7Gdr0XC5xoYiSRMaffbPLMaxay/JuSmO/qOCKiMIZnnuzEBHV0RIlKOCubTkVB7kVW0o66auh9FpYqP7JMIrKHV2aKFNExEvFuhag732T5hhH/bfzq+NbV/BS9BWws9BDqM2LBvjAgaLgqZ1VTjmkYbtqjIq6dQz3ESc8ir5nuyVyuAQeKIe57XyB5v5sbpPADqfChmXI5rn0CIt3iMlPzzUX5KuCC640lela6wp6xYfXk5TGsBgrIRZ+x9iOnU/M5qUsVGfxAnoI/FLMQ386k10G3ZzIgEcHrz/wwracMY2boJdgMEXugIJA6sPIH3WNCa6QWWOAGP2U736ApuXjwiDED/3WxfN6o4gcWEZwWYqOZQIFVZSu/LAo3Tby5x/bubkKySznqssDhv5rcdHN0+uOATFW2+1xJ2cPyeP5tJnTvBbEeWs5InWkeSZ84iB95Un6ETxxeHOpssT0ygyXtCmXWVAcA+uBwF2hcMZlA00dvoYfMvEPBFeVs9YLMcdZvkGTp5iaoQ= 21 | - secure: Bqvu0TyVQN/22yPX4F5kboh8Y8XQ31ptAD+yf7Rt9e9rjkl72I8hjmXxx8fBsmgZUIsqiuzUsEtKJ41TVtke2gDUacqWpp6cl9swgIwTqqjX8XI2jwcnn810d00/xX0Fy9k8hi5GIOpArjDz+oXDYiCebTsQi2v6LQ7taDvfhFRF09EBtBb+0A4M1pGT4haUe0RmcN6GtNTVtQKx/SQZFMT4rWTv0NmlZODGH/Bj7w65c71DD7ok37B3LJTlI7BkkSvwokrbCx/kPlKcDICP0LswqEIsHOkPEILTBG4PJR1W+IhaKfFvPqEsrerIcq+k08neZhyKqBzYqJV+Ri4wus8AqzKlZPNPALnJFqhuII3u6j/HSZsceFFOpZo7pq1m5FwT6HXJv3NjAHj8IeJOverJEL/iSf/VXEvRZrmykFgNEVyP9DOhdcLYM5t99VYzFItJMg59sXbyIxG0RzZjSxMMyswi1IK/SCWg5owacyO32+ptD+N6C6pEEaECltMA4hnC/yay3CUlK/KPRjzDyyQFA7dAtJofFlVSl/s59x5yz1cUKXhfcQEOi28dVqL5aNX9RvpLBkwQ22+ZzMEm20JvdoxrDiYs5okQ3b2SC5mGJPprEVbd6/bXbKIy4fXlZqcu39PtF9VVEEaOY5NJgElWHqwL2/Bvi/fOeFW6kYA= 22 | 23 | # $base_rmq_ref is used by rabbitmq-components.mk to select the 24 | # appropriate branch for dependencies. 25 | - base_rmq_ref=master 26 | 27 | elixir: 28 | - '1.9' 29 | otp_release: 30 | - '21.3' 31 | - '22.2' 32 | 33 | install: 34 | # This project being an Erlang one (we just set language to Elixir 35 | # to ensure it is installed), we don't want Travis to run mix(1) 36 | # automatically as it will break. 37 | skip 38 | 39 | script: 40 | # $current_rmq_ref is also used by rabbitmq-components.mk to select 41 | # the appropriate branch for dependencies. 42 | - make check-rabbitmq-components.mk 43 | current_rmq_ref="${TRAVIS_PULL_REQUEST_BRANCH:-${TRAVIS_BRANCH}}" 44 | - make xref 45 | current_rmq_ref="${TRAVIS_PULL_REQUEST_BRANCH:-${TRAVIS_BRANCH}}" 46 | - make tests 47 | current_rmq_ref="${TRAVIS_PULL_REQUEST_BRANCH:-${TRAVIS_BRANCH}}" 48 | 49 | after_failure: 50 | - | 51 | cd "$TRAVIS_BUILD_DIR" 52 | if test -d logs && test "$AWS_ACCESS_KEY_ID" && test "$AWS_SECRET_ACCESS_KEY"; then 53 | archive_name="$(basename "$TRAVIS_REPO_SLUG")-$TRAVIS_JOB_NUMBER" 54 | 55 | tar -c --transform "s/^logs/${archive_name}/" -f - logs | \ 56 | xz > "${archive_name}.tar.xz" 57 | 58 | aws s3 cp "${archive_name}.tar.xz" s3://server-release-pipeline/travis-ci-logs/ \ 59 | --region eu-west-1 \ 60 | --acl public-read 61 | fi 62 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Code of Conduct 2 | 3 | As contributors and maintainers of this project, and in the interest of fostering an open 4 | and welcoming community, we pledge to respect all people who contribute through reporting 5 | issues, posting feature requests, updating documentation, submitting pull requests or 6 | patches, and other activities. 7 | 8 | We are committed to making participation in this project a harassment-free experience for 9 | everyone, regardless of level of experience, gender, gender identity and expression, 10 | sexual orientation, disability, personal appearance, body size, race, ethnicity, age, 11 | religion, or nationality. 12 | 13 | Examples of unacceptable behavior by participants include: 14 | 15 | * The use of sexualized language or imagery 16 | * Personal attacks 17 | * Trolling or insulting/derogatory comments 18 | * Public or private harassment 19 | * Publishing other's private information, such as physical or electronic addresses, 20 | without explicit permission 21 | * Other unethical or unprofessional conduct 22 | 23 | Project maintainers have the right and responsibility to remove, edit, or reject comments, 24 | commits, code, wiki edits, issues, and other contributions that are not aligned to this 25 | Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors 26 | that they deem inappropriate, threatening, offensive, or harmful. 27 | 28 | By adopting this Code of Conduct, project maintainers commit themselves to fairly and 29 | consistently applying these principles to every aspect of managing this project. Project 30 | maintainers who do not follow or enforce the Code of Conduct may be permanently removed 31 | from the project team. 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an 34 | individual is representing the project or its community. 35 | 36 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 37 | contacting a project maintainer at [info@rabbitmq.com](mailto:info@rabbitmq.com). All complaints will 38 | be reviewed and investigated and will result in a response that is deemed necessary and 39 | appropriate to the circumstances. Maintainers are obligated to maintain confidentiality 40 | with regard to the reporter of an incident. 41 | 42 | This Code of Conduct is adapted from the 43 | [Contributor Covenant](https://contributor-covenant.org), version 1.3.0, available at 44 | [contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/) 45 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Thank you for using RabbitMQ and for taking the time to contribute to the project. 2 | This document has two main parts: 3 | 4 | * when and how to file GitHub issues for RabbitMQ projects 5 | * how to submit pull requests 6 | 7 | They intend to save you and RabbitMQ maintainers some time, so please 8 | take a moment to read through them. 9 | 10 | ## Overview 11 | 12 | ### GitHub issues 13 | 14 | The RabbitMQ team uses GitHub issues for _specific actionable items_ that 15 | engineers can work on. This assumes the following: 16 | 17 | * GitHub issues are not used for questions, investigations, root cause 18 | analysis, discussions of potential issues, etc (as defined by this team) 19 | * Enough information is provided by the reporter for maintainers to work with 20 | 21 | The team receives many questions through various venues every single 22 | day. Frequently, these questions do not include the necessary details 23 | the team needs to begin useful work. GitHub issues can very quickly 24 | turn into a something impossible to navigate and make sense 25 | of. Because of this, questions, investigations, root cause analysis, 26 | and discussions of potential features are all considered to be 27 | [mailing list][rmq-users] material. If you are unsure where to begin, 28 | the [RabbitMQ users mailing list][rmq-users] is the right place. 29 | 30 | Getting all the details necessary to reproduce an issue, make a 31 | conclusion or even form a hypothesis about what's happening can take a 32 | fair amount of time. Please help others help you by providing a way to 33 | reproduce the behavior you're observing, or at least sharing as much 34 | relevant information as possible on the [RabbitMQ users mailing 35 | list][rmq-users]. 36 | 37 | Please provide versions of the software used: 38 | 39 | * RabbitMQ server 40 | * Erlang 41 | * Operating system version (and distribution, if applicable) 42 | * All client libraries used 43 | * RabbitMQ plugins (if applicable) 44 | 45 | The following information greatly helps in investigating and reproducing issues: 46 | 47 | * RabbitMQ server logs 48 | * A code example or terminal transcript that can be used to reproduce 49 | * Full exception stack traces (a single line message is not enough!) 50 | * `rabbitmqctl report` and `rabbitmqctl environment` output 51 | * Other relevant details about the environment and workload, e.g. a traffic capture 52 | * Feel free to edit out hostnames and other potentially sensitive information. 53 | 54 | To make collecting much of this and other environment information, use 55 | the [`rabbitmq-collect-env`][rmq-collect-env] script. It will produce an archive with 56 | server logs, operating system logs, output of certain diagnostics commands and so on. 57 | Please note that **no effort is made to scrub any information that may be sensitive**. 58 | 59 | ### Pull Requests 60 | 61 | RabbitMQ projects use pull requests to discuss, collaborate on and accept code contributions. 62 | Pull requests is the primary place of discussing code changes. 63 | 64 | Here's the recommended workflow: 65 | 66 | * [Fork the repository][github-fork] or repositories you plan on contributing to. If multiple 67 | repositories are involved in addressing the same issue, please use the same branch name 68 | in each repository 69 | * Create a branch with a descriptive name in the relevant repositories 70 | * Make your changes, run tests (usually with `make tests`), commit with a 71 | [descriptive message][git-commit-msgs], push to your fork 72 | * Submit pull requests with an explanation what has been changed and **why** 73 | * Submit a filled out and signed [Contributor Agreement][ca-agreement] if needed (see below) 74 | * Be patient. We will get to your pull request eventually 75 | 76 | If what you are going to work on is a substantial change, please first 77 | ask the core team for their opinion on the [RabbitMQ users mailing list][rmq-users]. 78 | 79 | ## Running Tests 80 | 81 | To run a "fast suite" (a subset of tests): 82 | 83 | make ct-fast 84 | 85 | To run a "slow suite" (a subset of tests that take much longer to run): 86 | 87 | make ct-slow 88 | 89 | To run a particular suite: 90 | 91 | make ct-$suite_name 92 | 93 | for example, to run the `backing_queue` suite: 94 | 95 | make ct-backing_queue 96 | 97 | Finally, 98 | 99 | make tests 100 | 101 | will run all suites. 102 | 103 | ## Code of Conduct 104 | 105 | See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). 106 | 107 | ## Contributor Agreement 108 | 109 | If you want to contribute a non-trivial change, please submit a signed 110 | copy of our [Contributor Agreement][ca-agreement] around the time you 111 | submit your pull request. This will make it much easier (in some 112 | cases, possible) for the RabbitMQ team at Pivotal to merge your 113 | contribution. 114 | 115 | ## Where to Ask Questions 116 | 117 | If something isn't clear, feel free to ask on our [mailing list][rmq-users]. 118 | 119 | [rmq-collect-env]: https://github.com/rabbitmq/support-tools/blob/master/scripts/rabbitmq-collect-env 120 | [git-commit-msgs]: https://chris.beams.io/posts/git-commit/ 121 | [rmq-users]: https://groups.google.com/forum/#!forum/rabbitmq-users 122 | [ca-agreement]: https://cla.pivotal.io/sign/rabbitmq 123 | [github-fork]: https://help.github.com/articles/fork-a-repo/ 124 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This package is licensed under the MPL 2.0. For the MPL 2.0, please see LICENSE-MPL-RabbitMQ. 2 | 3 | If you have any questions regarding licensing, please contact us at 4 | info@rabbitmq.com. 5 | -------------------------------------------------------------------------------- /LICENSE-MPL-RabbitMQ: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PROJECT = rabbitmq_peer_discovery_k8s 2 | PROJECT_DESCRIPTION = Kubernetes-based RabbitMQ peer discovery backend 3 | PROJECT_MOD = rabbitmq_peer_discovery_k8s_app 4 | 5 | DEPS = rabbit_common rabbitmq_peer_discovery_common rabbit 6 | TEST_DEPS = rabbitmq_ct_helpers rabbitmq_ct_client_helpers ct_helper meck 7 | dep_ct_helper = git https://github.com/extend/ct_helper.git master 8 | 9 | DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-plugin.mk 10 | DEP_PLUGINS = rabbit_common/mk/rabbitmq-plugin.mk 11 | 12 | # FIXME: Use erlang.mk patched for RabbitMQ, while waiting for PRs to be 13 | # reviewed and merged. 14 | 15 | ERLANG_MK_REPO = https://github.com/rabbitmq/erlang.mk.git 16 | ERLANG_MK_COMMIT = rabbitmq-tmp 17 | 18 | include rabbitmq-components.mk 19 | include erlang.mk 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RabbitMQ Peer Discovery Kubernetes 2 | 3 | ## This was migrated to https://github.com/rabbitmq/rabbitmq-server 4 | 5 | This repository has been moved to the main unified RabbitMQ "monorepo", including all open issues. You can find the source under [/deps/rabbitmq_peer_discovery_k8s](https://github.com/rabbitmq/rabbitmq-server/tree/master/deps/rabbitmq_peer_discovery_k8s). 6 | All issues have been transferred. 7 | 8 | ## Overview 9 | 10 | This is an implementation of RabbitMQ [peer discovery interface](https://www.rabbitmq.com/blog/2018/02/12/peer-discovery-subsystem-in-rabbitmq-3-7/) 11 | for Kubernetes. 12 | 13 | This plugin only performs peer discovery using Kubernetes API as the source of data on running cluster pods. 14 | Please get familiar with [RabbitMQ clustering fundamentals](https://rabbitmq.com/clustering.html) before attempting 15 | to use it. 16 | 17 | Cluster provisioning and most of Day 2 operations such as [proper monitoring](https://rabbitmq.com/monitoring.html) 18 | are not in scope for this plugin. 19 | 20 | For a more comprehensive open source RabbitMQ on Kubernetes deployment solution, 21 | see the [RabbitMQ Cluster Operator for Kubernetes](https://www.rabbitmq.com/kubernetes/operator/operator-overview.html). 22 | The Operator is developed [on GitHub](https://github.com/rabbitmq/cluster-operator/) and contains its 23 | own [set of examples](https://github.com/rabbitmq/cluster-operator/tree/master/docs/examples). 24 | 25 | 26 | ## Supported RabbitMQ Versions 27 | 28 | This plugin ships with RabbitMQ 3.7.0 or later. 29 | 30 | 31 | ## Installation 32 | 33 | This plugin ships with [supported RabbitMQ versions](https://www.rabbitmq.com/versions.html). 34 | There is no need to install it separately. 35 | 36 | As with any [plugin](https://rabbitmq.com/plugins.html), it must be enabled before it 37 | can be used. For peer discovery plugins it means they must be [enabled](https://rabbitmq.com//plugins.html#basics) or [preconfigured](https://rabbitmq.com//plugins.html#enabled-plugins-file) 38 | before first node boot: 39 | 40 | ``` 41 | rabbitmq-plugins --offline enable rabbitmq_peer_discovery_k8s 42 | ``` 43 | 44 | ## Documentation 45 | 46 | See [RabbitMQ Cluster Formation guide](https://www.rabbitmq.com/cluster-formation.html) for an overview 47 | of the peer discovery subsystem, general and Kubernetes-specific configurable values and troubleshooting tips. 48 | 49 | Example deployments that use this plugin can be found in an [RabbitMQ on Kubernetes examples repository](https://github.com/rabbitmq/diy-kubernetes-examples). 50 | Note that they are just that, examples, and won't be optimal for every use case or cover a lot of important production 51 | system concerns such as monitoring, persistent volume settings, access control, sizing, and so on. 52 | 53 | 54 | ## Contributing 55 | 56 | See [CONTRIBUTING.md](./CONTRIBUTING.md) and our [development process overview](https://www.rabbitmq.com/github.html). 57 | 58 | 59 | ## License 60 | 61 | [Licensed under the MPL](LICENSE-MPL-RabbitMQ), same as RabbitMQ server. 62 | 63 | 64 | ## Copyright 65 | 66 | (c) 2007-2020 VMware, Inc. or its affiliates. 67 | -------------------------------------------------------------------------------- /examples/README.md: -------------------------------------------------------------------------------- 1 | # Deploy RabbitMQ on Kubernetes with the Kubernetes Peer Discovery Plugin 2 | 3 | These examples have graduated and moved to [a separate repository](https://github.com/rabbitmq/diy-kubernetes-examples). -------------------------------------------------------------------------------- /examples/gke/README.md: -------------------------------------------------------------------------------- 1 | # Deploy RabbitMQ on Kubernetes with the Kubernetes Peer Discovery Plugin to GKE 2 | 3 | This example has graduated and moved to [a separate repository](https://github.com/rabbitmq/diy-kubernetes-examples/tree/master/gke). -------------------------------------------------------------------------------- /examples/kind/README.md: -------------------------------------------------------------------------------- 1 | # Deploy RabbitMQ on Kubernetes with the Kubernetes Peer Discovery Plugin to Kind 2 | 3 | This example has graduated and moved to [a separate repository](https://github.com/rabbitmq/diy-kubernetes-examples/tree/master/kind). 4 | -------------------------------------------------------------------------------- /examples/minikube/README.md: -------------------------------------------------------------------------------- 1 | # Deploy RabbitMQ on Kubernetes with the Kubernetes Peer Discovery Plugin to Minikube 2 | 3 | This example has graduated and moved to [a separate repository](https://github.com/rabbitmq/diy-kubernetes-examples/tree/master/minikube). -------------------------------------------------------------------------------- /include/rabbit_peer_discovery_k8s.hrl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -define(CONFIG_MODULE, rabbit_peer_discovery_config). 9 | -define(UTIL_MODULE, rabbit_peer_discovery_util). 10 | -define(HTTPC_MODULE, rabbit_peer_discovery_httpc). 11 | 12 | -define(BACKEND_CONFIG_KEY, peer_discovery_k8s). 13 | 14 | -define(K8S_EVENT_SOURCE_DESCRIPTION, "rabbitmq_peer_discovery"). 15 | 16 | -define(CONFIG_MAPPING, 17 | #{ 18 | k8s_scheme => #peer_discovery_config_entry_meta{ 19 | type = string, 20 | env_variable = "K8S_SCHEME", 21 | default_value = "https" 22 | }, 23 | k8s_host => #peer_discovery_config_entry_meta{ 24 | type = string, 25 | env_variable = "K8S_HOST", 26 | default_value = "kubernetes.default.svc.cluster.local" 27 | }, 28 | k8s_port => #peer_discovery_config_entry_meta{ 29 | type = integer, 30 | env_variable = "K8S_PORT", 31 | default_value = 443 32 | }, 33 | k8s_token_path => #peer_discovery_config_entry_meta{ 34 | type = string, 35 | env_variable = "K8S_TOKEN_PATH", 36 | default_value = "/var/run/secrets/kubernetes.io/serviceaccount/token" 37 | }, 38 | k8s_cert_path => #peer_discovery_config_entry_meta{ 39 | type = string, 40 | env_variable = "K8S_CERT_PATH", 41 | default_value = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt" 42 | }, 43 | k8s_namespace_path => #peer_discovery_config_entry_meta{ 44 | type = string, 45 | env_variable = "K8S_NAMESPACE_PATH", 46 | default_value = "/var/run/secrets/kubernetes.io/serviceaccount/namespace" 47 | }, 48 | k8s_service_name => #peer_discovery_config_entry_meta{ 49 | type = string, 50 | env_variable = "K8S_SERVICE_NAME", 51 | default_value = "rabbitmq" 52 | }, 53 | k8s_address_type => #peer_discovery_config_entry_meta{ 54 | type = string, 55 | env_variable = "K8S_ADDRESS_TYPE", 56 | default_value = "ip" 57 | }, 58 | k8s_hostname_suffix => #peer_discovery_config_entry_meta{ 59 | type = string, 60 | env_variable = "K8S_HOSTNAME_SUFFIX", 61 | default_value = "" 62 | } 63 | }). 64 | -------------------------------------------------------------------------------- /priv/schema/rabbitmq_peer_discovery_k8s.schema: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | %% Kubernetes host 9 | 10 | {mapping, "cluster_formation.k8s.host", "rabbit.cluster_formation.peer_discovery_k8s.k8s_host", [ 11 | {datatype, string} 12 | ]}. 13 | 14 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_host", 15 | fun(Conf) -> 16 | case cuttlefish:conf_get("cluster_formation.k8s.host", Conf, undefined) of 17 | undefined -> cuttlefish:unset(); 18 | Value -> Value 19 | end 20 | end}. 21 | 22 | %% Kubernetes port 23 | 24 | {mapping, "cluster_formation.k8s.port", "rabbit.cluster_formation.peer_discovery_k8s.k8s_port", [ 25 | {datatype, integer}, 26 | {validators, ["non_negative_integer"]} 27 | ]}. 28 | 29 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_port", 30 | fun(Conf) -> 31 | case cuttlefish:conf_get("cluster_formation.k8s.port", Conf, undefined) of 32 | undefined -> cuttlefish:unset(); 33 | Value -> Value 34 | end 35 | end}. 36 | 37 | %% Kubernetes URI scheme 38 | 39 | {mapping, "cluster_formation.k8s.scheme", "rabbit.cluster_formation.peer_discovery_k8s.k8s_scheme", [ 40 | {datatype, string} 41 | ]}. 42 | 43 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_scheme", 44 | fun(Conf) -> 45 | case cuttlefish:conf_get("cluster_formation.k8s.scheme", Conf, undefined) of 46 | undefined -> cuttlefish:unset(); 47 | Value -> Value 48 | end 49 | end}. 50 | 51 | %% (ACL) Token path 52 | 53 | {mapping, "cluster_formation.k8s.token_path", "rabbit.cluster_formation.peer_discovery_k8s.k8s_token_path", [ 54 | {datatype, string} 55 | ]}. 56 | 57 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_token_path", 58 | fun(Conf) -> 59 | case cuttlefish:conf_get("cluster_formation.k8s.token_path", Conf, undefined) of 60 | undefined -> cuttlefish:unset(); 61 | Value -> Value 62 | end 63 | end}. 64 | 65 | %% Certificate path 66 | 67 | {mapping, "cluster_formation.k8s.cert_path", "rabbit.cluster_formation.peer_discovery_k8s.k8s_cert_path", [ 68 | {datatype, string} 69 | ]}. 70 | 71 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_cert_path", 72 | fun(Conf) -> 73 | case cuttlefish:conf_get("cluster_formation.k8s.cert_path", Conf, undefined) of 74 | undefined -> cuttlefish:unset(); 75 | Value -> Value 76 | end 77 | end}. 78 | 79 | %% Namespace path 80 | 81 | {mapping, "cluster_formation.k8s.namespace_path", "rabbit.cluster_formation.peer_discovery_k8s.k8s_namespace_path", [ 82 | {datatype, string} 83 | ]}. 84 | 85 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_namespace_path", 86 | fun(Conf) -> 87 | case cuttlefish:conf_get("cluster_formation.k8s.namespace_path", Conf, undefined) of 88 | undefined -> cuttlefish:unset(); 89 | Value -> Value 90 | end 91 | end}. 92 | 93 | %% Service name 94 | 95 | {mapping, "cluster_formation.k8s.service_name", "rabbit.cluster_formation.peer_discovery_k8s.k8s_service_name", [ 96 | {datatype, string} 97 | ]}. 98 | 99 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_service_name", 100 | fun(Conf) -> 101 | case cuttlefish:conf_get("cluster_formation.k8s.service_name", Conf, undefined) of 102 | undefined -> cuttlefish:unset(); 103 | Value -> Value 104 | end 105 | end}. 106 | 107 | %% Address type 108 | 109 | {mapping, "cluster_formation.k8s.address_type", "rabbit.cluster_formation.peer_discovery_k8s.k8s_address_type", [ 110 | {datatype, {enum, [hostname, ip]}} 111 | ]}. 112 | 113 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_address_type", 114 | fun(Conf) -> 115 | case cuttlefish:conf_get("cluster_formation.k8s.address_type", Conf, undefined) of 116 | undefined -> cuttlefish:unset(); 117 | Value -> Value 118 | end 119 | end}. 120 | 121 | %% Hostname suffix 122 | 123 | {mapping, "cluster_formation.k8s.hostname_suffix", "rabbit.cluster_formation.peer_discovery_k8s.k8s_hostname_suffix", [ 124 | {datatype, string} 125 | ]}. 126 | 127 | {translation, "rabbit.cluster_formation.peer_discovery_k8s.k8s_hostname_suffix", 128 | fun(Conf) -> 129 | case cuttlefish:conf_get("cluster_formation.k8s.hostname_suffix", Conf, undefined) of 130 | undefined -> cuttlefish:unset(); 131 | Value -> Value 132 | end 133 | end}. 134 | -------------------------------------------------------------------------------- /rabbitmq-components.mk: -------------------------------------------------------------------------------- 1 | ifeq ($(.DEFAULT_GOAL),) 2 | # Define default goal to `all` because this file defines some targets 3 | # before the inclusion of erlang.mk leading to the wrong target becoming 4 | # the default. 5 | .DEFAULT_GOAL = all 6 | endif 7 | 8 | # PROJECT_VERSION defaults to: 9 | # 1. the version exported by rabbitmq-server-release; 10 | # 2. the version stored in `git-revisions.txt`, if it exists; 11 | # 3. a version based on git-describe(1), if it is a Git clone; 12 | # 4. 0.0.0 13 | 14 | PROJECT_VERSION := $(RABBITMQ_VERSION) 15 | 16 | ifeq ($(PROJECT_VERSION),) 17 | PROJECT_VERSION := $(shell \ 18 | if test -f git-revisions.txt; then \ 19 | head -n1 git-revisions.txt | \ 20 | awk '{print $$$(words $(PROJECT_DESCRIPTION) version);}'; \ 21 | else \ 22 | (git describe --dirty --abbrev=7 --tags --always --first-parent \ 23 | 2>/dev/null || echo rabbitmq_v0_0_0) | \ 24 | sed -e 's/^rabbitmq_v//' -e 's/^v//' -e 's/_/./g' -e 's/-/+/' \ 25 | -e 's/-/./g'; \ 26 | fi) 27 | endif 28 | 29 | # -------------------------------------------------------------------- 30 | # RabbitMQ components. 31 | # -------------------------------------------------------------------- 32 | 33 | # For RabbitMQ repositories, we want to checkout branches which match 34 | # the parent project. For instance, if the parent project is on a 35 | # release tag, dependencies must be on the same release tag. If the 36 | # parent project is on a topic branch, dependencies must be on the same 37 | # topic branch or fallback to `stable` or `master` whichever was the 38 | # base of the topic branch. 39 | 40 | dep_amqp_client = git_rmq rabbitmq-erlang-client $(current_rmq_ref) $(base_rmq_ref) master 41 | dep_amqp10_client = git_rmq rabbitmq-amqp1.0-client $(current_rmq_ref) $(base_rmq_ref) master 42 | dep_amqp10_common = git_rmq rabbitmq-amqp1.0-common $(current_rmq_ref) $(base_rmq_ref) master 43 | dep_rabbit = git_rmq rabbitmq-server $(current_rmq_ref) $(base_rmq_ref) master 44 | dep_rabbit_common = git_rmq rabbitmq-common $(current_rmq_ref) $(base_rmq_ref) master 45 | dep_rabbitmq_amqp1_0 = git_rmq rabbitmq-amqp1.0 $(current_rmq_ref) $(base_rmq_ref) master 46 | dep_rabbitmq_auth_backend_amqp = git_rmq rabbitmq-auth-backend-amqp $(current_rmq_ref) $(base_rmq_ref) master 47 | dep_rabbitmq_auth_backend_cache = git_rmq rabbitmq-auth-backend-cache $(current_rmq_ref) $(base_rmq_ref) master 48 | dep_rabbitmq_auth_backend_http = git_rmq rabbitmq-auth-backend-http $(current_rmq_ref) $(base_rmq_ref) master 49 | dep_rabbitmq_auth_backend_ldap = git_rmq rabbitmq-auth-backend-ldap $(current_rmq_ref) $(base_rmq_ref) master 50 | dep_rabbitmq_auth_backend_oauth2 = git_rmq rabbitmq-auth-backend-oauth2 $(current_rmq_ref) $(base_rmq_ref) master 51 | dep_rabbitmq_auth_mechanism_ssl = git_rmq rabbitmq-auth-mechanism-ssl $(current_rmq_ref) $(base_rmq_ref) master 52 | dep_rabbitmq_aws = git_rmq rabbitmq-aws $(current_rmq_ref) $(base_rmq_ref) master 53 | dep_rabbitmq_boot_steps_visualiser = git_rmq rabbitmq-boot-steps-visualiser $(current_rmq_ref) $(base_rmq_ref) master 54 | dep_rabbitmq_cli = git_rmq rabbitmq-cli $(current_rmq_ref) $(base_rmq_ref) master 55 | dep_rabbitmq_codegen = git_rmq rabbitmq-codegen $(current_rmq_ref) $(base_rmq_ref) master 56 | dep_rabbitmq_consistent_hash_exchange = git_rmq rabbitmq-consistent-hash-exchange $(current_rmq_ref) $(base_rmq_ref) master 57 | dep_rabbitmq_ct_client_helpers = git_rmq rabbitmq-ct-client-helpers $(current_rmq_ref) $(base_rmq_ref) master 58 | dep_rabbitmq_ct_helpers = git_rmq rabbitmq-ct-helpers $(current_rmq_ref) $(base_rmq_ref) master 59 | dep_rabbitmq_delayed_message_exchange = git_rmq rabbitmq-delayed-message-exchange $(current_rmq_ref) $(base_rmq_ref) master 60 | dep_rabbitmq_dotnet_client = git_rmq rabbitmq-dotnet-client $(current_rmq_ref) $(base_rmq_ref) master 61 | dep_rabbitmq_event_exchange = git_rmq rabbitmq-event-exchange $(current_rmq_ref) $(base_rmq_ref) master 62 | dep_rabbitmq_federation = git_rmq rabbitmq-federation $(current_rmq_ref) $(base_rmq_ref) master 63 | dep_rabbitmq_federation_management = git_rmq rabbitmq-federation-management $(current_rmq_ref) $(base_rmq_ref) master 64 | dep_rabbitmq_java_client = git_rmq rabbitmq-java-client $(current_rmq_ref) $(base_rmq_ref) master 65 | dep_rabbitmq_jms_client = git_rmq rabbitmq-jms-client $(current_rmq_ref) $(base_rmq_ref) master 66 | dep_rabbitmq_jms_cts = git_rmq rabbitmq-jms-cts $(current_rmq_ref) $(base_rmq_ref) master 67 | dep_rabbitmq_jms_topic_exchange = git_rmq rabbitmq-jms-topic-exchange $(current_rmq_ref) $(base_rmq_ref) master 68 | dep_rabbitmq_lvc_exchange = git_rmq rabbitmq-lvc-exchange $(current_rmq_ref) $(base_rmq_ref) master 69 | dep_rabbitmq_management = git_rmq rabbitmq-management $(current_rmq_ref) $(base_rmq_ref) master 70 | dep_rabbitmq_management_agent = git_rmq rabbitmq-management-agent $(current_rmq_ref) $(base_rmq_ref) master 71 | dep_rabbitmq_management_exchange = git_rmq rabbitmq-management-exchange $(current_rmq_ref) $(base_rmq_ref) master 72 | dep_rabbitmq_management_themes = git_rmq rabbitmq-management-themes $(current_rmq_ref) $(base_rmq_ref) master 73 | dep_rabbitmq_message_timestamp = git_rmq rabbitmq-message-timestamp $(current_rmq_ref) $(base_rmq_ref) master 74 | dep_rabbitmq_metronome = git_rmq rabbitmq-metronome $(current_rmq_ref) $(base_rmq_ref) master 75 | dep_rabbitmq_mqtt = git_rmq rabbitmq-mqtt $(current_rmq_ref) $(base_rmq_ref) master 76 | dep_rabbitmq_objc_client = git_rmq rabbitmq-objc-client $(current_rmq_ref) $(base_rmq_ref) master 77 | dep_rabbitmq_peer_discovery_aws = git_rmq rabbitmq-peer-discovery-aws $(current_rmq_ref) $(base_rmq_ref) master 78 | dep_rabbitmq_peer_discovery_common = git_rmq rabbitmq-peer-discovery-common $(current_rmq_ref) $(base_rmq_ref) master 79 | dep_rabbitmq_peer_discovery_consul = git_rmq rabbitmq-peer-discovery-consul $(current_rmq_ref) $(base_rmq_ref) master 80 | dep_rabbitmq_peer_discovery_etcd = git_rmq rabbitmq-peer-discovery-etcd $(current_rmq_ref) $(base_rmq_ref) master 81 | dep_rabbitmq_peer_discovery_k8s = git_rmq rabbitmq-peer-discovery-k8s $(current_rmq_ref) $(base_rmq_ref) master 82 | dep_rabbitmq_prometheus = git_rmq rabbitmq-prometheus $(current_rmq_ref) $(base_rmq_ref) master 83 | dep_rabbitmq_random_exchange = git_rmq rabbitmq-random-exchange $(current_rmq_ref) $(base_rmq_ref) master 84 | dep_rabbitmq_recent_history_exchange = git_rmq rabbitmq-recent-history-exchange $(current_rmq_ref) $(base_rmq_ref) master 85 | dep_rabbitmq_routing_node_stamp = git_rmq rabbitmq-routing-node-stamp $(current_rmq_ref) $(base_rmq_ref) master 86 | dep_rabbitmq_rtopic_exchange = git_rmq rabbitmq-rtopic-exchange $(current_rmq_ref) $(base_rmq_ref) master 87 | dep_rabbitmq_server_release = git_rmq rabbitmq-server-release $(current_rmq_ref) $(base_rmq_ref) master 88 | dep_rabbitmq_sharding = git_rmq rabbitmq-sharding $(current_rmq_ref) $(base_rmq_ref) master 89 | dep_rabbitmq_shovel = git_rmq rabbitmq-shovel $(current_rmq_ref) $(base_rmq_ref) master 90 | dep_rabbitmq_shovel_management = git_rmq rabbitmq-shovel-management $(current_rmq_ref) $(base_rmq_ref) master 91 | dep_rabbitmq_stomp = git_rmq rabbitmq-stomp $(current_rmq_ref) $(base_rmq_ref) master 92 | dep_rabbitmq_stream = git_rmq rabbitmq-stream $(current_rmq_ref) $(base_rmq_ref) master 93 | dep_rabbitmq_toke = git_rmq rabbitmq-toke $(current_rmq_ref) $(base_rmq_ref) master 94 | dep_rabbitmq_top = git_rmq rabbitmq-top $(current_rmq_ref) $(base_rmq_ref) master 95 | dep_rabbitmq_tracing = git_rmq rabbitmq-tracing $(current_rmq_ref) $(base_rmq_ref) master 96 | dep_rabbitmq_trust_store = git_rmq rabbitmq-trust-store $(current_rmq_ref) $(base_rmq_ref) master 97 | dep_rabbitmq_test = git_rmq rabbitmq-test $(current_rmq_ref) $(base_rmq_ref) master 98 | dep_rabbitmq_web_dispatch = git_rmq rabbitmq-web-dispatch $(current_rmq_ref) $(base_rmq_ref) master 99 | dep_rabbitmq_web_stomp = git_rmq rabbitmq-web-stomp $(current_rmq_ref) $(base_rmq_ref) master 100 | dep_rabbitmq_web_stomp_examples = git_rmq rabbitmq-web-stomp-examples $(current_rmq_ref) $(base_rmq_ref) master 101 | dep_rabbitmq_web_mqtt = git_rmq rabbitmq-web-mqtt $(current_rmq_ref) $(base_rmq_ref) master 102 | dep_rabbitmq_web_mqtt_examples = git_rmq rabbitmq-web-mqtt-examples $(current_rmq_ref) $(base_rmq_ref) master 103 | dep_rabbitmq_website = git_rmq rabbitmq-website $(current_rmq_ref) $(base_rmq_ref) live master 104 | dep_toke = git_rmq toke $(current_rmq_ref) $(base_rmq_ref) master 105 | 106 | dep_rabbitmq_public_umbrella = git_rmq rabbitmq-public-umbrella $(current_rmq_ref) $(base_rmq_ref) master 107 | 108 | # Third-party dependencies version pinning. 109 | # 110 | # We do that in this file, which is copied in all projects, to ensure 111 | # all projects use the same versions. It avoids conflicts and makes it 112 | # possible to work with rabbitmq-public-umbrella. 113 | 114 | dep_accept = hex 0.3.5 115 | dep_cowboy = hex 2.8.0 116 | dep_cowlib = hex 2.9.1 117 | dep_jsx = hex 2.11.0 118 | dep_lager = hex 3.8.0 119 | dep_prometheus = git https://github.com/deadtrickster/prometheus.erl.git master 120 | dep_ra = git https://github.com/rabbitmq/ra.git master 121 | dep_ranch = hex 1.7.1 122 | dep_recon = hex 2.5.1 123 | dep_observer_cli = hex 1.5.4 124 | dep_stdout_formatter = hex 0.2.4 125 | dep_sysmon_handler = hex 1.3.0 126 | 127 | RABBITMQ_COMPONENTS = amqp_client \ 128 | amqp10_common \ 129 | amqp10_client \ 130 | rabbit \ 131 | rabbit_common \ 132 | rabbitmq_amqp1_0 \ 133 | rabbitmq_auth_backend_amqp \ 134 | rabbitmq_auth_backend_cache \ 135 | rabbitmq_auth_backend_http \ 136 | rabbitmq_auth_backend_ldap \ 137 | rabbitmq_auth_backend_oauth2 \ 138 | rabbitmq_auth_mechanism_ssl \ 139 | rabbitmq_aws \ 140 | rabbitmq_boot_steps_visualiser \ 141 | rabbitmq_cli \ 142 | rabbitmq_codegen \ 143 | rabbitmq_consistent_hash_exchange \ 144 | rabbitmq_ct_client_helpers \ 145 | rabbitmq_ct_helpers \ 146 | rabbitmq_delayed_message_exchange \ 147 | rabbitmq_dotnet_client \ 148 | rabbitmq_event_exchange \ 149 | rabbitmq_federation \ 150 | rabbitmq_federation_management \ 151 | rabbitmq_java_client \ 152 | rabbitmq_jms_client \ 153 | rabbitmq_jms_cts \ 154 | rabbitmq_jms_topic_exchange \ 155 | rabbitmq_lvc_exchange \ 156 | rabbitmq_management \ 157 | rabbitmq_management_agent \ 158 | rabbitmq_management_exchange \ 159 | rabbitmq_management_themes \ 160 | rabbitmq_message_timestamp \ 161 | rabbitmq_metronome \ 162 | rabbitmq_mqtt \ 163 | rabbitmq_objc_client \ 164 | rabbitmq_peer_discovery_aws \ 165 | rabbitmq_peer_discovery_common \ 166 | rabbitmq_peer_discovery_consul \ 167 | rabbitmq_peer_discovery_etcd \ 168 | rabbitmq_peer_discovery_k8s \ 169 | rabbitmq_prometheus \ 170 | rabbitmq_random_exchange \ 171 | rabbitmq_recent_history_exchange \ 172 | rabbitmq_routing_node_stamp \ 173 | rabbitmq_rtopic_exchange \ 174 | rabbitmq_server_release \ 175 | rabbitmq_sharding \ 176 | rabbitmq_shovel \ 177 | rabbitmq_shovel_management \ 178 | rabbitmq_stomp \ 179 | rabbitmq_stream \ 180 | rabbitmq_toke \ 181 | rabbitmq_top \ 182 | rabbitmq_tracing \ 183 | rabbitmq_trust_store \ 184 | rabbitmq_web_dispatch \ 185 | rabbitmq_web_mqtt \ 186 | rabbitmq_web_mqtt_examples \ 187 | rabbitmq_web_stomp \ 188 | rabbitmq_web_stomp_examples \ 189 | rabbitmq_website 190 | 191 | # Erlang.mk does not rebuild dependencies by default, once they were 192 | # compiled once, except for those listed in the `$(FORCE_REBUILD)` 193 | # variable. 194 | # 195 | # We want all RabbitMQ components to always be rebuilt: this eases 196 | # the work on several components at the same time. 197 | 198 | FORCE_REBUILD = $(RABBITMQ_COMPONENTS) 199 | 200 | # Several components have a custom erlang.mk/build.config, mainly 201 | # to disable eunit. Therefore, we can't use the top-level project's 202 | # erlang.mk copy. 203 | NO_AUTOPATCH += $(RABBITMQ_COMPONENTS) 204 | 205 | ifeq ($(origin current_rmq_ref),undefined) 206 | ifneq ($(wildcard .git),) 207 | current_rmq_ref := $(shell (\ 208 | ref=$$(LANG=C git branch --list | awk '/^\* \(.*detached / {ref=$$0; sub(/.*detached [^ ]+ /, "", ref); sub(/\)$$/, "", ref); print ref; exit;} /^\* / {ref=$$0; sub(/^\* /, "", ref); print ref; exit}');\ 209 | if test "$$(git rev-parse --short HEAD)" != "$$ref"; then echo "$$ref"; fi)) 210 | else 211 | current_rmq_ref := master 212 | endif 213 | endif 214 | export current_rmq_ref 215 | 216 | ifeq ($(origin base_rmq_ref),undefined) 217 | ifneq ($(wildcard .git),) 218 | possible_base_rmq_ref := master 219 | ifeq ($(possible_base_rmq_ref),$(current_rmq_ref)) 220 | base_rmq_ref := $(current_rmq_ref) 221 | else 222 | base_rmq_ref := $(shell \ 223 | (git rev-parse --verify -q master >/dev/null && \ 224 | git rev-parse --verify -q $(possible_base_rmq_ref) >/dev/null && \ 225 | git merge-base --is-ancestor $$(git merge-base master HEAD) $(possible_base_rmq_ref) && \ 226 | echo $(possible_base_rmq_ref)) || \ 227 | echo master) 228 | endif 229 | else 230 | base_rmq_ref := master 231 | endif 232 | endif 233 | export base_rmq_ref 234 | 235 | # Repository URL selection. 236 | # 237 | # First, we infer other components' location from the current project 238 | # repository URL, if it's a Git repository: 239 | # - We take the "origin" remote URL as the base 240 | # - The current project name and repository name is replaced by the 241 | # target's properties: 242 | # eg. rabbitmq-common is replaced by rabbitmq-codegen 243 | # eg. rabbit_common is replaced by rabbitmq_codegen 244 | # 245 | # If cloning from this computed location fails, we fallback to RabbitMQ 246 | # upstream which is GitHub. 247 | 248 | # Macro to transform eg. "rabbit_common" to "rabbitmq-common". 249 | rmq_cmp_repo_name = $(word 2,$(dep_$(1))) 250 | 251 | # Upstream URL for the current project. 252 | RABBITMQ_COMPONENT_REPO_NAME := $(call rmq_cmp_repo_name,$(PROJECT)) 253 | RABBITMQ_UPSTREAM_FETCH_URL ?= https://github.com/rabbitmq/$(RABBITMQ_COMPONENT_REPO_NAME).git 254 | RABBITMQ_UPSTREAM_PUSH_URL ?= git@github.com:rabbitmq/$(RABBITMQ_COMPONENT_REPO_NAME).git 255 | 256 | # Current URL for the current project. If this is not a Git clone, 257 | # default to the upstream Git repository. 258 | ifneq ($(wildcard .git),) 259 | git_origin_fetch_url := $(shell git config remote.origin.url) 260 | git_origin_push_url := $(shell git config remote.origin.pushurl || git config remote.origin.url) 261 | RABBITMQ_CURRENT_FETCH_URL ?= $(git_origin_fetch_url) 262 | RABBITMQ_CURRENT_PUSH_URL ?= $(git_origin_push_url) 263 | else 264 | RABBITMQ_CURRENT_FETCH_URL ?= $(RABBITMQ_UPSTREAM_FETCH_URL) 265 | RABBITMQ_CURRENT_PUSH_URL ?= $(RABBITMQ_UPSTREAM_PUSH_URL) 266 | endif 267 | 268 | # Macro to replace the following pattern: 269 | # 1. /foo.git -> /bar.git 270 | # 2. /foo -> /bar 271 | # 3. /foo/ -> /bar/ 272 | subst_repo_name = $(patsubst %/$(1)/%,%/$(2)/%,$(patsubst %/$(1),%/$(2),$(patsubst %/$(1).git,%/$(2).git,$(3)))) 273 | 274 | # Macro to replace both the project's name (eg. "rabbit_common") and 275 | # repository name (eg. "rabbitmq-common") by the target's equivalent. 276 | # 277 | # This macro is kept on one line because we don't want whitespaces in 278 | # the returned value, as it's used in $(dep_fetch_git_rmq) in a shell 279 | # single-quoted string. 280 | dep_rmq_repo = $(if $(dep_$(2)),$(call subst_repo_name,$(PROJECT),$(2),$(call subst_repo_name,$(RABBITMQ_COMPONENT_REPO_NAME),$(call rmq_cmp_repo_name,$(2)),$(1))),$(pkg_$(1)_repo)) 281 | 282 | dep_rmq_commits = $(if $(dep_$(1)), \ 283 | $(wordlist 3,$(words $(dep_$(1))),$(dep_$(1))), \ 284 | $(pkg_$(1)_commit)) 285 | 286 | define dep_fetch_git_rmq 287 | fetch_url1='$(call dep_rmq_repo,$(RABBITMQ_CURRENT_FETCH_URL),$(1))'; \ 288 | fetch_url2='$(call dep_rmq_repo,$(RABBITMQ_UPSTREAM_FETCH_URL),$(1))'; \ 289 | if test "$$$$fetch_url1" != '$(RABBITMQ_CURRENT_FETCH_URL)' && \ 290 | git clone -q -n -- "$$$$fetch_url1" $(DEPS_DIR)/$(call dep_name,$(1)); then \ 291 | fetch_url="$$$$fetch_url1"; \ 292 | push_url='$(call dep_rmq_repo,$(RABBITMQ_CURRENT_PUSH_URL),$(1))'; \ 293 | elif git clone -q -n -- "$$$$fetch_url2" $(DEPS_DIR)/$(call dep_name,$(1)); then \ 294 | fetch_url="$$$$fetch_url2"; \ 295 | push_url='$(call dep_rmq_repo,$(RABBITMQ_UPSTREAM_PUSH_URL),$(1))'; \ 296 | fi; \ 297 | cd $(DEPS_DIR)/$(call dep_name,$(1)) && ( \ 298 | $(foreach ref,$(call dep_rmq_commits,$(1)), \ 299 | git checkout -q $(ref) >/dev/null 2>&1 || \ 300 | ) \ 301 | (echo "error: no valid pathspec among: $(call dep_rmq_commits,$(1))" \ 302 | 1>&2 && false) ) && \ 303 | (test "$$$$fetch_url" = "$$$$push_url" || \ 304 | git remote set-url --push origin "$$$$push_url") 305 | endef 306 | 307 | # -------------------------------------------------------------------- 308 | # Component distribution. 309 | # -------------------------------------------------------------------- 310 | 311 | list-dist-deps:: 312 | @: 313 | 314 | prepare-dist:: 315 | @: 316 | 317 | # -------------------------------------------------------------------- 318 | # Umbrella-specific settings. 319 | # -------------------------------------------------------------------- 320 | 321 | # If the top-level project is a RabbitMQ component, we override 322 | # $(DEPS_DIR) for this project to point to the top-level's one. 323 | # 324 | # We also verify that the guessed DEPS_DIR is actually named `deps`, 325 | # to rule out any situation where it is a coincidence that we found a 326 | # `rabbitmq-components.mk` up upper directories. 327 | 328 | possible_deps_dir_1 = $(abspath ..) 329 | possible_deps_dir_2 = $(abspath ../../..) 330 | 331 | ifeq ($(notdir $(possible_deps_dir_1)),deps) 332 | ifneq ($(wildcard $(possible_deps_dir_1)/../rabbitmq-components.mk),) 333 | deps_dir_overriden = 1 334 | DEPS_DIR ?= $(possible_deps_dir_1) 335 | DISABLE_DISTCLEAN = 1 336 | endif 337 | endif 338 | 339 | ifeq ($(deps_dir_overriden),) 340 | ifeq ($(notdir $(possible_deps_dir_2)),deps) 341 | ifneq ($(wildcard $(possible_deps_dir_2)/../rabbitmq-components.mk),) 342 | deps_dir_overriden = 1 343 | DEPS_DIR ?= $(possible_deps_dir_2) 344 | DISABLE_DISTCLEAN = 1 345 | endif 346 | endif 347 | endif 348 | 349 | ifneq ($(wildcard UMBRELLA.md),) 350 | DISABLE_DISTCLEAN = 1 351 | endif 352 | 353 | # We disable `make distclean` so $(DEPS_DIR) is not accidentally removed. 354 | 355 | ifeq ($(DISABLE_DISTCLEAN),1) 356 | ifneq ($(filter distclean distclean-deps,$(MAKECMDGOALS)),) 357 | SKIP_DEPS = 1 358 | endif 359 | endif 360 | -------------------------------------------------------------------------------- /src/rabbit_peer_discovery_k8s.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% The Initial Developer of the Original Code is AWeber Communications. 6 | %% Copyright (c) 2015-2016 AWeber Communications 7 | %% Copyright (c) 2016-2020 VMware, Inc. or its affiliates. All rights reserved. 8 | %% 9 | 10 | -module(rabbit_peer_discovery_k8s). 11 | -behaviour(rabbit_peer_discovery_backend). 12 | 13 | -include_lib("rabbit_common/include/rabbit.hrl"). 14 | -include_lib("rabbitmq_peer_discovery_common/include/rabbit_peer_discovery.hrl"). 15 | -include("rabbit_peer_discovery_k8s.hrl"). 16 | 17 | -export([init/0, list_nodes/0, supports_registration/0, register/0, unregister/0, 18 | post_registration/0, lock/1, unlock/1, randomized_startup_delay_range/0, 19 | send_event/3, generate_v1_event/7]). 20 | 21 | -ifdef(TEST). 22 | -compile(export_all). 23 | -endif. 24 | 25 | %% 26 | %% API 27 | %% 28 | 29 | init() -> 30 | rabbit_log:debug("Peer discovery Kubernetes: initialising..."), 31 | ok = application:ensure_started(inets), 32 | %% we cannot start this plugin yet since it depends on the rabbit app, 33 | %% which is in the process of being started by the time this function is called 34 | application:load(rabbitmq_peer_discovery_common), 35 | rabbit_peer_discovery_httpc:maybe_configure_proxy(), 36 | rabbit_peer_discovery_httpc:maybe_configure_inet6(). 37 | 38 | -spec list_nodes() -> {ok, {Nodes :: list(), NodeType :: rabbit_types:node_type()}} | {error, Reason :: string()}. 39 | 40 | list_nodes() -> 41 | case make_request() of 42 | {ok, Response} -> 43 | Addresses = extract_node_list(Response), 44 | {ok, {lists:map(fun node_name/1, Addresses), disc}}; 45 | {error, Reason} -> 46 | Details = io_lib:format("Failed to fetch a list of nodes from Kubernetes API: ~s", [Reason]), 47 | rabbit_log:error(Details), 48 | send_event("Warning", "Failed", Details), 49 | {error, Reason} 50 | end. 51 | 52 | -spec supports_registration() -> boolean(). 53 | 54 | supports_registration() -> 55 | %% see rabbitmq-peer-discovery-aws#17, 56 | %% rabbitmq-peer-discovery-k8s#23 57 | true. 58 | 59 | 60 | -spec register() -> ok. 61 | register() -> 62 | ok. 63 | 64 | -spec unregister() -> ok. 65 | unregister() -> 66 | ok. 67 | 68 | -spec post_registration() -> ok | {error, Reason :: string()}. 69 | post_registration() -> 70 | Details = io_lib:format("Node ~s is registered", [node()]), 71 | send_event("Normal", "Created", Details). 72 | 73 | -spec lock(Node :: atom()) -> not_supported. 74 | 75 | lock(_Node) -> 76 | not_supported. 77 | 78 | -spec unlock(Data :: term()) -> ok. 79 | 80 | unlock(_Data) -> 81 | ok. 82 | 83 | -spec randomized_startup_delay_range() -> {integer(), integer()}. 84 | 85 | randomized_startup_delay_range() -> 86 | %% Pods in a stateful set are initialized one by one, 87 | %% so RSD is not really necessary for this plugin. 88 | %% See https://www.rabbitmq.com/cluster-formation.html#peer-discovery-k8s for details. 89 | {0, 2}. 90 | 91 | %% 92 | %% Implementation 93 | %% 94 | 95 | -spec get_config_key(Key :: atom(), Map :: #{atom() => peer_discovery_config_value()}) 96 | -> peer_discovery_config_value(). 97 | 98 | get_config_key(Key, Map) -> 99 | ?CONFIG_MODULE:get(Key, ?CONFIG_MAPPING, Map). 100 | 101 | %% @doc Perform a HTTP GET request to K8s 102 | %% @end 103 | %% 104 | -spec make_request() -> {ok, map() | list() | term()} | {error, term()}. 105 | 106 | make_request() -> 107 | M = ?CONFIG_MODULE:config_map(?BACKEND_CONFIG_KEY), 108 | {ok, Token} = file:read_file(get_config_key(k8s_token_path, M)), 109 | Token1 = binary:replace(Token, <<"\n">>, <<>>), 110 | ?HTTPC_MODULE:get( 111 | get_config_key(k8s_scheme, M), 112 | get_config_key(k8s_host, M), 113 | get_config_key(k8s_port, M), 114 | base_path(endpoints,get_config_key(k8s_service_name, M)), 115 | [], 116 | [{"Authorization", "Bearer " ++ binary_to_list(Token1)}], 117 | [{ssl, [{cacertfile, get_config_key(k8s_cert_path, M)}]}]). 118 | 119 | %% @spec node_name(k8s_endpoint) -> list() 120 | %% @doc Return a full rabbit node name, appending hostname suffix 121 | %% @end 122 | %% 123 | node_name(Address) -> 124 | M = ?CONFIG_MODULE:config_map(?BACKEND_CONFIG_KEY), 125 | ?UTIL_MODULE:node_name( 126 | ?UTIL_MODULE:as_string(Address) ++ get_config_key(k8s_hostname_suffix, M)). 127 | 128 | 129 | %% @spec maybe_ready_address(k8s_subsets()) -> list() 130 | %% @doc Return a list of ready nodes 131 | %% SubSet can contain also "notReadyAddresses" 132 | %% @end 133 | %% 134 | -spec maybe_ready_address([map()]) -> list(). 135 | 136 | maybe_ready_address(Subset) -> 137 | case maps:get(<<"notReadyAddresses">>, Subset, undefined) of 138 | undefined -> ok; 139 | NotReadyAddresses -> 140 | Formatted = string:join([binary_to_list(get_address(X)) || X <- NotReadyAddresses], ", "), 141 | rabbit_log:info("k8s endpoint listing returned nodes not yet ready: ~s", [Formatted]) 142 | end, 143 | maps:get(<<"addresses">>, Subset, []). 144 | 145 | %% @doc Return a list of nodes 146 | %% see https://kubernetes.io/docs/api-reference/v1/definitions/#_v1_endpoints 147 | %% @end 148 | %% 149 | -spec extract_node_list(map()) -> list(). 150 | 151 | extract_node_list(Response) -> 152 | IpLists = [[get_address(Address) 153 | || Address <- maybe_ready_address(Subset)] || Subset <- maps:get(<<"subsets">>, Response, [])], 154 | sets:to_list(sets:union(lists:map(fun sets:from_list/1, IpLists))). 155 | 156 | 157 | %% @doc Return a list of path segments that are the base path for k8s key actions 158 | %% @end 159 | %% 160 | -spec base_path(events | endpoints, term()) -> string(). 161 | base_path(Type, Args) -> 162 | M = ?CONFIG_MODULE:config_map(?BACKEND_CONFIG_KEY), 163 | {ok, Namespace} = file:read_file(get_config_key(k8s_namespace_path, M)), 164 | NameSpace1 = binary:replace(Namespace, <<"\n">>, <<>>), 165 | rabbit_peer_discovery_httpc:build_path([api, v1, namespaces, NameSpace1, Type, Args]). 166 | 167 | %% get_config_key(k8s_service_name, M) 168 | 169 | get_address(Address) -> 170 | M = ?CONFIG_MODULE:config_map(?BACKEND_CONFIG_KEY), 171 | maps:get(list_to_binary(get_config_key(k8s_address_type, M)), Address). 172 | 173 | 174 | generate_v1_event(Namespace, Type, Reason, Message) -> 175 | {ok, HostName} = inet:gethostname(), 176 | Name = 177 | io_lib:format(HostName ++ ".~B",[os:system_time(millisecond)]), 178 | TimeInSeconds = calendar:system_time_to_rfc3339(erlang:system_time(second)), 179 | generate_v1_event(Namespace, Name, Type, Reason, Message, TimeInSeconds, HostName). 180 | 181 | 182 | generate_v1_event(Namespace, Name, Type, Reason, Message, Timestamp, HostName) -> 183 | #{ 184 | metadata => #{ 185 | namespace => rabbit_data_coercion:to_binary(Namespace), 186 | name => rabbit_data_coercion:to_binary(Name) 187 | }, 188 | type => rabbit_data_coercion:to_binary(Type), 189 | reason => rabbit_data_coercion:to_binary(Reason), 190 | message => rabbit_data_coercion:to_binary(Message), 191 | count => 1, 192 | lastTimestamp => rabbit_data_coercion:to_binary(Timestamp), 193 | involvedObject => #{ 194 | apiVersion => <<"v1">>, 195 | kind => <<"RabbitMQ">>, 196 | name => rabbit_data_coercion:to_binary("pod/" ++ HostName), 197 | namespace => rabbit_data_coercion:to_binary(Namespace) 198 | }, 199 | source => #{ 200 | component => rabbit_data_coercion:to_binary(HostName ++ "/" ++ 201 | ?K8S_EVENT_SOURCE_DESCRIPTION), 202 | host => rabbit_data_coercion:to_binary(HostName) 203 | } 204 | }. 205 | 206 | 207 | %% @doc Perform a HTTP POST request to K8s to send and k8s v1.Event 208 | %% @end 209 | %% 210 | -spec send_event(term(),term(), term()) -> {ok, term()} | {error, term()}. 211 | send_event(Type, Reason, Message) -> 212 | M = ?CONFIG_MODULE:config_map(?BACKEND_CONFIG_KEY), 213 | {ok, Token} = file:read_file(get_config_key(k8s_token_path, M)), 214 | Token1 = binary:replace(Token, <<"\n">>, <<>>), 215 | {ok, NameSpace} = file:read_file( 216 | get_config_key(k8s_namespace_path, M)), 217 | NameSpace1 = binary:replace(NameSpace, <<"\n">>, <<>>), 218 | 219 | V1Event = generate_v1_event(NameSpace1, Type, Reason, Message), 220 | 221 | Body = rabbit_data_coercion:to_list(rabbit_json:encode(V1Event)), 222 | ?HTTPC_MODULE:post( 223 | get_config_key(k8s_scheme, M), 224 | get_config_key(k8s_host, M), 225 | get_config_key(k8s_port, M), 226 | base_path(events,""), 227 | [], 228 | [{"Authorization", "Bearer " ++ rabbit_data_coercion:to_list(Token1)}], 229 | [{ssl, [{cacertfile, get_config_key(k8s_cert_path, M)}]}], 230 | Body 231 | ). -------------------------------------------------------------------------------- /src/rabbitmq_peer_discovery_k8s.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | %% This module exists as an alias for rabbit_peer_discovery_aws. 9 | %% Some users assume that the discovery module is the same as plugin 10 | %% name. This module tries to fill the naming gap between module and plugin names. 11 | -module(rabbitmq_peer_discovery_k8s). 12 | -behaviour(rabbit_peer_discovery_backend). 13 | 14 | -export([init/0, list_nodes/0, supports_registration/0, register/0, unregister/0, 15 | post_registration/0, lock/1, unlock/1, randomized_startup_delay_range/0, 16 | send_event/3, generate_v1_event/7]). 17 | 18 | -define(DELEGATE, rabbit_peer_discovery_k8s). 19 | 20 | %% 21 | %% API 22 | %% 23 | 24 | init() -> 25 | ?DELEGATE:init(). 26 | 27 | -spec list_nodes() -> {ok, {Nodes :: list(), NodeType :: rabbit_types:node_type()}} | 28 | {error, Reason :: string()}. 29 | list_nodes() -> 30 | ?DELEGATE:list_nodes(). 31 | 32 | -spec supports_registration() -> boolean(). 33 | supports_registration() -> 34 | ?DELEGATE:supports_registration(). 35 | 36 | -spec register() -> ok. 37 | register() -> 38 | ?DELEGATE:register(). 39 | 40 | -spec unregister() -> ok. 41 | unregister() -> 42 | ?DELEGATE:unregister(). 43 | 44 | -spec post_registration() -> ok | {error, Reason :: string()}. 45 | post_registration() -> 46 | ?DELEGATE:post_registration(). 47 | 48 | -spec lock(Node :: atom()) -> not_supported. 49 | lock(Node) -> 50 | ?DELEGATE:lock(Node). 51 | 52 | -spec unlock(Data :: term()) -> ok. 53 | unlock(Data) -> 54 | ?DELEGATE:unlock(Data). 55 | 56 | -spec randomized_startup_delay_range() -> {integer(), integer()}. 57 | randomized_startup_delay_range() -> 58 | ?DELEGATE:randomized_startup_delay_range(). 59 | 60 | generate_v1_event(Namespace, Name, Type, Message, Reason, Timestamp, HostName) -> 61 | ?DELEGATE:generate_v1_event(Namespace, Name, Type, Message, Reason, Timestamp, HostName). 62 | 63 | %% @doc Perform a HTTP POST request to K8s to send and k8s v1.Event 64 | %% @end 65 | %% 66 | -spec send_event(term(),term(), term()) -> {ok, term()} | {error, term()}. 67 | send_event(Type, Reason, Message) -> 68 | ?DELEGATE:send_event(Type, Reason, Message). 69 | -------------------------------------------------------------------------------- /src/rabbitmq_peer_discovery_k8s_app.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbitmq_peer_discovery_k8s_app). 9 | 10 | %% 11 | %% API 12 | %% 13 | 14 | -behaviour(application). 15 | -export([start/2, stop/1]). 16 | 17 | start(_Type, _StartArgs) -> 18 | rabbitmq_peer_discovery_k8s_sup:start_link(). 19 | 20 | stop(_State) -> 21 | ok. 22 | -------------------------------------------------------------------------------- /src/rabbitmq_peer_discovery_k8s_node_monitor.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | %% This gen_server receives node monitoring events from net_kernel 9 | %% and forwards them to the Kubernetes API. 10 | 11 | -module(rabbitmq_peer_discovery_k8s_node_monitor). 12 | 13 | -behaviour(gen_server). 14 | 15 | -export([start_link/0]). 16 | -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, 17 | code_change/3]). 18 | 19 | %% 20 | %% API 21 | %% 22 | 23 | start_link() -> 24 | gen_server:start_link({local, ?MODULE}, ?MODULE, [], []). 25 | 26 | init([]) -> 27 | _ = net_kernel:monitor_nodes(true, []), 28 | {ok, #{}}. 29 | 30 | handle_call(_Msg, _From, State) -> 31 | {reply, not_understood, State}. 32 | 33 | handle_cast(_Msg, State) -> 34 | {noreply, State}. 35 | 36 | handle_info({nodeup, Node}, State) -> 37 | Details = io_lib:format("Node ~s is up ", [Node]), 38 | rabbit_peer_discovery_k8s:send_event("Normal", "NodeUp", Details), 39 | {noreply, State}; 40 | handle_info({nodedown, Node}, State) -> 41 | Details = io_lib:format("Node ~s is down or disconnected ", [Node]), 42 | rabbit_peer_discovery_k8s:send_event("Warning", "NodeDown", Details), 43 | {noreply, State}. 44 | 45 | terminate(_Arg, _State) -> 46 | ok. 47 | 48 | code_change(_OldVsn, State, _Extra) -> 49 | {ok, State}. 50 | -------------------------------------------------------------------------------- /src/rabbitmq_peer_discovery_k8s_sup.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbitmq_peer_discovery_k8s_sup). 9 | 10 | -behaviour(supervisor). 11 | 12 | -export([init/1, start_link/0]). 13 | 14 | -include_lib("rabbit_common/include/rabbit.hrl"). 15 | -include("rabbit_peer_discovery_k8s.hrl"). 16 | 17 | %% 18 | %% API 19 | %% 20 | 21 | init([]) -> 22 | Flags = #{strategy => one_for_one, intensity => 1, period => 1}, 23 | Fun0 = fun() -> {ok, {Flags, []}} end, 24 | Fun1 = fun() -> {ok, {Flags, []}} end, 25 | Fun2 = fun(_) -> 26 | Specs = [#{id => rabbitmq_peer_discovery_k8s_node_monitor, 27 | start => {rabbitmq_peer_discovery_k8s_node_monitor, start_link, []}, 28 | restart => permanent, 29 | shutdown => ?SUPERVISOR_WAIT, 30 | type => worker, 31 | modules => [rabbitmq_peer_discovery_k8s] 32 | }], 33 | {ok, {Flags, Specs}} 34 | end, 35 | rabbit_peer_discovery_util:maybe_backend_configured(?BACKEND_CONFIG_KEY, Fun0, Fun1, Fun2). 36 | 37 | start_link() -> 38 | supervisor:start_link({local, ?MODULE}, ?MODULE, []). 39 | -------------------------------------------------------------------------------- /test/config_schema_SUITE.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(config_schema_SUITE). 9 | 10 | -compile(export_all). 11 | 12 | all() -> 13 | [ 14 | run_snippets 15 | ]. 16 | 17 | %% ------------------------------------------------------------------- 18 | %% Testsuite setup/teardown. 19 | %% ------------------------------------------------------------------- 20 | 21 | init_per_suite(Config) -> 22 | rabbit_ct_helpers:log_environment(), 23 | Config1 = rabbit_ct_helpers:run_setup_steps(Config), 24 | rabbit_ct_config_schema:init_schemas(rabbitmq_peer_discovery_k8s, Config1). 25 | 26 | 27 | end_per_suite(Config) -> 28 | rabbit_ct_helpers:run_teardown_steps(Config). 29 | 30 | init_per_testcase(Testcase, Config) -> 31 | rabbit_ct_helpers:testcase_started(Config, Testcase), 32 | Config1 = rabbit_ct_helpers:set_config(Config, [ 33 | {rmq_nodename_suffix, Testcase} 34 | ]), 35 | rabbit_ct_helpers:run_steps(Config1, 36 | rabbit_ct_broker_helpers:setup_steps() ++ 37 | rabbit_ct_client_helpers:setup_steps()). 38 | 39 | end_per_testcase(Testcase, Config) -> 40 | Config1 = rabbit_ct_helpers:run_steps(Config, 41 | rabbit_ct_client_helpers:teardown_steps() ++ 42 | rabbit_ct_broker_helpers:teardown_steps()), 43 | rabbit_ct_helpers:testcase_finished(Config1, Testcase). 44 | 45 | %% ------------------------------------------------------------------- 46 | %% Testcases. 47 | %% ------------------------------------------------------------------- 48 | 49 | run_snippets(Config) -> 50 | ok = rabbit_ct_broker_helpers:rpc(Config, 0, 51 | ?MODULE, run_snippets1, [Config]). 52 | 53 | run_snippets1(Config) -> 54 | rabbit_ct_config_schema:run_snippets(Config). 55 | 56 | -------------------------------------------------------------------------------- /test/config_schema_SUITE_data/rabbitmq_peer_discovery_k8s.snippets: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | [ 9 | {k8s_discovery_mechanism_as_module, 10 | "cluster_formation.peer_discovery_backend = rabbit_peer_discovery_k8s 11 | cluster_formation.k8s.host = k8s.eng.megacorp.local", [ 12 | {rabbit, [ 13 | {cluster_formation, [ 14 | {peer_discovery_backend, rabbit_peer_discovery_k8s}, 15 | {peer_discovery_k8s, [ 16 | {k8s_host, "k8s.eng.megacorp.local"} 17 | ]} 18 | ]} 19 | ]} 20 | ], [rabbitmq_peer_discovery_k8s] 21 | }, 22 | 23 | {k8s_discovery_mechanism_as_alias1, 24 | "cluster_formation.peer_discovery_backend = k8s 25 | cluster_formation.k8s.host = k8s.eng.megacorp.local", [ 26 | {rabbit, [ 27 | {cluster_formation, [ 28 | {peer_discovery_backend, rabbit_peer_discovery_k8s}, 29 | {peer_discovery_k8s, [ 30 | {k8s_host, "k8s.eng.megacorp.local"} 31 | ]} 32 | ]} 33 | ]} 34 | ], [rabbitmq_peer_discovery_k8s] 35 | }, 36 | 37 | {k8s_discovery_mechanism_as_alias2, 38 | "cluster_formation.peer_discovery_backend = kubernetes 39 | cluster_formation.k8s.host = k8s.eng.megacorp.local", [ 40 | {rabbit, [ 41 | {cluster_formation, [ 42 | {peer_discovery_backend, rabbit_peer_discovery_k8s}, 43 | {peer_discovery_k8s, [ 44 | {k8s_host, "k8s.eng.megacorp.local"} 45 | ]} 46 | ]} 47 | ]} 48 | ], [rabbitmq_peer_discovery_k8s] 49 | }, 50 | 51 | {k8s_host, "cluster_formation.k8s.host = k8s.eng.megacorp.local", [ 52 | {rabbit, [ 53 | {cluster_formation, [ 54 | {peer_discovery_k8s, [ 55 | {k8s_host, "k8s.eng.megacorp.local"} 56 | ]} 57 | ]} 58 | ]} 59 | ], [rabbitmq_peer_discovery_k8s] 60 | } 61 | 62 | , {k8s_port, 63 | "cluster_formation.k8s.port = 9700", 64 | [{rabbit, [{cluster_formation, [ 65 | {peer_discovery_k8s, [ 66 | {k8s_port, 9700} 67 | ]} 68 | ]}]}], 69 | [rabbitmq_peer_discovery_k8s]} 70 | 71 | , {k8s_host_and_port, 72 | "cluster_formation.k8s.host = k8s.eng.megacorp.local 73 | cluster_formation.k8s.port = 443", 74 | [{rabbit, [{cluster_formation, [ 75 | {peer_discovery_k8s, [ 76 | {k8s_host, "k8s.eng.megacorp.local"}, 77 | {k8s_port, 443} 78 | ]} 79 | ]}]}], 80 | [rabbitmq_peer_discovery_k8s]} 81 | 82 | 83 | , {k8s_scheme, 84 | "cluster_formation.k8s.scheme = https", 85 | [{rabbit, [{cluster_formation, [ 86 | {peer_discovery_k8s, [ 87 | {k8s_scheme, "https"} 88 | ]} 89 | ]}]}], 90 | [rabbitmq_peer_discovery_k8s]} 91 | 92 | 93 | , {k8s_service_name, "cluster_formation.k8s.service_name = kubernetes-service", [ 94 | {rabbit, [ 95 | {cluster_formation, [ 96 | {peer_discovery_k8s, [ 97 | {k8s_service_name, "kubernetes-service"} 98 | ]} 99 | ]} 100 | ]} 101 | ], [rabbitmq_peer_discovery_k8s] 102 | } 103 | 104 | , {k8s_token_path, "cluster_formation.k8s.token_path = /a/b/c", [ 105 | {rabbit, [ 106 | {cluster_formation, [ 107 | {peer_discovery_k8s, [ 108 | {k8s_token_path, "/a/b/c"} 109 | ]} 110 | ]} 111 | ]} 112 | ], [rabbitmq_peer_discovery_k8s] 113 | } 114 | 115 | , {k8s_token_path, "cluster_formation.k8s.cert_path = /a/b/c", [ 116 | {rabbit, [ 117 | {cluster_formation, [ 118 | {peer_discovery_k8s, [ 119 | {k8s_cert_path, "/a/b/c"} 120 | ]} 121 | ]} 122 | ]} 123 | ], [rabbitmq_peer_discovery_k8s] 124 | } 125 | 126 | , {k8s_token_path, "cluster_formation.k8s.namespace_path = /a/b/c", [ 127 | {rabbit, [ 128 | {cluster_formation, [ 129 | {peer_discovery_k8s, [ 130 | {k8s_namespace_path, "/a/b/c"} 131 | ]} 132 | ]} 133 | ]} 134 | ], [rabbitmq_peer_discovery_k8s] 135 | } 136 | ]. 137 | -------------------------------------------------------------------------------- /test/rabbitmq_peer_discovery_k8s_SUITE.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% The Initial Developer of the Original Code is AWeber Communications. 6 | %% Copyright (c) 2015-2016 AWeber Communications 7 | %% Copyright (c) 2016-2020 VMware, Inc. or its affiliates. All rights reserved. 8 | %% 9 | 10 | -module(rabbitmq_peer_discovery_k8s_SUITE). 11 | 12 | -compile(export_all). 13 | -include_lib("common_test/include/ct.hrl"). 14 | -include_lib("eunit/include/eunit.hrl"). 15 | 16 | 17 | all() -> 18 | [ 19 | {group, unit} 20 | ]. 21 | 22 | groups() -> 23 | [ 24 | {unit, [], [ 25 | extract_node_list_long_test, 26 | extract_node_list_short_test, 27 | extract_node_list_hostname_short_test, 28 | extract_node_list_real_test, 29 | extract_node_list_with_not_ready_addresses_test, 30 | node_name_empty_test, 31 | node_name_suffix_test, 32 | registration_support, 33 | event_v1_test 34 | ]}]. 35 | 36 | init_per_testcase(T, Config) when T == node_name_empty_test; 37 | T == node_name_suffix_test -> 38 | meck:new(net_kernel, [passthrough, unstick]), 39 | meck:expect(net_kernel, longnames, fun() -> true end), 40 | Config; 41 | init_per_testcase(_, Config) -> 42 | Config. 43 | 44 | end_per_testcase(_, _Config) -> 45 | meck:unload(), 46 | application:unset_env(rabbit, cluster_formation), 47 | [os:unsetenv(Var) || Var <- ["K8S_HOSTNAME_SUFFIX", 48 | "K8S_ADDRESS_TYPE"]]. 49 | 50 | %%% 51 | %%% Testcases 52 | %%% 53 | 54 | registration_support(_Config) -> 55 | ?assertEqual(rabbit_peer_discovery_k8s:supports_registration(), true). 56 | 57 | extract_node_list_long_test(_Config) -> 58 | {ok, Response} = 59 | rabbit_json:try_decode( 60 | rabbit_data_coercion:to_binary( 61 | "{\"name\": \"mysvc\",\n\"subsets\": [\n{\n\"addresses\": [{\"ip\": \"10.10.1.1\"}, {\"ip\": \"10.10.2.2\"}],\n\"ports\": [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n},\n{\n\"addresses\": [{\"ip\": \"10.10.3.3\"}],\n\"ports\": [{\"name\": \"a\", \"port\": 93},{\"name\": \"b\", \"port\": 76}]\n}]}")), 62 | Expectation = [<<"10.10.1.1">>, <<"10.10.2.2">>, <<"10.10.3.3">>], 63 | ?assertEqual(Expectation, rabbit_peer_discovery_k8s:extract_node_list(Response)). 64 | 65 | extract_node_list_short_test(_Config) -> 66 | {ok, Response} = 67 | rabbit_json:try_decode( 68 | rabbit_data_coercion:to_binary( 69 | "{\"name\": \"mysvc\",\n\"subsets\": [\n{\n\"addresses\": [{\"ip\": \"10.10.1.1\"}, {\"ip\": \"10.10.2.2\"}],\n\"ports\": [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n}]}")), 70 | Expectation = [<<"10.10.1.1">>, <<"10.10.2.2">>], 71 | ?assertEqual(Expectation, rabbit_peer_discovery_k8s:extract_node_list(Response)). 72 | 73 | extract_node_list_hostname_short_test(_Config) -> 74 | os:putenv("K8S_ADDRESS_TYPE", "hostname"), 75 | {ok, Response} = 76 | rabbit_json:try_decode( 77 | rabbit_data_coercion:to_binary( 78 | "{\"name\": \"mysvc\",\n\"subsets\": [\n{\n\"addresses\": [{\"ip\": \"10.10.1.1\", \"hostname\": \"rabbitmq-1\"}, {\"ip\": \"10.10.2.2\", \"hostname\": \"rabbitmq-2\"}],\n\"ports\": [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n}]}")), 79 | Expectation = [<<"rabbitmq-1">>, <<"rabbitmq-2">>], 80 | ?assertEqual(Expectation, rabbit_peer_discovery_k8s:extract_node_list(Response)). 81 | 82 | extract_node_list_real_test(_Config) -> 83 | {ok, Response} = 84 | rabbit_json:try_decode( 85 | rabbit_data_coercion:to_binary( 86 | "{\"kind\":\"Endpoints\",\"apiVersion\":\"v1\",\"metadata\":{\"name\":\"galera\",\"namespace\":\"default\",\"selfLink\":\"/api/v1/namespaces/default/endpoints/galera\",\"uid\":\"646f8305-3491-11e6-8c20-ecf4bbd91e6c\",\"resourceVersion\":\"17373568\",\"creationTimestamp\":\"2016-06-17T13:42:54Z\",\"labels\":{\"app\":\"mysqla\"}},\"subsets\":[{\"addresses\":[{\"ip\":\"10.1.29.8\",\"targetRef\":{\"kind\":\"Pod\",\"namespace\":\"default\",\"name\":\"mariadb-tco7k\",\"uid\":\"fb59cc71-558c-11e6-86e9-ecf4bbd91e6c\",\"resourceVersion\":\"13034802\"}},{\"ip\":\"10.1.47.2\",\"targetRef\":{\"kind\":\"Pod\",\"namespace\":\"default\",\"name\":\"mariadb-izgp8\",\"uid\":\"fb484ab3-558c-11e6-86e9-ecf4bbd91e6c\",\"resourceVersion\":\"13035747\"}},{\"ip\":\"10.1.47.3\",\"targetRef\":{\"kind\":\"Pod\",\"namespace\":\"default\",\"name\":\"mariadb-init-ffrsz\",\"uid\":\"fb12e1d3-558c-11e6-86e9-ecf4bbd91e6c\",\"resourceVersion\":\"13032722\"}},{\"ip\":\"10.1.94.2\",\"targetRef\":{\"kind\":\"Pod\",\"namespace\":\"default\",\"name\":\"mariadb-zcc0o\",\"uid\":\"fb31ce6e-558c-11e6-86e9-ecf4bbd91e6c\",\"resourceVersion\":\"13034771\"}}],\"ports\":[{\"name\":\"mysql\",\"port\":3306,\"protocol\":\"TCP\"}]}]}")), 87 | Expectation = [<<"10.1.94.2">>, <<"10.1.47.3">>, <<"10.1.47.2">>, 88 | <<"10.1.29.8">>], 89 | ?assertEqual(Expectation, rabbit_peer_discovery_k8s:extract_node_list(Response)). 90 | 91 | extract_node_list_with_not_ready_addresses_test(_Config) -> 92 | {ok, Response} = 93 | rabbit_json:try_decode( 94 | rabbit_data_coercion:to_binary( 95 | "{\"kind\":\"Endpoints\",\"apiVersion\":\"v1\",\"metadata\":{\"name\":\"rabbitmq\",\"namespace\":\"test-rabbitmq\",\"selfLink\":\"\/api\/v1\/namespaces\/test-rabbitmq\/endpoints\/rabbitmq\",\"uid\":\"4ff733b8-3ad2-11e7-a40d-080027cbdcae\",\"resourceVersion\":\"170098\",\"creationTimestamp\":\"2017-05-17T07:27:41Z\",\"labels\":{\"app\":\"rabbitmq\",\"type\":\"LoadBalancer\"}},\"subsets\":[{\"notReadyAddresses\":[{\"ip\":\"172.17.0.2\",\"hostname\":\"rabbitmq-0\",\"nodeName\":\"minikube\",\"targetRef\":{\"kind\":\"Pod\",\"namespace\":\"test-rabbitmq\",\"name\":\"rabbitmq-0\",\"uid\":\"e980fe5a-3afd-11e7-a40d-080027cbdcae\",\"resourceVersion\":\"170044\"}},{\"ip\":\"172.17.0.4\",\"hostname\":\"rabbitmq-1\",\"nodeName\":\"minikube\",\"targetRef\":{\"kind\":\"Pod\",\"namespace\":\"test-rabbitmq\",\"name\":\"rabbitmq-1\",\"uid\":\"f6285603-3afd-11e7-a40d-080027cbdcae\",\"resourceVersion\":\"170071\"}},{\"ip\":\"172.17.0.5\",\"hostname\":\"rabbitmq-2\",\"nodeName\":\"minikube\",\"targetRef\":{\"kind\":\"Pod\",\"namespace\":\"test-rabbitmq\",\"name\":\"rabbitmq-2\",\"uid\":\"fd5a86dc-3afd-11e7-a40d-080027cbdcae\",\"resourceVersion\":\"170096\"}}],\"ports\":[{\"name\":\"amqp\",\"port\":5672,\"protocol\":\"TCP\"},{\"name\":\"http\",\"port\":15672,\"protocol\":\"TCP\"}]}]}")), 96 | Expectation = [], 97 | ?assertEqual(Expectation, rabbit_peer_discovery_k8s:extract_node_list(Response)). 98 | 99 | node_name_empty_test(_Config) -> 100 | Expectation = 'rabbit@rabbitmq-0', 101 | ?assertEqual(Expectation, rabbit_peer_discovery_k8s:node_name(<<"rabbitmq-0">>)). 102 | 103 | node_name_suffix_test(_Config) -> 104 | os:putenv("K8S_HOSTNAME_SUFFIX", ".rabbitmq.default.svc.cluster.local"), 105 | Expectation = 'rabbit@rabbitmq-0.rabbitmq.default.svc.cluster.local', 106 | ?assertEqual(Expectation, rabbit_peer_discovery_k8s:node_name(<<"rabbitmq-0">>)). 107 | 108 | event_v1_test(_Config) -> 109 | Expectation = #{ 110 | count => 1, 111 | type => <<"Normal">>, 112 | lastTimestamp => <<"2019-12-06T15:10:23+00:00">>, 113 | reason => <<"Reason">>, 114 | message => <<"MyMessage">>, 115 | metadata =>#{ 116 | name => <<"test">> , 117 | namespace => <<"namespace">> 118 | }, 119 | involvedObject =>#{ 120 | apiVersion => <<"v1">>, 121 | kind => <<"RabbitMQ">>, 122 | name => <<"pod/MyHostName">>, 123 | namespace => <<"namespace">> 124 | }, 125 | source =>#{ 126 | component => <<"MyHostName/rabbitmq_peer_discovery">>, 127 | host => <<"MyHostName">> 128 | } 129 | }, 130 | ?assertEqual(Expectation, 131 | rabbit_peer_discovery_k8s:generate_v1_event(<<"namespace">>, "test", 132 | "Normal", "Reason", "MyMessage", "2019-12-06T15:10:23+00:00", "MyHostName")). 133 | --------------------------------------------------------------------------------