BundleWorks Documentation
   Next

BundleWorks Documentation

Copyright © 2007 Sauers Technologies

December 1, 2007

Table of Contents

1. Introduction
1.1. What is BundleWorks?
1.2. Platform Support
1.3. Using this Documentation
2. Tutorial
2.1. Requirements
2.2. Introduction
2.3. Terms
2.4. Getting Started
2.5. Installing BundleWorks
2.6. Getting Help
2.7. Adding & Removing Bundles
2.8. Bundling Existing Software
2.9. Creating an Environment
2.10. Deploying Java & HelloServer
2.11. Running HelloServer
2.12. Creating Another Environment
2.13. Configuration Versioning
2.14. Upgrades and Rollbacks
2.15. Exploring
2.16. Cleaning Up
3. User's Guide
3.1. Installing BundleWorks
3.1.1. Preparing for Installation
3.1.2. Extracting the BundleWorks Archive
3.1.3. Deploying a BundleWorks Instance
3.2. Running BundleWorks
3.2.1. Loading BundleWorks
3.2.2. Using the Command Line
3.2.3. Using the Ant Tasks
3.2.4. "Load and Run"
3.3. Using BundleWorks
3.3.1. Typical BundleWorks Scenario
3.3.2. Developer Steps
3.3.3. System Administrator Steps
3.4. Bundles
3.4.1. Loadable vs. Executable
3.4.2. Third-Party vs. Custom
3.4.3. Creating Bundles
3.4.4. Adding Bundles to Inventory
3.4.5. Removing Bundles from Inventory
3.4.6. Importing Bundles
3.5. Environments
3.5.1. Creating an Environment
3.5.2. Removing an Environment
3.5.3. Using an Environment
3.6. Deployments
3.6.1. Deploying Bundles
3.6.2. Undeploying Bundles
3.6.3. Deployment Commands
3.6.4. Custom Commands
3.7. Advanced Features
3.7.1. Configuration Versioning
3.7.2. Tasks
3.7.3. Exporters
3.8. Security Considerations
3.8.1. Permissions
3.8.2. Distributing Bundles
3.9. Troubleshooting Tips
3.9.1. Using Logs
3.9.2. Debugging Scripts
3.9.3. Support Options
3.10. Uninstalling BundleWorks
4. Reference
4.1. BundleWorks Commands
4.1.1. add
4.1.2. bundle
4.1.3. deploy
4.1.4. envcreate
4.1.5. envremove
4.1.6. export
4.1.7. help
4.1.8. history
4.1.9. import
4.1.10. info
4.1.11. list
4.1.12. remove
4.1.13. taskrun
4.1.14. undeploy
4.1.15. use
4.1.16. version
4.1.17. whereis
4.1.18. which
4.2. Deployment Commands
4.2.1. cfgdiff
4.2.2. cfghistory
4.2.3. cfgrestore
4.2.4. cfgview
4.2.5. history
4.2.6. info
4.2.7. kill
4.2.8. restart
4.2.9. run
4.2.10. start
4.2.11. status
4.2.12. stop
4.2.13. version
4.3. Bundlers
4.3.1. ant
4.3.2. apache-source
4.3.3. custom
4.3.4. java-app
4.3.5. java-service
4.3.6. java-webapp
4.3.7. jdk
4.3.8. junit
4.3.9. loadable-source
4.3.10. mysql-ref
4.3.11. mysql-source
4.3.12. tomcat
4.4. Exporters
4.4.1. monit
4.4.2. nagios
4.5. Tasks
4.5.1. archivelogs
4.5.2. daily
4.5.3. hourly
4.5.4. monthly
4.5.5. weekly
4.6. Script Functions
4.6.1. adjust_paths
4.6.2. add_property
4.6.3. broadcast_message
4.6.4. check_config
4.6.5. check_if_running
4.6.6. copy_contents
4.6.7. env functions
4.6.8. prompt functions
4.6.9. remove_property
4.6.10. replace_vars
4.6.11. wait_for_start
4.6.12. wait_for_stop
4.7. BundleWorks Layouts
4.7.1. Bundle Directory Layout
4.7.2. Example of a Loadable Bundle
4.7.3. Example of an Executable Bundle
4.7.4. Environment Directory Layout
4.7.5. Example of an Environment
4.8. BundleWorks Variables
4.9. Bundle Hooks
4.10. Info Files
4.10.1. Bundle Info
4.10.2. Environment Info

List of Tables

4.1. Variables available in Bundle hooks
4.2. Environment Variables used by BundleWorks
4.3. Bundle Hooks
4.4. Bundle Info Attributes
4.5. Enviroment Info Attributes
   Next
   Chapter 1. Introduction