Previous Topic: Defining Simple AppliancesNext Topic: Defining Advanced Virtualization Attributes


Defining General

You can enter the general and visual information about your appliance. The most important parameters to define, at this point, are the name, instance name, and the icon color. As you think through how these parameters display on the grid, ask yourself what names would make this appliance understandable for other developers at a glance and what icon color scheme, such as indicating all gateways in red and servers in blue, would work for your use case. Keep in mind a catalog class appliance should work without any human intervention.

You can define the remaining parameters now or later depending on your use case.

General Attributes

Name

The class name is the name that displays on the icon in the catalog.

Instance Name Template

The name of the instance is automatically generated when you drag the icon on the canvas. You can change the instance name. The name is a single word, case sensitive, consisting of alphanumeric characters and underscore ([A-Za-z0-9_]); the name must be unique within the containing assembly.

Unlike the class name, the instance should name the role of the appliance. For example, in the catalog, the TomCat Application Server has an instance name of srv. In addition, the instance name should not have numbers or attributes, such as srv64. The name should be the role, not the class.

The name and instance name template display on the icon.

The first instance of the appliance uses the specified value, while subsequent instances use the name defined here, plus a numeric suffix. If no instance name is specified, the class name is used as the prefix for all appliances.

The appliance hostname is derived from the instance name. For information on disabling the default behavior of changing the hostname to a string derived from the instance name of the appliance, refer to the Customize Linux Appliance Behavior or Customize Windows Appliance Behavior in the Appliance Developer Guide.

Category

This is free text used to group appliances in the catalogs. You can use this to define a set of classes by function, such as database appliances or storage, by vendor, or other criteria.

Description

The description should describe the class and, typically, include the version of the main appliance package, such as TOMCAT appliance based on CentOS 6.3 64-bit and Apache Tomcat 6.

Documentation URL

The location of the documentation, such as the class datasheet or class documentation. You can add the URL later, if needed.

Visual Attributes

You can select the color, size, and operating system for the icon. The color is frequently used to group classes with different functions. For example, application servers could be purple and network components gray. In addition, select the size with an idea of the number of terminals in order to size a reasonably proportioned icon.