Sun Cluster Data Services Developer's Guide for Solaris OS

Preface

The Sun Cluster Data Services Developer's Guide for Solaris OS contains information about using the Resource Management API to develop Sun^TM Cluster data services on both SPARC® and x86 based systems.

Note –

In this document, the term “x86” refers to the Intel 32-bit family of microprocessor chips and compatible microprocessor chips made by AMD.

Note –

Sun Cluster software runs on two platforms, SPARC and x86. The information in this document pertains to both platforms unless otherwise specified in a special chapter, section, note, bulleted item, figure, table, or example.

Who Should Use This Book

This document is intended for experienced developers with extensive knowledge of Sun software and hardware. The information in this book assumes knowledge of the Solaris^TM Operating System.

How This Book Is Organized

The Sun Cluster Data Services Developer's Guide for Solaris OS contains the following chapters and appendixes:

Chapter 1, Overview of Resource Management provides an overview of the concepts needed to develop a data service.
Chapter 2, Developing a Data Service provides detailed information about developing a data service.
Chapter 3, Upgrading a Resource Type discusses the issues that you need to understand to upgrade a resource type and migrate a resource
Chapter 4, Resource Management API Reference provides a reference to the access functions and callback methods that make up the Resource Management API (RMAPI).
Chapter 5, Sample Data Service provides a sample Sun Cluster data service for the in.named() application.
Chapter 6, Data Service Development Library (DSDL) provides an overview of the application programming interfaces constituting the Data Services Development Library (DSDL)
Chapter 7, Designing Resource Types explains the typical usage of the DSDL in designing and implementing resource types.
Chapter 8, Sample DSDL Resource Type Implementation describes a sample resource type implemented with DSDL.
Chapter 9, SunPlex Agent Builder describes SunPlex^TM Agent Builder.
Chapter 10, Generic Data Services describes how to create a generic data service.
Chapter 11, Data Service Development Library Reference describes the DSDL API functions.
Chapter 12, CRNP provides information about the Cluster Reconfiguration Notification Protocol (CRNP). CRNP enables failover and scalable applications to be “cluster aware.”
Appendix A, Standard Properties describes the standard resource type, resource group, and resource properties.
Appendix B, Sample Data Service Code Listings provides the complete code for each method in the sample data service.
Appendix C, Data Service Development Library Sample Resource Type Code Listing lists the complete code for each method in the SUNW.xfnts() resource type.
Appendix D, Legal RGM Names and Values lists the requirements for legal characters for Resource Group Manager (RGM) names and values.
Appendix E, Requirements for Non-Cluster Aware Applications list the requirements for ordinary, non-cluster aware applications to be candidates for high availability.
Appendix F, Document Type Definitions for CRNP lists the document type definitions for CRNP.
Appendix G, CrnpClient.java Application shows the complete CrnpClient.java application that is discussed in Chapter 12, CRNP.

Topic	Documentation
Overview	Sun Cluster Overview for Solaris OS
Concepts	Sun Cluster Concepts Guide for Solaris OS
Hardware installation and administration	Sun Cluster 3.x Hardware Administration Manual for Solaris OS Individual hardware administration guides
Software installation	Sun Cluster Software Installation Guide for Solaris OS
Data service installation and administration	Sun Cluster Data Services Planning and Administration Guide for Solaris OS Individual data service guides
Data service development	Sun Cluster Data Services Developer’s Guide for Solaris OS
System administration	Sun Cluster System Administration Guide for Solaris OS
Error messages	Sun Cluster Error Messages Guide for Solaris OS
Command and function references	Sun Cluster Reference Manual for Solaris OS

Getting Help

If you have problems installing or using Sun Cluster, contact your service provider and provide the following information.

Your name and email address (if available)
Your company name, address, and phone number
The model number and serial number of your systems
The release number of the operating system (for example, Solaris 10)
The release number of Sun Cluster (for example, Sun Cluster 3.1)

Use the following commands to gather information on your systems for your service provider.

Command	Function
`prtconf -v`	Displays the size of the system memory and reports information about peripheral devices
`psrinfo -v`	Displays information about processors
`showrev -p`	Reports which patches are installed
SPARC: `prtdiag -v`	Displays system diagnostic information
`/usr/cluster/bin/scinstall -pv`	Displays Sun Cluster release and package version information

Also have available the contents of the /var/adm/messages file.

Accessing Sun Documentation Online

The docs.sun.com^SM Web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. The URL is http://docs.sun.com.

Ordering Sun Documentation

Sun Microsystems offers select product documentation in print. For a list of documents and how to order them, see “Buy printed documentation” at http://docs.sun.com.

Typographic Conventions

The following table describes the typographic changes used in this book.

Table P–1 Typographic Conventions


Typeface or Symbol	Meaning	Example
`AaBbCc123`	The names of commands, files, and directories; on-screen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with on-screen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	Command-line placeholder: replace with a real name or value	To delete a file, type `rm` `filename`.
AaBbCc123	Book titles, new words, or terms, or words to be emphasized.	Read Chapter 6 in User's Guide. These are called class options. You must be root to do this.

Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P–2 Shell Prompts


Shell	Prompt
C shell prompt	`machine_name%`
C shell superuser prompt	`machine_name#`
Bourne shell and Korn shell prompt	`$`
Bourne shell and Korn shell superuser prompt	`#`