Getting Started with OS Management

The following sections describe how to get started with the OS Management service.

General Workflow for Setting Up Managed Instances

  1. Review the prerequisites for setting up managed instances. See Prerequisites for Setting up a Managed Instance.
  2. Set up your policies for the OS Management service. See Setting Up Policies for OS Management.
  3. Enable OS Management on a new or existing instance. See Enabling the OS Management Service.
  4. Install the Agent used by the OS Management service, if required. See Installing the Agent.
  5. Verify the status of the Agent used by the OS Management service. See Verifying the Status of the Agent.
  6. Verify the status of the Agent used by the OS Management service. See Verifying the Status of the Agent Using the Console.
Note

If you need to disable the Agent used by the OS Management service, see Disabling the Agent on an Instance.

Prerequisites for Setting up a Managed Instance

You can only enable OS Management for a supported operating system.

Oracle Linux
  • Oracle Linux 6 and later
  • Oracle Linux 7 and later
  • Oracle Linux 8 and later
Note

For Oracle Linux 8, the OS Management service does not support updating application streams, also known as Appstreams or module streams.

Windows
  • Windows Server 2012 R2 Standard, Datacenter
  • Windows Server 2016 Standard, Datacenter
  • Windows Server 2019 Standard, Datacenter

For Windows instances, ensure your security lists or network rules are defined to allow access to the Windows update server. For more information, see Windows OS Updates for Windows Images.

You can only enable OS Management in a supported region. For more information, see Availability.

You must first set up the required OS Management policies. For more information about Identify Access and Management (IAM), see Authorization and Authentication.

Important

  • Do not use the OS Management service with Autonomous Linux images at this time. For more information, see Known Issues.

  • OS Management is not available as an Always Free service on the Oracle Cloud Free Tier. For more information about Always Free services, see Oracle Cloud Infrastructure's Free Tier.

The instance must be attached to a virtual cloud network (VCN) that has one of the following:

  • A private subnet with a service gateway that uses the All <region> Services in Oracle Services Network CIDR label.

  • A private subnet with a NAT gateway.

  • A public subnet with an Internet gateway.

To validate whether your instance can reach the OS Management ingestion service:

curl https://ingestion.osms.<region>.oci.oraclecloud.com/

For <region>, specify the region identifier (for example, us-phoenix-1). See Regions and Availability Domains for more information about region identifiers.

For example, the following sample output indicates that the instance can successfully reach the OS Management ingestion service.

Note

The 403 Forbidden status code message is expected in the output.
<html>
<head><title>403 Forbidden</title></head>
<body bgcolor="white">
<center><h1>403 Forbidden</h1></center>
<hr><center>nginx/1.14.2</center>
</body>
</html>

Setting Up Policies for OS Management

This topic explains how to set up the required policies for using the OS Management service.

Note

  • The policies can be set at the tenancy or compartment level. You must have the required privileges to create the policy. If you do not have required privileges, you should work with the administrator for your tenancy to either obtain the privileges to create the policies or to have the policies created for you.
  • For more information about setting up policies for the OS Management service, see Details for the OS Management Service.
To allow instances to use the OS Management service
To allow the OS Management service to emit metrics

Enabling the OS Management Service

Understanding the Agents used with the OS Management service
To enable the OS Management service on Linux instances
To enable the OS Management service on Windows instances

Installing the Agent

To install the Agent on Linux instances
To install the Agent on Windows instances

Verifying the Status of the Agent

To verify the status of the Agent on Linux instances
To verify the status of the Agent on Windows instances

Verifying the Status of the Agent Using the Console

To verify the status of Agent using the Console

Disabling the Agent on an Instance

To disable the Agent on Linux instances