SHARE_TREE(5)              Grid Engine File Formats              SHARE_TREE(5)



NNAAMMEE
       share_tree - Grid Engine share tree file format

DDEESSCCRRIIPPTTIIOONN
       The   share   tree  defines  the  long-term  resource  entitlements  of
       users/projects and of a hierarchy of arbitrary groups thereof.

       The current share tree  can  be  displayed  via  the  _q_c_o_n_f(1)  --ssssttrreeee
       option.  The  output follows the _s_h_a_r_e___t_r_e_e format description. A share
       tree can be created and an existing can be modified via the --aassttrreeee and
       --mmssttrreeee  options  to _q_c_o_n_f(1).  Individual share tree nodes can be cre-
       ated, modified, deleted, or shown via the --aassttnnooddee, --ddssttnnooddee, --mmssttnnooddee,
       and --ssssttnnooddee options to _q_c_o_n_f(1).

FFOORRMMAATT
       The format of a share tree file is defined as follows:

       +o  A  new  node  starts  with  the attribute iidd, and equal sign and the
          numeric identification number of the  node.  Further  attributes  of
          that node follow until another iidd-keyword is encountered.

       +o  The  attribute  ttyyppee  defines, if a sharetree node references a user
          (type=0), or a project (type=1)

       +o  The attribute cchhiillddnnooddeess contains a comma separated  list  of  child
          nodes to this node.

       +o  The  parameter nnaammee refers to an arbitrary name for the node or to a
          corresponding user (see _u_s_e_r(5)) or project (see _p_r_o_j_e_c_t(5)) if  the
          node is a leaf node of the share tree. The name for the root node of
          the tree is "Root" by convention.

       +o  The parameter sshhaarreess defines the share of the node among  the  nodes
          with the same parent node.

       +o  A user leaf node named 'default' can be defined as a descendant of a
          _p_r_o_j_e_c_t(5)) node in the share tree. The  default  node  defines  the
          number  of shares for users  who are running in the project, but who
          do not have a user node defined under the project. The default  user
          node  is  a convenient way of specifying a single node for all users
          which should receive an equal share of the  project  resources.  The
          default node may be specified by itself or with other _u_s_e_r(5)) nodes
          at the same level below a project.  All  users,  whether  explicitly
          specified  as  a  user node or those which map to the 'default' user
          node must have a corresponding _u_s_e_r(5)) object defined in  order  to
          get shares. Do not configure a _u_s_e_r(5)) object named 'default'.


EEXXAAMMPPLLEESS
       Jobs of projects P1 and P2 get 50 shares, all other jobs get 10 shares.

       id=0
       name=Root
       type=0
       shares=1
       childnodes=1,2,3
       id=1
       name=P1
       type=1
       shares=50
       childnodes=NONE
       id=2
       name=P2
       type=1
       shares=50
       childnodes=NONE
       id=3
       name=default
       type=0
       shares=10
       childnodes=NONE

SSEEEE AALLSSOO
       _s_g_e___i_n_t_r_o(1), _q_c_o_n_f(1), _p_r_o_j_e_c_t(5), _u_s_e_r(5).

CCOOPPYYRRIIGGHHTT
       See _s_g_e___i_n_t_r_o(1) for a full statement of rights and permissions.



GE 6.0                   $Date: 2007/10/09 15:43:20 $            SHARE_TREE(5)
