Add more informations about flexlm__licences var

CHANGELOG.md

@@ -1,5 +1,5 @@
 
-## v1.x
+## v2.0
 
 ### Features
 * Add a way to provide vendor daemon binaries and licence file.
@@ -10,6 +10,7 @@
 ### Enhancements
 * Set a var to manage the state of the deployment by this role.
 * Ensure to stop and disable services if deploy state is "absent".
+* Add more informations about flexlm__licences var.
 
 ## v1.0
 

README.md

@@ -11,7 +11,7 @@
 
 ## Overview
 
-A role to manage Flexlm daemon.
+A role to manage Flexlm daemon and licence/binaries files.
 
 ## Role Variables
 
@@ -23,8 +23,8 @@ A role to manage Flexlm daemon.
 * **flexlm__lmutil_source** : Source of the `lmutil` bin to send [default : `usr/local/bin/lmutil`].
 * **flexlm__lmutil_path** : The place to store `lmutil` bin [default : `/usr/local/bin/lmutil`].
 * **flexlm__user_name** : Username used to launch `lmgrd` [default : `flexlm`].
-* **flexlm__licences** : Lists to manage vendor daemon and licence files [default : `[]`].
 * **flexlm__service_unit_content** : Template used to generate the previous file [default : `etc/systemd/system/flexlm.service.j2`].
+* **flexlm__licences** : Lists to manage vendor daemon and licence files [default : `[]`].
 
 ## Example Playbook
 
@@ -61,7 +61,7 @@ A role to manage Flexlm daemon.
 This role will :
 * Copy the `lmgrd` and `lmutil` binaries to the client.
 * Create a specific user to launch daemon.
-* Set up a systemd service (flexlm-NAME). [Thanks to Kalebo instructions][kalebo instruction flexlm systemd].
+* Set up a systemd service (flexlm-item.name). [Thanks to Kalebo instructions][kalebo instruction flexlm systemd].
 * Copy vendor daemon binaries to the host if source is specified.
 * Copy licence file to the host if source is specified.
 

defaults/main.yml

@@ -75,24 +75,53 @@ flexlm__user_name: 'flexlm'
 flexlm__service_manage: True
 
                                                                    # ]]]
-                                                                   # ]]]
+# .. envvar:: flexlm__service_unit_content [[[
-
+#
-# service
+# Template used to provide systemd unit for ``flexlm-...`` services.
-flexlm__service_enabled: True
 flexlm__service_unit_content: 'etc/systemd/system/flexlm.service.j2'
 
+                                                                   # ]]]
+                                                                   # ]]]
+# Licence and Vendor bin [[[
+# ------------------------
 
+# .. envvar:: flexlm__licences [[[
+#
 # Lists to manage vendor daemon and licence files.
-# flexlm_licences:
+#
-#   - name: matlab
+# ``item.name``
-#     description: 'flexlm Licence Manager for Matlab'
+#   Give a short name for the software licence. Avoid whitespace and special
-#     bin_path: '/opt/matlab/bin'
+#   caracter cause this var will also be used to name the service.
-#     bin_src: '{{ inventory_dir + "/../resources/service/matlab-lm/bin/" }}'
+# ``item.description``
-#     lic_path: '/opt/matlab/etc/licence.lic'
+#   Optional. Here you can give a long description of the licence. Also used as
-#     lic_src: '{{ inventory_dir + "/../resources/hosts/matlab-lm/opt/matlab/etc/licence.lic" }}'
+#   service's description.
-#     service: True
+# ``item.bin_path``
-#     timewait: 60
+#   Optional. Specify asbolute path of the target directory on the remote host
-#     ports: [ '27000', '33188' ] # not used right now
+#   to store vendor daemon binaries. Also used as working directory for the service.
+#   [Default : ``/opt/item.name/bin``].
+# ``bin_src``
+#   Optional. Path from your controller used as source directory to provide the
+#   vendor daemon directory on the host. Should be a directory and don't omit
+#   the final **/**.
+# ``lic_path``
+#   Optional. Specify absolut path of the target licence file on the remote
+#   host. Also used as argument of the start command for the service.
+#   [Default : ``/opt/item.name/etc/licence.lic``].
+# ``lic_src``
+#   Optional. Path from your controller used as source file to provide the licence
+#   file on the host. Should be a file, not a directory.
+# ``service``
+#   Optional. If the service should be started and enabled.
+#   [Default : ``True``].
+# ``timewait``
+#   Optional. The time (in second) to wait before trying to restart the service
+#   after an error. I recommend at least 60 seconds because some vendor daemon
+#   keep a connection active even few seconds after the stop.
+#   [Default : ``60``].
+# ``ports``
+#   The list of ports used by this licence.
+#   Not used right now.
 flexlm__licences: []
 
                                                                    # ]]]
+                                                                   # ]]]