Search
SupportConsoleDevelopersStart a trialContact

Chapter 3. Deprecated features

download PDF

Deprecated functionality is still included in Ansible Automation Platform and continues to be supported during this version’s support cycle. However, the functionality will be removed in a future release of Ansible Automation Platform and is not recommended for new deployments.

The following table provides information about features that were deprecated in Ansible Automation Platform 2.5:

ComponentFeature

Automation controller,
automation hub, and
Event-Driven Ansible controller

Tokens for the automation controller and the automation hub are deprecated. If you want to generate tokens, use the platform gateway to create them.

The platform gateway is the service that handles authentication and authorization for the Ansible Automation Platform. It provides a single entry into the Ansible Automation Platform and serves the platform user interface, so you can authenticate and access all of the Ansible Automation Platform services from a single location.

Automation controller and
automation hub

All non-local authentications into the automation controller and automation hub are deprecated. Use the platform gateway to configure external authentications, such as SAML, LDAP, and RADIUS.

Ansible-core

The INI configuration option in the COLLECTIONS_PATHS is deprecated. Use the singular form COLLECTIONS_PATH instead.

Ansible-core

The environment variable ANSIBLE_COLLECTIONS_PATHS is deprecated. Use the singular form ANSIBLE_COLLECTIONS_PATH instead.

Ansible-core

Old-style Ansible vars plug-ins that use the entry points get_host_vars or get_group_vars were deprecated in ansible-core 2.16, and will be removed in ansible-core 2.18. Update the Ansible plug-in to inherit from BaseVarsPlugin and define a get_vars method as the entry point.

Ansible-core

The STRING_CONVERSION_ACTION configuration option is deprecated as it is no longer used in the ansible-core code base.

Ansible-core

The smart option for setting a connection plug-in is being removed as its main purpose of choosing between SSH and Paramiko protocols is now irrelevant. Select an explicit connection plug-in instead.

Ansible-core

The undocumented vaultid parameter in the vault and unvault filters is deprecated and will be removed in ansible-core version 2.20. Use vault_id instead.

Ansible-core

The string parameter keepcache in the yum_repository is deprecated.

Ansible-core

The required parameter in the API ansible.module_utils.common.process.get_bin_path is deprecated.

Ansible-core

module_utils - Importing the following convenience helpers from ansible.module_utils.basic has been deprecated:
get_exception, literal_eval, _literal_eval, datetime, signal, types, chain, repeat, PY2, PY3, b, binary_type, integer_types, iteritems, string_types, test_type, map, and shlex_quote.
Import the helpers from the source definition.

Ansible-core

ansible-doc - Role entrypoint attributes are deprecated and eventually will no longer be shown in ansible-doc from ansible-core.

Automation execution environment

Execution environment-29 will be deprecated in the next major release after Ansible Automation Platform 2.5.

Installer

The Ansible team is exploring ways to improve the installation of the Ansible Automation Platform on Red Hat Enterprise Linux, which may include changes to how components are deployed using RPM directly on the host OS. RPMs will be replaced by packages deployed into containers that are run via Podman; this is similar to how automation currently executes on Podman in containers (execution environments) on the host OS. Changes will be communicated through release notes, but removal will occur in major release versions of the Ansible Automation Platform.

3.1. Deprecated API endpoints

API endpoints that will be removed in a future release either because their functionality is being removed or superseded with other capabilities. For example, with the platform moving to a centralized authentication system in the platform gateway, the existing authorization APIs in the automation controller and automation hub are being deprecated for future releases as all authentication operations should occur in the platform gateway.

ComponentEndpointCapability

Automation controller

/api/o

Token authentication is moving to the platform gateway.

Automation hub

/api/login/keycloak

Moving to the platform gateway.

Automation hub

/api/v3/auth/token

Token authentication used for pulling collections will migrate to the platform gateway tokens.

Automation controller

/api/v2/organizations

Moving to the platform gateway.

Automation controller

/api/v2/teams

Moving to the platform gateway.

Automation controller

/api/v2/users

Moving to the platform gateway.

Automation controller

/api/v2/roles

Controller-specific role definitions are moving to /api/controller/v2/role_definitions.

Automation controller

The following roles lists:

  • /api/v2/teams/{id}/roles/
  • /api/v2/users/{id}/roles/

Controller-specific resource permissions are moving to /api/controller/v2/role_user_assignments and /api/controller/v2/role_team_assignments.

Automation controller

The following object roles lists:

  • /api/v2/credentials/{id}/object_roles/
  • /api/v2/instance_groups/{id}/object_roles/
  • /api/v2/inventories/{id}/object_roles/
  • /api/v2/job_templates/{id}/object_roles/
  • /api/v2/organizations/{id}/object_roles/
  • /api/v2/projects/{id}/object_roles/
  • /api/v2/teams/{id}/object_roles/
  • /api/v2/workflow_job_templates/{id}/object_roles/

Controller-specific resource permissions are moving to /api/controller/v2/role_user_assignments and /api/controller/v2/role_team_assignments.

Automation controller

The following resource access lists:

  • /api/v2/credentials/{id}/access_list/
  • /api/v2/instance_groups/{id}/access_list/
  • /api/v2/inventories/{id}/access_list/
  • /api/v2/job_templates/{id}/access_list/
  • /api/v2/organizations/{id}/access_list/
  • /api/v2/projects/{id}/access_list/
  • /api/v2/teams/{id}/access_list/
  • /api/v2/users/{id}/access_list/
  • /api/v2/workflow_job_templates/{id}/access_list/

No replacements yet.

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.