Setting tag omf-5.3-11
[omf.git] / omf-resctl.yaml.in
index 770976b..8f79701 100644 (file)
@@ -1,33 +1,77 @@
 #
-# $Id$
-$ $URL$
-#
 # This is the template Config file for the OMF Resource Controller
 # The uppercase symbols between '@' get filled by the Nodemanager 'omf_resctl' plugin 
 #
+# Copyright (c) 2006-2009 National ICT Australia (NICTA), Australia
+#
+# Copyright (c) 2004-2009 WINLAB, Rutgers University, USA
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#
+# NOTE: use only 'spaces' to indent !
+# ('tab' indents are not supported by the ruby yaml parser used to read this file)
+#
 ---
 :rcontroller:
- # Communication settings
- :comm:
+  # Communication settings 
+  :communicator:
+
+    # Number of seconds between consecutive HEARTBEAT messages
+    :heartbeat_interval: 10
+  
+    # Interface to the control network from which this resource can be controlled and managed
+    :control_if: control
+
+    # set this to false if you want to disable signature checks and message signing
+    :authenticate_messages: true
+
+    # your RSA/DSA SSH private key file
+    :private_key: @SLIVER_PRIVATE_KEY@
 
-   # Number of seconds between consecutive HEARTBEAT messages
-   :heartbeat_interval: 10
+    # directory holding the public keys of your OMF peers
+    :public_key_dir: @SLIVER_PUB_KEY_DIR@
 
-   # Interface to the control network from which this resource can be controlled and managed
-   :control_if: control
+    :type: 'xmpp'
+    :xmpp:
+      # Address of the PubSub server to use as gateway for PubSub communication
+      :pubsub_gateway: @XMPP_SERVER@
 
-   # Address of the XMPP server to use for PubSub communication
-   :xmpp_server: @XMPP_SERVER@
+      # Address of the PubSub server which host the communication for my slice
+      # Leave this commented if the pubsub groups for this slice are hosted on 
+      # the same server as the 'pubsub_gateway'
+      #:pubsub_domain: 10.0.0.200
+      # The following 'home_pubsub_user' and 'home_pubsub_pwd' are optional
+      # RC will create a unique user/pwd for itself if this is not provided
+      # In a typical OMF install, you should not uncomment these lines
+      # (do so only if you need to manually set user/password for 
+      # your client to connect to your pubsub server)
+      #:pubsub_user: 'my_RC_name' 
+      #:pubsub_pwd: 'my_RC_password'
 
- # Agent settings
- :agent:
 # Agent settings
 :agent:
 
-   # Name (i.e. unique HRN ID) of this resource
-   # Or this could also be passed as a command line parameter "--name"
-   # Or if set to 'default', then the RC will use the output of '/bin/hostname'
-   # check the node manager plugin code about this
-   # first implementation sets this to 'default'
-   :name: @NODE_HRN@
+    # Name (i.e. unique HRN ID) of this resource
+    # Or this could also be passed as a command line parameter "--name"
+    # Or if set to 'default', then the RC will use the output of '/bin/hostname'
+    :name: @NODE_HRN@
 
-   # Name (i.e. unique HRN ID) of the slice to which this resource is assigned
-   :slice: @SLICE_NAME@
+    # Name (i.e. unique HRN ID) of the slice to which this resource is assigned
+    :slice: @SLICE_NAME@