foreman_hdm 0.1.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7c2f8cc35ed7ff2b93dc0b5dbb3976d300c816c1375d1f30f14a5a72efdca74
-  data.tar.gz: be8956fb7497b6687442f6baff9675456da71f6964c2576dd524ec232ddc91bc
+  metadata.gz: 55623f7a7440aaab0000cc55ec9ef7236cfc7e94ec5ebc4a32a9c1a62d11a736
+  data.tar.gz: 1d58c2bf7261cb3ab2ed3fe7fc9c02ab216be3ede3070b684a7dcf4e9544e64b
 SHA512:
-  metadata.gz: 2fe04c4f63dd2bea87d24e87024bbe289563e0899cbb13406f286d12e21022032d0802a98570c261c1649a47de5a6445e9f169370cbb8bda1b0607b66c829989
-  data.tar.gz: 7d80a489929d79c35155c8d4733da9bb5768fe7fd62eefd456033c5517630269438fcbba6b4e1a8bbcf9b471f31f2211d5c2ce041d17034c1f782eeed8127005
+  metadata.gz: a495decc3c8536fd6f04ed543e774e23d785fb7a19282c37baf33d166c1fc2333e7279f6a669817405e19b2dc6c252bfdf8f15663eb580c2cef1d0749a036dfb
+  data.tar.gz: 9489039656916e68b6125f8d1d59e030a16004fa2f77d1554240c427cacdf8ace1d08243ff8d60e777594c9f5edbcb24896e0fec9f1ed0938223145d1a7e8dd8

data/README.md

@@ -6,16 +6,44 @@
 [![RubyGem Version](https://img.shields.io/gem/v/foreman_hdm.svg)](https://rubygems.org/gems/foreman_hdm)
 [![RubyGem Downloads](https://img.shields.io/gem/dt/foreman_hdm.svg)](https://rubygems.org/gems/foreman_hdm)
 
-Browse hiera data for a given Host using [HDM](https://github.com/betadots/hdm) and the [HDM smart proxy plugin](https://github.com/betadots/foreman_hdm).
+Browse hiera data for a given Host using [HDM](https://github.com/betadots/hdm) and the [HDM smart proxy plugin](https://github.com/betadots/smart_proxy_hdm).
+
+## Requirement
+
+You must have a [HDM](https://github.com/betadots/hdm) installation running.
+If you are running with authentication enabled, you need an API user in HDM.
 
 ## Installation
 
 See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
 for how to install Foreman plugins
 
+The most simple way is installing from packages (available with Foreman 3.6 and later)
+
+RedHat: `dnf install rubygem-foreman_hdm rubygem-smart_proxy_hdm`
+
+After installation you must initialize the database: `foreman-rake db:migrate`
+
+The HDM Smart Proxy must be configured:
+
+```yaml
+# /etc/foreman-proxy/settings.d/hdm.yml
+# HDM Smart Proxy
+:enabled: https
+:hdm_url: 'http://<HDM IP>:<HDM Port>'
+:hdm_user: '<HDM API User Email>'
+:hdm_password: '<HDM API User Password>'
+```
+
+Next you must restart the smart-proxy: `systemctl restart foreman-proxy`
+
 ## Usage
 
-*Usage here*
+Go to Foreman and Refresh the Smart Proxy features.
+
+Within the nodes or node groups you can now set the HDM Smart Proxy.
+
+When you now select a node, you will see an HDM tab.
 
 ## TODO
 
@@ -53,3 +81,7 @@ To make a new release, please do:
     * if required, add labels to unlabled PR/issues, regenerate the changelog
 * Create a PR with it
 * After it got merged, push a tag that's prefixed with `v`. GitHub Actions will do the actual release to Rubygems and GitHub Packages
+
+The Foreman team packages this gem as Debian package (deb) and as RedHat package
+(rpm). They have a bot that will automatically propose an rpm/deb update at
+[github.com/theforeman/foreman-packaging](https://github.com/theforeman/foreman-packaging/pulls).

data/Rakefile

@@ -53,7 +53,7 @@ else
     version = ForemanHdm::VERSION
     config.future_release = "v#{version}" if /^\d+\.\d+.\d+$/.match?(version)
     config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
-    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions]
     config.user = 'betadots'
     config.project = 'foreman_hdm'
   end

data/db/migrate/20240228114101_add_foreign_key_to_hdm_proxy_id.rb

@@ -0,0 +1,5 @@
+class AddForeignKeyToHdmProxyId < ActiveRecord::Migration[6.1]
+  def change
+    add_foreign_key :hosts, :smart_proxies, column: :hdm_proxy_id, on_delete: :nullify
+  end
+end

data/lib/foreman_hdm/engine.rb

@@ -16,26 +16,28 @@ module ForemanHdm
       end
     end
 
-    initializer 'foreman_hdm.register_plugin', :before => :finisher_hook do |_app|
-      Foreman::Plugin.register :foreman_hdm do
-        requires_foreman '>= 3.4.0'
-
-        # Add Global files for extending foreman-core components and routes
-        register_global_js_file 'global'
-
-        # Add permissions
-        security_block :foreman_hdm do
-          permission :view_foreman_hdm, { :'foreman_hdm/keys' => %i[index show] }
+    initializer 'foreman_hdm.register_plugin', :before => :finisher_hook do |app|
+      app.reloader.to_prepare do
+        Foreman::Plugin.register :foreman_hdm do
+          requires_foreman '>= 3.4.0'
+
+          # Add Global files for extending foreman-core components and routes
+          register_global_js_file 'global'
+
+          # Add permissions
+          security_block :foreman_hdm do
+            permission :view_foreman_hdm, { :'foreman_hdm/keys' => %i[index show] }
+          end
+
+          # Add a new role called 'Discovery' if it doesn't exist
+          role 'ForemanHdm', [:view_foreman_hdm]
+
+          smart_proxy_for Host::Managed, :hdm_proxy,
+            feature: 'Hdm',
+            label: N_('HDM Proxy'),
+            description: N_('Smart proxy to access HDM'),
+            api_description: N_('ID of HDM Proxy')
         end
-
-        # Add a new role called 'Discovery' if it doesn't exist
-        role 'ForemanHdm', [:view_foreman_hdm]
-
-        smart_proxy_for Host, :hdm_proxy,
-          feature: 'Hdm',
-          label: N_('HDM Proxy'),
-          description: N_('Smart proxy to access HDM'),
-          api_description: N_('ID of HDM Proxy')
       end
     end
 

data/lib/foreman_hdm/version.rb

@@ -1,3 +1,3 @@
 module ForemanHdm
-  VERSION = '0.1.4'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_hdm
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.1.0
 platform: ruby
 authors:
 - betadots GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2025-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,87 +45,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.5'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: theforeman-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.52'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.52.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.52'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.52.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.31.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.31.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.18'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.19.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.19.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.1.2
 description: Get hiera data from HDM and display alongside hosts in Foreman
 email:
 - info@betadots.de
@@ -140,6 +72,7 @@ files:
 - app/services/proxy_api/hdm.rb
 - config/routes.rb
 - db/migrate/20230519125201_add_hdm_proxy_id_to_hosts.rb
+- db/migrate/20240228114101_add_foreign_key_to_hdm_proxy_id.rb
 - db/seeds.d/75-hdm_seeds.rb
 - lib/foreman_hdm.rb
 - lib/foreman_hdm/engine.rb
@@ -150,7 +83,6 @@ files:
 - locale/foreman_hdm.pot
 - locale/gemspec.rb
 - package.json
-- test/factories/foreman_hdm_factories.rb
 - test/test_plugin_helper.rb
 - test/unit/foreman_hdm_test.rb
 - webpack/global_index.js
@@ -165,10 +97,11 @@ files:
 - webpack/test_setup.js
 homepage: https://github.com/betadots/foreman_hdm
 licenses:
-- GPL-3.0
+- GPL-3.0-only
 metadata:
   is_foreman_plugin: 'true'
-post_install_message: 
+  github_repo: https://github.com/betadots/foreman_hdm
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,11 +116,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Display hiera data in Foreman using HDM
 test_files:
-- test/factories/foreman_hdm_factories.rb
 - test/test_plugin_helper.rb
 - test/unit/foreman_hdm_test.rb

data/test/factories/foreman_hdm_factories.rb

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