vagrant-registration 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42f2db8ea11b622d6ad6dd1b691ccc5ded35c382
-  data.tar.gz: 3d54a94859b480f43847134eafad448fc25b4f21
+  metadata.gz: e315e6013e06ae4e0e2e443a8f4eda40e1460241
+  data.tar.gz: a279b9fefcb4e7e1d36ea9f2055d1c0a87599e3a
 SHA512:
-  metadata.gz: 597f363023a366eab93f06eb7ab900266107beeef7645372ce535559e9b0c7f1118767b67d5e308ab7b95b420d86c146bff7e28a407cfc821b95324805ade7c3
-  data.tar.gz: 02e667660538c40126bf11b2d01ac646b6629b23bf5e8b513475a8be3677aea78e8cc6eedc35f36850d9a8567e064a5b73d39c7f57f9c83f6efaa9ac7d4f33fc
+  metadata.gz: 99c38ec395222dda39ae3a9debfd4dd8a944735f122328b4be485952c7604b28f21cf4a9d249c6cf3ccc3823dd853855e266a5eb0b1150ed3c6673346a4dd9ec
+  data.tar.gz: 69771079e48c96a54d18d1eaa330dd275dbb4715aaf2416a9eaf352297cc9a51b97ce4801a368e8c2531fab0f37a98672459a70e51763bbabc53f2365cf7415a

data/README.md

@@ -1,42 +1,64 @@
 # vagrant-registration
 
-The vagrant-registration plugin supports new capabilities "register" and "unregister." The "register" event occurs during the "up" process, immediately after startup but before any provisioning (including built-in like rysnc). The "unregister" event occurs during the "halt" process (which also is called during the "destroy" process) immediately before the instances goes down. 
+The vagrant-registration plugin supports new capabilities "register" and "unregister." The "register" event occurs during the "up" process, immediately after startup but before any provisioning (including built-in like rsync). The "unregister" event occurs during the "halt" process (which also is called during the "destroy" process) immediately before the instances goes down.
 
-Essentially, this supports developers wanting to use linuxes that have a subscription model for updates, like RHEL.
+This allows developers to easily register their guests that use subscription model for updates, like Red Hat Enterprise Linux.
 
-To use, make sure you have the capabilities registered and your subscription-manager credentials properly configured in your Vagrant file.
 
-## Using
 
-The plugin is still very early alpha, so YMMV. If you try it out, and have problems, please feel free to file an issue. 
+## Installation
 
-* vagrant plugin install vagrant-registration
-* configure subscription-manager credentials in your Vagrantfile
-* that should be it
+Install as any other Vagrant plugin:
 
-### subscription-manager Credential Configuration
+```ruby
+vagrant plugin install vagrant-registration
+```
 
-You should add the following entries into your Vagrantfile:
+## Usage
 
-    config.registration.subscriber_username = 'foo'
-    config.registration.subscriber_password = 'bar'
+*Note:* This plugin is still alpha. Please help us to find and fix any bugs.
 
-This should go, preferably, into the Vagrantfile in your Vagrant home directory (defaults to ~/.vagrant.d), to make it available for every project. It can be later overriden in an individual project's Vagrant file, if needed.
+- Only RHEL Subscription Manager is currectly supported.
 
-If you prefer not to store your username/password on your filesystem, you can optionally configure vagrant-registration plugin to use environment variables, such as:
+### subscription-manager Configuration
 
-    config.registration.subscriber_username = ENV['SUB_USERNAME']
-    config.registration.subscriber_password = ENV['SUB_PASSWORD']
+vagrant-registration supports all the options of subscription-manager's register command.
+You can set any option easily by setting `config.registration.OPTION_NAME = 'OPTION_VALUE'`
+in your Vagrantfile (please see the subscription-manager's documentation for option
+description).
 
-Finally, if you do not provide credentials, you will be prompted for them in the "up process." However, this is a tentative feature because if you are launching more than one VM from one Vagrantfile, the feature acts unexepectedly (appearing to hang because the prompt for creds gets lost in the scrollback). 
+Setting up the credentials can be done as follows:
 
-You can also skip registration altogether if you would prefer but don't want to remove the plugin. If you want this function, please use
+```ruby
+    config.registration.username = 'foo'
+    config.registration.password = 'bar'
+```
 
+This should go, preferably, into the Vagrantfile in your Vagrant home directory
+(defaults to ~/.vagrant.d), to make it available for every project. It can be
+later overriden in an individual project's Vagrantfile, if needed.
+
+If you prefer not to store your username and/or password on your filesystem,
+you can optionally configure vagrant-registration plugin to use environment
+variables, such as:
+
+```ruby
+    config.registration.username = ENV['SUB_USERNAME']
+    config.registration.password = ENV['SUB_PASSWORD']
+```
+
+If you do not provide credentials, you will be prompted for them in the "up process". However, this is a tentative feature because if you are launching more than one VM from one Vagrantfile, the feature acts unexepectedly (appearing to hang because the prompt for creds gets lost in the scrollback). 
+
+You can also skip the registration process altogether by setting a `skip` option
+to `true`:
+
+```ruby
     config.registration.skip = true
+```
 
-RHEL Subscription Manager will fail if you attempt to register a registered machine (see the man page for why). In order to not slow boot time, we now, by default, pass the "--force" flag when we try to subscribe. If you want to disable this feature:
+*Note:* RHEL Subscription Manager will fail if you attempt to register an already registered machine (see man page for explanation). Not to slow the boot time, vagrant-registration appends the "--force" flag when subscribing. If you would like to disable this feature, set `force` option to `false`:
 
+```ruby
     config.registration.force = false 
+```
 
-## Support
-Currently, "capabilities" are only provided for Red Hat's Subscription Manager. To add others, one just needs to add a new guest plugin, then a cap directory with register.rb and unregister.rb. See the redhat guest for an example. 

data/lib/vagrant-registration/config.rb

@@ -3,38 +3,119 @@ require "vagrant"
 module VagrantPlugins
   module Registration
     class Config < Vagrant.plugin("2", :config)
-      # The username to subscribe with
+      # The username to subscribe with (required)
       #
       # @return [String]
-      attr_accessor :subscriber_username
+      attr_accessor :username
+      attr_accessor :subscriber_username # to stay backwards compatible
 
-      # The password of the subscriber
+      # The password of the subscriber (required)
       #
       # @return [String]
-      attr_accessor :subscriber_password
+      attr_accessor :password
+      attr_accessor :subscriber_password # to stay backwards compatible
 
-      # Skip the registration (skip if true)
+      # Give the hostname of the subscription service to use (required for Subscription
+      # Asset Manager, defaults to Customer Portal Subscription Management)
+      #
+      # @return [String]
+      attr_accessor :serverurl
+
+      # Give the hostname of the content delivery server to use to receive updates
+      # (required for Satellite 6)
+      #
+      # @return [String]
+      attr_accessor :baseurl
+
+      # Give the organization to which to join the system (required, except for
+      # hosted environments)
+      #
+      # @return [String]
+      attr_accessor :org
+
+      # Register the system to an environment within an organization (optional)
+      #
+      # @return [String]
+      attr_accessor :environment
+
+      # Name of the subscribed system (optional, defaults to hostname if unset)
+      #
+      # @return [String]
+      attr_accessor :name
+
+      # Auto attach suitable subscriptions (optional, auto attach if true)
       #
       # @return [Bool]
-      attr_accessor :skip
+      attr_accessor :auto_attach
+
+      # Attach existing subscriptions as part of the registration process (optional)
+      #
+      # @return [String]
+      attr_accessor :activationkey
 
-      # Force the registration (skip if true)
+      # Set the service level to use for subscriptions on that machine
+      # (optional, used only used with the --auto-attach)
+      #
+      # @return [String]
+      attr_accessor :servicelevel
+
+      # Set the operating system minor release to use for subscriptions for
+      # the system (optional, used only used with the --auto-attach)
+      #
+      # @return [String]
+      attr_accessor :release
+
+      # Force the registration (optional, force if true, defaults to true)
       #
       # @return [Bool]
       attr_accessor :force
 
+      # Set what type of consumer is being registered (optional, defaults to system)
+      #
+      # @return [String]
+      attr_accessor :type
+
+      # Skip the registration (optional, skip if true, defaults to false)
+      #
+      # @return [Bool]
+      attr_accessor :skip
+
       def initialize(region_specific=false)
+        @username = UNSET_VALUE
         @subscriber_username = UNSET_VALUE
+        @password = UNSET_VALUE
         @subscriber_password = UNSET_VALUE
-        @skip = UNSET_VALUE
+        @serverurl = UNSET_VALUE
+        @baseurl = UNSET_VALUE
+        @org = UNSET_VALUE
+        @environment = UNSET_VALUE
+        @name = UNSET_VALUE
+        @auto_attach = true
+        @activationkey = UNSET_VALUE
+        @servicelevel = UNSET_VALUE
+        @release = UNSET_VALUE
         @force = true
+        @type = UNSET_VALUE
+        @skip = UNSET_VALUE
       end
 
       def finalize!
-        @subscriber_username = nil if @subscriber_username == UNSET_VALUE
-        @subscriber_password = nil if @subscriber_password == UNSET_VALUE
-        @skip = false if @skip == UNSET_VALUE
+        @username = @subscriber_username if @username == UNSET_VALUE
+        @password = @subscriber_password if @password == UNSET_VALUE
+        @username = nil if @username == UNSET_VALUE
+        @password = nil if @password == UNSET_VALUE
+        @serverurl = nil if @serverurl = UNSET_VALUE
+        @baseurl = nil if @baseurl = UNSET_VALUE
+        @org = nil if @org = UNSET_VALUE
+        @environment = nil if @environment = UNSET_VALUE
+        @name = nil if @name == UNSET_VALUE
+        @auto_attach = true if @auto_attach == UNSET_VALUE
+        @activationkey = nil if @activationkey = UNSET_VALUE
+        @servicelevel = nil if @servicelevel = UNSET_VALUE
+        @release = nil if @release = UNSET_VALUE
         @force = true if @force == UNSET_VALUE
+        @type = nil if @type == UNSET_VALUE
+        @skip = false if @skip == UNSET_VALUE
       end
     end
   end

data/lib/vagrant-registration/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Registration
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/plugins/guests/redhat/cap/register.rb

@@ -3,11 +3,30 @@ module VagrantPlugins
     module Cap
       class Register
         def self.register(machine)
-          username = machine.config.registration.subscriber_username
-          password = machine.config.registration.subscriber_password
-          command = "subscription-manager register --username=#{username} --password=#{password} --auto-attach #{"--force" if machine.config.registration.force}"
+          command = "subscription-manager register #{configuration_to_options(machine.config)}"
           machine.communicate.execute("cmd=$(#{command}); if [ \"$?\" != \"0\" ]; then echo $cmd | grep 'This system is already registered' || (echo $cmd 1>&2 && exit 1) ; fi", sudo: true)
         end
+
+        private
+
+        # Build additional subscription-manager options based on plugin configuration
+        def self.configuration_to_options(config)
+          options = []
+          options << "--username=#{config.registration.username}"
+          options << "--password=#{config.registration.password}"
+          options << "--serverurl=#{config.registration.serverurl}" if config.registration.serverurl
+          options << "--baseurl=#{config.registration.baseurl}" if config.registration.baseurl
+          options << "--org=#{config.registration.org}" if config.registration.org
+          options << "--environment=#{config.registration.environment}" if config.registration.environment
+          options << "--name=#{config.registration.name}" if config.registration.name
+          options << "--auto-attach" if config.registration.auto_attach
+          options << "--activationkey=#{config.registration.activationkey}" if config.registration.activationkey
+          options << "--servicelevel=#{config.registration.servicelevel}" if config.registration.servicelevel
+          options << "--release=#{config.registration.release}" if config.registration.release
+          options << "--force" if config.registration.force
+          options << "--type=#{config.registration.type}" if config.registration.type
+          options.join(' ')
+        end
       end
     end
   end

data/plugins/guests/redhat/plugin.rb

@@ -20,7 +20,7 @@ module VagrantPlugins
 
       guest_capability("redhat", "rhcert") do
         require_relative "cap/redhat_certification_tool"
-        Cap::ContainerProbeTool
+        Cap::RedHatCertification
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-registration
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Langdon White
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies: []
 description: Enables guests to have a registration capability, this is expecially
   useful on RHEL or SLES
@@ -78,3 +78,4 @@ signing_key:
 specification_version: 4
 summary: Enables guests to have a registration capability
 test_files: []
+has_rdoc: