2 Generic Prerequisites for Deploying Oracle Management Cloud Agents
Before deploying Oracle Management Cloud agents (gateways, data collectors, or cloud agents) in your data center, ensure that the following prerequisites are met:
Supported Operating Systems
Table 2-1 Supported Operating Systems
Operating System | Version |
---|---|
Red Hat Enterprise Linux |
Red Hat Enterprise Linux 6 or later (64 bit) Red Hat Enterprise Linux 7 or later (64 bit) |
Oracle Linux |
Oracle Linux 6 or later (64 bit) Oracle Linux 7 or later (64 bit) Oracle Linux 8 or later (64 bit) |
SUSE Linux |
SUSE Linux Enterprise Server 11 (x86_64) |
Ubuntu Linux |
Ubuntu Linux 14.02 |
AIX |
AIX 6.1 Technology Level 9 or later AIX 7.1 Technology Level 3 or later AIX 7.2 (base) and later |
Oracle Solaris |
Oracle Solaris 10 or later for SPARC (64 bit) Oracle Solaris 11 or later for SPARC (64 bit) |
Microsoft Windows |
Microsoft Windows Server 2012 Standard (64 bit) Microsoft Windows Server 2016 Standard (64-bit) Microsoft Windows Server 2019 Standard (64-bit) |
Environment Requirements
-
You require the unzip utility to decompress the initial software zip file. Ensure you have it installed or download unzip to decompress the initial agent software zip file.
-
To download the Oracle Management Cloud agents install software bundle and perform other administration tasks from the Oracle Management Cloud interface, you must sign in as a user with the OMC Administrator role. See Add Users and Assign Roles in Getting Started with Oracle Management Cloud.
- Oracle recommends installing the Oracle Management Cloud agent as the same user who installed the Oracle software, if they want to discover and monitor Oracle software. Typically this user is
oracle
. -
If you plan to use the IT Analytics or Log Analytics components and if you want to collect data from an existing on-premises Oracle Enterprise Manager setup, then you must have an existing deployment of any one of the following in your data center.
-
Oracle Enterprise Manager Cloud Control 12.1.0.3
-
Oracle Enterprise Manager Cloud Control 12.1.0.4
-
Oracle Enterprise Manager Cloud Control 12.1.0.5
-
Oracle Enterprise Manager Cloud Control 13.1.0.x
-
Oracle Enterprise Manager Cloud Control 13.2.0.x
-
Oracle Enterprise Manager Cloud Control 13.3.0.x
-
Oracle Enterprise Manager Cloud Control 13.4.0.x
-
-
Agents installation requires fully qualified domain names (FQDN) for your hosts. For UNIX environments, add the FQDN in the
/etc/hosts
file and ensure that it maps to the correct host name and IP address of the host. The recommended format is as follows:<ip> <fully_qualified_host_name> <short_host_name>
For example:
If your host name is myhost and your domain is example.com (IPv4):
172.16.0.0 myhost.example.com myhost
If your host name is myhost and your domain is example.com (IPv6):
aaaa::111:2222:3333:4444 myhost.example.com myhost
You can run the following commands to verify. You should see the same host name and IP address displayed.
getent hosts `hostname` host `hostname`
In the output, the FQDN must appear in the second field as specified in the
/etc/hosts
file. For example, the previous commands should return the following output:$ getent hosts `hostname`
172.16.0.0 myhost.example.com myhost
$ host `hostname`
myhost.example.com has address 172.16.0.0
-
Ensure that you deploy the Oracle Management Cloud agents in the following sequence:
-
Gateway (if needed).
-
Data collector (if integrating with Oracle Enterprise Manager).
-
Cloud agents (for collecting availability, configuration and performance metrics).
-
-
For UNIX environments, the file system where the agent will be installed needs to allow executable binaries to run. Ensure that the file system was not mounted with the
noexec
option. If this parameter is set, then the entire file system does not allow the execution. You can use themount
command or check the file system in the mount options (/etc/fstab
) to verify if thenoexec
option has been set.
Permissions on Windows Systems
You must deploy an agent on Windows as an administrator and ensure that necessary permissions are set as follows:
-
From the Start menu, click Settings, then click Control Panel. From the Control Panel window, click Administrative Tools, and then click Local Security Policy. Expand the Local Policies folder and open the User Rights Assignment folder and set the following permissions:
-
Act as part of the operating system
-
Adjust memory quota for a process
-
Log on as a batch job
-
Replace process level tokens
-
Permissions Required on the Agent Base Directory
-
The Agent Base Directory is the directory where the agent will be installed. Ensure only the root user and agent installation user have write permission on the Agent Base Directory and its parent directory even after the agent installation, to make sure all agent life cycle operations such as update or delete complete successfully.
-
If the Agent Base Directory is created before the installation, ensure the directory is empty. The agent installation user must have write access to the directory.
-
If the Agent Base Directory is not created before installation, it will be created by default under the directory where the agent software zip file was extracted. Ensure the agent installation user has write access to the parent directory where the Agent Base Directory will be created.
Network Prerequisites
Oracle Management Cloud Agents communicate to Oracle Management Cloud. If your network setup has a firewall, ensure you allow HTTPS communication from the host on which the agent is to be deployed to *.oraclecloud.com
to allow outbound communication. You can use any available network connectivity tool to verify connectivity with the data center.
Oracle Management Cloud Agents (Cloud Agents, Data Collectors, Gateways) do not support NTLM Authorization Proxy Servers (APS).
Direction | Port | Protocol | Reason |
---|---|---|---|
Data Collector to OMR host |
22 or user defined |
SSH |
Data collector to connect with OMR host. |
Proxy server to external |
443 |
HTTPS |
Communication with Oracle Management Cloud services. |
Cloud agent node to gateway |
Gateway host port |
TCP |
Communication with gateway. |
Requirement for Integrating With Oracle Enterprise Manager
If you want to collect data from Oracle Enterprise Manager (EM), including Oracle Database Diagnostics Pack or Oracle WebLogic Server Management Pack, you must deploy a Data Collector. For collecting database performance data used by IT Analytics, ensure that the Data Collector owner (host user) is the same as the Oracle Enterprise Manager on-premises agent host user. This allows connections to the EM database targets using the EM monitoring credentials and ensures database performance data can be collected.
Requirement for Logs Collection on Unix
If you are deploying the agents for using Oracle Log Analytics on UNIX-based hosts, ensure that the cloud agent has the correct privileges to read the log files from where data has to be collected.
You can use either one of the following ways (in order of best practice) to make the log files readable to the cloud agent:
-
Use Access Control Lists (ACLs) to enable the cloud agent user to read the log file path and log files. An ACL provides a flexible permission mechanism for file systems. Ensure that the full path to the log files is readable through the ACL.
To set up an ACL in a UNIX-based host:
-
Determine whether the system that contains the log files has the
acl
package:rpm -q acl
If the system contains the
acl
package, then the previous command should return:acl-2.2.39-8.el5
If the system doesn’t have the
acl
package, then download and install the package. -
Grant the cloud agent user read access to the required log file:
setfacl -m u:<agentuser>:r file <path to the log file/log file name>
Grant the cloud agent user read access to the leading path or folders by running the following command:
setfacl -d -m u:<agentuser>:r file <path to the parent folder of the log file>
-
-
Place the cloud agent and the product that generates the logs in the same user group, and make the files readable to the entire group.
-
Install the cloud agent as the user that also owns the logs. This is difficult to achieve if there are a lot of different logs owned by different users on same host.
-
Make the log files readable to all users. For example,
chmod o+r <file>