Changeset 14143


Ignore:
Timestamp:
03/16/12 17:46:43 (12 years ago)
Author:
sil
Message:

Modified README for our first packaged release. See #5

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/sara_cmt/README

    r10765 r14143  
    1 
    2 ================================================================================
    3                     SARA CMT - SARA Cluster Management Tool
    4 ================================================================================
     1CMT is a Cluster Management Tool originally created at SARA Computing and
     2Networking Services, which is based in Amsterdam and known as SARA nowadays.
    53
    64
    7 This is a release of the SARA package for Cluster Management, containing a
    8 utility that's being used by SARA Computing & Networking Services to manage
    9 their clusters.
     5DEPENDENCIES
     6
     7CMT is dependent on the following packages:
     8 * Django==1.2
     9 * IPy==0.75
     10 * django-extensions==0.4
     11 * django-tagging==0.3.1
     12 * psycopg2==2.4.4
     13
     14Besides these Python-packages, the following software should be installed on your system:
     15 * Python>=2.6
     16 * header files and a static library for Python
     17 * header files for libpq (PostgreSQL library)
    1018
    1119
     20CONTACT
    1221
    13 --------------------------------------------------------------------------------
    14                                     FEATURES
    15 --------------------------------------------------------------------------------
    16 
    17 Some features of CMTSARA are:
    18  * Uses Django as a backend for a easy-to-use web-interface;
    19  * Has a CLI too, to use functionalities of SARA CMT from shellscripts, or
    20    interactive from shell. (WIP)
    21  * Automagic generation of configuration files for the cluster. (WIP)
    22  * Support for multiple clusters, networks, interfaces, etc...
    23 
    24 Wished features for future releases are:
    25  * Dynamically extendable data model
    26  * Tagging of models
    27  * Import as a Python-module
    28 
    29 For requests or suggestions, please mail to <sil.westerveld at sara.nl>.
    30 
    31 
    32 
    33 --------------------------------------------------------------------------------
    34                                  RELEASE NOTES
    35 --------------------------------------------------------------------------------
    36 
    37 No releases yet.
    38 
    39 
    40 
    41 --------------------------------------------------------------------------------
    42                                   DEPENDENCIES
    43 --------------------------------------------------------------------------------
    44 
    45 SARA CMT depends on the following packages:
    46  * django -- The Web framework for perfectionists with deadlines
    47  * django-evolution -- Schema Evolution for the Django Project
    48  * IPy -- class and tools for handling of IPv4 and IPv6 addresses and networks
    49 
    50 
    51 
    52 --------------------------------------------------------------------------------
    53         SOME USEFUL INFORMATION FOR WRITING YOUR OWN SARA CMT TEMPLATES
    54 --------------------------------------------------------------------------------
    55 
    56   * How to place comments in the template:
    57 
    58     - To comment-out (a part of) a line use
    59    
    60         {# <COMMENT> #}
    61 
    62     - For multiline commenting use
    63        
    64         {% comment %}
    65           <COMMENT 1>
    66           <COMMENT N>
    67         {% endcomment %}
    68 
    69 
    70   * Using variables:
    71    
    72     - The tags {{ and }} can be used for variables. The template engine
    73       evaluates the variable and replaces it in place. For example:
    74        
    75         {{ <VAR> }}
    76 
    77     - Use a dot to access attributes of a variable:
    78    
    79         {{ <VAR>.<ATTR> }}
    80 
    81     - Variables can be modified by using filters. The notation of a filter is
    82       like {{ var|filter }}. More about filters can be found at:
    83 
    84         http://docs.djangoproject.com/en/dev/ref/templates/builtins/#ref-templates-builtins-filters
    85    
    86     - The variables which can be used in CMTSARA-templates are:
    87       - <ModelName> : All the entities defined in the entity-dictionary
    88       - version     : The current version of CMTSARA
    89 
    90 
    91   * Building control structures:
    92    
    93     - For-loops are implemented like:
    94        
    95         {% for <ITEM> in <COLLECTION> %}
    96           <BODY>
    97         {% endfor %}
    98 
    99     - If-statements are used to evaluate a variable. Contents of the block are
    100       displayed if the variable is evaluated True. Syntax is like:
    101 
    102         {% if <VAR> %}
    103           <IF_BODY>
    104         {% else %}
    105           <ELSE_BODY>
    106         {% endif %}
    107 
    108       If-statements can be used to check values of a variable. In that case the
    109       syntax is:
    110      
    111         {% ifequal <ARG1> <ARG2> %}
    112           <BODY>
    113         {% endifequal %}
    114      
    115       This evaluates to True if the values of <ARG1> and <ARG2> are equal.
    116      
    117       The opposite of ifequal is ifnotequal, which can be used as follows:
    118        
    119         {% ifnotequal <ARG1> <ARG2> %}
    120           <BODY>
    121         {% endifnotequal %}
    122 
    123   * About empty lines:
    124 
    125     Empty lines, and lines with only whitespace characters, are removed by
    126     CMTSARA when generating files out of the templates. We've chosen for this
    127     approach because the Django Template Engine outputs blank lines for each
    128     evaluated line in the template it's parsing. In case of config-files this is
    129     not handy, because that many blank lines make a config file hard to read.
    130    
    131     When you wish to insert a blank line, you have to force it by using the
    132     following tag:
    133      
    134       { BLANKLINE }
     22For bugs, requests or suggestions, please mail to cmt@sara.nl
Note: See TracChangeset for help on using the changeset viewer.