Preface

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

Note - This Oracle Solaris Cluster release supports systems that use the SPARC and x86 families of processor architectures. In this document, “x86” refers to the larger family of x86 compatible products. Information in this document pertains to all platforms unless otherwise specified.

Bash is the default shell for Oracle Solaris 11. Machine names shown with the Bash shell prompt are displayed for clarity.

Who Should Use This Book

This document is intended for experienced developers with extensive knowledge of Oracle software and Oracle's Sun hardware. The information in this book assumes that you have knowledge of the Oracle Solaris Operating System.

How This Book Is Organized

The Oracle Solaris Cluster Data Services Developer's Guide 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 and describes the standard resource type, resource, and resource group properties. The chapter also the requirements for legal characters for Resource Group Manager (RGM) names and values.

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 Oracle Solaris 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, Oracle Solaris Cluster Agent Builder describes Oracle Solaris Cluster Agent Builder.

Chapter 10, Generic Data Service 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, Sample Data Service Code Listings provides the complete code for each method in the sample data service.

Appendix B, DSDL Sample Resource Type Code Listings lists the complete code for each method in the ORCL.xfnts resource type.

Appendix C, Requirements for Non-Cluster-Aware Applications list the requirements for ordinary, non-cluster aware applications to be candidates for high availability.

Appendix D, Document Type Definitions for the CRNP lists the document type definitions for the CRNP.

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

Getting Help

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

Your name and email address
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, the Solaris 10 OS)
The release number of Oracle Solaris Cluster software (for example, 4.0)

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
`pkg list`	Reports which packages are installed
`prtdiag -v`	Displays system diagnostic information
`/usr/cluster/bin/clnode show-rev`	Displays Oracle Solaris Cluster release and package version information

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

Documentation and Support

See the following web sites for additional resources:

Oracle Software Resources

Oracle Technology Network offers a range of resources related to Oracle software:

Discuss technical problems and solutions on the Discussion Forums.
Get hands-on step-by-step tutorials with Oracle By Example.

Typographic Conventions

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

Table P-1 Typographic Conventions

Typeface	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`	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. A cache is a copy that is stored locally. Do not save the file. Note: Some emphasized items appear bold online.

Shell Prompts in Command Examples

The following table shows the default UNIX system prompt and superuser prompt for shells that are included in the Oracle Solaris OS. Note that the default system prompt that is displayed in command examples varies, depending on the Oracle Solaris release.

Table P-2 Shell Prompts

Shell	Prompt
Bash shell, Korn shell, and Bourne shell	`$`
Bash shell, Korn shell, and Bourne shell for superuser	`#`
C shell	`machine_name%`
C shell for superuser	`machine_name#`

Skip Navigation Links
Exit Print View
	Oracle Solaris Cluster Data Services Developer's Guide Oracle Solaris Cluster 4.0