Deprecate foreman and katello modules (#42043)

* Deprecate foreman and katello modules in 2.8, remove in 2.12
pull/45861/head
Eric Helms 6 years ago committed by Alicia Cozine
parent bc69aeca7f
commit 74b94e119e

@ -67,10 +67,15 @@ Deprecation notices
The following modules will be removed in Ansible 2.12. Please update your playbooks accordingly. The following modules will be removed in Ansible 2.12. Please update your playbooks accordingly.
* ``foreman`` use <https://github.com/theforeman/foreman-ansible-modules> instead.
* ``katello`` use <https://github.com/theforeman/foreman-ansible-modules> instead.
Noteworthy module changes Noteworthy module changes
------------------------- -------------------------
* The ``foreman`` and ``katello`` modules have been deprecated in favor of a set of modules that are broken out per entity with better idempotency in mind.
* The ``foreman`` and ``katello`` modules replacement is officially part of the Foreman Community and supported there.
* The ``tower_credential`` module originally required the ``ssh_key_data`` to be the path to a ssh_key_file. * The ``tower_credential`` module originally required the ``ssh_key_data`` to be the path to a ssh_key_file.
In order to work like Tower/AWX, ``ssh_key_data`` now contains the content of the file. In order to work like Tower/AWX, ``ssh_key_data`` now contains the content of the file.
The previous behavior can be achieved with ``lookup('file', '/path/to/file')``. The previous behavior can be achieved with ``lookup('file', '/path/to/file')``.

@ -8,13 +8,17 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'], 'status': ['deprecated'],
'supported_by': 'community'} 'supported_by': 'community'}
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: foreman module: foreman
short_description: Manage Foreman Resources short_description: Manage Foreman Resources
deprecated:
removed_in: "2.12"
why: "Replaced by re-designed individual modules living at https://github.com/theforeman/foreman-ansible-modules"
alternative: https://github.com/theforeman/foreman-ansible-modules
description: description:
- Allows the management of Foreman resources inside your Foreman server. - Allows the management of Foreman resources inside your Foreman server.
version_added: "2.3" version_added: "2.3"
@ -33,6 +37,11 @@ options:
description: description:
- Username on Foreman server. - Username on Foreman server.
required: true required: true
verify_ssl:
description:
- Whether to verify an SSL connection to Foreman server.
type: bool
default: False
password: password:
description: description:
- Password for user accessing Foreman server. - Password for user accessing Foreman server.

@ -8,13 +8,17 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'], 'status': ['deprecated'],
'supported_by': 'community'} 'supported_by': 'community'}
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: katello module: katello
short_description: Manage Katello Resources short_description: Manage Katello Resources
deprecated:
removed_in: "2.12"
why: "Replaced by re-designed individual modules living at https://github.com/theforeman/foreman-ansible-modules"
alternative: https://github.com/theforeman/foreman-ansible-modules
description: description:
- Allows the management of Katello resources inside your Foreman server. - Allows the management of Katello resources inside your Foreman server.
version_added: "2.3" version_added: "2.3"

@ -51,8 +51,8 @@ lib/ansible/modules/network/nxos/nxos_snapshot.py ansible-format-automatic-speci
lib/ansible/modules/network/vyos/vyos_vlan.py ansible-format-automatic-specification lib/ansible/modules/network/vyos/vyos_vlan.py ansible-format-automatic-specification
lib/ansible/modules/notification/cisco_spark.py ansible-format-automatic-specification lib/ansible/modules/notification/cisco_spark.py ansible-format-automatic-specification
lib/ansible/modules/notification/logentries_msg.py ansible-format-automatic-specification lib/ansible/modules/notification/logentries_msg.py ansible-format-automatic-specification
lib/ansible/modules/remote_management/foreman/foreman.py ansible-format-automatic-specification lib/ansible/modules/remote_management/foreman/_foreman.py ansible-format-automatic-specification
lib/ansible/modules/remote_management/foreman/katello.py ansible-format-automatic-specification lib/ansible/modules/remote_management/foreman/_katello.py ansible-format-automatic-specification
lib/ansible/modules/source_control/github_deploy_key.py ansible-format-automatic-specification lib/ansible/modules/source_control/github_deploy_key.py ansible-format-automatic-specification
lib/ansible/modules/source_control/github_key.py ansible-format-automatic-specification lib/ansible/modules/source_control/github_key.py ansible-format-automatic-specification
lib/ansible/modules/storage/infinidat/infini_export.py ansible-format-automatic-specification lib/ansible/modules/storage/infinidat/infini_export.py ansible-format-automatic-specification

Loading…
Cancel
Save