foreman_hdm 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 473023f43bfd717f01a3560ea976b73fff89a9eb5f08ae8cb76f0dba17757df1
-  data.tar.gz: bce2799c02ae390435d2729e2ab6dc19f5737ffca65ba0d040127a4b3bb44c94
+  metadata.gz: 7c627d0c4d9425e3ccf9b2866feff8366ddcbf1ab3908e8cbb5d952de721b5ec
+  data.tar.gz: 96320bc1d09351c736ac810184c60fac735c46579ed9c92691faa0bfe5fb8498
 SHA512:
-  metadata.gz: 65aa3f660466e3f61392c8f5d314fb2186e8d9b0b6347b6a9a990e499b0bb773f69ac57f40bd23fdf6c7c75db68ef91dfc1e4ad569cc6844f2917cf7eee169e9
-  data.tar.gz: b115f38bf4c72167c09112404633377fb752bfee1d351c2b5f97a9bb91591857e17c577a74f4989c293942c9d79adb741a9e0da80555d59d80cd6cba5a56b96b
+  metadata.gz: b6e70f150af87ab8833f3c8c7c214477f269df2153591ad005ea681c19d4cda99c9c3ded8de7a0db7a37b31c977aa0d01a6603e65d16b612f3dd477abf60a4b1
+  data.tar.gz: 8cc9fb9f1fdfe3051262136b2c7ee21b9ab2260435d28ac6673b0bf04c491715419947a452b24cdc5fa545fc64f455e5c5a85e63655687ea1a22c3a06e381910

data/README.md

@@ -1,15 +1,49 @@
 # ForemanHdm
 
+[![License](https://img.shields.io/github/license/betadots/foreman_hdm.svg)](https://github.com/betadots/foreman_hdm/blob/master/LICENSE)
+[![Test](https://github.com/betadots/foreman_hdm/actions/workflows/test.yml/badge.svg)](https://github.com/betadots/foreman_hdm/actions/workflows/test.yml)
+[![Release](https://github.com/betadots/foreman_hdm/actions/workflows/release.yml/badge.svg)](https://github.com/betadots/foreman_hdm/actions/workflows/release.yml)
+[![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/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
 
@@ -36,3 +70,14 @@ 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/>.
 
+## Release a new version
+
+To make a new release, please do:
+
+* update the version in `lib/foreman_hdm/version.rb`
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+    * 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

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

@@ -31,7 +31,7 @@ module ForemanHdm
         # Add a new role called 'Discovery' if it doesn't exist
         role 'ForemanHdm', [:view_foreman_hdm]
 
-        smart_proxy_for Host, :hdm_proxy,
+        smart_proxy_for Host::Managed, :hdm_proxy,
           feature: 'Hdm',
           label: N_('HDM Proxy'),
           description: N_('Smart proxy to access HDM'),

data/lib/foreman_hdm/version.rb

@@ -1,3 +1,3 @@
 module ForemanHdm
-  VERSION = '0.1.3'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/package.json

@@ -21,7 +21,7 @@
     "url": "http://projects.theforeman.org/projects/foreman_hdm/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 6.0.0"
+    "@theforeman/vendor": ">= 12.0.1"
   },
   "dependencies": {
     "react-intl": "^2.8.0"
@@ -29,12 +29,11 @@
   "devDependencies": {
     "@babel/core": "^7.7.0",
     "@sheerun/mutationobserver-shim": "^0.3.3",
-    "@theforeman/builder": "^6.0.0",
-    "@theforeman/eslint-plugin-foreman": "6.0.0",
-    "@theforeman/find-foreman": "^4.8.0",
-    "@theforeman/stories": "^7.0.0",
-    "@theforeman/test": "^8.0.0",
-    "@theforeman/vendor-dev": "^6.0.0",
+    "@theforeman/builder": ">= 12.0.1",
+    "@theforeman/eslint-plugin-foreman": ">= 12.0.1",
+    "@theforeman/find-foreman": ">= 12.0.1",
+    "@theforeman/test": ">= 12.0.1",
+    "@theforeman/vendor-dev": ">= 12.0.1",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "prettier": "^1.19.1",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_hdm
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - betadots GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 0.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 0.35.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,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
@@ -165,7 +166,7 @@ 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: 
@@ -183,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Display hiera data in Foreman using HDM