From a673a56c74cd09cfac9a406e7b19d7a5b2dba38e Mon Sep 17 00:00:00 2001 From: Steve Brasier Date: Wed, 13 Dec 2023 15:51:22 +0000 Subject: [PATCH] add os_manila_mount role --- roles/os_manila_mount/LICENSE | 201 ++++++++++++++++++ roles/os_manila_mount/README.md | 118 ++++++++++ roles/os_manila_mount/defaults/main.yml | 20 ++ .../os_manila_share.cpython-38.pyc | Bin 0 -> 3185 bytes roles/os_manila_mount/library/manila_share.py | 39 ++++ .../library/os_manila_share.py | 63 ++++++ roles/os_manila_mount/meta/main.yml | 29 +++ roles/os_manila_mount/tasks/install.yml | 16 ++ roles/os_manila_mount/tasks/lookup.yml | 12 ++ roles/os_manila_mount/tasks/main.yml | 4 + roles/os_manila_mount/tasks/mount.yml | 66 ++++++ roles/os_manila_mount/templates/ceph.conf.j2 | 6 + .../os_manila_mount/templates/ceph.keyring.j2 | 4 + roles/os_manila_mount/templates/keyring.j2 | 4 + roles/os_manila_mount/tests/inventory | 2 + roles/os_manila_mount/tests/test.yml | 5 + 16 files changed, 589 insertions(+) create mode 100644 roles/os_manila_mount/LICENSE create mode 100644 roles/os_manila_mount/README.md create mode 100644 roles/os_manila_mount/defaults/main.yml create mode 100644 roles/os_manila_mount/library/__pycache__/os_manila_share.cpython-38.pyc create mode 100644 roles/os_manila_mount/library/manila_share.py create mode 100644 roles/os_manila_mount/library/os_manila_share.py create mode 100644 roles/os_manila_mount/meta/main.yml create mode 100644 roles/os_manila_mount/tasks/install.yml create mode 100644 roles/os_manila_mount/tasks/lookup.yml create mode 100644 roles/os_manila_mount/tasks/main.yml create mode 100644 roles/os_manila_mount/tasks/mount.yml create mode 100644 roles/os_manila_mount/templates/ceph.conf.j2 create mode 100644 roles/os_manila_mount/templates/ceph.keyring.j2 create mode 100644 roles/os_manila_mount/templates/keyring.j2 create mode 100644 roles/os_manila_mount/tests/inventory create mode 100644 roles/os_manila_mount/tests/test.yml diff --git a/roles/os_manila_mount/LICENSE b/roles/os_manila_mount/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/roles/os_manila_mount/LICENSE @@ -0,0 +1,201 @@ + 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. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/roles/os_manila_mount/README.md b/roles/os_manila_mount/README.md new file mode 100644 index 0000000..5139c87 --- /dev/null +++ b/roles/os_manila_mount/README.md @@ -0,0 +1,118 @@ +stackhpc.os_manila_mount +======================== + +Mount one or more shares created by OpenStack Manila. + +Currently only supports: +- CephFS-protocol shares. +- Enterprise Linux (RedHat clones) + +Requirements +------------ + +The host running the lookup action (see below) requires the following python packages: + +- python-openstackclient +- python-manilaclient + +That host also requires OpenStack credentials and access to the OpenStack APIs. + +Role Taskfiles +-------------- + +The default `tasks/main.yml` task file will install packages, lookup Manila share +details, create client configuration and mount shares. However it is possible to +separate out these actions using specific task files: +- `install.yml`: Only install release repo and packages. +- `lookup.yml`: Only lookup share details. +- `mount.yml`: Only create client configuration and mount shares. + +This may be useful for image build, or for situations where it is undesirable to +dynamically retrieve share information during mount. + +Role Variables +-------------- + +* `os_manila_mount_shares`: List of dicts defining the shares to mount, each +containing: + - `share_name`: Required. Name in Manila for the share ("Name" from `openstack share + list`). + - `share_user`: Required. CephX user for access ("Access To" from `openstack share + access list `). + - `mount_path`: Required. Directory path to mount the share at (will be created). + - `mount_user`: Optional. User to mount as (default: become user). + - `mount_group`: Optional. Group to mount as (default: become user). + - `mount_opts`: Optional. List of strings defining mount options. Default is + `os_manila_mount_opts` (i.e. same for all mounts). + - `mount_state`: Optional. Mount state, default `os_manila_mount_state` (i.e. same for + all mounts). +* `os_manila_share_lookup_host`: Optional. Inventory hostname of host to run lookup on. +Default `localhost`. +* `os_manila_share_lookup_once`: Optional. Bool controlling whether to run the lookup +task on only one host. Default is `true` for speed, but if +`os_manila_mount_shares` varies between hosts in the play this must be set to `false`. + +* `os_manila_mount_state`: Optional. As for `state` of [ansible.posix.mount](https://docs.ansible.com/ansible/latest/collections/ansible/posix/mount_module.html). Default `mounted`. +* `os_manila_mount_opts`: Optional. List of strings defining default mount options +(see `defaults/main.yml`). + +* `os_manila_mount_share_info`: Automatically populated by lookup task. If not running +that, this should be a list of dicts each containing: + - `host`: Host/port for Ceph mon(s), e.g. `mon1:port,mon2:port,mon3:port` + - `export`: Exported path. + - `access_key`: The access key for this share for the `share_user`. + **WARNING: This value should be kept secret.** + - `item`: The relevant dict from `os_manila_mount_shares`. + + By default the result of the lookup is not shown in logs to avoid exposing `access_key`. +If necessary for debugging, set `no_log=true` to see it. Note that running ansible with +`-v` will expose `access_key`. + +Ceph variables: +* `os_manila_mount_ceph_version`: Optional. Ceph version string, default `pacific`. From + `octopus` alternatively an `x.y.z` version may be used. +* `os_manila_mount_ceph_rpm_key`: Optional. URL for Ceph rpm key. +* `os_manila_mount_ceph_release_repo`: Optional. URL for Ceph release repo. +* `os_manila_mount_ceph_conf_path`: Optional. Path for Ceph configuration directory, +default `/etc/ceph`. + + +Example Playbook +---------------- + +Note this role must be run with `become`. + + --- + - hosts: all + become: yes + gather_facts: no + vars: + os_manila_mount_shares: + - share_name: manila-test-share + share_user: testuser + mount_path: /mnt/manila + mount_user: "{{ ansible_user }}" + mount_group: "{{ ansible_user }}" + tasks: + - import_role: + name: stackhpc.os-manila-mount + +An easy way to run this example with both the lookup and the mount done on localhost is: + + python -m venv venv + . .venv/bin/activate + pip install -U pip + pip install -U ansible python-openstackclient python-manilaclient + ansible-galaxy install stackhpc.os-manila-mount + + ansible-playbook -c local test.yml + +License +------- + +Apache + +Author Information +------------------ + +http://www.stackhpc.com diff --git a/roles/os_manila_mount/defaults/main.yml b/roles/os_manila_mount/defaults/main.yml new file mode 100644 index 0000000..126577c --- /dev/null +++ b/roles/os_manila_mount/defaults/main.yml @@ -0,0 +1,20 @@ +--- + +# Fill these in for each cluster +os_manila_mount_shares: [] +os_manila_share_lookup_host: localhost +os_manila_share_lookup_once: true +os_manila_mount_state: mounted +os_manila_mount_opts: + - x-systemd.device-timeout=30 + - x-systemd.mount-timeout=30 + - noatime + - _netdev # prevents mount blocking early boot before networking available + - rw +os_manila_mount_share_info: [] # populated by lookup mode + +# CEPH specific defaults +os_manila_mount_ceph_version: pacific # from octopus, alternatively an x.y.z version can be used +os_manila_mount_ceph_rpm_key: https://download.ceph.com/keys/release.asc +os_manila_mount_ceph_release_repo: "https://download.ceph.com/rpm-{{ os_manila_mount_ceph_version }}/el{{ ansible_distribution_major_version }}/noarch/ceph-release-1-1.el{{ ansible_distribution_major_version }}.noarch.rpm" +os_manila_mount_ceph_conf_path: /etc/ceph diff --git a/roles/os_manila_mount/library/__pycache__/os_manila_share.cpython-38.pyc b/roles/os_manila_mount/library/__pycache__/os_manila_share.cpython-38.pyc new file mode 100644 index 0000000000000000000000000000000000000000..7f90ddb5ceb382ea33748a02a9871e41636b1537 GIT binary patch literal 3185 zcmaJ@Pj4H?6`z^?ONx}JKT#|-O&FwVO4K4H#dcEFtt(q{VOxR^e^zJV-TEh8j}w7D8)XDna6Z%cm_AP8Bx#V7Pq;>U1&?Z z%qMt-SHCHF7N6u(|015vYkV47htKd?Xk9+X--5Qp=lR>vmc<0Wam1t)ks+#c7gt%Kr@H@DY*q#mi@AuMcHgi@rRiIYYtXA#d$TvhJ& zWRfOf66YqaCU;Q!Fl-lV$jx4mwsW(cs5CDJVJMXHkHkqxF*d`CL2JPC03KBXk&;uI zk&JSB7bJv|ZRch;=m-er)b6JnUu^l0cOHD^Z*J^uG+18NLG#hTD`OOVt@xJ6Dfrms zVjMk{fjns?%I^f-C=QD8X73~~X>;6*8#uWQf>4vXR8B+hjaA|bO?dPwzl08_DS1YZ zZ23vbE{vDBW_n?A_L82mj6Acrf#aMmkkme4^Msq{0Ko1dSUY1@R%(yNGK7u2?YTR< z{)5kV_BTC8|H<*%;EzvY5hzg)+af%wpCo-*-|30&ZW_RA7$<$MnkPXg{`->pst!BF zMK_ItSgqHW)VDM@I_hxn@h^QtbdMvMbUWa8-M``HEK#{LG|6ia$S{t;(hrmFL3HSq z55?>L4E7c5GXQ&NhGC9k|CvgvsDyo&yl;aBrYv9HBcdM^us5XozL z8qAjAB)BxnYpygOj>*8TG-mJY(xGEMnZ(z=yIXsz@s&!;)%;M7kc907MKr{m&ax#a{>XEs-gwI@9@J{&bzu5wLNx||h zv;C><>jyIF)UT!0&AJT!QDm4} zmzd|Wf&%kLVgh*+#lC9l@TQ6v%^O7qUnv^)HCJijM=(nz?wnUESjLZ&Fh~J!O5&zo z()Ax-!6i#*h^3%m=LX;b34kuB!;mSqyn?!-2^2%2~ zOmXj8E!X@$;H`5}0P7|_v$zm2gOBPWeztZxJ`Z2}(5N;5g%(F7 zTASpncQoc~z#M~Gb_?+4AWA8D{>AfKnGINTx8*x9&A?o1-dgb{hJ+qRDjiIZ;I*V$ zL5R_9F!??h7eOoyZPP?ffU?0nvj;^%TMR>tg`pg!(F&|hv==6#? z0pQGS@8t$;HsWbRsA23$uiBR=! zlGfY7v8We_LEh6)Y)Uv>5)CxHs=?Be;duwj>XmCJNW=CONj5dj4c^~{KlnwvMp;Bh*DiK^+`l$yhf*d8&^~Z(J09U>|e3fZ}Cz- z(e{g@S`d5H*D8$h^~^Cl0Z=};s{0@aWpJ0T?n~2UKiL(aC?KgDT0-_PlR*Z-Qv;eR zL%FTcIVil?lgM$o>%-YA>iT}8;w=WndAM0reZQYZv1&dIR21rX$T{$kSjxTH#`f-` z`=7&kZ)