主页
产品
Red Hat Ansible Automation Platform
2.5
Configuring automation execution
Chapter 11. Subscription management in Ansible Automation Platform and automation controller

此内容没有您所选择的语言版本。

Chapter 11. Subscription management in Ansible Automation Platform and automation controller

Ansible Automation Platform provides capabilities to monitor usage, activate subscriptions, and maintain compliance with Red Hat subscription requirements.

11.1. Host metrics and subscription

Host metrics can be used to accurately count node usage and ensure subscription compliance. For example, if a host is no longer in use or otherwise should not be counted towards the subscription total, it can be soft-deleted.

11.1.1. Host Metrics dashboard

To view your host metrics, in the navigation pane, select Automation Analytics Host Metrics.

The Host Metrics dashboard provides high level automation run details per managed host, including:

The first and last time a host was automated.
The number of times automation has been run or attempted to be run against a host.
The number of times a managed host has been deleted.

The ability to view the number of times automation has been run on hosts enables you to:

View your most commonly automated hosts.
More accurately reflect the scope of your automation landscape.

11.1.1.1. Soft deletion

Soft deletion enables the removal of decommissioned hosts from the Host Metrics view and excludes them from any potential managed node counting. Additionally, the following host types can also be deleted:

Ephemeral, uniquely provisioned hosts, such as those used for CI-CD, or testing only.
Bench provisioning or temporary hosts.
Older hosts that have been decommissioned and are never automated against.

Soft deletion is intended for legitimate use case scenarios only. It must not be used to violate subscription counting, for example, for the purposes of node recycling. For more information, see How are "managed nodes" defined as part of the Red Hat Ansible Automation Platform offering?

11.2. Activating Red Hat Ansible Automation Platform

Red Hat Ansible Automation Platform uses available subscriptions or a subscription manifest to authorize the use of Ansible Automation Platform. To obtain a subscription, you can do either of the following:

Use your Red Hat customer or Satellite credentials when you launch Ansible Automation Platform.
Upload a subscriptions manifest file either using the Red Hat Ansible Automation Platform interface or manually in an Ansible playbook.

11.2.1. Activate with credentials

When Ansible Automation Platform launches for the first time, the Ansible Automation Platform Subscription screen automatically displays. You can use your Red Hat credentials to retrieve and import your subscription directly into Ansible Automation Platform.

Note

You are opted in for Automation Analytics by default when you activate the platform on first time log in. This helps Red Hat improve the product by delivering you a much better user experience. You can opt out, after activating Ansible Automation Platform, by doing the following:

From the navigation panel, select Settings System.
Clear the Gather data for Automation Analytics option.
Click Save.

Procedure

Log in to Red Hat Ansible Automation Platform.
Select Username / password.
Enter your Red Hat username and password.
Select your subscription from the Subscription list.
Note
You can also use your Satellite username and password if your cluster nodes are registered to Satellite through Subscription Manager.
Review the End User License Agreement and select I agree to the End User License Agreement.
Click Finish.

Verification

After your subscription has been accepted, subscription details are displayed. A status of Compliant indicates your subscription is in compliance with the number of hosts you have automated within your subscription count. Otherwise, your status will show as Out of Compliance, indicating you have exceeded the number of hosts in your subscription. Other important information displayed include the following:

Hosts automated: Host count automated by the job, which consumes the license count
Hosts imported: Host count considering all inventory sources (does not impact hosts remaining)
Hosts remaining: Total host count minus hosts automated

11.2.2. Activate with a manifest file

If you have a subscriptions manifest, you can upload the manifest file either by using the Red Hat Ansible Automation Platform interface.

Note

From the navigation panel, select Settings System.
Uncheck the Gather data for Automation Analytics option.
Click Save.

11.3. Keeping your subscription in compliance

Your subscription has two possible statuses:

Compliant: Indicates that your subscription is appropriate for the number of hosts that you have automated within your subscription count.
Out of compliance: Indicates that you have exceeded the number of hosts in your subscription.

Compliance is computed as follows:

managed > manifest_limit    =>  non-compliant
managed =< manifest_limit   =>  compliant

Where: managed is the number of unique managed hosts without deletions, and manifest_limit is the number of managed hosts in the subscription manifest.

Other important information displayed are:

Hosts automated: The number of hosts automated by the job, which consumes the license count.
Hosts imported: The number of hosts considering unique host names across all inventory sources. This number does not impact hosts remaining.
Hosts remaining: The number of hosts minus the number of hosts automated.
Hosts deleted: The number of hosts that were deleted, freeing the license capacity.
Active hosts previously deleted: The number of hosts now active that were previously deleted.

For example, if you have a subscription capacity of 10 hosts:

Starting with 9 hosts, 2 hosts were added and 3 hosts were deleted, you now have 8 hosts (compliant).
3 hosts were automated again, now you have 11 hosts, which puts you over the subscription limit of 10 (non-compliant).
If you delete hosts, refresh the subscription details to see the change in count and status.

11.3.1. Viewing hosts automated in the user interface

Procedure

In the navigation panel, select Automation Analytics Host Metrics to view the activity associated with hosts, such as those that have been automated and deleted.
Each unique hostname is listed and sorted by the user’s preference. image::ug-host-metrics.png[Host metrics]
Note
A scheduled task automatically updates these values on a weekly basis and deletes jobs with hosts that were last automated more than a year ago.
Delete unnecessary hosts directly from the Host Metrics view by selecting the desired hosts and clicking Delete.
These are soft-deleted, meaning their records are not removed, but are not being used and thereby not counted towards your subscription.

For more information, see Configuring automation execution/index#controller-keep-subscription-in-compliance[Keeping your subscription in compliance].

11.3.2. Viewing Hosts automated in the CLI

Automation controller provides a way to generate a CSV output of the host metric data and host metric summary through the Command Line Interface (CLI). You can also soft delete hosts in bulk through the API.

11.3.2.1. awx-manage utility

The awx-manage utility supports the following options:

awx-manage host_metric --csv

This command produces host metric data, a host metrics summary file, and a cluster info file. To package all the files into a single tarball for distribution and sharing use:

awx-manage host_metric --tarball

To specify the number of rows (<n>) to output to each file:

awx-manage host_metric --tarball --rows_per_file <n>

Automation Analytics receives and uses the JSON file.

For more information on using metrics-utility CLI, see Configuring automation execution/assembly-controller-metrics[Usage reporting with metrics-utility]

11.3.3. Deleting Hosts automated using API endpoint

The API lists only non-deleted records and are sortable by last_automation and used_in_inventories columns.

You can use the host metric API endpoint, api/v2/host_metric to soft delete hosts, using:

api/v2/host_metric <n> DELETE

A monthly scheduled task automatically deletes jobs that uses hosts from the Host Metric table that were last automated more than a year ago.

返回顶部