GrADS Data Server - Configuration File Reference

Table of Contents

• Basic format description
  
  
• Example of a configuration file
  
  
• Tag hierarchy
  
  
• Tag definitions

Basic format description

The GDS configuration file is in XML format. This means it must start with the following line:

and then contain a set of nested "tags" .Each tag specifies the configuration options for a particular module of the server. In cases where configuration for a module is more complex, the tag for that module may contain further tags. Tags are written in one of two forms. For a tag with no contents, the syntax is:

and for a tag with contents, it is:


  (other tags)


The GDS configuration file does not currently use plain text or CDATA segments.

back to table of contents

Example configuration files

Most tags are completely optional; the GDS will use reasonable defaults when it can. The only settings that are always needed are the location of GrADS, and the location of the dataset to serve. Also, for the admin service to be enabled, an authorization string must be set. Here's a minimal example configuration file, using mostly default settings:


<gds>
  <catalog>
    <data>
      <datadir file="/data/mruns/" suffix=".nc" format="nc" />
    
  
  <grads>
    <invoker grads_dir="/home/jdoe/grads/" />
  
  <mapper>
    <service-admin auth="sDFe294f3nv034u8"/>
  

  

Whereas, this is what a more customized GDS configuration file might look like:


<gds name="my_server home="http://www.some.edu/~jdoe/data_server_info.html">
  <catalog temp_entries_limit="500">
    <data>
       <dataset name="my_data" file="/data/my_data.ctl" format="ctl"/>
       <datadir name="my_model_runs" file="/data/mruns/" suffix=".nc" format="nc"
                doc="http://www.some.edu/my_online_data/mrun_info.html" >
         <metadata name="model_version" value="1.0.0"/>
         <metadata-filter att_name="ensemble_id"/>
       </datadir>
       <datadir name="my_model_runs_optimized" file="/data/mruns/" suffix=".ctl" format="ctl"
                doc="http://www.some.edu/my_online_data/mrun_info.html"
                direct_subset="true" source_suffix="dat" />
       <mapdir name="private_data">
         <datalist file="secret_datasets.lst"/>
       
    
  
  <log mode="rotate" frequency="week">
    <log_override module="grads/invoker" level="verbose"/>
  
  <grads>
    <invoker grads_dir="/home/jdoe/grads/" time_limit="600"/>
    <analyzer storage="250" time_limit="60"/>
    <dods subset_size="2000" />
    <uploader/>
  
  <mapper>
    <service-admin auth="sDFe294f3nv034u8"/>
  
  <privilege_mgr default="public">
    <ip_range mask="127.0.0.1" privilege="full" />
    
    <privilege name="full" />
                    analyze_allowed="false"
               abuse_hits="1000"
               abuse_timeout="24/>
      
    
  
  <servlet>
    <filter-overload limit="20" />
  
  

back to table of contents

Tag hierarchy

The following table shows the tag structure of the configuration file. This corresponds to the runtime structure of the server. The top level tag must always be . Each tag must be contained by the tag immediately to its left, and can contain any of the tags to its right. Tags followed by * can appear multiple times.

back to table of contents

Tag definitions