2 Oracle Database Appliance Plug-in Installation and Deployment

This chapter provides the instructions for deployment of the Oracle Database Appliance plug-in. The following topics are discussed:

2.1 Oracle Database Appliance Plug-in Deployment Prerequisites

Before deploying the Oracle Database Appliance plug-in, make sure the following prerequisites are met:

2.1.1 Create a Database Server ILOM Service Processor User

For the Enterprise Manager agent to communicate with an ILOM service processor, there must be a specific user ID established on the ILOM service processor.

Note:

Adding the specific user ID requires administrator level privilege on the ILOM service processor.

The specific ILOM user ID can be added in the ILOM service processor web interface, ILOM CLI, or with the ipmitool command. This example uses ILOM CLI.

For security reasons, the password to the ILOM service processor root user ID does not appear in the ILOM CLI commands in this example.

  1. Log in to the Service Processor as root:

    # ssh root@[Service Processor IP]
    Password:
    
  2. Change to the users directory:

    # cd /SP/users
    
  3. Create the oemuser user and password:

    # create oemuser
    
    Creating user...
    Enter new password: ********
    Enter new password again: ********
    
    Created /SP/users/oemuser
    
  4. Change to the new user's directory and set the role:

    # cd oemuser
    /SP/users/oemuser
    
    set role='cro'
    Set 'role' to 'cro'
    
  5. Test the ILOM user ID created in step 3 by listing the last 10 system events:

    # ipmitool -I lan -H <ilom_hostname> -U oemuser -P oempasswd -L USER sel list last 10
    
  6. Repeat steps 1 through 5 for the rest of the server node ILOM service processors in your Oracle Database Appliance.

2.1.2 Create Monitoring OS User on Oracle Database Appliance Server

The root user can perform monitoring on Oracle Database Appliance agents. However, if the root user is not accessible for security reasons, an alternative method is to create a monitoring OS user as the monitoring user, and set the privilege delegation appropriately.

The following is an example that creates an oak/welcome2 user for the purpose of monitoring Oracle Database Appliance.

  1. Run the following commands

    #useradd user oak
    #passwd oak welcome2
    
  2. Add Sudo privilege for user oak.

    1. Modify the /etc/sudoers file on the host using the visudo command.

    2. Add the following commands to the /etc/sudoers file.

      Cmnd_Alias  PLUGIN_AGENT_SCRIPT=$PERL_HOME/bin/perl 
      $AGENT_HOME/plugins/$PLUGIN_OPAR_VERSION /scripts/*.pl* , \ 
      $AGENT_HOME/sbin/nmosudo DEFAULT_PLUGIN DEFAULT_FUNCTIONALITY 
      DEFAULT_SUBACTION DEFAULT_ACTION perl -e exit 0
      MONITOR_USER  ALL=(ALL)  PLUGIN_AGENT_SCRIPT
      

      Note that:

      $AGENT_HOME is the absolute path to the installed agent home. The agent home directory is created during agent deployments to the hosts. For example, /u01/app/agent_home/

      $PLUGIN_OPAR_VERSION is the complete Oracle Database Appliance Plug-in OPAR file that is deployed to the OMS and the agents. It is in the format oracle.dba.odba.agent.plugin_12.1.0.1.0, where 12.1.0.1.0 is the plug-in version, that might increase in the future.

      $PERL_HOME is the absolute path to the installed executable Perl. For example, /u01/app/agent_home/core/12.1.0.4.0/perl/

  3. Set privilege delegation to the host targets.

    1. Log in to Enterprise Manager.

    2. In the Setup menu select Security, then Privilege Delegation.

    3. Select the Sudo type.

    4. Apply /usr/bin/sudo -u %RUNAS% %COMMAND% to Sudo Command Settings.

2.1.3 Verify Software Versions

Oracle Database Appliance Software

The supported version is Oracle Appliance Manager 12.1.2.2.0. To verify the software version on Oracle Database Appliance run the command:

# oakcli show version

See Also:

Oracle Database Appliance Administration and Reference Guide for information about the oakcli show version command.

Grid Infrastructure/DB Cluster

Grid Infrastructure/DB Cluster is required to be up and running before discovery. The Oracle Database Appliance deployment should be completed and the Grid Infrastructure cluster should be up and running prior to deploying the plug-in.

2.1.4 Verify Names Resolution

Each server node should be verified to be able to resolve the hostnames of the ILOM servers. If the names of those components are not registered in DNS, then entries can be added to the /etc/hosts file of each server node.

2.1.5 Verify Firewall Configuration

To verify the firewall configuration:

  1. Allow ping

    In many secure network environments, it is normal for the ping service to be disabled. Enterprise Manager uses ping to establish the basic availability and status of the Oracle Database Appliance.

    • The server nodes need to have the ping service and port enabled from the OMS Server(s).

    • All other Oracle Database Appliance components (such as ILOM servers) need to have the ping service and port enabled from the server nodes (where the agents are running).

    Note:

    The ping traffic overhead is minimal. The agent pings the targets every five minutes.
  2. Open Database Ports

    The database listener ports must be opened for the Enterprise Manager OMS server(s). Note that Oracle Database Appliance databases will use SCAN listeners; so, ports will need to be opened for the base server node, the node virtual IP, and scan listeners addresses.

  3. Open Enterprise Manager Upload Port

    The Enterprise Manager Cloud Control 12c agents require access to the Enterprise Manager Servers upload service, normally configured on port 4889 for HTTP uploads and 4900 for HTTPS. To verify the ports assigned, run the following command on the OMS server command line.

    $ emctl status oms -details
    

    These ports will need to be opened for each of the server nodes.

  4. Open Agent Ports

    The OMS server(s) will need to be able to connect to the Enterprise Manager Cloud Control 12c Agent HTTP/HTTPS port on each server node. The Agent port defaults to 3872. If port 3872 is not available, the next available port starting from port 1830 is used.

    To identify the port used:

    • Run the following command on the server node command line:

      $ emctl status agent
      
    • Alternatively, you can look for the value of the EMD_URL property in the emd.properties file the following directory:

      <AGENT_HOME>/agent_inst/sysman/config
      
  5. Open SSH Ports

    The Enterprise Manager Cloud Control 12c Agents require ssh access to the Database Appliance components they monitor. As the Agents will run on the server nodes the ssh ports, 22, on each of the ILOMs will need to be opened for each of the server nodes.

    Note:

    The emkit configures ssh access but still requires the ports to be opened first.
  6. Allow UDP Traffic (SNMP Ports)

    All Oracle Database Appliance components need to be able to send SNMP traps to the Agents running on the server nodes. SNMP uses the UDP protocol so the Agent port and port 162 need to be opened for UDP traffic between the ILOMs and the Agent.

2.2 Installing Enterprise Manager Agent

Deploy the Enterprise Manager agent on ODA_BASE for Oracle Database Appliance VM deployment, and in Linux Hosts for Oracle Database Appliance Bare Metal deployment.

Note:

Enterprise Manager target discovery supports the use of either management network hostname or client network hostname for the server nodes. When installing the Enterprise Manager agent on the server nodes, you should use the same hostname as used in Oracle Clusterware.

You can identify the hostname of the nodes in the cluster by running the olsnodes command on one of the server nodes. It is recommended that a fully qualified hostname, including the domain name, be used when specifying an Enterprise Manager agent hostname.

Notes:

  • The Enterprise Manager agent must be deployed to all server nodes of the Oracle Database Appliance. The host target name of the server node must be the fully qualified host name, for example, dbm1db01.mydomain.com.

  • Non-fully qualified hostname (for example, dbm1db01) or IP address must not be used for the host target name of the server node.

  • The same version of the Enterprise Manager agent and the same version of the plug-ins should be deployed on all server nodes within the same Oracle Database Appliance.

See Also:

Oracle Enterprise Manager Cloud Control Basic Installation Guide for information about installing management agents

2.2.1 Installing Enterprise Manager Agent Using the Push Method

To install Enterprise Manager Agent using the push method:

  1. Add the Oracle Database Appliance server nodes as host targets to Oracle Enterprise Manager Cloud Control 12c. From the Enterprise Manager home page, click the Setup menu (upper right corner), Add Target, then Add Targets Manually.

  2. On the Add Host Targets: Host and Platform screen, specify a session name. Then identify the fully qualified hostnames and select the platform.

    Note:

    If the Agent software is not available for your platform, go to the Extensibility page and download it first.
  3. Click Next to add the details for the host.

  4. On the Installation Details screen, provide the following information:

    • Installation Base Directory

    • Instance Directory

    • Named Credential

    • For Port, leave this field blank. As part of the installation process, an available port will be selected automatically.

  5. Click Next to review the details about the host.

  6. Click Deploy Agent to start the agent deployment process.

  7. As the deployment process continues, remote prerequisite checks are automatically checked. If there are no issues, you will be presented with an Agent Deployment Summary with an indication that the agent deployment has passed.

Important:

If the root.sh was not executed during deployment, then make sure to execute it on all server nodes.

2.2.1.1 Installing Oracle Management Agent in Silent Mode Option

You can install Oracle Management Agent in silent mode as an alternative to installing it using the Add Host Target Wizard. Silent mode requires you to use a response file for providing the installation details and a deployment script for silently installing the Management Agent using the information supplied in the response file.

See the Installing Oracle Management Agent in Silent Mode chapter in the Oracle Enterprise Manager Cloud Control Advanced Installation and Configuration Guide for more information:

http://docs.oracle.com/cd/E24628_01/install.121/e24089/install_agent_usng_rsp.htm#CEGGACJE

2.3 Deploying the Oracle Database Appliance Plug-in

Oracle Enterprise Manager Plug-in for Oracle Database Appliance is delivered as a plug-in archive file (*.opar) named 12.1.0.VERSION.0_oracle.dba.odba_2000_0.opar.

Assuming you have an existing Oracle Enterprise Manager installation that you plan to use, and you have installed Oracle Enterprise Manager Agent, Oracle Database Appliance Plug-in deployment comprises the following steps:

  1. Import the Oracle Database Appliance Plug-in Archive File Locally (steps) or Import the Oracle Database Appliance Plug-in Archive File Remotely (steps)

  2. Deploy Oracle Database Appliance Plug-in on Enterprise Manager Cloud Control (OMS Servers) (steps)

  3. Deploy Oracle Database Appliance Plug-in to the Management Agents on Both Oracle Database Appliance Server Nodes (Hosts) (steps)

2.3.1 Import the Oracle Database Appliance Plug-in Archive File Locally

To import the Oracle Database Appliance plug-in archive file locally, follow these steps.

  1. Copy the Oracle Database Appliance Plug-in OPAR file to the OMS host system.

  2. Open a terminal (such as PuTTY) on the OMS host machine and connect as oracle user.

  3. Copy the OPAR file to the host.

  4. Log on to OMS using emcli.

    $ /u01/app/middleware/oms/bin/emcli login -username=user_name -password=password
    
  5. Import the OPAR file to OMS using emcli.

    Importing ensures the content that you have created and packaged in the plug-in is available with Enterprise Manager Cloud Control.

    $ /u01/app/middleware/oms/bin/emcli import_update -file=OPAR_FILE_LOCATION -omslocal
    

    For example,

    /u01/app/middleware/oms/bin/emcli import_update -file=/tmp/12.1.0.VERISON.0_oracle.dba.odba_2000_0.opar -omslocal
    

    Note:

    Append the -omslocal flag because the plug-in archive is on the same system where you are running this command (copied in step 3 above). Specify the absolute path name that exists on the system.

2.3.2 Import the Oracle Database Appliance Plug-in Archive File Remotely

If you are running EMCLI on a different system than the system where you created the plug-in archive (*.opar file), then run the following command:

emcli import_update
    -file="path to the .opar file"
    -host="host name of plug-in host"
    -credential_name="credential for plug-in host"
    -credential_owner="credential owner on the plug-in host"

where:

-file is the absolute path to the *.opar file on the system where you created the archive.

-host is the host name for the host target where the file is available.

-credential_name is the name of the credentials on the remote system you are connecting to.

-credential_owner is the owner of the credentials on the host system you are connecting to.

For example:

emcli import_update
    -file=/tmp/sample_plugin.opar
    -host="host1.acme.com" 
    -credential_name="myOracleCred"
    -credential_owner="myPassword"

2.3.3 Deploy Oracle Database Appliance Plug-in on Enterprise Manager Cloud Control (OMS Servers)

To deploy the Oracle Database Appliance plug-in do the following steps.

  1. Open a web browser and log in to Enterprise Manager Cloud Control.

  2. Open the Setup menu, and select Extensibility then Plug-ins.

  3. Under Engineered System select ORACLE DATABASE APPLIANCE.

  4. Click Deploy on and follow the instructions.

    This step takes approximately 3 to 5 minutes, including stopping and restarting OMS. During the deployment use $ ./emctl status oms -details to check OMS status.

  5. Wait until OMS is back up.

2.3.4 Deploy Oracle Database Appliance Plug-in to the Management Agents on Both Oracle Database Appliance Server Nodes (Hosts)

To deploy the Oracle Database Appliance plug-in to the management agents on both Oracle Database Appliance nodes, do the following steps.

  1. Open a web browser and log in to Enterprise Manager Cloud Control.

  2. Open the Setup menu and select Extensibility then Plug-ins.

  3. Under Engineered System select ORACLE DATABASE APPLIANCE.

  4. Click Deploy on and choose Management Agents.

    This step takes approximately 2 minutes depending on how many agents are deployed at the same time. This step does not restart OMS. Wait until the deployment process is finished.