From d7242cd8297e548b7bef81bc2135fe8be38bbab5 Mon Sep 17 00:00:00 2001 From: Adrien Waksberg Date: Sun, 9 Aug 2020 08:20:33 +0200 Subject: [PATCH] release: version 1.0.0 --- .gitignore | 2 + .yamllint | 12 ++ CHANGELOG.md | 10 ++ LICENSE | 201 +++++++++++++++++++++++++ README.md | 60 ++++++++ defaults/main.yml | 4 + library/gitlab_runner.py | 57 +++++++ meta/main.yml | 20 +++ molecule/default/converge.yml | 12 ++ molecule/default/molecule.yml | 22 +++ molecule/default/tests/test_default.py | 18 +++ tasks/main.yml | 37 +++++ 12 files changed, 455 insertions(+) create mode 100644 .gitignore 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 library/gitlab_runner.py create mode 100644 meta/main.yml create mode 100644 molecule/default/converge.yml create mode 100644 molecule/default/molecule.yml create mode 100644 molecule/default/tests/test_default.py create mode 100644 tasks/main.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1331d18 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.kitchen/* +*.pyc 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..bb60ed2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# CHANGELOG + +This project adheres to [Semantic Versioning](http://semver.org/). +Which is based on [Keep A Changelog](http://keepachangelog.com/) + +## [Unreleased] + +## [v1.0.0] - 2020-08-09 + +- first version diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fe50898 --- /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 2020 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..36a21cf --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Ansible role: Gitlab Runner + +[![Version](https://img.shields.io/badge/latest_version-1.0.0-green.svg)](https://git.yaegashi.fr/nishiki/ansible-role-gitlab/releases) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/ansible-role-gitlab/src/branch/master/LICENSE) + +Install and configure a Gitlab runner + +## Requirements + +* Ansible >= 2.9 +* Debian Buster + +## Role variables + +- `gitlab_runner_runners` - array with the runners to manage + +``` + - name: docker on machine + executor: docker + url: https://gitlab.example.com + token: Secret + options: + docker-image: 'alpine:latest' + locked: false +``` + +## How to use + +``` +- hosts: server + roles: + - gitlab_runner +``` + +## Development + +### Test with molecule and docker + +* install [docker](https://docs.docker.com/engine/installation/) +* install `python3` and `python3-pip` +* install molecule and dependencies `pip3 install molecule 'molecule[docker]' docker ansible-lint testinfra yamllint` +* run `molecule test` + +## License + +``` +Copyright (c) 2020 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..c79a873 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,4 @@ +--- +gitlab_runner_repository: > + deb https://packages.gitlab.com/runner/gitlab-runner/debian/ {{ ansible_distribution_release }} main +gitlab_runner_runners: [] diff --git a/library/gitlab_runner.py b/library/gitlab_runner.py new file mode 100644 index 0000000..630e366 --- /dev/null +++ b/library/gitlab_runner.py @@ -0,0 +1,57 @@ +#!/usr/bin/python + +from ansible.module_utils.basic import * +import subprocess + +class GitlabRunner: + def __init__(self, name): + self.name = name + self.exist = self.name in open('/etc/gitlab-runner/config.toml').read() + + def register(self, url, token, executor, options): + opts = [] + for k, v in options.items(): + if v is False: + opts.append('--%s=false' % k) + else: + opts.append('--%s' % k) + if v is not True: + opts.append(str(v)) + + subprocess.check_call(['gitlab-runner', 'register', + '--non-interactive', + '--name', self.name, + '--url', url, + '--registration-token', token, + '--executor', executor, + ] + opts ) + + def unregister(self): + subprocess.check_call(['gitlab-runner', 'unregister', '--name', self.name]) + +def main(): + changed = False + fields = { + 'name': { 'type': 'str', 'required': True }, + 'url': { 'type': 'str', 'required': True }, + 'token': { 'type': 'str', 'required': True, 'no_log': True }, + 'executor': { 'type': 'str', 'required': True }, + 'options': { 'type': 'dict', 'default': {} }, + 'state': { 'type': 'str', 'default': 'present', 'choices': ['present', 'absent'] } + } + module = AnsibleModule(argument_spec=fields) + + runner = GitlabRunner(module.params['name']) + if module.params['state'] == 'present': + if not runner.exist: + runner.register(module.params['url'], module.params['token'], + module.params['executor'], module.params['options']) + changed = True + elif runner.exist: + runner.unregister() + changed = True + + module.exit_json(changed=changed) + +if __name__ == '__main__': + main() diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..6a8911d --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,20 @@ +--- +galaxy_info: + role_name: gitlab_runner + author: Adrien Waksberg + company: Adrien Waksberg + description: Install and configure Gitlab runner + license: Apache2 + min_ansible_version: 2.9 + + platforms: + - name: Debian + versions: + - buster + + galaxy_tags: + - git + - gitlab + - ci + +dependencies: [] diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml new file mode 100644 index 0000000..e33f215 --- /dev/null +++ b/molecule/default/converge.yml @@ -0,0 +1,12 @@ +--- +- name: Converge + hosts: all + roles: + - ansible-role-gitlab_runner + vars: + gitlab_runner_runners: + - name: test + url: https://gitlab.example.com + token: TesT + executor: docker + state: absent diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..c3a2f2c --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,22 @@ +--- +driver: + name: docker +platforms: + - name: debian10 + image: nishiki/debian10:molecule + privileged: true + volumes: + - /sys/fs/cgroup:/sys/fs/cgroup:ro + command: /bin/systemd + capabilities: + - SYS_ADMIN + exposed_ports: + - 22/tcp + published_ports: + - 0.0.0.0:2222:22/tcp +lint: | + set -e + yamllint . + ansible-lint +verifier: + name: testinfra diff --git a/molecule/default/tests/test_default.py b/molecule/default/tests/test_default.py new file mode 100644 index 0000000..54bbe9e --- /dev/null +++ b/molecule/default/tests/test_default.py @@ -0,0 +1,18 @@ +import testinfra.utils.ansible_runner + +def test_packages(host): + package = host.package('gitlab-runner') + assert package.is_installed + +def test_config_file(host): + config = host.file('/etc/gitlab-runner/config.toml') + assert config.exists + assert config.is_file + assert config.user == 'root' + assert config.group == 'root' + assert config.mode == 0o600 + +def test_service(host): + service = host.service('gitlab-runner') + assert service.is_running + assert service.is_enabled diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..aac17d4 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,37 @@ +--- +- name: add gpg key + apt_key: + url: https://packages.gitlab.com/runner/gitlab-runner/gpgkey + tags: gitlab-runner + +- name: add repository + apt_repository: + repo: '{{ gitlab_runner_repository }}' + tags: gitlab-runner + +- name: install package + package: + name: gitlab-runner + environment: + GITLAB_RUNNER_DISABLE_SKEL: 'true' + tags: gitlab-runner + +- name: register runners + gitlab_runner: + name: '{{ item.name }}' + url: '{{ item.url }}' + token: '{{ item.token }}' + executor: '{{ item.executor }}' + options: '{{ item.options|default({}) }}' + state: '{{ item.state|default("present") }}' + loop: '{{ gitlab_runner_runners }}' + loop_control: + label: '{{ item.name }}' + tags: gitlab-runner + +- name: enable and start service + service: + name: gitlab-runner + state: started + enabled: true + tags: gitlab-runner