From aa9406e767ff7ee7dbe4869dd59834e208aff016 Mon Sep 17 00:00:00 2001 From: Adrien Waksberg Date: Thu, 21 Feb 2019 22:19:56 +0100 Subject: [PATCH] first version --- .gitignore | 1 + .kitchen.yml | 27 +++ .yamllint | 12 ++ CHANGELOG.md | 7 + LICENSE | 201 ++++++++++++++++++ README.md | 88 ++++++++ defaults/main.yml | 44 ++++ handlers/main.yml | 6 + meta/main.yml | 20 ++ tasks/main.yml | 64 ++++++ templates/my.cnf.j2 | 9 + test/integration/default/default.yml | 22 ++ .../default/serverspec/default_spec.rb | 51 +++++ test/integration/inventory | 1 + 14 files changed, 553 insertions(+) create mode 100644 .gitignore create mode 100644 .kitchen.yml create mode 100644 .yamllint create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 defaults/main.yml create mode 100644 handlers/main.yml create mode 100644 meta/main.yml create mode 100644 tasks/main.yml create mode 100644 templates/my.cnf.j2 create mode 100644 test/integration/default/default.yml create mode 100644 test/integration/default/serverspec/default_spec.rb create mode 100644 test/integration/inventory diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..79776e8 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.kitchen/* diff --git a/.kitchen.yml b/.kitchen.yml new file mode 100644 index 0000000..7a16e14 --- /dev/null +++ b/.kitchen.yml @@ -0,0 +1,27 @@ +--- +driver: + name: docker_cli + +transport: + name: docker_cli + +provisioner: + name: ansible_playbook + hosts: localhost + require_ansible_repo: false + require_ansible_omnibus: false + require_chef_for_busser: true + ansible_verbose: false + ansible_inventory: ./test/integration/inventory + +platforms: + - name: debian-9 + driver_config: + image: "nishiki/debian9:ansible-<%= ENV['ANSIBLE_VERSION'] ? ENV['ANSIBLE_VERSION'] : '2.7' %>" + command: /bin/systemd + volume: + - /sys/fs/cgroup:/sys/fs/cgroup:ro + security_opt: seccomp=unconfined + +suites: + - name: default diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..5465b58 --- /dev/null +++ b/.yamllint @@ -0,0 +1,12 @@ +--- +extends: default + +ignore: | + .kitchen/* + vendor/ + +rules: + line-length: + max: 120 + level: warning + truthy: false diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..190d06e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# CHANGELOG + +This project adheres to [Semantic Versioning](http://semver.org/). +Which is based on [Keep A Changelog](http://keepachangelog.com/) + +## [Unreleased] +- first version diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..afe21bd --- /dev/null +++ b/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 2019 Adrien Waksberg + + 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/README.md b/README.md new file mode 100644 index 0000000..149e708 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +# Ansible role: MariaDB +[![Version](https://img.shields.io/badge/latest_version-1.0.0_dev-green.svg)](https://git.yaegashi.fr/nishiki/ansible-role-mariadb/releases) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/ansible-role-mariadb/src/branch/master/LICENSE) + +Install and configure MariaDB + +## Requirements + +* Ansible >= 2.7 +* Debian Stretch + +## Role variables + +- `mariadb_user` - login to connect on mariadb (default: `root`) +- `mariadb_password` - password to connect on mariadb (default: `secret`) +- `mariadb_master` - the server is master (default: `no`) +- `mariadb_autorestart` - restart mariadb when the config change (default: `no`) +- `mariadb_users` - array with the users to manage + +``` +- name: johndoe + password: supersecret + privileges: + - 'database.*:SELECT,UPDATE' + state: present +``` + +- `mariadb_databases` - array with the databases to manage + +``` +- name: superprogram + state: present +``` + +- `mariadb_config` - hash with mariadb configuration + +``` + mysqld: + server-id: 1 + bind-address: 0.0.0.0 +``` + +## How to use + +``` +- hosts: server + roles: + - mariadb +``` + +## Development +### Test syntax with yamllint + +* install `python` and `python-pip` +* install yamllint `pip install yamllint` +* run `yamllint .` + +### Test syntax with ansible-lint + +* install `python` and `python-pip` +* install yamllint `pip install ansible-lint` +* run `ansible-lint .` + +### Tests with docker + +* install [docker](https://docs.docker.com/engine/installation/) +* install ruby +* install bundler `gem install bundler` +* install dependencies `bundle install` +* run the tests `kitchen test` + +## License + +``` +Copyright (c) 2019 Adrien Waksberg + +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/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..cfc8a62 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,44 @@ +--- +mariadb_user: root +mariadb_password: secret +mariadb_master: no +mariadb_autorestart: no +mariadb_users: [] +mariadb_databases: [] +mariadb_config: {} +mariadb_default_config: + client: + default-character-set: utf8mb4 + mysql: + default-character-set: utf8mb4 + server: {} + mariadb: {} + mysqld_safe: + socket: /var/run/mysqld/mysqld.sock + nice: 0 + skip_log_error: true + syslog: true + mysqld: + user: mysql + pid-file: /var/run/mysqld/mysqld.pid + socket: /var/run/mysqld/mysqld.sock + bind-address: 127.0.0.1 + port: 3306 + basedir: /usr + datadir: /var/lib/mysql + tmpdir: /tmp + lc-messages-dir: /usr/share/mysql + skip-external-locking: true + key_buffer_size: 16M + max_allowed_packet: 16M + thread_stack: 192K + thread_cache_size: 8 + myisam_recover_options: BACKUP + query_cache_limit: 1M + query_cache_size: 16M + log_error: /var/log/mysql/error.log + expire_logs_days: 10 + max_binlog_size: 100M + character-set-server: utf8mb4 + collation-server: utf8mb4_general_ci +mariadb_full_config: '{{ mariadb_default_config|combine(mariadb_config, recursive=True) }}' diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..1ed3f5e --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,6 @@ +--- +- name: restart mariadb + service: + name: mysql + state: restarted + when: mariadb_autorestart diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..ce19906 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,20 @@ +--- +galaxy_info: + role_name: mariadb + author: Adrien Waksberg + company: Adrien Waksberg + description: Install and configure mysql + license: Apache2 + min_ansible_version: 2.7 + + platforms: + - name: Debian + versions: + - stretch + + galaxy_tags: + - database + - sql + - mysql + +dependencies: [] diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..0b9de18 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,64 @@ +--- +- name: install package + package: + name: mariadb-server + retries: 2 + register: result + until: result is succeeded + tags: mariadb + +- name: copy configuration file + template: + src: my.cnf.j2 + dest: /etc/mysql/mariadb.cnf + owner: root + group: root + mode: 0644 + notify: restart mariadb + tags: mariadb + +- name: enable and start the service + service: + name: mysql + state: started + enabled: yes + tags: mariadb + +- name: remove anonymous users + mysql_user: + name: '' + host_all: yes + state: absent + login_user: '{{ mariadb_user }}' + login_password: '{{ mariadb_password }}' + run_once: true + no_log: true + when: mariadb_master + tags: mariadb + +- name: manage users + mysql_user: + name: '{{ item.name }}' + host: '{{ item.host }}' + password: '{{ item.password }}' + priv: '{{ item.privileges|default("")|join(",") }}' + state: '{{ item.state|default("present") }}' + login_user: '{{ mariadb_user }}' + login_password: '{{ mariadb_password }}' + loop: '{{ mariadb_users }}' + run_once: true + no_log: true + when: mariadb_master + tags: mariadb + +- name: manage databases + mysql_db: + name: '{{ item.name }}' + state: '{{ item.state|default("present") }}' + login_user: '{{ mariadb_user }}' + login_password: '{{ mariadb_password }}' + loop: '{{ mariadb_databases }}' + run_once: true + no_log: true + when: mariadb_master + tags: mariadb diff --git a/templates/my.cnf.j2 b/templates/my.cnf.j2 new file mode 100644 index 0000000..b4ae60d --- /dev/null +++ b/templates/my.cnf.j2 @@ -0,0 +1,9 @@ +# {{ ansible_managed }} + +{% for section, options in mariadb_full_config.iteritems() %} +[{{section}}] +{% for option, value in options.iteritems() %} +{{ option }}{% if not value is sameas true %} = {{ value }}{% endif %} + +{% endfor %} +{% endfor %} diff --git a/test/integration/default/default.yml b/test/integration/default/default.yml new file mode 100644 index 0000000..9390384 --- /dev/null +++ b/test/integration/default/default.yml @@ -0,0 +1,22 @@ +--- +- hosts: localhost + connection: local + vars: + mariadb_autorestart: yes + mariadb_master: yes + mariadb_config: + client-server: {} + mysqld: + server-id: 5 + log-bin: mysql-bin + mariadb_databases: + - name: test + mariadb_users: + - name: toto + host: '%' + password: test + privileges: + - 'test.*:ALL' + + roles: + - ansible-role-mariadb diff --git a/test/integration/default/serverspec/default_spec.rb b/test/integration/default/serverspec/default_spec.rb new file mode 100644 index 0000000..71c2afe --- /dev/null +++ b/test/integration/default/serverspec/default_spec.rb @@ -0,0 +1,51 @@ +require 'serverspec' + +set :backend, :exec + +puts +puts '================================' +puts %x(ansible --version) +puts '================================' + +describe package('mariadb-server') do + it { should be_installed } +end + +describe file('/etc/mysql/mariadb.cnf') do + it { should be_file } + it { should be_mode 644 } + it { should be_owned_by 'root' } + it { should be_grouped_into 'root' } + it { should contain 'server-id = 5' } +end + +describe service('mysql') do + it { should be_enabled } + it { should be_running.under('systemd') } +end + +describe port(3306) do + it { should be_listening } +end + +describe command('mysql -u root -e "show databases"') do + its(:exit_status) { should eq 0 } + its(:stdout) { should contain 'test' } +end + +describe command('mysql -u root -e "select user, host from mysql.user"') do + its(:exit_status) { should eq 0 } + its(:stdout) { should contain(/toto.*%/) } +end + +describe command('mysql -u root -e "show grants for toto@\'%\'"') do + its(:exit_status) { should eq 0 } + its(:stdout) do + should contain "GRANT ALL PRIVILEGES ON `test`.* TO 'toto'@'%'" + end +end + +describe command('mysql -u root -e "show variables where variable_name = \'log_bin\'"') do + its(:exit_status) { should eq 0 } + its(:stdout) { should contain 'ON' } +end diff --git a/test/integration/inventory b/test/integration/inventory new file mode 100644 index 0000000..2fbb50c --- /dev/null +++ b/test/integration/inventory @@ -0,0 +1 @@ +localhost