BBC New Media and Technology
New Media Database Configuration and Deployment Guide
New Media and
Technology
New Media Database Configuration and
Deployment Guide
Document Authorisation
Name:
Mike Hilton
Position:
New Media Database Architect
Signature:
13th May 2003
Date:
Document references
Version:
1.0
Date:
13th May 2003
CI Ref.
Version
Date
:
: Issue 1.0
: 13/05/03
Page 1 of 5
BBC New Media and Technology
New Media Database Configuration and Deployment Guide
Work carried out by:
Name
Mike Hilton
Department
Infrastructure Cluster
Ext
73988
Document History
Version
1.0
Date
13/05/03
Author
Mike Hilton
Release / Version
<Specify release /
version id>
Description
First Issue
Any comments or queries about this document should be addressed to Mike Hilton
CI Ref.
Version
Date
:
: Issue 1.0
: 13/05/03
Page 2 of 5
BBC New Media and Technology
New Media Database Configuration and Deployment Guide
Contents
1
2
3
Application Overview ............................................................................ 4
Deliverables............................................................................................. 4
Environment Details .............................................................................. 4
3.1
3.2
4
Installation Instructions ........................................................................ 4
4.1
5
6
7
8
Required Software Stack .................................................................................. 4
Environment Variables .................................................................................... 4
Configuration files ............................................................................................ 5
Known Bugs ............................................................................................ 5
Usage Guide ............................................................................................ 5
Release Notes .......................................................................................... 5
Related Documents ................................................................................ 5
CI Ref.
Version
Date
:
: Issue 1.0
: 13/05/03
Page 3 of 5
BBC New Media and Technology
New Media Database Configuration and Deployment Guide
1 Application Overview
<Provide an overview of the application, and tehe components being used to make up
delivery>
2 Deliverables
<List release deliverables explicitly>
Id
3
Deliverable
Name
Description
Release/Version Test Ref
Environment Details
3.1 Required Software Stack
< For each software item that the installed database software is dependent upon,
describe the software package that the release and/or version number, what it is used for,
list any dependencies that the software may have on other software package / versions,
and note any other useful / important information about the item. >
Id
Software
Version
Role in
solution
Dependencies Comments
3.2 Environment Variables
< For each environment variable, describe the variable name, value, and what it is used
for >
Name
4
Value
Description
Installation Instructions
<List step by step, installation instructions for the application being installed. List
specific installation files, order of installation / configuration, scripts to run etc..
Describe specifics of target deployment hardware platforms if known.>
CI Ref.
Version
Date
:
: Issue 1.0
: 13/05/03
Page 4 of 5
BBC New Media and Technology
New Media Database Configuration and Deployment Guide
4.1 Configuration files
<For each configuration file list the configuration items (name, value pairs, and describe
the purpose of the configuration variable / value>
Name
Value
Description
5 Known Bugs
<List any / all known bugs. Include bug log reference numbers if known.>
6 Usage Guide
<Describe usage of each the delivered application / components. Include information
about :
How to start the application
Administration instructions
Maintenance instructions
How to stop the application
Full details may be provided in separate Usage Guide if necessary>
7 Release Notes
<List any specific instructions relating to this particular release.
List any bug fixes in this release>
8 Related Documents
<List any related documents – e.g. application checklist, design documents, interface
specs, test specs, test execution results etc. >
<Provide any other miscellaneous information, not covered by the sections above, as
Appendixes if necessary>
CI Ref.
Version
Date
:
: Issue 1.0
: 13/05/03
Page 5 of 5