Cluster Server 7.3.1 Agent for Oracle Installation and Configuration Guide - Solaris

Last Published:
Product(s): InfoScale & Storage Foundation (7.3.1)
Platform: Solaris
  1. Introducing the Cluster Server agent for Oracle
    1. About the Cluster Server agent for Oracle
      1.  
        About the agent for Oracle ASM
    2.  
      Supported software for VCS agent for Oracle
    3.  
      Changes introduced in the 7.3.1 release
    4. How the agent makes Oracle highly available
      1.  
        How the Oracle and Netlsnr agents support intelligent resource monitoring
      2.  
        How the agent monitors Oracle instances running in Solaris zones
      3.  
        How the agent makes Oracle ASM instance highly available
      4.  
        How the agent supports container database (CDB) and pluggable database (PDB) in Oracle 12C
    5. About Cluster Server agent functions for Oracle
      1. Oracle agent functions
        1.  
          Startup and shutdown options for the Oracle agent
        2.  
          Startup and shutdown options for the pluggable database (PDB)
        3.  
          Recommended startup modes for pluggable database (PDB) based on container database (CDB) startup modes
        4.  
          Monitor options for the Oracle agent in traditional database and container database
        5.  
          Monitor for the pluggable database
        6.  
          How the agent handles Oracle error codes during detail monitoring
        7.  
          Info entry point for Cluster Server agent for Oracle
        8.  
          Action entry point for Cluster Server agent for Oracle
        9. How the Oracle agent supports health check monitoring
          1.  
            Generating the executable required for Oracle health check monitoring
          2.  
            Considerations to run the build_oraapi.sh script
          3.  
            Building the Oracle agent executable using the build_oraapi.sh script
      2.  
        Netlsnr agent functions
      3. ASMInst agent functions
        1.  
          ASMInst agent Startup options
        2.  
          ASMInst agent Shutdown options
        3.  
          Monitor options for the ASMInst agent
      4.  
        ASMDG agent functions
    6.  
      Typical Oracle configuration in a VCS cluster
    7.  
      About setting up Oracle in a VCS cluster
  2. Installing and configuring Oracle
    1.  
      About installing Oracle in a VCS environment
    2.  
      Before you install Oracle in a VCS environment
    3. About VCS requirements for installing Oracle
      1.  
        Location of the $ORACLE_HOME
      2.  
        Replacing the long pathnames for $ORACLE_HOME in the agent attributes
      3.  
        Failing over Oracle after a VCS node failure during hot backup
    4. About Oracle installation tasks for VCS
      1.  
        Installation tasks for $ORACLE_HOME on shared disks
      2.  
        Installation tasks for $ORACLE_HOME on local disks
      3.  
        Installation tasks for Oracle using ASM
    5. Installing ASM binaries for Oracle 11gR2 or 12c in a VCS environment
      1.  
        Configuring VCS to support Oracle Restart function
    6. Configuring Oracle ASM on the first node of the cluster
      1.  
        Enabling the clustering daemon for ASM-managed database
      2.  
        Enabling Oracle Cluster Synchronization Service daemon to start automatically
    7.  
      Configuring and starting up ASM on remaining nodes for 11gR2 or 12c
    8. Installing Oracle binaries on the first node of the cluster
      1.  
        Disabling the clustering daemon for Oracle 10g or later
    9.  
      Configuring the Oracle database
    10.  
      Copying the $ORACLE_BASE/admin/SID directory
    11.  
      Copying the Oracle ASM initialization parameter file
    12.  
      Verifying access to the Oracle database
  3. Installing and removing the agent for Oracle
    1.  
      Before you install or upgrade the agent for Oracle
    2.  
      Installing the VCS agent for Oracle software
    3. Upgrading the VCS agent for Oracle
      1.  
        Upgrading VCS agent for Oracle to use with VCS 7.3.1
    4.  
      Disabling the Cluster Server agent for Oracle
    5.  
      Removing the Cluster Server agent for Oracle
  4. Configuring VCS service groups for Oracle
    1.  
      About configuring a service group for Oracle
    2. Configuring Oracle instances in VCS
      1.  
        Configuring a single Oracle instance in VCS
      2.  
        Configuring multiple Oracle instances (single listener) in VCS
      3.  
        Configuring multiple Oracle instances (multiple listeners) in VCS
      4.  
        Configuring an Oracle instance with shared server support in VCS
    3. Before you configure the VCS service group for Oracle
      1.  
        Importing the type definition files for Cluster Server agent for Oracle
    4. Configuring the VCS service group for Oracle
      1.  
        Configuring the VCS service group for Oracle using Cluster Manager (Java console)
      2. Configuring the VCS service group for Oracle using the command-line
        1.  
          Encrypting Oracle database user and listener passwords
    5. Setting up detail monitoring for VCS agents for Oracle
      1. Setting up detail monitoring for Oracle
        1.  
          Enabling and disabling detail monitoring for Oracle resource
      2.  
        Setting up detail monitoring for Netlsnr
    6. Enabling and disabling intelligent resource monitoring for agents manually
      1.  
        Administering the AMF kernel driver
  5. Administering VCS service groups for Oracle
    1.  
      About administering VCS service groups
    2.  
      Bringing the service group online
    3.  
      Taking the service group offline
    4.  
      Switching the service group
    5.  
      Modifying the service group configuration
  6. Pluggable database (PDB) migration
    1.  
      Migrating Pluggable Databases (PDB) between Container Databases (CDB)
  7. Troubleshooting Cluster Server agent for Oracle
    1.  
      About troubleshooting Cluster Server agent for Oracle
    2.  
      Error messages common to the Oracle and Netlsnr agents
    3.  
      Error messages specific to the Oracle agent
    4.  
      Error messages specific to the Netlsnr agent
    5.  
      Error messages specific to the ASMInst agent
    6.  
      Error messages specific to the ASMDG agent
    7.  
      Troubleshooting issues specific to Oracle in a VCS environment
    8. Verifying the Oracle health check binaries and intentional offline for an instance of Oracle
      1.  
        Verifying the intentional offline behavior of the VCS Oracle agent
    9.  
      Disabling IMF for a PDB resource
  8. Appendix A. Resource type definitions
    1.  
      About the resource type and attribute definitions
    2. Resource type definition for the Oracle agent
      1.  
        Attribute definition for the Oracle agent
      2.  
        About the Sid attribute in a policy managed database
    3. Resource type definition for the Netlsnr agent
      1.  
        Attribute definition for the Netlsnr agent
    4. Resource type definition for the ASMInst agent
      1.  
        Attribute definition for the ASMInst agent
    5. Resource type definition for the ASMDG agent
      1.  
        Attribute definition for the ASMDG agent
  9. Appendix B. Sample configurations
    1.  
      About the sample configurations for Oracle enterprise agent
    2. Sample single Oracle instance configuration
      1.  
        Sample VCS configuration file for single Oracle instance
    3. Sample multiple Oracle instances (single listener) configuration
      1.  
        Sample VCS configuration file for multiple Oracle instances (single listener)
    4. Sample multiple instance (multiple listeners) configuration
      1.  
        Sample VCS configuration file for multiple Oracle instances (multiple listeners)
    5. Sample Oracle configuration with shared server support
      1.  
        Sample VCS configuration file for Oracle instance configured with shared server support
    6. Sample configuration for Oracle instances in Solaris zones
      1.  
        Zone root on local disk for single Oracle instance
      2.  
        Zone root on shared disk for single Oracle instance
      3.  
        Zone root on local disk for multiple Oracle instances
      4.  
        Zone root on shared disk for multiple Oracle instances
      5.  
        Zone root on local disk for Oracle instance with shared server support
      6.  
        Zone root on shared disk for Oracle instance with shared server support
      7.  
        Oracle instance in the context of project
      8.  
        Sample VCS configuration file for zone root on local disk or on shared disk
    7. Sample Oracle ASM configurations
      1. Sample configuration for ASM disks as raw disks
        1.  
          Sample VCS configuration file for ASM-managed Oracle instance
      2. Sample configuration for ASM disks as VxVM volumes
        1.  
          Sample VCS configuration file for ASM disks as VxVM disks
      3. Sample configuration for ASM disks as CVM volumes
        1.  
          Sample VCS configuration file for ASM that uses CVM volumes
    8.  
      Sample configuration of Oracle pluggable database (PDB) resource in main.cf
    9.  
      Sample configuration of migratable Oracle pluggable database (PDB) resource in main.cf
    10.  
      Sample Configuration of Oracle supported by systemD
    11.  
      Sample configuration of ASMInst supported by systemD
  10. Appendix C. Best practices
    1.  
      Best practices for multiple Oracle instance configurations in a VCS environment
  11. Appendix D. Using the SPFILE in a VCS cluster for Oracle
    1.  
      About the Oracle initialization parameter files
    2.  
      Starting an Oracle instance
    3.  
      Using the SPFILE in a VCS cluster
  12. Appendix E. OHASD in a single instance database environment
    1.  
      About OHASD in a single instance database environment
    2.  
      Configuring the Application agent to make OHASD highly available

Setting up detail monitoring for Oracle

Detail monitoring for an Oracle resource verifies whether a database is ready for transactions by performing an update transaction against a table within the database. The update action is taken by the two scripts, SqlTest.pl and SimpleTest.pl, provided with the Cluster Server agent for Oracle. The scripts are available under the directory /opt/VRTSagents/ha/bin/Oracle/. Both scripts update the timestamp to monitor the database.

The SqlTest.pl script checks whether the database is open before updating the timestamp. If the database is found to be in restricted mode, quiesced mode, or suspended mode, the monitor returns success. In such a case, only basic monitoring occurs. The SimpleTest.pl script does not perform database checks but only issues update statements against the table.

Before enabling detail monitoring for Oracle, you must create a test table (with a timestamp) in the Oracle database. The agent uses this test table for internal purposes. recommends that you do not perform any other transaction on the test table. The detail monitor script, MonScript, must exist and have execute permission for root. You can use a custom monitor script, or the scripts provided with the agent. In the monitor script, the return code 100 indicates failure. Return codes from 101 to 110 indicate success.

The example to set up detail monitoring, based on the use of the supplied script, shows how to create and test a table for use by detail monitoring, and how to enable detail monitoring.

To set up detail monitoring for Oracle

  1. Make the VCS configuration writable:
    # haconf -makerw
  2. Freeze the service group to avoid automated actions by VCS caused by an incomplete reconfiguration:
    # hagrp -freeze service_group
  3. Log on as an Oracle user.
    # su - <Owner>
  4. Set the environment variables for ORACLE_HOME and ORACLE_SID.
    # export ORACLE_HOME=<Home>
    # export ORACLE_SID=<Sid>
  5. Start the sqlplus utility to set up a database table:
    $ORACLE_HOME/bin/sqlplus /nolog
  6. As the database administrator, issue the following statements at the sqlplus prompt to create the test table.

    For traditional or container databases:

    connect / as sysdba
    
    create user  <User>
    identified by <Pword> 
    default tablespace USERS
    temporary tablespace TEMP   
    quota 100K on USERS;
    
    grant create  session to <User>;
    
    create table <User>.<Table> (  tstamp date );
    insert into <User>.<Table> (tstamp) values  (SYSDATE);

    Note:

    For a CDB resource, the user name should be prefixed with C##.

    To enable detail monitoring for PDB, issue the following statements at the sqlplus prompt to create the test table:

    $ORACLE_HOME/bin/sqlplus /nolog
    connect / as sysdba
    

    Create common user for CDB if not already created.

    create user <User>
    identified by <Pword>
    default tablespace USERS
    temporary tablespace TEMP
    quota 100K on USERS;
    grant connect to <User> container=all;
    alter session set container=PDBName
    create table <User>.<Table> ( tstamp date );
    insert into <User>.<Table> (tstamp) values (SYSDATE);

    Note:

    The VCS Agent for Oracle requires a common user for both CDB and PDB detail monitoring, else detail monitoring will not work for PDB.

  7. To test the database table for use, do the following for CDB or traditional databases:
    $ORACLE_HOME/bin/sqlplus /nolog
    connect / as sysdba
    connect  <User>/<Pword>
    update <User>.<Table> set(tstamp)=SYSDATE;
    select TO_CHAR(tstamp, 'MON DD, YYYY HH:MI:SS AM')
    from <User>.<Table>;

    For PDB

    alter session set container=PDBName;
    update <User>.<Table> set (  tstamp ) = SYSDATE;
    select TO_CHAR(tstamp, 'MON DD, YYYY HH:MI:SS  AM') 
    from <User>.<Table>;
    exit
    
  8. Enable the detail monitoring for the Oracle resource using the following VCS commands:
    # hares -modify OracleResource User <User>
    # hares -modify OracleResource Pword <Pword>
    # hares -modify OracleResource Table <Table>
    # hares -modify OracleResource MonScript "./bin/Oracle/SqlTest.pl"

    # hares -override OracleResource LevelTwoMonitorFreq
    # hares -modify OracleResource LevelTwoMonitorFreq 1
    # haconf -dump  -makero
    # hagrp -unfreeze service_group

    You can also use Cluster Manager (Java Console) to set these attributes.