Documentation Roadmap


#1

OSM Documentation Roadmap

This is a work-in-progress to outline the documentation requirements for the Charmed Distribution of Open Source Mano.

Document Requirements

  • Browseable on the web
  • Available in PDF, Word, Visio, etc.
  • Written in English

Document(s)

This information may be presented as part of one or more separate documents:

Operational Guides

These guides focus on the operation of Open Source Mano.

  • Operational Maintenance Guide (Runbook). This operative guide should allow an efficient management and a quick resolution of the problems that may appear. It must include the following information:

    1. start/stop monitoring processes;
    2. backup configuration and restoration procedure;
    3. special operations for eventualities and contingency management;
    4. Continuity plan;
    5. troubleshooting guide: causes of system error and its management (what, where, decision tree…);
    6. Severity mapping;
    7. Alarm handling;
    8. KPI/KQI/capacity thresholds recommendation;
    9. Routine maintenance tasks;
    10. Preventive health checks;
    11. Interface development guide.
  • VNF Onboarding Guide

Administrative and Technical Guides

These guides focus on the administration of the Charmed Distribution of Open Source Mano and Open Source Mano itself.

  • System Configuration Guide
    Detailed information about the configuration files and an estimation of the disk space required should be provided.

  • Installation Guide
    Detailed information on how to perform a new installation and how to configure the system.

  • Troubleshooting Guide

  • Architecture Guide
    Describes the overall architecture of the Charmed Distribution of Open Source Mano and Open Source Mano itself.

Other

  • Product documentation and architecture Documentation describing the overall architecture of the proposed system showing, at least:
    1. Requirements for the physical environment to run the Product in appropriate conditions for different sizes/scales (see Capacity considerations for more details).;
    2. Logical functionalities;
    3. External interfaces;
    4. Relevant internal interfaces;
    5. Relevant communication protocols.

#2

Is there any input from the Juju core team that would be useful?


#3

Not at the moment, but I’ll let you know if that changes!