Add support for licensed pbs professional

README.md

@@ -296,6 +296,79 @@ By default, `azpbs` will use `/opt/cycle/pbspro/logging.conf`, as defined in `/o
 Every `autoscale` iteration, `azpbs` prints out a table of all of the nodes, their resources, their assigned jobs and more. This log
 contains these values and nothing else.
 
+## Using Altair PBS Professional in CycleCloud
+
+CycleCloud project for OpenPBS uses opensource version of OpenPBS. You may use your own
+[Altair PBS Professional](https://www.altair.com/pbs-professional/) licenses and installers according to your Altair PBS Professional license agreement.  
+This section documents how to use Altair PBS Professional with the CycleCloud OpenPBS project.
+
+### Prerequisites
+
+This example will use the 2022.1.1 version, which has been tested with the template.
+
+1. Users must provide Altair PBS Professional binaries (the same works with RHEL 8.x with _.el8.x86_64.rpm_)
+
+  * pbspro-client-2022.1.1.el7.x86_64.rpm
+  * pbspro-execution-2022.1.1.el7.x86_64.rpm
+  * pbspro-server-2022.1.1.el7.x86_64.rpm
+
+2. A license server reachable from Azure CycleCloud Altair PBS Professional head node and execution nodes
+
+3. (Optional to tune avilable versions) The cyclecloud cli must be configured. Documentation is available [here](https://docs.microsoft.com/en-us/azure/cyclecloud/install-cyclecloud-cli) 
+
+
+### Copy the binaries into the cloud locker
+
+To copy the installer with _azcopy_ to the Azure CycleCloud storage account, use the following commands (the same works with RHEL 8.x with _.el8.x86_64.rpm_):
+
+```bash
+
+$ azcopy cp pbspro-client-2022.1.1.el7.x86_64.rpm https://<storage-account-name>.blob.core.windows.net/cyclecloud/blobs/pbspro
+$ azcopy cp pbspro-execution-2022.1.1.el7.x86_64.rpm https://<storage-account-name>.blob.core.windows.net/cyclecloud/blobs/pbspro
+$ azcopy cp pbspro-server-2022.1.1.el7.x86_64.rpm https://<storage-account-name>.blob.core.windows.net/cyclecloud/blobs/pbspro
+```
+
+### Define license server
+
+In Altair PBS Professional cluster template, a specific parameter in Advanced Settings allows the definition of license server IP and port.
+
+### Adding other versions to the cluster template
+
+Make a local copy of the Altair PBS Professional template and modify it to use other versions of the installers
+instead of the default 2022.1.1.
+
+```bash
+wget https://raw.githubusercontent.com/Azure/cyclecloud-pbspro/master/templates/pbspro.txt
+```
+
+In the _pbspro.txt_ file, locate the `PBSVersion` definition and
+insert the desired version in the options. For example for version 
+
+> NOTE:
+> The version should match the one in installer file name.
+
+```ini
+        [[[parameter PBSVersion]]]
+        Label = Altair PBS Version
+        Config.Plugin = pico.form.Dropdown
+        Config.Entries := {[Label="Altair PBS Pro 2021.1"; Value="2021.1.4"]}
+        DefaultValue = 2021.1.4
+
+```
+
+These configs will make the additional versions available in the UI
+
+### Import the cluster template file
+
+Using the cyclecloud cli, import a cluster template from the new cluster template file.
+
+```bash
+cyclecloud import_template -f pbspro.txt --force
+```
+
+Similar to this [tutorial](https://docs.microsoft.com/en-us/azure/cyclecloud/tutorials/modify-cluster-template) in the documentation, new Altair PBS Professional cluster is now available in the *Create Cluster* menu in the UI.
+
+Configure and create the cluster in the UI, save it, and start it.
 
 # Contributing
 

specs/default/chef/site-cookbooks/pbspro/attributes/default.rb

@@ -7,6 +7,10 @@
 default[:pbspro][:autoscale_installer] = "cyclecloud-pbspro-pkg-#{node[:pbspro][:autoscale_version]}.tar.gz"
 default[:pbspro][:cron_method] = "pbs_cron"
 default[:pbspro][:version] = "20.0.1-0"
+default[:pbspro][:license] = ""
+default[:pbspro][:professional] = false
+default[:pbspro][:pbsdata_uid] = 11100
+default[:pbspro][:pbsdata_gid] = 11100
 default[:pbspro][:slots] = nil
 default[:pbspro][:idle_timeout] = 300
 default[:pbspro][:boot_timeout] = 3600

specs/default/chef/site-cookbooks/pbspro/recipes/default.rb

@@ -14,4 +14,4 @@
     source "#{node['jetpack']['downloads']}/#{hwlocs_lib_el8}"
     action :install
   end
-end
+end

specs/default/chef/site-cookbooks/pbspro/recipes/execute.rb

@@ -10,12 +10,18 @@
 platform = node['platform_family']
 pbsdist = "el#{plat_ver}"
 package_name = node[:pbspro][:package]
-
-if package_name == nil
-  if pbsprover.to_i < 20 
-    package_name = "pbspro-execution-#{pbsprover}.x86_64.rpm"
-  else
-    package_name = "openpbs-execution-#{pbsprover}.x86_64.rpm"
+pbs_professional = node[:pbspro][:professional]
+
+
+if pbs_professional
+  package_name = "pbspro-execution-#{pbsprover}.#{pbsdist}.x86_64.rpm"
+else
+  if package_name == nil
+    if pbsprover.to_i < 20 
+      package_name = "pbspro-execution-#{pbsprover}.x86_64.rpm"
+    else
+      package_name = "openpbs-execution-#{pbsprover}.x86_64.rpm"
+    end
   end
 end
 

specs/default/chef/site-cookbooks/pbspro/recipes/login.rb

@@ -7,13 +7,19 @@
 pbsprover = node[:pbspro][:version]
 plat_ver = node['platform_version'].to_i
 pbsdist = "el#{plat_ver}"
+pbs_professional = node[:pbspro][:professional]
 package_name = node[:pbspro][:package]
 
+
 if package_name.nil?
-  if pbsprover.to_i < 20 
-    package_name = "pbspro-client-#{pbsprover}.x86_64.rpm"
+  if pbs_professional
+    package_name = "pbspro-client-#{pbsprover}.#{pbsdist}.x86_64.rpm"
   else
-    package_name = "openpbs-client-#{pbsprover}.x86_64.rpm"
+    if pbsprover.to_i < 20 
+      package_name = "pbspro-client-#{pbsprover}.x86_64.rpm"
+    else
+      package_name = "openpbs-client-#{pbsprover}.x86_64.rpm"
+    end
   end
 end
 

specs/default/chef/site-cookbooks/pbspro/recipes/server.rb

@@ -7,6 +7,10 @@
 pbsprover = node[:pbspro][:version]
 plat_ver = node['platform_version'].to_i
 pbsdist = "el#{plat_ver}"
+pbs_professional = node[:pbspro][:professional]
+pbsdata_uid = node[:pbspro][:pbsdata_uid]
+pbsdata_gid = node[:pbspro][:pbsdata_gid]
+
 cron_method = node[:pbspro][:cron_method] || "pbs_cron"
 package_name = node[:pbspro][:package]
 
@@ -29,17 +33,37 @@
 end
 
 if package_name.nil?
-  if pbsprover.to_i < 20 
-    package_name = "pbspro-server-#{pbsprover}.x86_64.rpm"
+  if pbs_professional
+    package_name = "pbspro-server-#{pbsprover}.#{pbsdist}.x86_64.rpm"
   else
-    package_name = "openpbs-server-#{pbsprover}.x86_64.rpm"
+    if pbsprover.to_i < 20 
+      package_name = "pbspro-server-#{pbsprover}.x86_64.rpm"
+    else
+      package_name = "openpbs-server-#{pbsprover}.x86_64.rpm"
+    end
   end
 end
 
 jetpack_download package_name do
   project 'pbspro'
 end
 
+if pbs_professional
+  group 'pbsdata' do
+    gid pbsdata_gid
+    system true
+  end
+
+  user 'pbsdata' do
+    system true
+    uid pbsdata_uid
+    gid 'pbsdata'
+    manage_home true
+    home '/home/pbsdata'
+    shell '/bin/bash'
+  end
+end
+
 if plat_ver < 8
   yum_package package_name do
     source "#{node['jetpack']['downloads']}/#{package_name}"
@@ -80,6 +104,17 @@
   action [:enable, :start]
 end
 
+if pbs_professional
+pbspro_license = node[:pbspro][:license]
+  bash 'setup license cyclecloud-pbspro' do
+    code <<-EOH
+     /opt/pbs/bin/qmgr -c 'set server pbs_license_info=#{pbspro_license}'  
+    EOH
+
+    action :run
+  end
+end
+
 file "/etc/profile.d/azpbs_autocomplete.sh" do
   content 'eval "$(/opt/cycle/pbspro/venv/bin/register-python-argcomplete azpbs)" || echo "Warning: Autocomplete is disabled" 1>&2'
   mode '0755'

templates/openpbs.txt

@@ -20,6 +20,7 @@ Autoscale = $Autoscale
 
         [[[configuration]]]
         pbspro.version = $PBSVersion
+        pbspro.professional = false
         # For fast spin-up after Deallocate, force an immediate re-converge on boot
         cyclecloud.converge_on_boot = true