Documentation_Plan

Documentation Plan

Phase 1: Aeolus Information Planning

This is the project page for Aeolus Re-documentation. This plan provides an overview of the documentation expansion.

Purpose of the Documentation

Aeolus is Iaas Cloud computing management software. The ‘Getting Started Guide’ produced by Aeolus is a basic how to document and will be re-formatted and re-written to provide the audience/user with further in-depth instructions.

What the documentation will cover

The expansion of the Aeolus ‘how to’ will provide a more comprehensive and in-depth version of the already existing documentation and usage guides. The updated documentation will include GUi and Command Line instructions for all necessary elements, include runtime configuration, permissions and logging and reporting as extra support.

The basic glossary will be expanded to incorporation all new terms used and the Aeolus Configuration will now include Audrey Configuration (configuring, usage, and deletion).

Audience

The audience for the documentation will be users who need to manage instances using multiple cloud provides.

• New Users - provide basic instructions for Aeolus
• Developers - people who might have an interest in enhancing Aeolus
• Cloud Computing Enthusiasts - those who have an interest in cloud computing and wish to further their knowledge

This documentation aims to be readable and useful by both experienced cloud management users and non-experienced individuals who have had no priors with cloud computing.

Audience Goals

• Successfully understand the processes of installing Aeolus
• Understand both GUi and command line based instructions

Usability Goals

New and old users who are looking to increase their general knowledge of Aeolsu and its components. Advanced Aeolus users will have little to no use of this updated manual as it still aims to provide the basics.

Objectives

The upgrade of this manual aims to:

• Cover both GUI and Command Line in a comprehensive manner
• Include extra support on features such a runtime configuration, permissions, logging and reporting
• Expand the basic glossary to encompass new terms

Existing Documentation

• http://aeolusproject.org/use_it.html
• http://docs.redhat.com/docs/en-US/CloudForms/1.0/html/Cloud_Engine_User_Guide/index.html

Initial Schedule Outline

Phase 1: Information Planning
10% = 20 Hours, 3 July 2012

Phase 2 Content Specification
20% = 32 Hours, 16 July 2012

Phase 3: Implementation
50% = 92 Hours, 21 August 2012

Phase 4: QE
19% = 24 Hours, 30 August 2012

Phase 5: Evaluation
1% = 8 Hours, 4 September 2012

Phase 2: Content Specifications

Pages Added

There were 9 chapters on the 0.10.0 Aeolus user guide. There will be an estimated amount of 13 chapters at the end of the document expansion.

Screen shots

GUI screen shots will be required for the updated document. It is estimated that per chapter there will be at least one screenshot. Numbers have not been made finite as a result of updating software.

Contents Page

Items bolded are items that are being added to the original document, or modified.

1. Basic Glossary - Expansion to encompass new terms that are being incorporated.
   *** Eg: Audrey, Runtime Configuration
   # Configuring Aeolus
   # First Log In
   ## Administrator Passwords
   # Configure Providers
   ## Configuring EC2 Provider
   ##**Configuring RHEVM/Ovirt Provider*
   ## Configuring VMware Provider
   ## Audrey Configuration
   ## Creating a Cloud
   # Create A Fedora 16 Template
   ## Creating the Template
   ## Uploading to Aeolus
   ## Building a Template into an Image
   ## Pushing the Image to a Provider- Pushes the target image to a Provider

   1. Importing an Image from a Provider - Details how to grab an image from a provider and import onto your Aeolus environment
      # Configure Command Line Interface Tool
      ## Building an Image with Aeolus Command Line- Uses Aeolus command line tool to build Template Descriptor Language (TDL) file into an image for a cloud resource provider
   2. Command Line Syntax - Action types for Aeolus
      # Start an Instance of the Image
      ## Create a Catalogue- Collection of the deployable. These deployables simplify the process of launching an application
   3. Create the Deployable - An instance, or a set of instances launched in a provider
      ## Configure EC2 for SSH Connections
      ## Connect to the Instance
      # Runtime Configuration
      ## Adding Audrey to an Instance of the Image- Configuration of an instance with specialised parameters upon launch of an application. Installs Audrey to component outline
   4. Adding Runtime Configuration to a Deployable - Providers users with runtime configuration options when launching an application
      ## Launching Instances with a Runtime Configuration- Provides users with runtime configuration options when launching an application

2. Users

   1. Shows users how to edit and delete details of an existing user

3. Permissions

   1. Global Permissions - Global roles grants to a user or set of users launching a deployment
      ## Provider Permissions- Providers users with access to Providers
   2. Pool Permissions - Provides users with access to Pools
      ## Deployable Permissions- Provides users with access to a deployable

4. Stop Running Instance

   1. Stopping the Instances
   2. Check for Instances left running in EC2

5. Logging and Reporting - Function for generating event reports for instances and a series of logs to track functions for individual components
   ## Accessing Aeolus Log- New function

   1. Accessing Instance History
   2. Exporting Instance History
   3. Accessing Log Files

6. Cleaning Up

   1. Unconfiguring Aeolus

   2. Remove AMI’s left in EC2

      • Deregistering an AMI
      • Removing Storage

   3. Next Steps (links to mailing list, etc)