Download Database Build Book - Office of the Chief Information Officer

Government of Newfoundland and Labrador
Office of the Chief Information Officer
Database Build Book
Purpose: The Database Build Book will be used as an installation and database configuration guide. This
guide will assist in creating and installing an application in the event that the database were to fail and had to
be rebuilt and installed from scratch.
Application Portfolio Number
Project Name
Project Number
<< DTC Number >>
Project Sponsor
Project Manager
(name)
Project Description
(email)
(phone number)
<< Provide a short description of the project. >>
Important Notes for Completing this Document
Each section of the Database Build Book must be completed in full. If a particular section is not applicable to
this project, then you must write Not Applicable and provide a reason.
Important Note: No sections are to be deleted from this document. Text contained within << >> provides
information on how to complete that section and can be deleted once the section has been completed.
Database Build Book
Template Version 2.7 2014-04-06
Page 1 of 6
High Sensitivity
Government of Newfoundland and Labrador
Office of the Chief Information Officer
TABLE OF CONTENTS
1.0 OVERVIEW ....................................................................................................................................................... 3
2.0 ARCHITECTURE SYSTEM OVERVIEW .......................................................................................................... 3
3.0 DATABASE ...................................................................................................................................................... 3
SECURITY/ENCRYPTION ......................................................................................................................................... 3
SOFTWARE INSTALLATION ...................................................................................................................................... 4
DATABASE CREATION ............................................................................................................................................. 4
DATABASE INITIALIZATION PARAMETERS.................................................................................................................. 5
DATABASE BACKUP DOCUMENTATION ..................................................................................................................... 5
IMPORTANT NOTES ................................................................................................................................................ 5
4.0 REVIEWED BY: ................................................................................................................................................ 6
5.0 APPROVED BY: ............................................................................................................................................... 6
Database Build Book
Template Version 2.7 2014-05-29
Page 2 of 6
High Sensitivity
Government of Newfoundland and Labrador
Office of the Chief Information Officer
1.0 OVERVIEW
Contact Information
<< A Chart of Authorities will be completed for each application. The Chart of
Authorities is the primary source for all authorization. >>
<< Identify the location and name of the Chart of Authorities in TRIM. >>
2.0 ARCHITECTURE SYSTEM OVERVIEW
Description
<< Provide a brief overview of the database architecture. Table structure,
relationships etc.
Important note: A more in-depth explanation of the System Architecture can
be derived from the Detailed Architecture Design (DAD) document and from
the Server Build book for the project. >>
Database Architecture
Diagram
<< Include a schematic diagram that illustrates the database in relation to the
overall application. >>
3.0 DATABASE
Description
<< Provide a brief overview of the database technology such as; Oracle,
MySQL, SQL Server, etc to build the database. >>
<< Fill in the sections below with the information relevant to the database
technology used. >>
Security/Encryption
Overview
<< Provide a brief overview of database security/encryption such as:
encryption technique, database lockdown, security configurations etc. >>
Important note: Unless noted, all Enterprise Architecture Group guidelines
were followed. Additional, information can be derived from the Detailed
Architecture Design (DAD) and Database Server Build Book documents.
Encryption Technique
Database Lockdown
Security Configurations
Other (Provide a detailed
description of any other
Database Build Book
Template Version 2.7 2014-05-29
Page 3 of 6
High Sensitivity
Government of Newfoundland and Labrador
Office of the Chief Information Officer
technique)
Software Installation
Description
<< Detail the steps for downloading and installing the database software.
Examples of the types of information can include, but are not limited to the
following: download link/URL, unpacking files, host file configuration, setting
kernel parameters, setup, and patch level if applicable. >>
Database Software Installation Instructions
Step #
Instructions
Database Creation
Description
<< Provide detailed installation/configuration steps necessary for creating the
database. Two creation scenarios can exist: A) Database is created from
scratch or B) the database is restored from a pre-existing database backup.
Important Note: For Scenario A provide the location of instance and table
creation scripts in the “Instance creation and population” section below. >>
Scenario A: New Database Creation
Step #
Instructions
Scenario B: Database Restore from a Pre-Existing Backup
Step #
Database Build Book
Template Version 2.7 2014-05-29
Instructions
Page 4 of 6
High Sensitivity
Government of Newfoundland and Labrador
Office of the Chief Information Officer
Database Initialization Parameters
Description
<< Provide information on the parameters applicable to the database
software version used for database creation. >>
Database Creation
Initialization
Location and description of parameters
Password Files
Parameter Files
Memory Parameters
Database Files
Archive Logs (Oracle)
Redo Logs (Oracle)
Control Files (Oracle)
Transaction Logs (SQL
Server)
Binary Logs (MySQL)
iblogs (MySQL)
Other
Database Backup Documentation
Description
<< Provide detailed information on database backup, if the documentation
has already been created list the TRIM reference number. >>
Notes:
Important Notes
Description
Database Build Book
Template Version 2.7 2014-05-29
<< Provide noteworthy information pertaining to any aspect of the database
build process. These notes will inform and assist those personnel who are
not familiar with the database during the build/re-build phase. >>
Page 5 of 6
High Sensitivity
Government of Newfoundland and Labrador
Office of the Chief Information Officer
Notes
4.0 REVIEWED BY:
Project Manager
(Print name)
(signature)
(date)
(Print name)
(signature)
(date)
(Print name)
(signature)
(date)
Application Delivery Manager
5.0 APPROVED BY:
Application Protection
Manager
Database Build Book
Template Version 2.7 2014-05-29
Page 6 of 6
High Sensitivity