pSeries High Availability Software Development

ASCII-based Cluster Configuration

Configure HACMP through user-created XML files

June-August 2005 | pSeries HACMP Train The Trainer (T3) Presentations

2005 IBM Corporation

IBM eServer pSeries

Enhancement: ASCII-based
Well defined and well documented XML Configuration File structure using a Document Type Definition and an XML Schema Will allow configuration data for all features, not just ones handled by OLPW Defined paths from one configuration format to another Updated tools that produce an XML configuration file that will pass validation in XML editors
June-August 2005 | Teach The Trainer (T3)

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Challenges
Customers need an easy way to modify cluster configurations and apply to many clusters Previously, users were told not to create their own XML cluster configuration files or edit existing ones, except with OLPW XML files generated by OLPW and Export Definition File for Online Planning Worksheets with the embedded Document Type Definition (DTD) configuration do not pass validation in XML editors without effort by the user
June-August 2005 | Teach The Trainer (T3)

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Challenges (Cont)
The data stored in HACMP cluster snapshots cannot be easily used by OLPW or cl_opsconfig cl_opsconfig does not perform extensive validation resulting in users getting error messages they may not understand
June-August 2005 | Teach The Trainer (T3)

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Terminology
XML eXtensible Markup Language DTD Document Type Definition. It defines the document structure with a list of legal elements
June-August 2005 | Teach a Trainer (T3) XML Namespace Provides Themethod to avoid element name conflicts

XML Schema an XML based alternative to DTD that describes the structure of an XML document

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Terminology
OLPW Online Planning Worksheets. Also known as Cluster Worksheets OLPW Worksheet an XML file containing a cluster configuration. This file is created by OLPW and by the cl_exportdefinition utility
June-August 2005 | Teach The Trainer (T3)

cl_opsconfig The cluster utility used by OLPW that takes an OLPW Worksheet file and configures an HACMP cluster based upon the information contained. This feature will update it to also take ASCII-based cluster configuration files created by a user cl_exportdefinition The cluster utility that creates an OLPW Worksheet file from an existing HACMP cluster. This feature will update it to create the XML file from an existing cluster snapshot
HACMP 5.3 Train The Trainer: ASCII-based Cluster Configuration
2005 IBM Corporation

IBM eServer pSeries

Description of Functionality : XML Documentation

External DTD
The DTD will now reside in a separate file at /usr/es/sbin/cluster/worksheets/hacmp-v5300.dtd The DTD is installed at part of the cluster.es.client.lib fileset Provides minimal validation of required elements and their order
June-August 2005 | Teach The Trainer (T3)

External XML Schema

Resides in /usr/es/sbin/cluster/worksheets/hacmp-v5300.xsd The XML Schema is installed at part of the cluster.es.client.lib fileset Provides more extensive validation than the DTD including data type, length, format, and possible data values when necessary

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Solution: XML File Format - <CONFIG>

The top-level element tag is <CONFIG>
<CONFIG xsi:noNamespaceSchemaLocation="/usr/es/sbin/cluster/worksheets/hacmpv5300.xsd">

5 Required Child elements for <CONFIG>. Each of these have their own required elements:
<VERSION> June-August <CLUSTER> <NODES> <NETWORKS> <INTERFACES>
2005 | Teach The Trainer (T3)

Examples of other useful elements:

<META_DEBUG> <IPLABELS> <APPLICATIONSERVERS> <RESOURCEGROUPS>
HACMP 5.3 Train The Trainer: ASCII-based Cluster Configuration
2005 IBM Corporation

IBM eServer pSeries

Solution: XML File Format - <VERSION>

The data in the <VERSION> element corresponds to the cluster version for which the XML configuration file was made. Must be <VERSION>5300</VERSION>
<xs:simpleType name="version"> June-August 2005 | Teach The Trainer (T3) <xs:restriction base="xs:string"> <xs:enumeration value="5300"></xs:enumeration> </xs:restriction> </xs:simpleType>

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Solution: XML File Format - <CLUSTER>

Specifies the cluster name
<xs:element name="CLUSTER">
<xs:complexType>

<xs:sequence> <xs:element name="CLUSTERNAME" type="name32"></xs:element> <xs:element name="AUTHOR" type="xs:string" June-August 2005 | Teach The Trainer (T3) minOccurs="0"></xs:element> <xs:element name="COMPANY" type="xs:string" minOccurs="0"></xs:element> <xs:element name="DATE" type="xs:string" minOccurs="0"></xs:element> <xs:element name="NOTES" type="xs:string" minOccurs="0"></xs:element> <xs:sequence>
<xs:complexType>

<xs:element>

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Solution: XML File Format - <Node>

Specifies the nodes in the cluster
<xs:element name="NODES"> <xs:complexType> <xs:sequence> <xs:element ref="NODE" maxOccurs="unbounded"></xs:element> <xs:sequence> <xs:complexType> <xs:element> <xs:element name="NODE"> <xs:complexType> <xs:sequence> <xs:element ref="NODENAME"></xs:element> <xs:element name="COMMUNICATIONPATH" type="communicationpath" minOccurs="0"></xs:element> <xs:element name="HMCADDRESS" type="ipaddress" minOccurs="0"/> <xs:element name="LPARMANAGEDSYSTEM" type="string128" minOccurs="0"/> <xs:sequence> <xs:complexType> <xs:element>
HACMP 5.3 Train The Trainer: ASCII-based Cluster Configuration
2005 IBM Corporation

June-August 2005 | Teach The Trainer (T3)

IBM eServer pSeries

Solution: Example snippet of an XML Config File

<NODES> <NODE> <NODENAME>central</NODENAME> <COMMUNICATIONPATH>10.70.11.2</COMMUNICATIONPATH> </NODE> </NODES> <NETWORKS> <NETWORK> <NETWORKNAME>net_ether_01</NETWORKNAME> <NETWORKTYPE>ether</NETWORKTYPE> June-August 2005 | Teach The Trainer (T3) <IPALIASING>yes</IPALIASING> <NETMASK>255.255.255.0</NETMASK> </NETWORK> </NETWORKS> <INTERFACES> <INTERFACE> <INTERFACETYPE>ether</INTERFACETYPE> <NETWORKNAME>net_ether_01</NETWORKNAME> <NODENAME>central</NODENAME> <IPLABELNAME>central_enboot</IPLABELNAME> <NETWORKINTERFACE>en0</NETWORKINTERFACE> </INTERFACE> </INTERFACES>
HACMP 5.3 Train The Trainer: ASCII-based Cluster Configuration
2005 IBM Corporation

IBM eServer pSeries

Solution: SMITs
A new SMIT panel will allow the user to convert an existing snapshot to and XML Configuration file for use by OLPW or an XML editor cl_exportdefinition will do the conversion
-> Extended Configuration -> Snapshot Configuration -> Convert Existing Snapshot For Online Planning Worksheets
Convert Existing Snapshot for Online Planning Worksheets Type or select values in entry fields. Press Enter AFTER making all desired changes. Cluster Snapshot Name * File Name Description [Entry Fields] cluster_snapshot [/var/hacmp/log/cluster.haw] [Cluster snapshot 06/07/2006]
June-August 2005 | Teach The Trainer (T3)

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Solution: Compare a Cluster to a Previous Snapshot

Export Definition File for OLPW XML File

HACMP Cluster

June-August 2005 | Teach The Trainer (T3)

diff

Differences File

Convert Existing Snapshot for OLPW Old Snapshot file XML File

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Solution: Duplicate a Cluster with Changes

cl_opsconfig New HACMP Cluster

Favorite XML Editor

June-August 2005 | Teach The Trainer (T3)

Updated XML File

Export Definition File for OLPW

XML File

HACMP Cluster
HACMP 5.3 Train The Trainer: ASCII-based Cluster Configuration
2005 IBM Corporation

IBM eServer pSeries

Solution: Updates to OLPW, cl_opsconfig, and cl_exportdefinition

OLPW will filter on the *.xml file type, along with *.haw and *.ws filetypes when opening a new file. OLPW will expose validation functionality through use of new command line option. XML files validated by OLPW will not be modified cl_opsconfig will use OLPW| Teach The Trainer code if file not marked as validated, June-August 2005 validation (T3) java is available and the OLPW feature is installed OLPW and cl_exportdefinition will not create the embedded DTD OLPW will ignore the XML data it does not support. If the file is re-saved, the data will be lost. The user will be warned before this happens

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Solution: OLPW User Interface Updates

Dynamic LPAR resources Resource Group Dependencies Resource Group Location Dependencies
June-August 2005 | Teach The Trainer (T3)

Custom Resource Group Recovery

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Limitations
Custom Snapshot Methods
Information gathered by custom snapshot methods will not be included when converting a Cluster Snapshot to an XML file

In XML files, the use of shorthand beginning and ending tags for elements with June-August 2005 | Teach The Trainer (T3) no data, such as <COMPANY/>, is not allowed. Both the beginning and ending tags must be used, for example <COMPANY></COMPANY> OLPW does not use the provided XML Schema to validate the configuration file, but rather uses its own internal validation code

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

IBM eServer pSeries

Troubleshooting
No new log files were added as part of this feature Existing debug options for cl_opsconfig will help
cl_opsconfig can be run with debug flags turned on. Each key will display the debug information for a different cl_opsconfig operation cl_opsconfig dkey1[,,keyn] filename cl_opsconfig can also | be runTrainer (T3) test flag that wont configure the June-August 2005 Teach The with the cluster, but will instead display the commands used to configure the cluster cl_opsconfig -t filename

cl_opsconfig will only validate documents if Java and OLPW is installed on the cluster node
XML configuration files should be validated using OLPW installed on a laptop or workstation or have an XML editor validate it using the provided XML Schema
HACMP 5.3 Train The Trainer: ASCII-based Cluster Configuration
2005 IBM Corporation

IBM eServer pSeries

Summary
Simplifies the process of creating and saving cluster definition files Provides multiple options for creation of a cluster definition file Allows creation, modification, and manual editing of a cluster June-August 2005 | Teach The Trainer (T3) configuration file using any XML editor Converts an HACMP snapshot into an XML cluster definition file Automated management of cluster definition files reduces administration and maintenance time

HACMP 5.3

Train The Trainer: ASCII-based Cluster Configuration

2005 IBM Corporation

10