From 955d21b3c3f18e8e8c7d1835e7290cb7e5c1b397 Mon Sep 17 00:00:00 2001 From: Liang Fang Date: Tue, 17 Mar 2020 06:30:07 -0700 Subject: [PATCH] Initial repo During stack.sh - git clone open-cas repo - compile open-cas - install open-cas - configure open-cas During unstack.sh - remove cached devices - remove cache instance - uninstall open-cas Change-Id: I037b9cf585048b63de6a5f554620a89a8de67e1b Signed-off-by: Liang Fang --- .zuul.yaml | 8 +++ LICENSE | 176 +++++++++++++++++++++++++++++++++++++++++++++ README.rst | 7 ++ devstack/plugin.sh | 86 ++++++++++++++++++++++ tox.ini | 24 +++++++ 5 files changed, 301 insertions(+) create mode 100644 .zuul.yaml create mode 100644 LICENSE create mode 100644 README.rst create mode 100755 devstack/plugin.sh create mode 100644 tox.ini diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..e84e13c --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,8 @@ +- project: + check: + jobs: + - openstack-tox-bashate + + gate: + jobs: + - openstack-tox-bashate diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..c9d3229 --- /dev/null +++ b/README.rst @@ -0,0 +1,7 @@ +======================== +devstack-plugin-open-cas +======================== + +To use: + +enable_plugin devstack-plugin-open-cas https://opendev.org/openstack/devstack-plugin-open-cas diff --git a/devstack/plugin.sh b/devstack/plugin.sh new file mode 100755 index 0000000..afb51e8 --- /dev/null +++ b/devstack/plugin.sh @@ -0,0 +1,86 @@ +# Devstack open-cas plugin + +OPENCAS_REPO_DIR=${DEST:-/} +OPENCAS_REPO_URL=${OPENCAS_REPO_URL:-https://github.com/Open-CAS/open-cas-linux.git} +OPENCAS_REPO_BRANCH=master +OPENCAS_CACHE_SIZE=${OPENCAS_CACHE_SIZE:-1048576} + + +function git_clone_opencas { + cd $OPENCAS_REPO_DIR + git_clone $OPENCAS_REPO_URL $OPENCAS_REPO_DIR $OPENCAS_REPO_BRANCH + cd open-cas-linux + git submodule update --init +} + +function compile_opencas { + sudo ./configure + make +} + +function install_opencas { + sudo make install + sudo casadm -V +} + +function create_cache_instance { + sudo modprobe brd rd_nr=1 rd_size=$OPENCAS_CACHE_SIZE max_part=0 + RAM_DEV=/dev/ram0 + sudo casadm -S -d $RAM_DEV -f + sudo casadm -L +} + +function remove_cores { + cache_id="" + core_id="" + (sudo casadm -L) | while read line ; do + col1=$(echo $line | awk '{print $1}') + col2=$(echo $line | awk '{print $2}') + if [[ "$col1" =~ cache ]]; then + cache_id=$col2 + fi + if [[ "$col1" =~ core ]]; then + core_id=$col2 + sudo casadm -R -i $cache_id -j $core_id -f + fi + done +} + +function remove_cache_instance { + (sudo casadm -L) | while read line ; do + col1=$(echo $line | awk '{print $1}') + col2=$(echo $line | awk '{print $2}') + if [[ "$col1" =~ cache ]]; then + cache_id=$col2 + sudo casadm -T -i $cache_id + fi + done +} + +function uninstall_opencas { + cd $OPENCAS_REPO_DIR + cd open-cas-linux + pwd + sudo make uninstall +} + +if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then + echo_summary "git clone open-cas" + git_clone_opencas + echo_summary "compile open-cas" + compile_opencas + echo_summary "Install open-cas" + install_opencas + echo_summary "create cache instance" + create_cache_instance +fi + +if [[ "$1" == "unstack" ]]; then + sudo casadm -L + echo_summary "remove cores" + remove_cores + echo_summary "remove cache instance" + remove_cache_instance + echo_summary "uninstall opencas" + uninstall_opencas +fi diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..88e9fb3 --- /dev/null +++ b/tox.ini @@ -0,0 +1,24 @@ +[tox] +minversion = 1.6 +skipsdist = True +envlist = bashate + +[testenv] +usedevelop = False + +[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 -iE006"