foreman_abrt 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 769f6ad2b02f93ffcdb04442d9d7dc40112fd021
-  data.tar.gz: acd38d6397e402ea73ff985fe5acfcda26166ed9
+  metadata.gz: cfaeae561a0aa0b23662859fa0ec95cf5cedcf48
+  data.tar.gz: 07905ce91d1c21b2460308238f48bc9fb426a9e6
 SHA512:
-  metadata.gz: 54d6109b36930d19c2f1d0a17f66c7215a5315fe45e17425c2356438566562357fbc5ba4ad6f056ef4c642f7db46921211364e079f46b15a868afe99f7f7e50d
-  data.tar.gz: ef725709ff54801474564ba87af02cc61dd819b250d19e199703d4b770bc849a74f2bf1dd11d3aef6007a830b13595370c7570fc6c9be74e8dda7d4ca7cf6dd2
+  metadata.gz: e4db6b1b79e7eb4c8c6b4844adc409dbff7e30c7ee46c6897c02d77b93dd1faa113ccdfe18c5f48e297599489cdf90147bc304b06905eb5af07bd5148dfe0cf9
+  data.tar.gz: 68d43a865cec510d101841d39fabdb92a40e42ed07c9b9b27bd1105cac980da58c0f85810465cbeff1f1d333de39680fd3ec40b43aa5b73d9d5676cdc1cc4d44

data/README.md

@@ -25,19 +25,33 @@ for analysis.
 
 ![foreman abrt workflow](/extra/foreman_abrt_workflow.png?raw=true)
 
+### Network ports
+
+Reports from managed hosts are sent to smart-proxy's https port which is 8443
+for standalone Foreman installations and 9090 for Katello.
+
+The proxy sends the reports using Foreman's API, which normally runs on
+standard https (port 443).
+
 ## Installation
 
 To be able to see ABRT problem reports in your Foreman instance, you need to
 install the plugin itself, install ABRT plugin for your smart proxies and
 configure your hosts to send the problem reports to their smart proxy.
 
+Please note that the configuration is slightly different when using Foreman
+stand-alone and when it is part of Katello. Any configuration specific to
+**Katello** will be explicitly indicated.
+
 Both plugins are available as RPMs in [Foreman YUM repositories](http://yum.theforeman.org/).
 
 ### Prerequisites
 
 The plugins require both Foreman and smart-proxy to be version 1.7 or later.
 
-The plugins have been tested on Fedora 19, RHEL 6 and RHEL 7.
+The plugins have been tested on Fedora 19, RHEL 6 and RHEL 7. Versions of the
+plugins compatible with Katello are `foreman_abrt-0.0.4` and
+`smart_proxy_abrt-0.0.6`.
 
 To have hosts automatically send ureports to Foreman, you need to have ABRT
 2.1.11 or higher installed on them. RHEL 7 and Fedora 19 and higher satisfy
@@ -63,18 +77,6 @@ You need to install the `rubygem-smart_proxy_abrt` package.
 
 The plugin needs some configuration in order to work correctly.
 
-- Edit `/etc/foreman-proxy/settings.yml` to configure the main Foreman host,
-  which is normally not needed. Assuming Foreman runs on `f19-foreman.tld` the
-  file should contain following:
-
-  ```
-  # URL of your foreman instance
-  :foreman_url: https://f19-foreman.tld
-  ```
-  Please note that the `:foreman_url:` setting may be entirely missing in the
-  file. In that case just add the line to the end of
-  `/etc/foreman-proxy/settings.yml`.
-
 - Ensure that `/etc/foreman-proxy/settings.d/abrt.yml` contains the following line:
   ```
   :enabled: true
@@ -93,13 +95,20 @@ The plugin needs some configuration in order to work correctly.
 ### Configuring hosts to send problem reports to Foreman
 
 This setup needs to be performed on every host that you wish to report its
-crashes to Foreman.
+crashes to Foreman. The host has to be managed by Puppet, i.e. host record must
+exist in Foreman web interface.
 
 - Make sure that ABRT is installed and running.
   ```
-  ~# yum install abrt-cli
-  ~# systemctl start abrtd
-  ~# systemctl start abrt-ccpp
+  yum install abrt-cli
+  systemctl start abrtd abrt-ccpp
+  systemctl enable abrtd abrt-ccpp
+  ```
+
+- Enable auto-reporting by running the following command:
+
+  ```
+  abrt-auto-reporting enabled
   ```
 
 - Configure ABRT reporting destination -
@@ -107,7 +116,7 @@ crashes to Foreman.
 
   ```
   # URL of your foreman-proxy, with /abrt path.
-  URL = https://f19-smartproxy.tld:8443/abrt
+  URL = https://smartproxy.tld:8443/abrt
   # Verify the server certificate.
   SSLVerify = yes
   # This asks puppet config for the path to the ceritificates. you can
@@ -116,28 +125,45 @@ crashes to Foreman.
   SSLClientAuth = puppet
   ```
 
+  **Katello:** when using Foreman with Katello, the host needs to be registered
+  (using subscription-manager) to your Katello instance. You can find the
+  registration instructions on `https://foreman.tld/content_hosts/register`.
+  The `/etc/libreport/plugins/ureport.conf` file should instead contain the
+  following:
+
+  ```
+  # URL of your foreman-proxy, with /abrt path.
+  URL = https://smartproxy.tld:9090/abrt
+  # Verify the server certificate.
+  SSLVerify = yes
+  # Use the subscription management certificates to authenticate to the proxy.
+  SSLClientAuth = /etc/pki/consumer/cert.pem:/etc/pki/consumer/key.pem
+  ```
+
 - Add the Puppet CA to the list of trusted certificate authorities. This is
   needed for verifying the validity of smart-proxy's certificate:
 
   ```
-  ~# cp /var/lib/puppet/ssl/certs/ca.pem /etc/pki/ca-trust/source/anchors/
-  ~# update-ca-trust
+  cp /var/lib/puppet/ssl/certs/ca.pem /etc/pki/ca-trust/source/anchors/
+  update-ca-trust
   ```
 
-- Enable auto-reporting by running the following command:
+  **Katello:** when using Foreman with Katello, the subscription management
+  certificate should be used instead:
 
   ```
-  ~# abrt-auto-reporting enabled
+  cp /etc/rhsm/ca/katello-server-ca.pem /etc/pki/ca-trust/source/anchors/
+  update-ca-trust
   ```
 
 ### Verifying that the setup works
 
 You can verify your setup by crashing something on your managed host. We have a
-set of utilities in the Fedora repository especially for this purpose:
+set of utilities in the Fedora/EPEL repository especially for this purpose:
 
 ```
-~# yum -y install will-crash
-~$ will_segfault
+yum -y install will-crash
+will_segfault
 Will segfault.
 Segmentation fault (core dumped)
 ```
@@ -149,14 +175,27 @@ default). This means that within half an hour you should be able to see the bug
 report in the Foreman web interface. You can send the reports to Foreman
 manually by running the `smart-proxy-abrt-send` command.
 
-If the will-crash package is not available, you can try the following. Please
-make sure not to actually report this to `sleep` maintainers, though:
+Please note that you need to enable the
+[EPEL](https://fedoraproject.org/wiki/EPEL) repository if you are using RHEL in
+order to install will-crash. If the will-crash package is not available, you
+can try the following. Please make sure not to actually report this to `sleep`
+maintainers, though:
 
 ```
-~$ sleep 1d &
-~$ kill -SEGV $!
+sleep 1d &
+kill -SEGV $!
 ```
 
+### Testing aggregation
+
+If you crash the same program twice (on one host) within the same period that
+smart-proxy waits between forwarding the reports to foreman, then only one
+report with count = 2 should appear in the web interface.
+
+However, be careful about ABRT's rate limiting - if you crash a program
+and then crash it again sooner that 20 seconds then the second crash is
+simply ignored.
+
 ## Usage
 
 The list of received problem reports can be accessed by clicking on *Problem
@@ -197,4 +236,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

data/app/models/abrt_report.rb

@@ -41,7 +41,7 @@ class AbrtReport < ActiveRecord::Base
 
   def self.import(json)
     reports = []
-    host    = Host.find_by_name(json[:host])
+    host    = Host.find_by_name(json[:host]) || Host.joins(:provision_interface).where({:nics => {:ip => json[:host]}}).try(:first)
 
     # If the host lookup failed, it is possible that we are using subscription management certificates which
     # have UUID in their CN instead of host's FQDN. Try asking Katello if it knows host with such UUID.

data/db/migrate/20140414095631_create_abrt_reports.rb

@@ -13,7 +13,7 @@ class CreateAbrtReports < ActiveRecord::Migration
       t.boolean :response_known
       t.string :response_bthash
 
-      t.timestamps
+      t.timestamps :null => false
     end
 
     create_table :abrt_report_response_destinations do |t|

data/db/seeds.d/75-abrt-seeds.rb

@@ -1,2 +1,3 @@
 # Create feature for Smart Proxy
-Feature.find_or_create_by_name('Abrt')
+f = Feature.where(:name => 'Abrt').first_or_create
+raise "Unable to create Abrt proxy feature: #{format_errors f}" if f.nil? || f.errors.any?

data/lib/foreman_abrt/engine.rb

@@ -15,12 +15,14 @@ module ForemanAbrt
 
     # Add any db migrations
     initializer 'foreman_abrt.load_app_instance_data' do |app|
-      app.config.paths['db/migrate'] += ForemanAbrt::Engine.paths['db/migrate'].existent
+      ForemanAbrt::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
     end
 
     initializer 'foreman_abrt.register_plugin', :after=> :finisher_hook do |app|
       Foreman::Plugin.register :foreman_abrt do
-        requires_foreman '>= 1.5'
+        requires_foreman '>= 1.8'
 
         # Add permissions
         security_block :foreman_abrt do

data/lib/foreman_abrt/version.rb

@@ -1,3 +1,3 @@
 module ForemanAbrt
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: foreman_abrt
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Martin Milata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
   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'
 description: Foreman plugin that allows you to see problem reports submitted by Automatic
@@ -32,44 +32,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/overrides/add_host_bug_report_tab.rb
-- app/assets/stylesheets/abrt_reports.css
+- LICENSE
+- README.md
+- Rakefile
 - app/assets/javascripts/abrt_reports.js
-- app/views/abrt_reports/_host_tab_pane.html.erb
-- app/views/abrt_reports/_host_tab.html.erb
-- app/views/abrt_reports/_basic_auth_modal.html.erb
-- app/views/abrt_reports/index.html.erb
-- app/views/abrt_reports/_show_response.html.erb
-- app/views/abrt_reports/_list.html.erb
-- app/views/abrt_reports/show.html.erb
-- app/views/dashboard/_foreman_abrt_widget.html.erb
-- app/helpers/abrt_reports_helper.rb
-- app/controllers/concerns/foreman_abrt/dashboard_controller_extensions.rb
-- app/controllers/api/v2/abrt_reports_controller.rb
+- app/assets/stylesheets/abrt_reports.css
 - app/controllers/abrt_reports_controller.rb
-- app/models/setting/abrt.rb
-- app/models/concerns/foreman_abrt/host_extensions.rb
+- app/controllers/api/v2/abrt_reports_controller.rb
+- app/controllers/concerns/foreman_abrt/dashboard_controller_extensions.rb
+- app/helpers/abrt_reports_helper.rb
 - app/models/abrt_report.rb
 - app/models/abrt_report_response_destination.rb
 - app/models/abrt_report_response_solution.rb
+- app/models/concerns/foreman_abrt/host_extensions.rb
+- app/models/setting/abrt.rb
+- app/overrides/add_host_bug_report_tab.rb
+- app/views/abrt_reports/_basic_auth_modal.html.erb
+- app/views/abrt_reports/_host_tab.html.erb
+- app/views/abrt_reports/_host_tab_pane.html.erb
+- app/views/abrt_reports/_list.html.erb
+- app/views/abrt_reports/_show_response.html.erb
+- app/views/abrt_reports/index.html.erb
+- app/views/abrt_reports/show.html.erb
+- app/views/dashboard/_foreman_abrt_widget.html.erb
 - config/routes.rb
 - db/migrate/20140414095631_create_abrt_reports.rb
 - db/migrate/20140909170102_abrt_reports_drop_timestamps.rb
 - db/seeds.d/75-abrt-seeds.rb
+- lib/foreman_abrt.rb
 - lib/foreman_abrt/engine.rb
 - lib/foreman_abrt/version.rb
-- lib/foreman_abrt.rb
 - lib/tasks/foreman_abrt_tasks.rake
-- LICENSE
-- Rakefile
-- README.md
-- test/unit/abrt_report_test.rb
-- test/unit/helpers/abrt_reports_helper_test.rb
-- test/unit/foreman_abrt_test.rb
-- test/functional/abrt_reports_controller_test.rb
 - test/fixtures/abrt_reports.yml
+- test/functional/abrt_reports_controller_test.rb
 - test/test_plugin_helper.rb
-- test/factories/foreman_abrt_factories.rb
+- test/unit/abrt_report_test.rb
+- test/unit/foreman_abrt_test.rb
+- test/unit/helpers/abrt_reports_helper_test.rb
 homepage: http://github.com/abrt/foreman_abrt
 licenses:
 - GPL-3.0
@@ -80,25 +79,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Display reports from Automatic Bug Reporting Tool
 test_files:
-- test/unit/abrt_report_test.rb
-- test/unit/helpers/abrt_reports_helper_test.rb
-- test/unit/foreman_abrt_test.rb
+- test/test_plugin_helper.rb
 - test/functional/abrt_reports_controller_test.rb
 - test/fixtures/abrt_reports.yml
-- test/test_plugin_helper.rb
-- test/factories/foreman_abrt_factories.rb
+- test/unit/abrt_report_test.rb
+- test/unit/foreman_abrt_test.rb
+- test/unit/helpers/abrt_reports_helper_test.rb

data/test/factories/foreman_abrt_factories.rb

@@ -1,5 +0,0 @@
-FactoryGirl.define do
-  factory :host do
-    name 'foreman_abrt'
-  end
-end