Service Documentation Template


This template MUST be used to describe Web services hosted on machines where the Web Redirector runs. This is imposed by security measures. To fill in a Service Documentation Card for your service you can refer to the section below. The Web Service owners/managers are responsible for ensuring that the information provided is correct and updated. VOCs are responsible for providing a repository of all service documentation cards for services hosted on the same machine where the Web Redirector runs. The service documentation card is reviewed and updated by the service managers/owners on a quarterly base or whenever a change takes place.

Service template

Contact details of SM/AM and service security responsible:
Name, Email address, Phone Number, Out-of-office hours phone number
Please, refer to any security policy document used within the experiment.
Service name: Short name of the service
Service description (purpose): A short description of the service, including the foreseen network access pattern (so that anomalies can be detected by the site and local IDS systems tailored to monitor the traffic).
Service Criticality: The experiment web service criticality. Please, refer any related document. Accepted unavailability/downtime expressed in hours or days. Impact of the service on other services and on the experiment operations.
Hardware configuration: Specific hardware requirements for the services such as memory, number of cores, 32 or 64 bit architectures, disk space, RAID configuration, etc. The need for hot spares or DNS load balancing must be specified here.
File-system layout: Special partitions and file system needs. Please, specify disk space per partition.
Network configuration: protocols and ports; targets: specific ranges, local site, WNs only; other special firewall rules, DNS alias for the web redirector : Protocol (TCP/UDP) and the port number. A reference to the protocol description should be supplied if it’s not a “standard” protocol (i.e. one that can be found in the IETF RFC of GGF GWD). How will the port/protocol be accessed: is it outbound from the VO box or inbound into the VO box? What network(s) will contact the box/be contacted by the box? Specify at least one (or more) of “world”, “specific range” (and indicate the range. Standard CERN fixed networks are in, “local site” (i.e. all machines into the LCG-related network segments inside the site hosting the box), or “WNs only” (only worker node machines inside the site’s network). Other special firewall rules. Please specify as well the DNS alias to be used to address your service through the web redirector.
Groups and users: Local groups and users used/needed by the service. For instance, the need for special generic accounts to manage or run the service.
Installation or upgrade special instructions: Installation or upgrading instructions including special directives: stop/start, can the service be upgraded while running?, etc.
Broadcasting, recovery and draining procedures: A description of what needs to be done in case of a malfunctioning service: broadcasting user communities, recovering procedures, etc. together with a description of draining procedures if draining is needed. It is recommended to avoid draining procedures.
Business continuity plan: The plan that should be follow by the Web Service Manager/Owner to recover and restore partially or completely interrupted critical (urgent) functions within a predetermined time after a disaster or extended disruption and what support is needed by the VOC.
Service Backup: The need of backing up specific service data. Please specify which areas need to be backed-up and under which conditions (can the backup be performed with a running service?). Please specify also the frequency of the backup.
Privileged access: The list of people needing interactive, root or sudo access to the machines where the service runs and motivation.
Logging configuration and destination: A description of the logging by the service (a must in case of a service providing a service to the world or specific network ranges), and the destination of the logging entries (syslog, file).
Monitoring and publication: Monitored items; storage of the information or logs; publication information; security used to store or publish. Please, specify if lemon sensors are available and how the importance of the machines where the service runs should be specified. Please refer to this document.
Dependency on software packages or other systems/services: List software packages needed by the service and the dependency from other systems/services. In particular, how the dependency from other systems/services affects this service. Please also list if the service has configuration files that contain sensitive information and where/how these files are stored and should be retrieved to properly configure the service.
Files integrity checking: A list of files and checksums (types and values).

Service Documentation Form

A Twiki Form has been made available for you to fill in Service information according to the template above. In order to use such a Twiki Form you can do the following:
  1. While editing your twiki page click on the Add Form bottom at the end of the page
  2. Select the Form template WLCGServiceDocumentationForm
  3. A form will appear at the bottom of your page. All fields marked with a red asterisk are mandatory. Fill in the form and then press the Save button.
  4. The form will be saved at the end of your twiki page.
  5. Send the pointer to your twiki page to your VOC.

-- FlaviaDonno - 04-Jun-2010

Edit | Attach | Watch | Print version | History: r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r1 - 2010-06-04 - FlaviaDonno
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    LCG All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright &© 2008-2023 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback