Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A document with the description of the service and how the service operationally works should be redacted.
And example of the structure of the document and the aspects that should be described follows:

Introduction 

...

    • CentOS Release 6.6 Final
    • Apache HTTP server (Apache/2.2.15)
    • Wildfly application server (Wildfly/8.1.0.Final) and Java(TM) SE Runtime Environment (build 1.7.0_67-b01)
    • Database management system (PostgreSQL server 8.4.20)

 

...

Generic requirements 

 Infrastructure hosting requirements 

...

...

 

Hardware and network 

...

 

...

High availability 

...

 Monitoring

...

 

...

Addressing and naming 

...

 System administration requirements

Operating system administration - highly desirable

Disaster recovery and backup - should be defined; daily database backups and weekly VM backups should be sufficient

Log retention - one or two months

Accessibility of service instances service instance accessibility is not critical

 Operation procedures

Enrol of a new user - to be defined with MDVPN team

Deployment of new customer instances (if applicable)- N/A (there should be only one instance)

Updates of the service instances - system software should be updated regularly

 Key Performance indicators 

...

 Support 

...

The following list is a complete example of what should be documented.
It might be that some of these points are not applicable to your service. For a more complete list of things that should be documented check the check list attached to this page. 

...