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 SunTM 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 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 that you need to develop a data service.

Chapter 2, Developing a Data Service provides detailed information about developing a data service.

Chapter 3, Resource Management API Reference provides a reference to the access functions and callback methods that make up the Resource Management API (RMAPI).

Chapter 4, Modifying a Resource Type discusses the issues that you need to understand to modify a resource type. Information about the means by which you enable a cluster administrator to upgrade a resource is also included.

Chapter 5, Sample Data Service provides a sample Sun Cluster data service for the in.named application.

Chapter 6, Data Service Development Library provides an overview of the application programming interfaces that make up the Data Services Development Library (DSDL).

Chapter 7, Designing Resource Types explains the typical use of the DSDL in designing and implementing resource types.

Chapter 8, Sample DSDL Resource Type Implementation describes a sample resource type that is implemented with the DSDL.

Chapter 9, SunPlex Agent Builder describes SunPlexTM Agent Builder.

Chapter 10, Generic Data Services describes how to create a generic data service.

Chapter 11, DSDL API Functions describes the DSDL API functions.

Chapter 12, Cluster Reconfiguration Notification Protocol provides information about the Cluster Reconfiguration Notification Protocol (CRNP). The CRNP enables failover and scalable applications to be “cluster aware.”

Appendix A, Standard Properties describes the standard resource type, resource, and resource group properties.

Appendix B, Sample Data Service Code Listings provides the complete code for each method in the sample data service.

Appendix C, DSDL Sample Resource Type Code Listings 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 the CRNP lists the document type definitions for the CRNP.

Appendix G, CrnpClient.java Application shows the complete CrnpClient.java application that is discussed in Chapter 12, Cluster Reconfiguration Notification Protocol.

Related Documentation

Information about related Sun Cluster topics is available in the documentation that is listed in the following table. Sun Cluster documentation is available at http://docs.sun.com.

Topic 

Documentation 

Overview 

Sun Cluster Overview for Solaris OS

Concepts 

Sun Cluster Concepts Guide for Solaris OS

Hardware installation and administration 

Sun Cluster 3.0-3.1 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

For a complete list of Sun Cluster documentation, see the release notes for your release of Sun Cluster software at http://docs.sun.com.

Getting Help

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

Use the following commands to gather information about 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.

Documentation, Support, and Training

Sun Function 

URL 

Description 

Documentation 

http://www.sun.com/documentation/

Download PDF and HTML documents, and order printed documents 

Support and Training 

http://www.sun.com/supportraining/

Obtain technical support, download patches, and learn about Sun courses 

Typographic Conventions

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

Table P–1 Typographic Conventions

Typeface or Symbol 

Meaning 

Example 

AaBbCc123

The names of commands, files, and directories, and onscreen computer output 

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.

AaBbCc123

What you type, contrasted with onscreen computer output 

machine_name% su

Password:

aabbcc123

Command-line placeholder: replace with a real name or value 

The command to remove a file is rm filename.

AaBbCc123

Book titles, new terms, and terms to be emphasized 

Read Chapter 6 in the User's Guide.

Perform a patch analysis.

Do not save the file.

[Note that some emphasized items appear bold online.] 

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 

#