Documentation

Documentation Organization

The goal for this documentation is to that we have a single source for each type of documentation that can be included in the releases, linked to from anywhere and easy to maintain. 

VCL Install Guide

• Design Considerations - Decisions to be made before starting a VCL install
• Network Diagram
• Installation
  • Database Configuration
  • Web Code Installation
  • Management Node Installation
• Creating Base Environments
  • Create a Windows Base Image
  • Create a Linux Base Image
• Installing & Configuring Provisioning Modules
  • xCAT (xCAT.pm)
  • xCAT 2.1 (xCAT21.pm)
  • VMware Server (vmware.pm) - uses vmware-cmd on host server to interact with VMware Server and ESX Standard Server
  • VMware ESX (esx.pm) - uses the VMware Perl Toolkit API to manage VMware ESX and ESXi
  • Lab (Lab.pm) - brokers access to standalone lab machines (does not support reloading or imaging)
• Experimental
  • Creating a Standalone VMware VCL Environment - instructions to set up a working VCL environment on a single computer using VMware

VCL System Administration Guides

• Administrator's FAQ
• HowTo's
  • Web interface administrative tools
  • Add machines to computer table
    *
• Granting access through the Privilege tree
• Group management 
• Tying in web authentication - LDAP, shibboleth, etc
• Creating web skins
• How Image management works

VCL End-User Guides

• Getting started
• How to create images
• XML RPC Documentation

VCL Developer Guidelines

• Joining Apache VCL community
  • mailing lists
• How to become a committer
• Code Architecture
  • Web - php
  • Backend  - vcld perl
  • database schema - mysql
• Creating additional modules for backend
  • Provisioning modules
  • OS modules
• Web code structure - php
• JIRA
  • Reporting bugs
  • Suggestions for improvements
• Commits into apache vcl svn repository
  • Guidelines