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 list of Oracle-provided images that support the OS Management service. See Supported Images.
  2. Review the prerequisites for setting up managed instances. See Prerequisites.
  3. Set up your IAM policies for the OS Management service. See Setting Up IAM Policies for OS Management.
  4. Enable OS Management on a new or existing instance. See Enabling OS Management for a New Compute Instance and Enabling the OS Management Service Agent Plugin for an Existing Compute Instance.
  5. Verify the status of the OS Management Service Agent plugin. See Verifying the Status of the OS Management Service Agent Plugin.
  6. Start using the OS Management service to manage your instances. See What to Do Next.

Supported Images

OS Management is supported on the following Oracle Linux and Windows platform images and on custom images based on these supported images. For more information about these images, see Platform Images.

Oracle Linux
  • Oracle Linux 6 and later.
  • Oracle Linux 7 and later.
  • Oracle Linux 8 and later.
  • Oracle Autonomous Linux, beginning with the August 2021 platform image. For more information, see Oracle Autonomous Linux.
Important

  • Beginning with the Oracle Linux 8 platform images released in October 2021, the OS Management Service Agent plugin is enabled by default in Oracle Cloud Agent 1.16.0 for Oracle Linux 8 instances.

    For Oracle Linux 8 instances that were launched before October 2021 (running Oracle Cloud Agent 1.15.0 or earlier), the OS Management Service Agent plugin is disabled by default. The OS Management Service Agent plugin for disabled Oracle Linux 8 instances remain disabled after being updated to Oracle Cloud Agent 1.16.0.

    For disabled Oracle 8 instances, you might see a discrepancy in the status of the OS Management Service Agent plugin after the update to Oracle Cloud Agent 1.16.0. For more information, see Known Issues.

  • Beginning with Oracle Cloud Agent 1.15.0, the OS Management service is supported on Arm-based Ampere A1 Compute shapes.
  • For Oracle Linux 8, the OS Management service does not support updating application streams, also known as Appstreams or module streams. For more information, see Known Issues.

  • Beginning with the Oracle Linux platform images released in September 2020, the OS Management service uses the OS Management Service Agent plugin for all Oracle Linux instances. The OS Management Service Agent plugin replaces the OS Management Service Agent (osms-agent) package. For more information about the OS Management Service Agent plugin, see OS Management Components and Features.

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

Prerequisites

Important

OS Management is not available on the Oracle Cloud Free Tier.

  • Images: Use a supported image. For more information, see Supported Images.
  • IAM policies: Set the required IAM policies for the OS Management service. For more information, see Setting Up IAM Policies for OS Management.
  • Security Lists (Windows instances only): Define your security lists or network rules to allow access to the Windows update server. For more information, see Windows OS Updates for Windows Images.
  • Service gateways or public IP addresses (Linux instances only): Attach your instance 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.

    For detailed instructions, see Access to Oracle Services: Service Gateway.

  • Oracle Cloud Agent: Ensure that the Oracle Cloud Agent software is installed and running on the instance. By default, the Oracle Cloud Agent is installed on current Oracle-provided images. For steps to manually install Oracle Cloud Agent on older images, see Installing the Oracle Cloud Agent Software.
  • OS Management Service Agent plugin: Ensure that the OS Management Service Agent plugin is enabled and running on the instance. By default, the OS Management Service Agent plugin is enabled and running on current Oracle-provided images.

Setting Up IAM Policies for OS Management

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

Note

  • 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.

Required Dynamic Group

Before you create the required IAM policies for OS Management, you first need to create a dynamic group. A dynamic group can include instances based on instance OCID or include instances that reside in a compartment based on compartment OCID. For more information about dynamic groups, see Managing Dynamic Groups.

When you create a dynamic group, you define the group members in matching rule statements using the rule builder.

Important

A single instance can belong to a maximum of five dynamic groups. A good practice is to reuse the same dynamic group wherever possible across services instead of creating one or more dynamic groups for each service.

When defining matching rules, you set conditions for the matching rule statements:

  • All of the following (All) includes only instances that match all the statements in the rule.

  • Any of the following (Any) includes instances that match any of the statements in the rule.

Follow these guidelines when creating matching rule statements:

  • You can add one or more rules to define the instances to be permitted in the policy.

  • All statements require that all matching rule statements be true. This condition can cause problems when you add multiple compartments or instances to the group under a single rule or multiple rules. When using All, each rule condition must be met (true); otherwise the request is denied.

  • Dynamic groups do not support compartment inheritance. Be sure to specify the compartment OCIDs of the compartments where the instances reside.

Tip

The OCID for an instance is displayed on the Instance Details page while the OCID for the compartment is displayed on the Compartments page or by using the oci metadata utility.

After creating the dynamic group, you can create your IAM policy to permit instances to make API calls against the OS Management service.

Example: Dynamic Group

Provides a dynamic group example to help you understand the use of any and all conditions in a matching rule statement.

Understanding Any and All Conditions

Policy Rule: When using All, for the policy to be true, instances must match all rule statements.

All {instance.id = 'ocid1.instance1.oc1.iad..exampleuniqueid1', instance.compartment.id ='ocid1.compartmentA.oc1..exampleuniqueid2'}

In this example, instance1 (ocid1.instance1.oc1.iad..exampleuniqueid1) must reside in compartmentA (ocid1.compartmentA.oc1..exampleuniqueid2) for the policy to be true. If instance1 is not in compartmentA, the matching statement is false and the service fails.

Using the same example, by changing All to Any, either an instance that matches the OCID for instance1 or an instance in compartmentA would be true.

Required IAM Policies

For an instance to be registered with the OS Management service, you must create policies that allow instances to use OS Management.

Before you create the IAM policies, you first need to create a dynamic group.

Required IAM Policies for a Tenancy

To apply the policies for OS Management to the tenancy, use the following policies.

Allow service osms to read instances in tenancy
Allow dynamic-group <dynamic_group_name> to read instance-family in tenancy
Allow dynamic-group <dynamic_group_name> to use osms-managed-instances in tenancy
Required IAM Policies for a Compartment

To apply the policies for OS Management only to a compartment inside the tenancy, use the following policies.

Note

The policy statement that is set in tenancy must be set at the tenancy level.
Allow service osms to read instances in tenancy
Allow dynamic-group <dynamic_group_name> to read instance-family in compartment <compartment_name>
Allow dynamic-group <dynamic_group_name> to use osms-managed-instances in compartment <compartment_name>

After setting the policies, you must restart the Oracle Cloud Agent.

To restart the Oracle Cloud Agent on Oracle Linux instances:
  1. Log in to your instance. See Connecting to an Instance.
  2. Restart the Oracle Cloud Agent service.
    Oracle Linux 7 and Oracle Linux 8
    sudo systemctl restart oracle-cloud-agent.service
    Oracle Linux 6
    sudo initctl restart oracle-cloud-agent
Note

For more information about each of these policies, including steps for setting up dynamic groups, see Detailed Steps. For details about OS Management permissions, see OS Management Policy Reference.
Detailed Steps
Note

Before you create the IAM policies, you first need to create a dynamic group.
  1. Create a policy that grants the OS Management service permission to read instance information in the tenancy. This policy allows the OS Management to emit metrics.

    Important

    This policy must be specified at the tenancy level.

    For example:

    Allow service osms to read instances in tenancy

    For more information about metrics for OS Management, see OS Management Metrics.

  2. Create a policy granting instances of that dynamic group permission to retrieve their details for authorization purposes.

    For example, to set the policy in the tenancy:

    Allow dynamic-group <dynamic_group_name> to read instance-family in tenancy

    For example, to set the policy in a specified compartment:

    Allow dynamic-group <dynamic_group_name> to read instance-family in compartment <compartment_name>
  3. Create a policy that grants instances access to the OS Management service.

    For example, to set the policy in the tenancy:

    Allow dynamic-group <dynamic_group_name> to use osms-managed-instances in tenancy

    For example, to set the policy in a specified compartment:

    Allow dynamic-group <dynamic_group_name> to use osms-managed-instances in compartment <compartment_name>
  4. Restart the Oracle Cloud Agent.

    To restart the Oracle Cloud Agent on Oracle Linux instances:
    1. Log in to your instance. See Connecting to an Instance.
    2. Restart the Oracle Cloud Agent service.
      Oracle Linux 7 and Oracle Linux 8
      sudo systemctl restart oracle-cloud-agent.service
      Oracle Linux 6
      sudo initctl restart oracle-cloud-agent

Enabling OS Management for a New Compute Instance

Using the Console
  1. Follow the steps to create an instance, until the advanced options. Ensure that the instance has either a public IP address or a service gateway, as described in the prerequisites.
  2. Enable the OS Management Service Agent plugin.
  3. Click Show Advanced Options.
  4. On the Oracle Cloud Agent tab, select the OS Management Service Agent check box. This check box is selected by default.
    Note

    If you're using an older Oracle-provided image or a custom image that is not based on a recent Oracle-provided image, you must manually install the Oracle Cloud Agent software. You can do this by providing a cloud-init script. For more information, see Installing the Oracle Cloud Agent Software. Compare the date of the image to the date listed in Supported Images.

  5. Click Create.

    Important

    When registering with the OS Management service, Oracle Linux instances subscribe to the default channel list and all other channel subscriptions are disabled. If you need to reenable any of these channels, you can do so using the Console, CLI, or REST APIs. For more information, see Managing Software Sources.
Using the API
Note

If you're using an older Oracle-provided image or a custom image that is not based on a recent Oracle-provided image, you must manually install the Oracle Cloud Agent software. You can do this by providing a cloud-init script. For more information, see Installing the Oracle Cloud Agent Software. Compare the date of the image to the date listed in Supported Images.

  1. Ensure that the instance has either a public IP address or a service gateway, as described in the prerequisites.
  2. Use the LaunchInstance operation. Include the following parameters:
    {
      "agentConfig": {
        "isManagementDisabled": false,
        "pluginsConfig": [
          {
            "name": "OS Management Service Agent",
            "desiredState": "ENABLED"
          }
        ]
      }
    }
  3. Proceed to Verifying the Status of the OS Management Service Agent Plugin.
Important

When registering with the OS Management service, Oracle Linux instances subscribe to the default channel list and all other channel subscriptions are disabled. If you need to reenable any of these channels, you can do so using the Console, CLI, or REST APIs. For more information, see Managing Software Sources.

Enabling the OS Management Service Agent Plugin for an Existing Compute Instance

Using the Console
  1. Install the Oracle Cloud Agent software, if it is not already installed.
  2. Open the navigation menu, click Compute, and then click Instances.
  3. Click the instance that you're interested in.
  4. Click the Oracle Cloud Agent tab.
  5. Toggle the Enable Plugin switch to Enabled, if the switch is disabled.

    It takes up to 10 minutes for the change to take effect.

    For more information about how to enable and run plugins, see Managing Plugins with Oracle Cloud Agent.

  6. Proceed to Verifying the Status of the OS Management Service Agent Plugin.
Important

When registering with the OS Management service, Oracle Linux instances subscribe to the default channel list and all other channel subscriptions are disabled. If you need to reenable any of these channels, you can do so using the Console, CLI, or REST APIs.
Using the API
  1. Install the Oracle Cloud Agent software, if it is not already installed.
  2. Use the LaunchInstance operation. Include the following parameters:
    {
      "agentConfig": {
        "isManagementDisabled": false,
        "areAllPluginsDisabled": false,
        "pluginsConfig": [
          {
            "name": "OS Management Service Agent",
            "desiredState": "ENABLED"
          }
        ]
      }
    }
  3. Ensure that the instance has either a public IP address or a service gateway, as described in the prerequisites.
  4. Proceed to Verifying the Status of the OS Management Service Agent Plugin.
Important

When registering with the OS Management service, Oracle Linux instances subscribe to the default channel list and all other channel subscriptions are disabled. If you need to reenable any of these channels, you can do so using the Console, CLI, or REST APIs.

Disabling the OS Management Service Agent Plugin

Using the Console
  1. Open the navigation menu, click Compute, and then click Instances.
  2. Click the instance that you're interested in.
  3. Click the Oracle Cloud Agent tab.
  4. Toggle the Enable Plugin switch to Disabled, if the switch is enabled.

    It takes up to 10 minutes for the change to take effect.

    For more information about how to enable and run plugins, see Managing Plugins with Oracle Cloud Agent.

  5. Restore the yum configuration in the instance after disabling the OS Management Service Agent plugin.
    1. Log in to your instance. See Connecting to an Instance.
    2. Unregister the instance from the OS Management service.
      sudo osms unregister
Using the API
  1. Use the LaunchInstance operation. Include the following parameters:
    {
      "agentConfig": {
        "isManagementDisabled": false,
        "areAllPluginsDisabled": false,
        "pluginsConfig": [
          {
            "name": "OS Management Service Agent",
            "desiredState": "DISABLED"
          }
        ]
      }
    }
  2. Restore the yum configuration in the instance after disabling the OS Management Service Agent plugin.
    1. Log in to your instance. See Connecting to an Instance.
    2. Unregister the instance from the OS Management service.
      sudo osms unregister

Verifying the Status of the OS Management Service Agent Plugin

Oracle Linux instances
Important

The OS Management Service Agent plugin requires Oracle Cloud Agent 1.2.0 or later.
  1. Log in to your instance. See Connecting to an Instance.
  2. 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>
    
  3. Verify the yum configuration.
    ls /etc/yum.repos.d
    1. Check that the existing yum repository configuration is disabled.
    2. Ensure that the *.repo files in the /etc/yum.repos.d directory are backed up to *.repo.osms-backup in the same directory.

    For example:

    $ ls /etc/yum.repos.d
    ksplice-ol7.repo.osms-backup                oracle-linux-ol7.repo.osms-backup
    ksplice-uptrack.repo.osms-backup            oracle-softwarecollection-ol7.repo.osms-backup
    oci-included-ol7.repo.osms-backup           uek-ol7.repo.osms-backup
    oracle-epel-ol7.repo.osms-backup            virt-ol7.repo.osms-backup
    oraclelinux-developer-ol7.repo.osms-backup
  4. Verify that the OS Management Service Agent plugin is running on the instance.
    ps -elf | grep osms | grep -v grep

    For example:

    $ ps -elf | grep osms | grep -v grep
    4 S root     24269 24245  0  80   0 - 62257 -      Jun30 ?        00:00:00 /usr/bin/sudo -n /usr/libexec/oracle-cloud-agent/plugins/osms/osms-agent
    4 S root     24273 24269  0  80   0 -  2165 -      Jun30 ?        00:00:00 /usr/libexec/oracle-cloud-agent/plugins/osms/osms-agent
    4 S root     24274 24273  0  80   0 - 406892 -     Jun30 ?        00:50:28 /usr/libexec/oracle-cloud-agent/plugins/osms/osms-agent
    Note

    If the OS Management Service Agent plugin is not installed or has been stopped, no output is displayed for this command.

After the OS Management Service Agent plugin is running, you have completed the getting started tasks for setting up the managed instance. You can now use the OS Management service to manage the instance. Proceed to What to Do Next.

Windows instances
  1. Log in to your instance. See Connecting to an Instance.
  2. Perform one of the following procedures:

    To verify the status of the Oracle Cloud Agent using Windows PowerShell:

    1. Open Windows PowerShell.

    2. Run the Get-Service OCAOSMS command and verify that the status is running.

      For example:

      PS C:\Users\opc> Get-Service OCAOSMS
      Status   Name               DisplayName
      ------   ----               -----------
      Running  OCAOSMS            Oracle Cloud Operating System Manag...
                                  

    To verify the status of the Oracle Cloud Agent using Computer Management:

    1. Go to Computer Management.
      Tip

      In the Search column, you can get to Computer Management by searching on the keywords: Computer Management or compmgmt.msc.
    2. Click Services and Applications and then Services.

    3. Verify that the Oracle Cloud Agent service is running.

After the OS Management Service Agent plugin is running, you have completed the getting started tasks for setting up the managed instance. You can now use the OS Management service to manage the instance.

What to Do Next

After setting up managed instances, you can start using the OS Management service to keep those instances up to date with the latest patches and updates.

Common tasks that you perform after creating managed instances include: