rPath Appliance Platform Agent:Configuration Wizard

From rPath Wiki

The rPath Appliance Platform Agent Configuration Wizard prompts for a step-by-step initial configuration the first time an administrator logs in to the web interface. The appliance agent is said to be in wizard mode during this initial configuration.

Wizard mode runs through a set of plugins before allowing the user to access any other appliance agent page. The plugins included in this sequence are determined by the wizard.plugins directive in rPath Appliance Platform Agent configuration. The appliance agent steps through the plugins in the order they are specified in wizard.plugins. Each stage in the wizard is applied once the data is submitted back to the Agent's web server. The wizard session will time out after some period of time configured by the ISV, after which the user must log in again. If this occurs, the wizard will pick up at the last plugin that was not completed.

Default Wizard Sequence

The default Configuration Wizard sequence is as follows:

1. User Management (change the password for the admin user)
2. Configure Email
3. Configure Notification
4. Configure Networking
5. Configure Proxy
6. Manage Entitlements (if applicable)
7. Back Up and Restore (configure a backup schedule)

Customize the Wizard

Developers can specify plugins which should be part of the Configuration Wizard by adding a custom wizard.plugins directive in /etc/raa/custom.cfg, the file used to apply custom configuration for the appliance agent. Use the plugin identifiers for each plugin in the order you want the plugins to be presented to the initial user. Use the wizard.plugins directive in /etc/raa/prod.cfg as a reference.

The following is an example of some default plugins with a custom ManageGame plugin added:

# Wizard plugins to run in this order.
wizard.plugins = ["/usermanagement/UserInterface", "/configure/Network", "gamemgmt/ManageGame"]

The appliance agent will not exit the wizard mode until the plugin is configured. After a the plugin is configured, the appliance agent will not run the plugin in wizard mode again unless the plugin's wizardSerial attribute is modified.

Add a New Plugin to the Wizard

If a newly developed custom plugin is included in an appliance, use the wizard.plugins directive as previously described if it should be part of the Configuration Wizard sequence. Additionally, to inform the framework that a plugin should use the wizard mode, call self.wizardDone() from the web component of the plugin (see Plugin Development pages for more information).