Infrastructure Editor Reference

This document describes the AppLogic Infrastructure Editor. The Infrastructure Editor is a visual tool that makes it easy to create, assemble and troubleshoot disposable infrastructure for AppLogic applications. The user interface of the editor is highly interactive and is modeled after Visio: you assemble infrastructure by dragging components onto the canvas, wiring them together and configuring each component using a property sheet.

Quick Links to Other Editor Documentation

The following are shortcuts to topics relating to the AppLogic Infrastructure Editor:

• Application Configuration describes the Application Configurator tool
• Manage Application Volumes describes how to manage application volumes
• Instance Settings Property Sheet covers the Instance Settings property sheet
• Class Editor - Simple Appliances describes the Class Editor for simple Appliances
• Class Editor - Assemblies describes the Class Editor for Assemblies
• ADL Descriptor Viewer/Editor - describes the ADL class descriptor editor/viewer.
• Application Migration Wizard - describes the application migration wizard for importing/exporting applications from/to a remote grid.
• Application Provisioning Wizard - describes the application provisioning wizard.
• Appliance Consoles
  • SSH Console
  • Text Boot Console
  • Graphical Console

Overview

This is the main screen of the Infrastructure editor. You use it to create and modify the disposable infrastructure for your applications. The same editor is used to edit the structure of the application and the structure of composite appliances (assemblies). In fact, the application itself is an assembly called main.

The editor main layout includes a palette with appliance catalogs on the left and a drawing canvas on the right.

You can reach the Infrastructure editor by first logging in and then selecting an application to edit.

Editing Applications

The application as a whole is an assembly -- a composite appliance with a well-defined boundary, built as a structure of connected appliance instances (subordinates). In addition to the application assembly main, which is created automatically by AppLogic, you can create additional assemblies that you can use to build up your application.

So, to restate, the infrastructure editor allows you to visually edit the interior structure of an assembly: to define the subordinate instances, their configurations and connections.

The editor provides a drawing canvas, where you build structures of connected appliances. The editor further provides a number of property sheets for configuring various aspects of the application and its appliances.

We have designed the editor to be intuitive and use the palette-and-canvas layout familiar from a number of drawing applications. Instead of reading the following sections that describe with text how to do visual operations, feel free to simply try the editor. Drag things left and right; double-click and right-click on various items and see what happens. If it wasn't easy to figure it out, please tell us.

Menu

The editor menu contains:

• Application
  • Configure - Configure the application - opens Application Configurator
  • Manage Volumes - Manage application volumes - opens Manage Volumes dialog
  • Login (ssh) - Log into the configured default appliance of the application via SSH - opens SSH Console
  • Login (web) - Access the Web Interface of the default appliance. This option is only available when the configured default appliance provides WEB access via its default interface.
  • Login (text) - Access the text boot console of the configured default appliance - opens Text Console
  • Login (graphic) - Access the graphical console of the configured default appliance - opens Graphical Console
  • Monitor - Monitor the application - opens Application Monitor
  • Modify Boundary - Edit the application boundary - opens Assembly Class Editor
  • ADL Main Descriptor - View/edit the class descriptor for the application's main assembly - opens ADL Descriptor Viewer / Editor
  • ADL Package Descriptor - View/edit the application's package descriptor - opens ADL Descriptor Viewer / Editor
  • save - save the current application
  • print - print the assembly currently on the canvas
  • Documentation - View application documentation. This item is only available if a Documentation URL is set for the application.
  • Close - close the editor

• Edit
  • Add Annotation - Add an annotation to the application
  • Cut - cut the selected appliance(s) into the clipboard (singletons are not supported)
  • Copy - copy the selected appliance(s) to the clipboard (singletons are not supported)
  • Paste - paste any appliance(s) from the clipboard to the canvas (singletons are not supported)
  • Delete - delete the selected appliance(s)
  • Select Mode - selection mode
  • Connect Mode - Select connection mode (default)
  • Balloon Mode - Select balloon connection mode
  • Pan Mode - pan the canvas (scroll)
  • Show/Hide Validation Errors - Show or hide the validation errors (unconfigured mandatory properties/volumes, unconnected mandatory terminals)

• Assembly
  • Navigate Up - Navigate
  • Login (ssh) - Log into the configured default appliance of the assembly via SSH - opens SSH Console
  • Login (web) - Access the Web Interface of the default appliance of the assembly. This option is only available when the configured default appliance provides WEB access via its default interface.
  • Login (text) - Access the text boot console of the configured default appliance of the assembly - opens Text Console
  • Login (graphic) - Access the graphical console of the configured default appliance of the assembly - opens Graphical Console
  • Modify Boundary - View/Edit the boundary of the assembly - opens Assembly Class Editor
  • ADL Class Descriptor - View/Edit the class descriptor of the assembly - opens ADL Descriptor Viewer / Editor
  • Class Documentation - View the assembly's class documentation. This item is only available if a Documentation URL is set for the assembly class..

• Appliance
  • Attributes - View/configure the appliance attributes. Opens Attributes Tab of the Instance Settings Property Sheet.
  • Resources - View/configure the appliance resources. Opens Resources Tab of the Instance Settings Property Sheet.
  • User Volumes - View/configure the appliance user volumes. Opens User Volumes Tab of the Instance Settings Property Sheet.
  • Property Values - View/configure the appliance property values. Opens Properties Tab of the Instance Settings Property Sheet.
  • Notes - View/Edit appliance instance notes. Opens Notes Tab of the Instance Settings Property Sheet.
  • Login (ssh) - Log into the selected appliance via SSH - opens SSH Console
  • Login (web) - Access the Web Interface of the selected appliance.
  • Login (text) - Access the text boot console of the selected appliance - opens Text Console
  • Login (graphic) - Access the graphical console of the selected appliance - opens Graphical Console
  • Set/Unset Default Console - Set or unset the selected appliance as the default console within the current scope.
  • View Interior - View the interior of the selected catalog class assembly.
  • View Boundary - View the selected catalog class' class boundary definition - opens Assembly Class Editor
  • Modify Interior - View/Edit the interior of the selected singleton class assembly.
  • Modify Boundary - View/Edit the selected class' class boundary definition - opens Assembly Class Editor
  • ADL Class Descriptor - View/edit the selected appliance's class descriptor - - opens ADL Descriptor Viewer / Editor
  • Branch Class - Branch the selected class thus creating a singleton appliance. This item is shown if the selected instance is not a singleton class. See Branching Classes for more information.
  • Move to Catalog - Move the selected singleton to a catalog.
  • Class Documentation - View class documentation for the selected appliance. This item is only shown if a Documentation URL is configured on the appliance.

• Tools
  • Grid Shell - Open a grid shell with the current application and or selected instance set as the current application and component.

• Help
  • Editor Documentation - opens this document
  • AppLogic Documentation - Opens AppLogic Documentation
  • AppLogic Forums - Goto AppLogic Forum
  • 3Tera Website - Goto 3Tera website
  • About AppLogic - information about the maker of AppLogic

Tool Bar

The editor toolbar provides quick access to the following functions:

• Application operations
  • Save - save the current application
  • Print - print the current application

• Clipboard operations
  • Cut - cut the selected appliance(s) into the clipboard
  • Copy - copy the selected appliance(s) to the clipboard
  • Paste - paste any appliance(s) from the clipboard to the canvas
  • Move to Catalog - move the selected appliance to the catalog

• Annotations
  • Add Annotation - Add an annotation to the application

• Edit mode
  • Select Mode - selection mode
  • Connect Mode - connection mode (default)
  • Balloon Mode - balloon connection mode
  • Pan Mode - pan the canvas (scroll)

• AppLogic operations
  • grid shell - open command line shell
  • Login (ssh) - Login to the configured default appliance of the application or the selected appliance instance via SSH - opens SSH Console
  • Login (web) - Access the Web Interface of the default appliance of the application or the selected appliance instance. This option is only available when the configured default appliance or selected instance provides WEB access via its default interface.
  • Login (text) - Access the text boot console of the configured default appliance or the selected appliance instance - opens Text Console
  • Login (graphic) - Access the graphical console of the configured default appliance or the selected appliance instance - opens Graphical Console
  • Set/Unset Default Console - Set or unset the selected appliance as the default appliance
  • Monitor - Monitor application - opens Application Monitor

Next to the buttons, the editor shows the name of the application and the hierarchical path to the assembly being edited. The path also doubles as "breadcrumb" navigation: you can step up to parent assemblies, all the way up to main.

Canvas Context Menu

The following operations are available by right-clicking on the canvas via the right-click context menu:

• Canvas Operations
  • Paste - Paste any appliance(s) from the clipboard to the canvas
  • Add Annotation - Add an annotation to the application

• Application Access Operations
  • Login - Access the default console of the configured default appliance of the application.

• Application Editing Operations
  • Manage Volumes - Manage application volumes - opens Manage Volumes dialog
  • Modify Application Boundary - Edit the application boundary - opens Assembly Class Editor
  • Configure Application - Configure the application - opens Application Configurator

• Application Documentation Operations
  • Application Documentation - View application documentation. This item is only shown if a Documentation URL is set for the application.

Instance Context Menu

The following operations are available by right-clicking on an appliance within the application via the right-click context menu:

• Appliance Configuration Operations
  • Attributes - View/configure the appliance attributes. Opens Attributes Tab of the Instance Settings Property Sheet.
  • Resources - View/configure the appliance resources. Opens Resources Tab of the Instance Settings Property Sheet.
  • User Volumes - View/configure the appliance user volumes. Opens User Volumes Tab of the Instance Settings Property Sheet.
  • Property Values - View/configure the appliance property values. Opens Properties Tab of the Instance Settings Property Sheet.
  • Notes - View/Edit appliance instance notes. Opens Notes Tab of the Instance Settings Property Sheet.

• Appliance Access Operations
  • Login - Login to the the selected appliance. If the appliance is an assembly, the default console of that appliance is logged into; if the appliance is not an assembly, then that appliance is logged into.

• Appliance Class Operations
  • Branch Class - Branch the selected class thus creating a singleton appliance. This item is shown if the selected instance is not a singleton class. See Branching Classes for more information.
  • View Interior - View the interior of the selected class assembly. This item is shown if the selected instance is a catalog appliance
  • View Boundary - View the selected class's boundary definition. This item is shown if the selected instance is a catalog appliance
  • Modify Interior - View/Edit the interior of the selected singleton class assembly.
  • Modify Boundary - View/Edit the selected class' class boundary definition.
  • Class Documentation - View class documentation for the selected appliance. This item is only shown if a Documentation URL is configured on the appliance.

Catalogs

In AppLogic, each application has access to a two or more catalogs. At a minimum, the application has access to the global system catalog and to its local catalog.

The global system catalog contains appliance classes that are common for AppLogic and are accessible to all applications. Changing an appliance in the global catalog affects all applications.

The local catalog contains appliance classes specific to the application you are editing. Each application has its own local catalog. Changing an appliance in the local catalog affects only this application. Many applications don't actually have any appliances in the local catalog and use only appliances from the global catalog.

You can select which catalog to use by choosing it from the drop-down box above the palette.

The appliance classes in a catalog are grouped by category. You can visually collapse or expand a category by clicking on the category name. If the catalog has a lot of appliances, you may be able to scroll the catalog up and down as well.

The editor shows the catalog appliances with smaller shapes, using the same color and terminals as the appliance will have when dropped on the canvas. The class name of each appliance is shown under the shape.

You can create an instance of an appliance class by dragging its shape onto the canvas.

You can move a singleton appliance to the catalog -- and make it a catalog class -- by dragging the singleton into the catalog (make sure you have selected the correct catalog first). See Branching Classes for more information on singletons and on customizing classes.

You can access the following operations over appliance classes by opening the right-click menu on a class in the catalog:

• Delete Class - Delete the class
• Rename Class - Rename the class
• Create Instance - Create an instance (similar to dragging the class shape onto the canvas)
• Move To... - Move the class to another catalog (or to the application as a singleton)
• View Descriptor - View the class descriptor - opens ADL Descriptor Viewer / Editor
• View Boundary - View the class (in the Class Editor)
• Class Documentation - View the class documentation
• Help - View this document

Canvas

The canvas is the drawing area, where you assemble your application by dragging elements from the catalog pallete and connecting them.

In addition to dragging instances around, selecting instances and re-routing connections, you can right-click on the canvas and access the following operations:

• paste from clipboard
• create annotation
• access application console
• manage application volumes
• edit or view the boundary of the assembly (opens the Class Editor)
• configure the application as a whole (opens the Application Configuration)
• view application documentation

Status Bar

The status bar shows your user name and the names of the currently selected appliances.

Also, it shows a progress indicator for some of the longer operations (such as loading or saving an application).

Subordinate Instances

You can create an instance of an appliance -- a subordinate within the assembly -- by simply dragging an appliance shape from a catalog palette onto the canvas. Once you create the instance, you can move its shape freely anywhere on the canvas.

The shape consists of the following visual elements:

• a main body (the rectangle in the middle)
• an instance name, shown in the center of the shape
• a class name, shown in the lower left side of the shape
• one or more terminals, shown as block arrows ( and ) on the left and/or right side of the shape

You can configure the instance settings of the new appliance by double-clicking on it: the editor opens the Instance Settings property sheet for the instance.

You can change the class name of a subordinate by SHIFT-dragging the new class form the catalog onto the existing subordinate. This is useful if you wish to replace a WEB5 with WEB64, replace an IN gateway with INSSL, etc.. However, the following limitations apply:

• the names and number of terminals must be the same between the two classes
• the subordinate that is to be replaced may not be a branched instance.

If the existing subordinate is not connected to any other instance, the class name of the subordinate may be changed regardless of the number and names of its terminals.

You can also perform the following operations on it by opening a right-click menu on the shape:

• configure Instance Settings: Attributes, Resources, User Volumes and Properties
• Log into the appliance
• branch the appliance class to create a new class based on this instance (called a singleton class). See Branching Classes for more information.
• view or edit the appliance class (opens the Class Editor property sheet)
• view or edit the interior of an appliance, if it is itself an assembly (step into the assembly)
• View the class documentation

Connections

Once you have a few instances, you can also connect them. Appliances can be connected by connecting their terminals (the named "arrows" that stick out of the appliance shape). You connect two appliances by clicking on the terminals you want to connect: click the output first, then the input you want it connected to.

The mouse cursor will provide clues as to what connections are allowed. Many outputs can be connected to a single input. Each output, however, can be connected to exactly one input. It is even possible (but rarely useful) to connect the output of an appliance to an input of the same appliance.

For more information on what the connections mean at runtime and the benefits of using connections, please see the AppLogic Overview.

When multiple outputs are connected to a single input, the editor reduces visual clutter by joining the connections with as few lines as possible. Whenever a connection joins an existing connection, the editor places a small dot, indicating the joining of connections.

You can route the connections manually by dragging their corners up/down or left/right. Once you position the mouse cursor on a connection corner, it will give you visual clue as to what directions are allowed. You can also add a segment to the connection route, which will allow you to make a route that passes around another appliance.

You can perform the following operations over a connection by right-clicking on the connection and selecting from the menu:

• add a segment
• re-route the connection (automatic re-route, useful to simplify connections)
• delete the connection

Selection

You can select one or more appliances in order to perform operations on them.

Clicking on an appliance makes it the selected appliance. Clicking on an appliance while holding the Ctrl key adds the appliance to the currently selected appliance group. Drawing a rectangle on the canvas around several appliances selects all the appliances within that rectangle.

The editor shows the current selection with dashed line. Once you select a few appliances, you can do the following with them:

• move them as a group. The editor will keep the connection routing between the selected appliances and re-route the connections between the selected appliances and the appliances that remain on the canvas.
• delete them (press the Del key on the keyboard, or select Delete from the right-click menu on one of the selected appliances)
• cut or copy them as a group to the clipboard

Annotations

You can add one or more notes or annotations to the application such as describing usage of various appliances in its architecture.

An annotation can be created by clicking on the Annotation button on the tool bar. You can edit the annotation by clicking on the created text box. In addition, you can change the color of the background by clicking on the icons in the bottom left corner of the annotation text box. Clicking on the lower right corner of the annotation text box and then dragging the mouse will resize the annotation text box. The color of the text background may be changed by clicking on the icons in the lower left corner of the text box.

Editing Assemblies

This section describes elements and editing capabilities that are available only when editing assemblies that are not the application top-level assembly (main).

The editing of an assembly is very much like editing and configuring application main. The following is a description of how to create and edit an assembly class.

• Drag the assembly template class from the "New Singletons" section of the catalog pane onto the canvas.

• Right click on the new assembly appliance shape and chose "Edit Class". Configure the boundary of the assembly class as you would for a simple class. See Assembly class editor for details).

• To edit the interior of the assembly, Right click on the assembly appliance shape and chose "Edit Interior". You will be presented with a canvas that contains shapes for the assembly as defined by the class boundary.

• Create the infrastructure of the assembly by dragging classes from a catalog or creating new singleton classes as you would for editing the application main.
  Note, in order to move around the assembly terminals, you need to click within the gray area on the terminal shape to select it and then drag it to the desired position on the canvas.

• Configure the assembly subordinate instances are required. See class editor for details).

• When you are all done creating and configuring the assembly interior, click the "Save" button to save your changes.

• After testing the assembly, you can move it to a catalog by clicking on the assembly class shape and dragging it to the appropriate catalog as you would do for a simple class.

In AppLogic, assemblies can be used in any place you would use a simple appliance. This makes it possible to reuse infrastructure without increasing the the complexity of the application. For example, a specialist in database clustering can create a "stock" assembly for clustered database deployment like the one shown above and publish it in a catalog.

Application integrators can then use this assembly in multiple applications, whenever they need database scalability and/or high availability, and without having to know how exactly the cluster is set up and operates.

Design Rule Check

The editor tracks unconfigured mandatory properties/volumes and unconnected mandatory terminals for all appliances in an application. Such appliances that need configuration and/or are missing connections are visually flagged with on the canvas. When the mouse cursor is dragged over the flagged appliance, the editor displays the list of properties/volumes/terminals that need attention. The editor also displays on the status bar the number of entities that need attention. This feature also includes highlighting unconfigured mandatory properties/volumes that are not configured on appliances/applications.

-- PeterNic - 22 May 2006