smart_proxy_salt 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3ac4ad731748d62d1ec922520aa60ce1a7db4b001b2aeaabfe9c2e0709e3f9e
-  data.tar.gz: b345c0ae059918e924a6ec771664a38e687d3b8a288559cd48274e271f69c551
+  metadata.gz: 6e76b784ec95950584ee9dc9601fd4b16502d24e948570f5c2e5cca2fc37cf48
+  data.tar.gz: be2a3a41b1bda928582f8f3f97b47e2fe544272efdba65ae11ca06d937b44551
 SHA512:
-  metadata.gz: 20b39c0f2ef2a6ea13cf94d996141ee1e28ff542fd8def32275560085b8f6c31e57d0d834e6179744c98a4eccfcb3efa4dc8ce74e178b0751103933253d1c465
-  data.tar.gz: d1dd34e0c168829fe049c8db0bb751782b3548a39566c530d148a00485fcf0c96c2fd52b96a7bb71b7a0ac3b9e5ea74629ab39e7b4ef166b1f0ba1163aa6fbd7
+  metadata.gz: 3ae10fb0bc8ca6451ef5c519fa9a229d34cb72e4fa06a4c1446e286bfb3f7abebb3019e0d8ad0911efee1304104d369da7214698716f285bfc011acc6c5b2adc
+  data.tar.gz: b1414a95f7fa718cf1b8720b5e592ab23177ff60c7180df87e9d928b6629925343276bb057e26ac56da4e77bf34826f7079f7daebb3bd6af910243d7abd0a80c

data/lib/smart_proxy_salt/version.rb

@@ -3,6 +3,6 @@
 module Proxy
   # Salt module
   module Salt
-    VERSION = '3.1.0'
+    VERSION = '3.1.1'
   end
 end

data/salt/report_upload/README.md

@@ -0,0 +1,31 @@
+# Foreman Salt Report Upload
+
+Currently, there are two possibilites to upload the salt report to Foreman:
+1. Use /usr/sbin/upload-salt-reports which is called by a cron job every 10 minutes by default
+2. Upload the report immediately by using a Salt Reactor.
+
+This README, handles the second option and how to configure it
+
+## Setup
+Add the content of 'master.snippet' to '/etc/salt/master' which configures a reactor. 
+In case there is already a reactor configured, you need to adapt it using the options mentioned in 'master.snippet'.
+
+In case '/srv/salt' is configured as 'file_roots' in your '/etc/salt/master' config, setup the necessary salt state file and Salt runner functions:
+
+```
+/srv/salt/foreman_report_upload.sls
+/srv/salt/_runners/foreman_report_upload.py
+```
+
+After changing the salt master run:
+
+```
+systemctl restart salt-master
+```
+
+After adding the foreman_report_upload.sls and foreman_report_upload.py, run the following:
+
+```
+salt-run saltutil.sync_all
+```
+

data/salt/report_upload/master.snippet

@@ -0,0 +1,3 @@
+reactor:
+  - 'salt/job/*/ret/*':
+    - /srv/salt/foreman_report_upload.sls

data/salt/report_upload/srv/salt/_runners/foreman_report_upload.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+'''
+Uploads reports from the Salt job cache to Foreman
+'''
+from __future__ import absolute_import, print_function, unicode_literals
+
+FOREMAN_CONFIG = '/etc/salt/foreman.yaml'
+
+try:
+    from http.client import HTTPConnection, HTTPSConnection
+except ImportError:
+    from httplib import HTTPSConnection, HTTPSConnection
+
+import ssl
+import json
+import yaml
+import os
+import sys
+import base64
+
+# Import python libs
+import logging
+
+log = logging.getLogger(__name__)
+
+
+def salt_config():
+    with open(FOREMAN_CONFIG, 'r') as f:
+        config = yaml.load(f.read())
+    return config
+
+
+def upload(report):
+    config = salt_config()
+    headers = {'Accept': 'application/json',
+               'Content-Type': 'application/json'}
+
+    if config[':proto'] == 'https':
+        ctx = ssl.create_default_context()
+        ctx.load_cert_chain(certfile=config[':ssl_cert'], keyfile=config[':ssl_key'])
+        if config[':ssl_ca']:
+          ctx.load_verify_locations(cafile=config[':ssl_ca'])
+        connection = HTTPSConnection(config[':host'],
+                port=config[':port'], context=ctx)
+    else:
+        connection = HTTPConnection(config[':host'],
+                port=config[':port'])
+        if ':username' in config and ':password' in config:
+            token = base64.b64encode('{}:{}'.format(config[':username'],
+                                                    config[':password']))
+            headers['Authorization'] = 'Basic {}'.format(token)
+
+    connection.request('POST', '/salt/api/v2/jobs/upload',
+            json.dumps(report), headers)
+    response = connection.getresponse()
+
+    if response.status == 200:
+        info_msg = 'Success {0}: {1}'.format(report['job']['job_id'], response.read())
+        log.info(info_msg)
+    else:
+        log.error("Unable to upload job - aborting report upload")
+        log.error(response.read())
+
+
+def create_report(json_str):
+    msg = json.loads(json_str)
+
+    return {'job':
+             {
+               'result': {
+                 msg['id']: msg['return'],
+               },
+               'function': 'state.highstate',
+               'job_id': msg['jid']
+             }
+           }
+
+
+def now(highstate):
+    '''
+    Upload a highstate to Foreman
+    highstate :
+        dictionary containing a highstate (generated by a Salt reactor)
+    '''
+    log.debug('Upload highstate to Foreman')
+
+    try:
+        report = create_report(highstate)
+        upload(report)
+    except Exception as exc:
+        log.error('Exception encountered: %s', exc)
+

data/salt/report_upload/srv/salt/foreman_report_upload.sls

@@ -0,0 +1,6 @@
+{% if 'cmd' in data and data['cmd'] == '_return' and 'fun' in data and data['fun'] == 'state.highstate' %}
+foreman_report_upload:
+  runner.foreman_report_upload.now:
+    - args: 
+      - highstate: '{{data|json}}'
+{% endif %}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_salt
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Michael Moll
@@ -9,64 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2019-11-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: logging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +122,10 @@ files:
 - lib/smart_proxy_salt_core/salt_runner.rb
 - lib/smart_proxy_salt_core/salt_task_launcher.rb
 - lib/smart_proxy_salt_core/version.rb
+- salt/report_upload/README.md
+- salt/report_upload/master.snippet
+- salt/report_upload/srv/salt/_runners/foreman_report_upload.py
+- salt/report_upload/srv/salt/foreman_report_upload.sls
 - sbin/upload-salt-reports
 - settings.d/salt.saltfile.example
 - settings.d/salt.yml.example