diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8fc05ab --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.swp +.tox diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..67db858 --- /dev/null +++ b/LICENSE @@ -0,0 +1,175 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. diff --git a/README.md b/README.md new file mode 100644 index 0000000..79b1a0f --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# devstack-plugin-kafka + +The devstack plugin for installing and configuring Apache Kafka + +## How to Use + +in your local.conf file + + [[local|localrc]] + enable_plugin devstack-plugin-kafka https://github.com/openstack/devstack-plugin-kafka.git diff --git a/devstack/plugin.sh b/devstack/plugin.sh new file mode 100644 index 0000000..f7aef38 --- /dev/null +++ b/devstack/plugin.sh @@ -0,0 +1,129 @@ +#!/bin/bash + +# devstack/plugin.sh +# Functions to install and configure Apache Kafka +# +# Dependencies: +# +# - ``functions`` file +# +# ``stack.sh`` calls the entry points in this order: +# +# - download_kafka +# - install_kafka +# - configure_kafka +# - init_kafka +# - stop_kafka +# - cleanup_kafka + +# Save trace setting +XTRACE=$(set +o | grep xtrace) +set +o xtrace + +# Functions +# ------------ +# download_kafka() - downloading kafka +function download_kafka { + if [ ! -f ${FILES}/kafka_${SCALA_VERSION}-${KAFKA_VERSION}.tgz ]; then + wget ${KAFKA_BASEURL}/${KAFKA_VERSION}/kafka_${SCALA_VERSION}-${KAFKA_VERSION}.tgz \ + -O ${FILES}/kafka_${SCALA_VERSION}-${KAFKA_VERSION}.tgz + fi +} + +# install_kafka() - installing Kafka with Scala and Zookeeper +function install_kafka { + + local scala_version=${SCALA_VERSION}.0 + + if is_ubuntu; then + sudo apt-get install -y scala + elif is_fedora; then + + is_package_installed java-1.8.0-openjdk-headless || install_package java-1.8.0-openjdk-headless + + if [ ! -f ${FILES}/scala-${scala_version}.tar.gz ]; then + wget ${SCALA_BASEURL}/scala-${scala_version}.tgz \ + -O ${FILES}/scala-${scala_version}.tar.gz + fi + + if [ ! -d ${FILES}/scala-${scala_version} ]; then + tar -xvzf ${FILES}/scala-${scala_version}.tar.gz -C ${FILES} + fi + + if [ ! -d /usr/lib/scala-${scala_version} ]; then + sudo mv ${FILES}/scala-${scala_version} /usr/lib + sudo ln -s /usr/lib/scala-${scala_version} /usr/lib/scala + export PATH=$PATH:/usr/lib/scala/bin + fi + fi + + download_kafka + + if [ ! -d ${FILES}/kafka_${SCALA_VERSION}-${KAFKA_VERSION} ]; then + tar -xvzf ${FILES}/kafka_${SCALA_VERSION}-${KAFKA_VERSION}.tgz -C ${FILES} + fi + if [ ! -d ${KAFKA_DEST}/kafka ]; then + mkdir -p ${KAFKA_DEST} + mv ${FILES}/kafka_${SCALA_VERSION}-${KAFKA_VERSION} ${KAFKA_DEST}/kafka + fi +} + +# init_kafka() - starting Kafka and Zookeeper processes +function init_kafka { + # start Zookeeper process before starting Kafka + ${KAFKA_DEST}/kafka/bin/zookeeper-server-start.sh -daemon ${KAFKA_DEST}/kafka/config/zookeeper.properties + ${KAFKA_DEST}/kafka/bin/kafka-server-start.sh -daemon ${KAFKA_DEST}/kafka/config/server.properties +} + +# configure_kafka() - configuring Kafka service +function configure_kafka { + # currently a no op + : +} + +# stop_kafka() - stopping Kafka process +function stop_kafka { + ${KAFKA_DEST}/kafka/bin/kafka-server-stop.sh + ${KAFKA_DEST}/kafka/bin/zookeeper-server-stop.sh +} + +# cleanup_kafka() - removing Kafka files +# make sure this function is called only after calling stop_kafka() function +function cleanup_kafka { + rm ${FILES}/kafka_${SCALA_VERSION}-${KAFKA_VERSION}.tgz + rm -rf ${KAFKA_DEST}/kafka +} + +# check for kafka service +if is_service_enabled devstack-plugin-kafka; then + if [[ "$1" == "source" ]]; then + # Initial source + source $TOP_DIR/lib/kafka + + elif [[ "$1" == "stack" && "$2" == "install" ]]; then + # Perform installation of service source + echo_summary "Installing kafka" + install_kafka + + echo_summary "Initializing kafka" + init_kafka + + elif [[ "$1" == "unstack" ]]; then + # Shut down kafka services + echo_summary "Shut down kafka service" + stop_kafka + + elif [[ "$1" == "clean" ]]; then + # Remove state and transient data + # Remember clean.sh first calls unstack.sh + echo_summary "Clean up kafka service" + cleanup_kafka + fi +fi + +# Restore xtrace +$XTRACE + +## Local variables: +## mode: shell-script +## End: diff --git a/devstack/settings b/devstack/settings new file mode 100644 index 0000000..52d8002 --- /dev/null +++ b/devstack/settings @@ -0,0 +1,14 @@ +# Devstack settings + +enable_service kafka + +# Kafka installation directory +KAFKA_DEST=${KAFKA_DEST:-/opt/stack/devstack-plugin-kafka} + +# Specify Kafka version +KAFKA_VERSION=${KAFKA_VERSION:-0.9.0.1} +KAFKA_BASEURL=${KAFKA_BASEURL:-http://www.us.apache.org/dist/kafka} + +# Specify Scala version +SCALA_VERSION=${SCALA_VERSION:-2.10} +SCALA_BASEURL=${SCALA_BASEURL:-http://www.scala-lang.org/files/archive} diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..8e75f0d --- /dev/null +++ b/tox.ini @@ -0,0 +1,25 @@ +[tox] +minversion = 1.6 +skipsdist = True +envlist = bashate + +[testenv] +usedevelop = False +install_command = pip install {opts} {packages} + +[testenv:bashate] +deps = bashate +whitelist_externals = bash +commands = bash -c "find {toxinidir} \ + -not \( -type d -name .?\* -prune \) \ + -not \( -type d -name doc -prune \) \ + -type f \ + -not -name \*~ \ + -not -name \*.md \ + \( \ + -name \*.sh -or \ + -name \*rc -or \ + -name functions\* -or \ + -wholename \*/lib/\* \ + \) \ + -print0 | xargs -0 bashate -v"