Getting Started with OS Management Hub
Get started with OS Management Hub by ensuring service prerequisites are met before registering instances.
OS Management Hub requires an Oracle Cloud Infrastructure tenancy. To get started with OS Management Hub, you need to:
Supported Environments
OS Management Hub can manage OCI instances and on-premises or supported third-party cloud instances. OS Management Hub provides updates as they're made available by OS vendors. Available updates are subject to the vendor's OS lifecycle programs.
Tenancy Requirements
- OS Management Hub requires infrastructure services in your Oracle Cloud tenancy.
- If you're using Oracle Cloud software or platform services, you might not have infrastructure services. Learn more about Oracle's cloud services.
- OS Management Hub isn't available on the Oracle Cloud Free Tier.
Supported OS Versions
- OCI instances
-
-
Oracle Linux 6, 7, 8, or 9
- Windows Server 2016, 2019, or 2022 Standard, Datacenter
-
Oracle Autonomous Linux 7 or 8 (managed by the Autonomous Linux service which uses OS Management Hub for automated patching)
Important
OS Management Hub requires minimum Oracle Cloud Agent version 1.40. For instances using platform images released before April 2024, upgrade the Oracle Cloud Agent to 1.40 or later. -
- On-premises or third-party cloud instances
-
- Oracle Linux 7, 8, or 9
Supported third-party clouds
OS Management Hub can manage Oracle Linux instances in the following third-party clouds:
- Amazon Web Services (AWS)
- For information on how to create an Oracle Linux instance in AWS, see Launch an Oracle Linux Instance in AWS.
- Microsoft Azure
Compartment Considerations
You can specify which compartment the following resources reside in. This can be useful to limit access to resources on a per compartment basis.
- Software sources: Vendor software sources always reside in the root compartment, but can be replicated to other compartments. See Replicating Vendor Software Sources. Custom software sources can reside in any compartment.
- Profiles: Service-provided profiles always reside in the root compartment. Default profiles must reside in the root compartment. All other profiles can reside in any compartment. See Understanding Profiles.
- Management stations: Can reside in any compartment.
- Groups: Can reside in any compartment.
- Lifecycle environments: Can reside in any compartment.
Best Practices
When creating groups or lifecycle environments, limit instance members to the same compartment as the group or lifecycle environment. OS Management Hub displays instance members, jobs, and reports for a single compartment at a time. When all instance members are in the same compartment, you have a direct view of all members, jobs, and reports associated with the group or lifecycle environment.
If instance members are in several compartments, your view of instances, jobs, and reports is limited to the selected compartment. You must change the compartment scope when viewing members, examining job logs, and running reports. For example, when looking at a job for a multi-compartment group, you would need to change compartments to view all the associated children jobs. Additionally, depending on your policies, a user might not have permissions to all the compartments for the instance members. These users will have an incomplete view of the group or lifecycle environment.
Moving Resources Between Compartments
You can move most resources between compartments within the same region of your tenancy. However, any scheduled jobs associated with the resource don't move to the destination compartment. They continue to reside in the source compartment. For example, if you move a group, any scheduled jobs associated with the group remain in the old compartment.
Before moving resources, verify that policies and permissions are correctly set so that you don't accidentally lose access to the resource.
To move resources, see:
- Moving a Custom Software Source
- Moving a Profile
- Moving a Management Station
- Moving a Group
- Moving a Lifecycle Environment
- Moving a Scheduled Job
For general information about moving resources between compartments in OCI, see Moving Resources Between Compartments.
Networking Considerations
- OCI Linux
-
Attach instances 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.
-
- OCI Windows
-
Define the security lists or network rules to allow Windows instances access to the Windows update server. For more information, see Windows OS Updates for Windows Images.
- On-premises or supported third-party cloud
-
Ensure the instance acting as the management station can reach the OCI network.
- For Microsoft Azure, verify that your Azure Virtual Network allows traffic on the proxy and mirror listening ports for your management station.
- For Amazon Web Services (AWS), verify that your Amazon Virtual Private Cloud (VPC) allows traffic on the proxy and mirror listening ports for your management station.
For more information, see Creating a Management Station.
Required IAM Policy
For policy management, define groups of users and dynamic groups of resources. Then create policies that grant permissions to the groups instead of individual users or resources. See Example Policies for specific use cases. See Getting Started with Policies for general information on policies.
- Recommended User Group
-
Create a user group to administer the OS Management Hub service in the tenancy. Any user that belongs to the group automatically inherits the policies and permissions with that specific group.
- Required Dynamic Group
-
Create a dynamic group to include the instances that will be managed by OS Management Hub. As new instances register with the OS Management Hub, the dynamic group will include them based on the rule statements. Dynamic group rules are compartment specific. You must specify a rule for every compartment and subcompartment with instances that you want managed by OS Management Hub.
Tip
A single resource 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.
Note
The rule builder provides flexibility for creating rules that reference multiple resources. Be aware of the differences when using ALL and ANY conditions with rule builder. For more information, see Managing Dynamic Groups .OCI instances require a different dynamic group rule than non-OCI instances (on-premises or third-party cloud). If managing multiple instance types, include both rules. You can use a single dynamic group that contains rules for both instance types.
- Rule for OCI instances
-
Add a rule statement for each compartment (and subcompartment) that will contain instances.
ALL {instance.compartment.id='<compartment_ocid>'}
- Rule for non-OCI instances
-
Add a rule statement for each compartment (and subcompartment) that will contain instances.
ALL {resource.type='managementagent', resource.compartment.id='<compartment_ocid>'}
- Required Policies
-
You must have a policy that allows instances to register with OS Management Hub and allows users to manage and operate the service. Before creating the policy, create a dynamic group and the recommended user group. You can set the required IAM policies for OS Management Hub either at the tenancy or compartment level.
Note
The policy statement uses the default identity domain unless you define the identity domain before the group or dynamic group name (for example,<identity_domain_name>/<dynamic_group_name>
). For more information, see Policy Syntax.- Tenancy-level policies
-
To apply the required IAM policies at the tenancy level, use the following policy statements:
allow dynamic-group <osmh_dynamic_group> to {OSMH_MANAGED_INSTANCE_ACCESS} in tenancy where request.principal.id = target.managed-instance.id allow group <user_group> to manage osmh-family in tenancy
If managing on-premises or third-party cloud instances, include the following additional policy statements. These aren't required if managing only OCI instances.
allow group <user_group> to manage management-agents in tenancy allow group <user_group> to manage management-agent-install-keys in tenancy
- Compartment-level policies (if not using tenancy-level)
-
If the tenancy administrator doesn't permit setting IAM policies at the tenancy level, you can restrict the use of OS Management Hub resources to a compartment and its subcompartments (policies use compartment inheritance).
To apply the IAM policies to a compartment inside the tenancy, use the following policy statements:
allow dynamic-group <osmh_dynamic_group> to {OSMH_MANAGED_INSTANCE_ACCESS} in compartment <compartment_name> where request.principal.id = target.managed-instance.id allow group <user_group> to manage osmh-family in compartment <compartment_name>
If managing on-premises or third-party cloud instances, include the following additional policy statements. These aren't required if managing only OCI instances.
allow group <user_group> to manage management-agents in compartment <compartment_name> allow group <user_group> to manage management-agent-install-keys in compartment <compartment_name>
For more information, see Example Policies.
What's Next
- Add vendor software sources and entitlements to the tenancy.
- For on-premises or third-party cloud, create a management station and use the profile to register the management station as an instance with the OS Management Hub service.
- Create a profile to register an instance with the content associated with specific software sources, a lifecycle environment, or a group.
- Register an instance with the OS Management Hub service.