op5util 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98b7c7098263b0b79fbcc7dab53a96c1d66d9001
-  data.tar.gz: ed48f74b4482bc6d8a3e3688d7f6a5583526e1bd
+  metadata.gz: 5bab4098ca55a344b20d807011731cce8c646170
+  data.tar.gz: 759ed9612ee285dc48648ebd54dc3bbea4dc78ec
 SHA512:
-  metadata.gz: a4e6f2e3588cbbb251e67fe09ddfb4946d4b10715f3d6849d9d45699c7a610bae978e23f7d274c34f82e30afef19a58aa3d26d0f110fdaadaef316084e0da7e5
-  data.tar.gz: 837f71ec446b2151ac5c68ebf5e9ee412257fb97142dde0b0946c9e27f9937740f8b203c0923a4656d936cfa75249f2b2290fdfea3e9ab2e9f2fb809bb852bed
+  metadata.gz: 6da7903090af03d5d2011c0014a9171f1acceb56a5f27a7304807b0f6005a1a4382e274d91fdacabb639c8849a8201a82841b06a912b2038f0a4df13c7861816
+  data.tar.gz: 9a0e569b092a711731955ad31b2b853f61882b90eaa6e7fa744d72b64db787403ccd21b56b879e0300d559314ae69c59c505ed27cbfb74d506afa69de24bdb8f

data/Readme.md

@@ -1,4 +1,25 @@
-## Op5util
+# Op5util
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+- [Introduction](#introduction)
+- [Capabilities](#capabilities)
+- [Screenshots, example usage](#screenshots-example-usage)
+  - [Add a host to op5, check host status](#add-a-host-to-op5-check-host-status)
+  - [Another use case](#another-use-case)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Commands, help text example](#commands-help-text-example)
+- [Roadmap, TODO](#roadmap-todo)
+- [Contact, bug-reports etc](#contact-bug-reports-etc)
+- [Version history](#version-history)
+- [How op5util may be used with ansible](#how-op5util-may-be-used-with-ansible)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Introduction
 
 Are you using Op5? Perhaps you do most of your work from the command-line
 and want to be able to do the most common Op5 tasks without logging in
@@ -11,8 +32,8 @@ Those two use-cases were my biggest itches when I first started to use
 saved curl commands to interact with the REST-api and soon op5util.rb
 was born.
 
-The design nowdays is reasonable modular so new functions can be easily
-added if they are needed, pull requests are happily accepted.
+The design nowdays is reasonably modular so new functions can be easily
+added as needed, pull requests are happily accepted.
 
 I use op5util daily in a production environment, but it comes with no
 warranties.
@@ -24,13 +45,13 @@ Currently op5util have implemented these functions:
 * Add a new host to be monitored by Op5
 * Add a existing host to more hostgroups
 * Schedule downtime for a host
+* Acknowledge alarms for host/service
 * Show status summary of all services/host and summary of service per host
 * Show status summary of services for a host and list all services w. status for a host
 * Schedule forced checks of a host and the hosts services to be done now
 * List all hostgroups available, including members and service checks
-
-These are the most common vanilla administrative tasks I perform to keep
-the networked monitored.
+* List all hosts, with optioinal detailed info
+* Autocomplete template for bash/zsh is included
 
 ## Screenshots, example usage
 
@@ -42,9 +63,9 @@ Adding a host using ```op5util add -g linux_hosts wiki``` and at the same time a
 membership in the linux_hosts hostgroup for the host, so some standard service checks are
 defined.
 
-To avoid waiting for checks to be performed on the new host, we tell Op5 to check them
-now with the command ```op5util schedule wiki```, and after only a short wait we can
-take a look at the detailed host status with ```op5util status -l wiki```.
+To avoid waiting for checks to be performed on the new host, we tell Op5 to check the new
+host and it's services right away with the command ```op5util schedule wiki```, and after
+only a short wait we can take a look at the detailed host status with ```op5util status -l wiki```.
 
 ![Usage example](https://raw.githubusercontent.com/np422/Op5util/master/screenshots/usecase2.png)
 
@@ -62,37 +83,37 @@ with the terminal output by op5util.
 
 Op5util is installed using ```gem install op5util```
 
-The export of the environment variable MONITOR is to avoid using the command-line
-flag ```-m monitor.ipa.hemma``` on every command, and by saving credentials in the in the .op5pass
-file you don't need type the -u/-p thereafter.
+The export of the environment variable MONITOR and saving credentials in the in the .op5pass
+file is to avoid using the command-line flags ```-m monitor.ipa.hemma -u user -p password```
+on every command.
 
-Check the overall status with the command ```op5util status```, as one host is down we request more
-info to be displayed with ```op5util status -l```, and we see that the host gitlab01 is down, to
+First check the overall status with the command ```op5util status```, as one host is down we request
+more info to be displayed with ```op5util status -l```, and we see that the host gitlab01 is down, to
 acknowledge the alarms, ```op5util acknowledge gitlab01```.
 
-Once the problem is resolved and the host is up, ```op5util schedule gitlab01, because impatience,
- a final check with ```op5util status gitlab01```.
+Once the problem is resolved and the host is up, ```op5util schedule gitlab01```, because impatience,
+and a final check with ```op5util status gitlab01```.
 
 ![screenshot](https://raw.githubusercontent.com/np422/Op5util/master/screenshots/usecase1.png)
 
 ## Installation
 
-Install instructions intended for and tested on a fresh install of ubuntu 16.04.
+Install instructions are intended for and tested on a fresh install of ubuntu 16.04.
 
 Op5util is distributed as a ruby gem, so first ruby must be installed.
 
-``` shell
+```shell
 user@host:~$ sudo apt-get install -y ruby
 ```
 
-Use the command gem install, sudo is needed. This will automatically install op5util
-and the other gems that op5util depends on.
+Use the command gem install to install op5util, sudo is needed. This will automatically
+install op5util and the other gems that op5util depends on.
 
 ```shell
 user@host:~$ sudo gem install op5util
 ```
 
-Latest version is 0.1.6, you can verify that op5util is installed correctly with:
+The latest version is 0.1.7, you can verify that op5util is installed correctly using:
 
 ``` shell
 user@host:~$ gem list --details op5util
@@ -108,7 +129,7 @@ op5util (0.1.6)
     A utility to do common Op5 administration from the commandline
 ```
 
-Rubygem homepage for op5util is available at: https://rubygems.org/gems/op5util
+The rubygem homepage for op5util is available at: https://rubygems.org/gems/op5util
 
 ## Usage
 
@@ -116,9 +137,8 @@ There is no man-page, but the built in help text should do the job.
 
 If you enter the command ```op5util help``` the top-level documentation is displayed.
 
-IMHO git has very good command line interface and I've tried to make op5util to do user
-interaction in the same spirit as git.
-
+Help for a op5util command is diplayed with ```op5util help <command>```, examples are
+present below.
 
 ``` text
 NAME
@@ -139,7 +159,7 @@ SYNOPSIS
     op5util [global options] command [command options] [arguments...]
 
 VERSION
-    0.1.6
+    0.1.7
 
 GLOBAL OPTIONS
     -f, --authfile=authfile - Authfile containing "username:password" used to authenticate with Op5
@@ -161,6 +181,7 @@ COMMANDS
     add            - Add a new host to be monitored by the Op5 server
     add_hostgroups - Add host to a new hostgroup(s)
     autocomplete   - Show instruction on howto setup tab autocomplete for op5util in your shell
+    commit         - Commit any pending changes
     downtime       - Schedule fixed downtime for a host
     help           - Shows a list of commands or help for one command
     hosts          - List all hosts, or detailed information about a single host
@@ -171,11 +192,10 @@ COMMANDS
     status         - Show monitoring status, if no host is given all hosts/services are included
 ```
 
-### Command usage
-
-To get information about a specific command, use ```op5util help add``` , example below.
+### Commands, help text example
 
-``` textNAME
+``` text
+NAME
     add - Add a new host to be monitored by the Op5 server
 
 SYNOPSIS
@@ -202,18 +222,25 @@ COMMAND OPTIONS
 
 ## Roadmap, TODO
 
-A lot remains, the code really should be DRY'ied up, more automated pre-release tests, more
-documentation and perhaps even adding some more functions, but the current version of op5util
-is already useful to me in my day-time job, perhaps it also could be useful to other Op5
-administrators?
+A lot remains, the code really should be refactored and DRY'ied up, the commands probably need
+some re-thinking, more automated pre-release tests, more documentation and perhaps even
+adding some more functions, but the current version of op5util is already useful to me
+in my day-time job, perhaps it also could be useful to other Op5 administrators?
 
-Please, give my repo a github star or drop me line if you find this utility useful. Feel
-free to leave a bug-reports or feature requests as an issue in this repo.
+## Contact, bug-reports etc
 
-/Niklas
+Please, give my repo a github star or drop me line if you find this utility useful. You can
+contact me at niklasp@<insert googles mail-service here>.com
+
+And please feel free to leave bug-reports or feature requests as issues in this repo.
 
 ## Version history
 
+### 0.1.7
+
+New command 'commit' that commits any pending/unsaved changes done previously, combined with
+the option --no-commit on the add_host and add_hostgroup commands.
+
 ### 0.1.6
 
 New command 'hosts' which lists hosts, included example of ansible playbook
@@ -232,13 +259,13 @@ Gemspec filespec corrected to avoid unnecessary large .gem-files.
 Environment variable OP5AUTHFILE possible to use instead of --authfile, check permission
 of authfile and refuse to start if readable by other than owner.
 
-## Example, use op5util with ansible
+## How op5util may be used with ansible
 
 Use the example below as a source of inspiration on how op5util can be used from
 an ansible playbook.
 
 In this example the variable 'hostgroups', which should be a list, will be used to
-assign hostgroups, otherwise the default hostgroup 'linux_hosts' will beassigned.
+assign hostgroups, otherwise the default hostgroup 'linux_hosts' will be assigned.
 
 ``` yaml
 ---

data/bin/op5util

@@ -54,6 +54,9 @@ command :add do |c|
   c.desc 'IP-address of host, resolved with DNS from hostname if not supplied'
   c.flag [:i, :ipaddr]
 
+  c.desc 'Don\'t commit changes upon exit'
+  c.switch [:n, 'no-commit'.to_sym]
+
   c.action do |_global_options, options, args|
     # Your command logic here
     # If you have any errors, just raise them
@@ -69,8 +72,11 @@ command :add_hostgroups do |c|
   c.desc 'Hostgroup(s) that host should be a member of'
   c.flag [:g, :hostgroups], :multiple => true
 
+  c.desc 'Don\'t commit changes upon exit'
+  c.switch [:n, 'no-commit'.to_sym]
+
   c.action do |_global_options, options, args|
-    monitor.add_hostgroups(args[0], options[:hostgroups])
+    monitor.add_hostgroups(args[0], options[:hostgroups], options['no-commit'.to_sym])
   end
 end
 
@@ -100,7 +106,7 @@ command :status do |c|
   c.desc 'Print only a brief status information with stats summarized'
   c.switch [:s, :short]
 
-  c.desc 'Print a summary with hosts listed and service information per hsot'
+  c.desc 'Print a summary with hosts listed and service information per host'
   c.switch [:l, :long]
 
   c.action do |_global_options, options, args|
@@ -121,7 +127,6 @@ command :acknowledge do |c|
 
   c.desc 'Make comment persistent after problems are resolved'
   c.switch [:p, :persistent]
-
   c.desc 'Print more verbose output'
   c.switch [:v, :verbose]
 
@@ -174,6 +179,13 @@ command :autocomplete do |c|
   end
 end
 
+desc 'Commit any pending changes'
+command :commit do |c|
+  c.action do
+    monitor.commit_op5_config
+  end
+end
+
 pre do |global, _command, _options, _args|
   global[:authfile] = ENV['OP5AUTHFILE'] if !ENV['OP5AUTHFILE'].nil? && (global[:authfile] == '~/.op5pass')
   Op5util.check_auth(global) ? true : false

data/lib/op5util/add_host.rb

@@ -16,12 +16,7 @@ module Op5util
                                  headers: { 'Content-Type' => 'application/json' },
                                  body: body, basic_auth: @auth, verify: false)
       raise ApiError, "Response code: #{response.code}, Message: #{response.body}" if response.code != 201
-      puts 'New host created'
-
-      url = @base_uri + 'config/change'
-      response = self.class.post(url, body: {}, basic_auth: @auth, verify: false)
-      raise ApiError, "Response code: #{response.code}, Message: #{response.body}" if response.code != 200
-      puts 'New op5-config saved'
+      commit_op5_config unless options['no-commit'.to_sym]
     end
 
     private

data/lib/op5util/add_hostgroups.rb

@@ -5,7 +5,7 @@ module Op5util
   class NoSuchHostError < StandardError; end
   # Foo
   class Monitor
-    def add_hostgroups(host, hostgroups)
+    def add_hostgroups(host, hostgroups, no_commit_config)
       hostgroups.each do |group|
         members = get_hostgroup_members(group)
         if !members.grep(host).empty?
@@ -16,6 +16,7 @@ module Op5util
           update_hostgroup(group, members)
         end
       end
+      commit_op5_config unless no_commit_config
     end
 
     private

data/lib/op5util/autocomplete.rb

@@ -20,28 +20,28 @@ _op5util()
 
     case "${op5command}" in
         acknowledge)
-            COMPREPLY=( $(compgen -W "-c --comment=Work_in_Progress -p --persistent --no-persistent -v --verbose --no-verbose SOME_OP5_HOST" -- ${cur}) )
+            COMPREPLY=( $(compgen -W "-c --comment=Work_in_Progress -p --persistent --no-persistent -v --verbose --no-verbose $(op5util hosts)" -- ${cur}) )
             ;;
         add)
-            COMPREPLY=( $(compgen -W "-a --alias=\" -c --contactgroups=\" -g --hostgroups=\" -i --ipaddr=\" HOST_TO_ADD" -- ${cur}) )
+            COMPREPLY=( $(compgen -W "-a --alias=\" -c --contactgroups=\" -g --hostgroups=\" -i --ipaddr=\" HOST_TO_ADD  $(op5util hostgroups)" -- ${cur}) )
             ;;
         add_hostgroups)
-            COMPREPLY=( $(compgen -W "-g --hostgroup= SOME_OP5_HOST" -- ${cur}) )
+            COMPREPLY=( $(compgen -W "-g --hostgroup=  $(op5util hosts)" -- ${cur}) )
             ;;
         autocomplete)
             COMPREPLY=( $(compgen -W "ENTER" -- ${cur}) )
             ;;
         downtime)
-            COMPREPLY=( $(compgen -W "-t --time=n_hour_duration_of_downtime -w --wait=n_hours_before_downtime_start -c --comment= SOME_OP5_HOST" -- ${cur}) )
+            COMPREPLY=( $(compgen -W "-t --time=n_hour_duration_of_downtime -w --wait=n_hours_before_downtime_start -c --comment=  $(op5util hosts)" -- ${cur}) )
             ;;
         hostgroups)
-            COMPREPLY=( $(compgen -W "-l --long SOME_OP5_HOSTGROUP" -- ${cur}) )
+            COMPREPLY=( $(compgen -W "-l --long  $(op5util hostgroups)" -- ${cur}) )
             ;;
         schedule)
-            COMPREPLY=( $(compgen -W "-v --verbose SOME_OP5_HOST" -- ${cur}) )
+            COMPREPLY=( $(compgen -W "-v --verbose  $(op5util hosts)" -- ${cur}) )
             ;;
         status)
-            COMPREPLY=( $(compgen -W "-l --long -s --short SOME_OP5_HOST" -- ${cur}) )
+            COMPREPLY=( $(compgen -W "-l --long -s --short  $(op5util hosts)" -- ${cur}) )
             ;;
         *)
             ;;

data/lib/op5util/commit.rb

@@ -0,0 +1,31 @@
+module Op5util
+  require 'resolv'
+  class ApiError < StandardError; end
+  # Foo
+  class Monitor
+    def commit_op5_config
+      if pending_changes.empty?
+        puts 'No changes to commit'
+      else
+        do_commit
+      end
+    end
+
+    private
+
+    def pending_changes
+      url = @base_uri + 'config/change'
+      response = self.class.get(url, basic_auth: @auth, verify: false)
+      raise ApiError, "Response code: #{response.code}, Message: #{response.body}" if response.code != 200
+      JSON.parse!(response.body)
+    end
+
+    def do_commit
+      url = @base_uri + 'config/change'
+      response = self.class.post(url, body: {}, basic_auth: @auth, verify: false)
+      raise ApiError, "Response code: #{response.code}, Message: #{response.body}" if response.code != 200
+      puts 'Op5-config commited'
+    end
+
+  end
+end

data/lib/op5util/version.rb

@@ -1,3 +1,3 @@
 module Op5util
-  VERSION = '0.1.6'.freeze
+  VERSION = '0.1.7'.freeze
 end

data/lib/op5util.rb

@@ -11,3 +11,4 @@ require 'op5util/list_hostgroups.rb'
 require 'op5util/schedule_checks.rb'
 require 'op5util/autocomplete.rb'
 require 'op5util/list_hosts.rb'
+require 'op5util/commit.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: op5util
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Niklas Paulsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -127,6 +127,7 @@ files:
 - lib/op5util/add_hostgroups.rb
 - lib/op5util/autocomplete.rb
 - lib/op5util/check_auth.rb
+- lib/op5util/commit.rb
 - lib/op5util/list_hostgroups.rb
 - lib/op5util/list_hosts.rb
 - lib/op5util/method_template.rb
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A utility to do common Op5 administration from the commandline