From 9266bcdbe66f2075513c1735c4170a348389b2da Mon Sep 17 00:00:00 2001 From: Mooash Date: Wed, 15 Apr 2015 10:45:29 +1000 Subject: [PATCH] Updating CONTRIBUTING --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++- LICENSE | 1 - README.md | 1 - defaults/main.yml | 1 - handlers/main.yml | 1 - meta/main.yml | 1 - tasks/main.yml | 1 - tasks/packages-archlinux.yml | 1 - tasks/packages-debian.yml | 1 - tasks/packages-redhat.yml | 1 - templates/nrpe.cfg.j2 | 1 - templates/nrpe_ansible.cfg.j2 | 1 - vars/Archlinux.yml | 1 - vars/Debian.yml | 1 - vars/RedHat-x64.yml | 1 - vars/RedHat-x86.yml | 1 - vars/RedHat.yml | 1 - 17 files changed, 39 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 096969f..a2e47c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,2 +1,40 @@ -Please see my contributing rules outlined here: http://mooash.github.io/contributing/ +### General +I've set some general contribution outlines [here](https://mooash.github.io/contributing/#pk_campaign=GitHub-Project&pk_kwd=nagios-nrpe-server). Please read them before opening a pull request. + +### Project Specific + +#### Ansible formatting + +I try and follow Ansible's [playbook best practices](https://docs.ansible.com/playbooks_best_practices.html) to the best of my ability. That said, these rules always apply: + + * [Always Mention The State](https://docs.ansible.com/playbooks_best_practices.html#always-mention-the-state) + * Move big plays to multiple lines. Plays like template look ugly on single lines. + Not OK: + + ```yaml + # Create nrpe_ansible.cfg + - name: Create nrpe_ansible.cfg from template + sudo: true + template: src="nrpe_ansible.cfg.j2" dest="{{ nagios_nrpe_server_dir }}/nrpe_ansible.cfg" owner=root group=root mode=0644 + notify: restart nagios-nrpe-server + ``` + + OK: + + ```yaml + # Create nrpe_ansible.cfg + - name: Create nrpe_ansible.cfg from template + sudo: true + template: > + src="nrpe_ansible.cfg.j2" + dest="{{ nagios_nrpe_server_dir }}/nrpe_ansible.cfg" + owner=root group=root mode=0644 + notify: restart nagios-nrpe-server + ``` + * If a play is OS specific, state it in the play name. + eg: `- name: Installing packages [Debian]` or `- name: Installing packages [RedHat]` + +### Questions? + +If you're confused on any of the above, just contact me so I can clear up my documentation. diff --git a/LICENSE b/LICENSE index f2830d1..ba39607 100644 --- a/LICENSE +++ b/LICENSE @@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - diff --git a/README.md b/README.md index a08fc04..eedfb97 100644 --- a/README.md +++ b/README.md @@ -68,4 +68,3 @@ Author Information ------------------ Checkout my blog [here](http://www.mooash.me) - diff --git a/defaults/main.yml b/defaults/main.yml index c5030e0..97df8e7 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -2,4 +2,3 @@ nagios_nrpe_server_bind_address: 127.0.0.1 nagios_nrpe_server_port: 5666 nagios_nrpe_server_allowed_hosts: 127.0.0.1 - diff --git a/handlers/main.yml b/handlers/main.yml index 6881f4c..b04b6b5 100644 --- a/handlers/main.yml +++ b/handlers/main.yml @@ -6,4 +6,3 @@ - name: restart nagios-nrpe-server sudo: true service: name="{{ nagios_nrpe_server_service }}" state=restarted - diff --git a/meta/main.yml b/meta/main.yml index 81d548e..3acafb9 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -21,4 +21,3 @@ galaxy_info: - monitoring - system dependencies: [] - diff --git a/tasks/main.yml b/tasks/main.yml index 2f314f0..38b0bc1 100644 --- a/tasks/main.yml +++ b/tasks/main.yml @@ -59,4 +59,3 @@ - name: Ensure NRPE server is running sudo: true service: name="{{ nagios_nrpe_server_service }}" state=started enabled=yes - diff --git a/tasks/packages-archlinux.yml b/tasks/packages-archlinux.yml index 73ef0e5..e0d1cfb 100644 --- a/tasks/packages-archlinux.yml +++ b/tasks/packages-archlinux.yml @@ -8,4 +8,3 @@ - name: Install Nagios NRPE Server [Arch Linux] sudo: true pacman: name=nrpe state=present - diff --git a/tasks/packages-debian.yml b/tasks/packages-debian.yml index 28e0e09..6e8b0ae 100644 --- a/tasks/packages-debian.yml +++ b/tasks/packages-debian.yml @@ -8,4 +8,3 @@ - name: Install Nagios NRPE Server [Debian] sudo: true apt: name=nagios-nrpe-server state=present - diff --git a/tasks/packages-redhat.yml b/tasks/packages-redhat.yml index 6129b5f..50261c7 100644 --- a/tasks/packages-redhat.yml +++ b/tasks/packages-redhat.yml @@ -10,4 +10,3 @@ sudo: true yum: name=nagios-plugins-all state=present enablerepo="{{ nagios_nrpe_server_repo_redhat }}" notify: restart nagios-nrpe-server - diff --git a/templates/nrpe.cfg.j2 b/templates/nrpe.cfg.j2 index 2c1d629..9b46783 100644 --- a/templates/nrpe.cfg.j2 +++ b/templates/nrpe.cfg.j2 @@ -213,4 +213,3 @@ include={{ nagios_nrpe_server_dir }}/nrpe_ansible.cfg # only snipplets ending in .cfg will get included include_dir={{ nagios_nrpe_server_dir }}/nrpe.d/ {% endif %} - diff --git a/templates/nrpe_ansible.cfg.j2 b/templates/nrpe_ansible.cfg.j2 index 5f1cf78..1868d71 100644 --- a/templates/nrpe_ansible.cfg.j2 +++ b/templates/nrpe_ansible.cfg.j2 @@ -5,4 +5,3 @@ # Example check command[check_mailq]={{ nagios_nrpe_server_plugins_dir }}/check_mailq -c 50 -w 20 - diff --git a/vars/Archlinux.yml b/vars/Archlinux.yml index f368bca..1100997 100644 --- a/vars/Archlinux.yml +++ b/vars/Archlinux.yml @@ -7,4 +7,3 @@ nagios_nrpe_server_group: 31 nagios_nrpe_server_service: nrpe nagios_nrpe_server_plugins_dir: /usr/lib/monitoring-plugins nagios_nrpe_server_dir: /etc/nrpe - diff --git a/vars/Debian.yml b/vars/Debian.yml index c798c6f..2034ed8 100644 --- a/vars/Debian.yml +++ b/vars/Debian.yml @@ -9,4 +9,3 @@ nagios_nrpe_server_group: nagios nagios_nrpe_server_service: nagios-nrpe-server nagios_nrpe_server_plugins_dir: /usr/lib/nagios/plugins nagios_nrpe_server_dir: /etc/nagios - diff --git a/vars/RedHat-x64.yml b/vars/RedHat-x64.yml index 8acf17e..1605107 100644 --- a/vars/RedHat-x64.yml +++ b/vars/RedHat-x64.yml @@ -1,2 +1 @@ nagios_nrpe_server_plugins_dir: /usr/lib64/nagios/plugins - diff --git a/vars/RedHat-x86.yml b/vars/RedHat-x86.yml index f2d66ef..8b7f02a 100644 --- a/vars/RedHat-x86.yml +++ b/vars/RedHat-x86.yml @@ -1,2 +1 @@ nagios_nrpe_server_plugins_dir: /usr/lib/nagios/plugins - diff --git a/vars/RedHat.yml b/vars/RedHat.yml index 7914dff..777f705 100644 --- a/vars/RedHat.yml +++ b/vars/RedHat.yml @@ -9,4 +9,3 @@ nagios_nrpe_server_group: nrpe nagios_nrpe_server_repo_redhat: epel nagios_nrpe_server_service: nrpe nagios_nrpe_server_dir: /etc/nagios -