ShowTable of Contents
This document details the deployment instructions for the IBM® Domino® Messaging ServerTM Hypervisor Edition, as well as the IBM® Domino® Enterprise ServerTM Hypervisor Edition. Domino is provided in the form of Open Virtual Archives (hereafter referred to as OVAs, or images) for deploying through the IBM Workload Deployer Appliance (IWD) and IBM PureSystems.
IBM PureSystems is a new product family of expertly integrated systems from IBM that combine software and hardware to give you a pre-configured, efficient virtualization platform. The offering from PureSystems that function with the IBM Domino Messaging Hypervisor Edition is the IBM PureApplication System (PureApp), and includes IBM middleware images and patterns to customize and deploy, relying on the IWD function to handle image and instance management. Because the IWD function is an integral part of PureApp, working with the IBM Domino Messaging and Enterprise Server patterns within PureApp is identical to working with them on IWD.
This OVA allows you to experience the fully functional Domino Messaging Server instance deployed through IWD and PureApp. The images also include definitions and configurations for multiple parts of a typical Domino Messaging server deployment, allowing you to build very simple to more complex topologies quickly and easily. In addition, the packages also include optional Domino configuration optimization capabilities according to the virtual machines’ configuration.
In this guide we focus on the process of setting up an instance of IBM Domino messaging server, covering the following topics in detail:
Initializing a new instance based of the OVA, using deployment patterns created by the user
Accessing and managing IBM Domino messaging server
Building a new OVA based on an instance you customize
This documentation is intended for users who have a general knowledge of Linux® and how it works. To get the most from this article, you should have a good understanding of Linux commands and how to manipulate input and output. You should also have a good working knowledge of the PureApp and IWD appliance, its administrative console, and how to deploy patterns using it.
We provide a basic overview of how to manage IBM Domino messaging server and include links to product documentation for more detailed information and guidance on how to use the product to build a messaging solution.
OVA contents and configuration
The Domino Messaging Server OVA is a pre-installed and pre-configured instance of the product. Instances created based on this OVA are ready to use and pre-configured with certain features to make it easier to get started. The product configuration includes:
Domino Domain Certificate and Security Enablement - During the deployment of the OVA, you will be required to set the Domino organization ID and password, the organization unit ID and password, and the Domino administrator ID and password. With this basic Domino startup information, the Domino security configuration will be enabled.
Domino Messaging Administration Server - A messaging administration server part is defined to be run in it's own virtual machine for managing a Domino domain containing Domino messaging server clusters or a set of Domino messaging custom servers not belong to a cluster.
Domino Messaging Custom Server - A messaging custom server part is defined to be run in its own virtual machine for providing the Domino messaging service in a Domino domain. The custom server will belong to a cluster if it's Domino cluster setting is enabled in the patterns.
Domino Messaging Addition Server - A messaging additional server part is defined to be run in its own virtual machine for providing the Domino messaging service as a member of an existing Domino domain which may or may not deployed through the Domino Messaging server OVA.
Domino Messaging Standalone Server - A messaging standalone server part is defined to be run in its own virtual machine as an all-in-one Domino messaging server as well as a messaging administration server which has its own Domino domino setup.
SSL Security enablement - Domino server SSL is enabled so that clients and servers that connect to the server use SSL to ensure privacy and authentication on the network.
Web Server enablement - The IBM Domino Web Server is configured to provide port 80 and 443 access to the Domino Messaging Server, so that clients can access the Domino messaging service directly from browsers.
Attachment and Object Service enablement - Domino Attachment and Object Service (DAOS) is configured for all Domino messaging servers deployed through the Domino messaging server patterns. If a second hard disk is configured, DAOS will store the attachments on that disk via a simple setup of a directory mount point in the IWD UI.
Transaction logging enablement - Domino transaction logging is enabled to captures changes made to databases and to write them to a transaction log. The logged transactions are then written to disk in a batch, either when resources are available or when scheduled. If a second disk is configured, the transaction logs are stored on that disk automatically without additional configuration being required.
Internet Cluster Manager enablement - An Internet Cluster Manager (ICM) instance is enabled in the Domino Administration server part of the simple cluster pattern to let you use Domino clusters to provide failover and workload balancing to HTTP clients (Internet browsers) when they access the Domino messaging services.
Domino Cluster enablement - A Domino cluster is enabled if there is a Domino Administration server part and Domino custom server parts deployed. The cluster enablement requires you input the name of Domino cluster from the deployment UI.
Adding the OVA to IWD and PureSystems
There are two methods for adding the Domino Messaging Server OVA into IWD: the Web interface and the command line.
To import the image, patterns, and script packages using pure.cli commands
Uncompress and extract the downloaded Domino Messaging Server Hypervisor Edition to a temporary directory. You should have a file named install and 2 subdirectories: ./content and ./pure.cli in the /tmp/Domino_Messaging_9.0.0_RHEL directory. For example:
unzip Domino_Messaging_9.0.0_RHEL.zip -d /tmp
You should also have a file named ./content/patterns.json and 4 subdirectories: ./content/add_ons, ./content/images, ./content/locales and ./content/script_packages
Determine the hostname, username and password for your IWD or PureApp appliance.
Execute the installation command for your platform with the parameters as shown:
/tmp/Domino_Messaging_9.0.0_RHEL/install -u username -p password -h pureApp_hostname
/tmp/Domino_Messaging_9.0.0_RHEL is the temporary directory where the Domino Messaging Server package was extracted.
username is the IWD or PureApp administrator username
password is the IWD or PureApp password
pureApp_hostname is the IWD or PureApp appliance hostname
To import just the image using the PureApp or IWD Web interface
Extract the ./IBM_Domino_Messaging_Server_Image_for_Red_Hat_Linux_Systemsl.ova file from the downloaded package under the Domino_Messaging_9.0.0_RHEL/content/images subdirectory and make it accessible via and HTTP or SCP server. Click the link Catalog, then Virtual Images menu located on the PureApp Workload page. This takes you to a page containing all the virtual images in the catalog.
Click the New Virtual Image icon ( ) and enter the requested information to add the Domino Messaging Server OVA into the catalog.
For remote access, specify either a SCP or HTTP URL in the Location field and, optionally, a user ID and password, if the URL is protected (see figure 1).
To manually import the script packages IWD or PureApp Web interface
Extract the script package files from the downloaded package under the ./Domino_Messaging_9.0.0_RHEL/content/script_packages sub-directory. Click the link Add Script Packages located under the PureApp System Console, Catalog, Script Packages page. This takes you to a page containing all the script packages in the catalog.
Click the New Script Package icon and enter the requested information to add the script package into the catalog.
Select the zip file on the local filesystem using the Browse field, and select Upload (see figure 2).
Initializing a new instance of the OVA
The following sections outline prerequisite information and steps for creating a new instance or pattern of an image. Details of how to use the IWD and PureApp administrative console, set up an account, and a cloud of hypervisors are not provided here. For more information on the IWD and PureApp, refer to the IWD InfoCenters
and PureSystem Infocenters
If you imported the package with the install commands described , there are several pre-defined patterns representing various deployment options. You can view them on the Patterns, Virtual Systems page. If you did not import the patterns, or if you wish to create new patterns:
Click the new pattern icon ( ) on the patterns tab of the Web interface to create a new pattern for the Pure Domino Messaging Server image (see figure 3).
Enter the required information and optional description. IWD then creates a new blank pattern with the information specified (see figure 4).
Click the edit pattern icon ( ). A list of all the parts, Add-ons, and script packages provided by the virtual image that are available for the pattern to use are in the parts for ESX (see figure 5). The canvas is where you drag parts over to model virtual machines that will be created.
To create a standalone Domino messaging server instance in a single virtual machine that runs Domino messaging sever locally, simply drag the Standalone server part over into the canvas. A single box containing the part appears (figure 6), representing a single virtual image, which is the simplest to deploy for standalone systems.
To build a more complex pattern, such as a Domino messaging cluster, use the Administration server part and Custom server part instead of the Standalone server part and add Custom server machines to the deployment, simply by dragging over multiple parts (see figure 7). IWD automatically detects and creates links between various machines and configures them accordingly at deployment. The Administration server part must be used over the Standalone Server Part to provide server management capability when supporting more complex configurations.
You can make additional changes, such as memory, CPU, and passwords for each VM, and set specific ordering requirements on the deployment operations. Click Done editing to save a your pattern. You can then make your pattern read-only, or deploy it.
Parts of the OVA
The Domino Messaging Server OVA contains four parts that can be used for defining patterns for deployment:
Administration Server - A messaging administration server part is defined to be run in its own virtual machine for managing a Domino domain containing Domino messaging server clusters or a set of Domino messaging custom servers not belonging to a cluster.
Custom Server - A messaging custom server part is defined to be run in its own virtual machine for providing Domino messaging service in a Domino domain. The custom server will belong to a cluster if the Domino cluster setting is enabled in the pattern.
Additional Server - A messaging additional server part is defined to be run in its own virtual machine for providing Domino messaging service as a member of an existing Domino domain which may or may not deployed through Domino Messaging server OVA.
Standalone Server - A messaging standalone server part is defined to be run in its own virtual machine as an all-in-one Domino messaging server as well as a messaging administration server which has its own Domino domino setup.
Included Script packages
The Domino Messaging Server package also includes optional script packages that can be used with your patterns for enhanced functionality.
Enable Internet Cluster Manager - Optionally enable the internet cluster manager for a Domino cluster deployment. This script package will enable and configure the ICM service in the Domino administration server.
Move Transaction logging and DAOS storage to the second disk - Optionally optimize the configuration of Transaction logging and DAOS only if a second disk has been configured for the server.
Must Gather - Enabled for all patterns to clean up the configuration data used for Domino system deployment.
Additional script packages
For more details on script packages and patterns, see the IWD and PureApp Infocenters.
To deploy a pattern:
Select a pattern to deploy, and then click the Deploy in the cloud icon (). A prompt displays in where you can configure the deployment by setting the virtual system name, scheduling the deployment, and configuring each virtual machine. For the Domino Messaging Server OVA, the configuration consists of setting passwords, the cluster and node names, and determining whether to federate the node if it's the administration server node.
In the initial deployment window (see figure 8), specify a name for this deployment. Select a Cloud Group on which to deploy the pattern, and then click the Configure virtual parts link to provide the missing configuration details for the Domino messaging pattern, on a per-part basis.
As you click each part in the virtual system description window, a resulting window displays to set the required parameters for each part (see an example in figure 9). For instance, the setting of Domino messaging administration server includes organization name and password, organization unit name and password, administrator id and password and cluster name, etc.
Click OK after filling out each part's required values in the window, and then click the OK button to start the deployment. IWD will optionally notify you via email when the deployment has completed.
Working with an OVA instance
Congratulations on completing the deployment of a Domino Messaging Server OVA.
We will now brief you on how to get started with the system. For more information on how to administer, customize, and develop applications for IBM Domino, refer to the IBM Domino 9.0 page.
File system locations
The locations for the file systems are summarized in the following:
The Domino installation directory is located in /opt/ibm/domino.
The Domino data directory is located in /local/notesdata.
Accessing the site from a browser
After Domino messaging server has started, you can access it using the following URLs:
A Domino Messaging Server instance based on this OVA can be serviced just like any other native installation of this software. Corrective service packages in the form of Hotfixes (that address a particular product issue) or Fixpackss (regular, cumulative roll-ups of Hotfixes into a single installable unit) are available from IBM Support or from IBM Passport Advantage.
Extending and capturing an OVA
After customizing an instance of a Domino Messaging Server OVA with your custom applications, you may want to build a new OVA based on this instance from which new instances can be created. Follow the instructions to prepare and capture a new OVA.
Extending a virtual image
To do this:
Go to the virtual images catalog and select the OVA you wish to extend. It is recommended you use the Standalone server image.
Click the extend icon (), enter the requested information, and click OK. A new virtual image is created, along with a single virtual machine of that image.
Once the virtual machine is deployed, you can make any changes you wish to the virtual machine. These changes are what you will capture as a part of your new virtual image.
Capturing a virtual image
To do this:
Capture the virtual image by clicking the capture icon (). When the capture is finished the virtual image will contain all the changes you made. Those changes will be reflected in any patterns you deploy that use that virtual image. WCA will automatically reset the virtual machine before capturing.
You can recapture your virtual machine as many times as you like. When you are finished with your changes, you can mark the virtual image as read-only by clicking the Make read-only icon ().
IWD or PureApp limitations
Some problems were uncovered during testing on current IWD and PureApp firmware. These will be fixed in future fixpacks of that firmware, and workarounds are listed if possible.
IWD Pattern Editor Problems on Windows XP clients with Internet Explorer 8.0
Various problems, such as obsolete content, disappearing parts, etc occur when interacting with the IWD pattern editor.
Unicode values for Cell and Node names cause instance failure
When deploing an IWD pattern, specifying Unicode characters for the Cell and/or Node names cause problems during instance startup and the system in not correctly initialized.