From 40df8fb8144b0da6d991802f208e78550cac1fa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Han?= Date: Tue, 10 May 2016 18:29:27 +0200 Subject: [PATCH] ceph-client: introduce new client role MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit By default, this roles will create a ceph config file and get the admin key. You can optionnally add other users, keys and pools for your tests. Closes: #769 Signed-off-by: Sébastien Han --- contrib/splitup.yml | 1 + group_vars/clients.sample | 22 ++ roles/ceph-client/LICENSE | 201 ++++++++++++++++++ roles/ceph-client/README.md | 41 ++++ roles/ceph-client/defaults/main.yml | 15 ++ roles/ceph-client/meta/main.yml | 14 ++ roles/ceph-client/tasks/create_users_keys.yml | 14 ++ roles/ceph-client/tasks/main.yml | 4 + roles/ceph-client/tasks/pre_requisite.yml | 9 + roles/ceph-common/defaults/main.yml | 1 + .../tasks/installs/install_on_redhat.yml | 20 ++ site.yml.sample | 5 + 12 files changed, 347 insertions(+) create mode 100644 group_vars/clients.sample create mode 100644 roles/ceph-client/LICENSE create mode 100644 roles/ceph-client/README.md create mode 100644 roles/ceph-client/defaults/main.yml create mode 100644 roles/ceph-client/meta/main.yml create mode 100644 roles/ceph-client/tasks/create_users_keys.yml create mode 100644 roles/ceph-client/tasks/main.yml create mode 100644 roles/ceph-client/tasks/pre_requisite.yml diff --git a/contrib/splitup.yml b/contrib/splitup.yml index fb6415b18..9c3d804d3 100644 --- a/contrib/splitup.yml +++ b/contrib/splitup.yml @@ -29,6 +29,7 @@ - ceph-agent - ceph-fetch-keys - ceph-rbd-mirror + - ceph-client basedir: "{{ lookup('pipe', 'git rev-parse --show-toplevel') }}" tasks: diff --git a/group_vars/clients.sample b/group_vars/clients.sample new file mode 100644 index 000000000..b3bca0822 --- /dev/null +++ b/group_vars/clients.sample @@ -0,0 +1,22 @@ +--- +# Variables here are applicable to all host groups NOT roles + +# This sample file generated by generate_group_vars_sample.sh + +# Dummy variable to avoid error because ansible does not recognize the +# file as a good configuration file when no variable in it. +dummy: + +########### +# GENERAL # +########### + +#fetch_directory: fetch/ + +#user_config: false +#pools: +# - { name: test, pgs: "{{ pool_default_pg_num }}" } + +#keys: +# - { name: client.test, value: "mon 'allow r' osd 'allow class-read object_prefix rbd_children, allow rwx pool={{ pools.name }}'" } + diff --git a/roles/ceph-client/LICENSE b/roles/ceph-client/LICENSE new file mode 100644 index 000000000..acee72b2b --- /dev/null +++ b/roles/ceph-client/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 [2014] [Sébastien Han] + + 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/ceph-client/README.md b/roles/ceph-client/README.md new file mode 100644 index 000000000..3f3a3a2dc --- /dev/null +++ b/roles/ceph-client/README.md @@ -0,0 +1,41 @@ +# Ansible role: Ceph Client + +This role bootstraps all the necessary bits to run a Ceph client. + +# Requirements + +Nothing, it runs out of the box. + +# Role variables + +Have a look at: `defaults/main.yml`. + +## Mandatory variables + +None. + +# Dependencies + +The role `ceph.ceph-common` must be installed. + +# Example Playbook + +``` +- hosts: servers + remote_user: ubuntu + roles: + - { role: ceph.ceph-client } +``` + +# Contribution + +**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS** +**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)** + +# License + +Apache + +# Author Information + +This role was created by [Sébastien Han](http://sebastien-han.fr/). diff --git a/roles/ceph-client/defaults/main.yml b/roles/ceph-client/defaults/main.yml new file mode 100644 index 000000000..4cc10939b --- /dev/null +++ b/roles/ceph-client/defaults/main.yml @@ -0,0 +1,15 @@ +--- +########### +# GENERAL # +########### + +fetch_directory: fetch/ + +user_config: false +pools: + - { name: test, pgs: "{{ pool_default_pg_num }}" } + - { name: test2, pgs: "{{ pool_default_pg_num }}" } + +keys: + - { name: client.test, value: "mon 'allow r' osd 'allow class-read object_prefix rbd_children, allow rwx pool=test'" } + - { name: client.test2, value: "mon 'allow r' osd 'allow class-read object_prefix rbd_children, allow rwx pool=test2'" } diff --git a/roles/ceph-client/meta/main.yml b/roles/ceph-client/meta/main.yml new file mode 100644 index 000000000..f0a366a39 --- /dev/null +++ b/roles/ceph-client/meta/main.yml @@ -0,0 +1,14 @@ +--- +galaxy_info: + author: Sébastien Han + description: Installs A Ceph Client + license: Apache + min_ansible_version: 1.7 + platforms: + - name: Ubuntu + versions: + - trusty + categories: + - system +dependencies: + - { role: ceph.ceph-common } diff --git a/roles/ceph-client/tasks/create_users_keys.yml b/roles/ceph-client/tasks/create_users_keys.yml new file mode 100644 index 000000000..f52864dc8 --- /dev/null +++ b/roles/ceph-client/tasks/create_users_keys.yml @@ -0,0 +1,14 @@ +--- +- name: create pools + command: ceph --cluster {{ cluster }} osd pool create {{ item.name }} {{ item.pgs }} + with_items: pools + changed_when: false + failed_when: false + +- name: create keys + command: ceph --cluster {{ cluster }} auth get-or-create {{ item.name }} {{ item.value }} -o /etc/ceph/{{ cluster }}.{{ item.name }}.keyring + args: + creates: /etc/ceph/{{ cluster }}.{{ item.name }}.keyring + with_items: keys + changed_when: false + when: cephx diff --git a/roles/ceph-client/tasks/main.yml b/roles/ceph-client/tasks/main.yml new file mode 100644 index 000000000..c2b363f62 --- /dev/null +++ b/roles/ceph-client/tasks/main.yml @@ -0,0 +1,4 @@ +--- +- include: pre_requisite.yml +- include: create_users_keys.yml + when: user_config diff --git a/roles/ceph-client/tasks/pre_requisite.yml b/roles/ceph-client/tasks/pre_requisite.yml new file mode 100644 index 000000000..576371ecb --- /dev/null +++ b/roles/ceph-client/tasks/pre_requisite.yml @@ -0,0 +1,9 @@ +--- +- name: copy ceph admin keyring + copy: + src: "{{ fetch_directory }}/{{ fsid }}/etc/ceph/{{ cluster }}.client.admin.keyring" + dest: "/etc/ceph/" + owner: "{{ key_owner }}" + group: "{{ key_group }}" + mode: "{{ key_mode }}" + when: cephx diff --git a/roles/ceph-common/defaults/main.yml b/roles/ceph-common/defaults/main.yml index 10e17830d..f3d0b4f78 100644 --- a/roles/ceph-common/defaults/main.yml +++ b/roles/ceph-common/defaults/main.yml @@ -18,6 +18,7 @@ rgw_group_name: rgws mds_group_name: mdss restapi_group_name: restapis rbdmirror_group_name: rbdmirrors +client_group_name: clients # If check_firewall is true, then ansible will try to determine if the # Ceph ports are blocked by a firewall. If the machine running ansible diff --git a/roles/ceph-common/tasks/installs/install_on_redhat.yml b/roles/ceph-common/tasks/installs/install_on_redhat.yml index 733554292..5b64b3ab6 100644 --- a/roles/ceph-common/tasks/installs/install_on_redhat.yml +++ b/roles/ceph-common/tasks/installs/install_on_redhat.yml @@ -104,6 +104,26 @@ mds_group_name in group_names and ansible_pkg_mgr == "dnf" +- name: install distro or red hat storage ceph base + yum: + name: "ceph-base" + state: "{{ (upgrade_ceph_packages|bool) | ternary('latest','present') }}" + when: + (ceph_origin == "distro" or ceph_stable_rh_storage or ceph_dev or + (ceph_stable and ceph_stable_release not in ceph_stable_releases)) and + client_group_name in group_names and + ansible_pkg_mgr == "yum" + +- name: install distro or red hat storage ceph base + dnf: + name: "ceph-base" + state: "{{ (upgrade_ceph_packages|bool) | ternary('latest','present') }}" + when: + (ceph_origin == "distro" or ceph_stable_rh_storage or ceph_dev or + (ceph_stable and ceph_stable_release not in ceph_stable_releases)) and + client_group_name in group_names and + ansible_pkg_mgr == "dnf" + - name: install ceph-test yum: name: ceph-test diff --git a/site.yml.sample b/site.yml.sample index f2e81dce7..3945ea1ef 100644 --- a/site.yml.sample +++ b/site.yml.sample @@ -35,3 +35,8 @@ become: True roles: - ceph-rbd-mirror + +- hosts: clients + become: True + roles: + - ceph-client