Oracle Solaris Cluster Data Services Developer's Guide

October 2012, E29471–01

This book describes the Oracle Solaris Cluster data service application programming interface (API). Developers can use this API to turn a standard user application, such as a web browser or database, into a highly available data service that can run in the Oracle Solaris Cluster environment.

Document Information
Preface
1. Overview of Resource Management
- Oracle Solaris Cluster Application Environment
- Resource Group Manager Model
- Resource Group Manager
- Callback Methods
- Programming Interfaces
- Resource Group Manager Administrative Interface
  - clsetup Utility
  - Administrative Commands
2. Developing a Data Service
- Analyzing the Application for Suitability
- Determining the Interface to Use
- Setting Up the Development Environment for Writing a Data Service
  - How to Set Up the Development Environment
  - Transferring a Data Service to a Cluster
- Setting Standard Properties
- Node List Properties
- Setting Resource and Resource Type Properties
- Implementing Callback Methods
- Generic Data Service
- Controlling an Application
  - Starting and Stopping a Resource
    - Using Start and Stop Methods
    - Deciding Which Start and Stop Methods to Use
  - Using the Optional Init, Fini, and Boot Methods
- Monitoring a Resource
  - Implementing Monitors and Methods That Execute Exclusively in the Global Zone
- Adding Message Logging to a Resource
- Providing Process Management
- Providing Administrative Support for a Resource
- Implementing a Failover Resource
- Implementing a Scalable Resource
  - Validation Checks for Scalable Services
- Writing and Testing Data Services
- Legal RGM Names
  - RGM Legal Names
    - Rules for Names Except Resource Type Names
    - Format of Resource Type Names
  - RGM Values
3. Resource Management API Reference
- RMAPI Access Methods
  - RMAPI Shell Commands
  - C Functions
- RMAPI Callback Methods
4. Modifying a Resource Type
- Overview of Modifying a Resource Type
- Setting Up the Contents of the Resource Type Registration File
- What Happens When a Cluster Administrator Upgrades
- Determining Installation Requirements and Packaging
- Documentation to Provide for a Modified Resource Type
5. Sample Data Service
- Overview of the Sample Data Service
- Defining the Resource Type Registration File
- Providing Common Functionality to All Methods
- Controlling the Data Service
  - How the Start Method Works
  - How the Stop Method Works
- Defining a Fault Monitor
- Handling Property Updates
  - How the Validate Method Works
  - How the Update Method Works
6. Data Service Development Library
- DSDL Overview
- Managing Configuration Properties
- Starting and Stopping a Data Service
- Implementing a Fault Monitor
- Accessing Network Address Information
- Debugging the Resource Type Implementation
- Enabling Highly Available Local File Systems
7. Designing Resource Types
- Resource Type Registration File
- Validate Method
- Start Method
- Stop Method
- Monitor_start Method
- Monitor_stop Method
- Monitor_check Method
- Update Method
- Description of Init, Fini, and Boot Methods
- Designing the Fault Monitor Daemon
8. Sample DSDL Resource Type Implementation
- X Font Server
  - X Font Server Configuration File
  - TCP Port Number
- ORCL.xfnts RTR File
- Naming Conventions for Functions and Callback Methods
- scds_initialize() Function
- xfnts_start Method
- xfnts_stop Method
- xfnts_monitor_start Method
- xfnts_monitor_stop Method
- xfnts_monitor_check Method
- ORCL.xfnts Fault Monitor
- xfnts_validate Method
- xfnts_update Method
9. Oracle Solaris Cluster Agent Builder
- Agent Builder Overview
- Before You Use Agent Builder
- Using Agent Builder
- Directory Structure That Agent Builder Creates
- Agent Builder Output
10. Generic Data Service
- Generic Data Service Concepts
- Using Agent Builder to Create a Service That Uses the GDS
  - Creating and Configuring GDS-Based Scripts
    - How to Start Agent Builder and Create the Scripts
    - How to Configure the Scripts
  - Output From Agent Builder
- Using Oracle Solaris Cluster Administration Commands to Create a Service That Uses the GDS
  - How to Use Oracle Solaris Cluster Administration Commands to Create a Highly Available Service That Uses the GDS
  - How to Use Oracle Solaris Cluster Administration Commands to Create a Scalable Service That Uses the GDS
- Command-Line Interface for Agent Builder
  - How to Use the Command-Line Version of Agent Builder to Create a Service That Uses GDS
11. DSDL API Functions
- General-Purpose Functions
- Property Functions
- Network Resource Access Functions
- PMF Functions
- Fault Monitor Functions
- Utility Functions
12. Cluster Reconfiguration Notification Protocol
- CRNP Concepts
- How a Client Registers With the Server
- How the Server Replies to a Client
  - Contents of an SC_REPLY Message
  - How a Client Is to Handle Error Conditions
- How the Server Delivers Events to a Client
  - How the Delivery of Events Is Guaranteed
  - Contents of an SC_EVENT Message
- How the CRNP Authenticates Clients and the Server
- Example of Creating a Java Application That Uses the CRNP
13. Security for Data Services
- Storing Application Passwords in Private Strings
- Invoking Application Programs with Least Privilege
A. Sample Data Service Code Listings
- Resource Type Registration File Listing
- Start Method Code Listing
- Stop Method Code Listing
- gettime Utility Code Listing
- PROBE Program Code Listing
- Monitor_start Method Code Listing
- Monitor_stop Method Code Listing
- Monitor_check Method Code Listing
- Validate Method Code Listing
- Update Method Code Listing
B. DSDL Sample Resource Type Code Listings
- xfnts.c File Listing
- xfnts_monitor_check Method Code Listing
- xfnts_monitor_start Method Code Listing
- xfnts_monitor_stop Method Code Listing
- xfnts_probe Method Code Listing
- xfnts_start Method Code Listing
- xfnts_stop Method Code Listing
- xfnts_update Method Code Listing
- xfnts_validate Method Code Listing
C. Requirements for Non-Cluster-Aware Applications
- Multihosted Data
  - Using Symbolic Links for Multihosted Data Placement
- Host Names
- Multihomed Hosts
- Binding to INADDR_ANY as Opposed to Binding to Specific IP Addresses
- Client Retry
D. Document Type Definitions for the CRNP
- SC_CALLBACK_REG XML DTD
- NVPAIR XML DTD
- SC_REPLY XML DTD
- SC_EVENT XML DTD
E. CrnpClient.java Application
- Contents of CrnpClient.java
Index
- Numbers and Symbols
- A
- B
- C
- D
- E
- F
- G
- H
- I
- J
- K
- L
- M
- N
- O
- P
- R
- S
- T
- U
- V
- W
- X

Skip Navigation Links
	Oracle Solaris Cluster Data Services Developer's Guide Oracle Solaris Cluster 4.1