Add retirement warnings to security role

This patch adds deprecation/retirement warnings to the documentation,
README files, and the role itself.

Change-Id: I419ee0d3bcd3a772f6864acd3d07b062bf6cd7c5
(cherry picked from commit b97de6d748)

README.md

@@ -1,6 +1,14 @@
 openstack-ansible-security
 ==========================
 
+**DEPRECATION NOTICE:** The openstack-ansible-security role is deprecated and
+will be retired soon. Consumers of this role should use the
+[ansible-hardening](https://github.com/openstack/ansible-hardening) role
+instead.
+
+Overview
+--------
+
 The openstack-ansible security role applies security hardening configurations
 from the [Security Technical Implementation Guide(STIG)](http://iase.disa.mil/stigs/Pages/index.aspx)
 to systems running Ubuntu 14.04, Ubuntu 16.04, CentOS 7, and Red Hat

README.rst

@@ -10,6 +10,11 @@ Team and repository tags
 Security hardening for OpenStack-Ansible
 ----------------------------------------
 
+**DEPRECATION NOTICE:** The openstack-ansible-security role is deprecated and
+will be retired soon. Consumers of this role should use the
+`ansible-hardening <https://github.com/openstack/ansible-hardening>`_ role
+instead.
+
 Documentation for openstack-ansible-security is available in the `official
 OpenStack documentation site`_.
 

doc/source/index.rst

@@ -2,6 +2,13 @@
 Automated security hardening for Linux hosts
 ============================================
 
+.. warning::
+
+    The openstack-ansible-security role is deprecated and will be retired soon.
+    Consumers of this role should begin consuming the
+    `ansible-hardening <https://github.com/openstack/ansible-hardening>`_
+    role to receive the latest updates.
+
 The openstack-ansible-security Ansible role uses industry-standard security
 hardening guides to secure Linux hosts. Although the role is designed to work
 well in OpenStack environments that are deployed with OpenStack-Ansible, it can

tasks/main.yml

@@ -13,6 +13,41 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+  - name: Print warning about role deprecation
+    debug:
+      msg: |
+        *********************************************************************
+         ____                                _           _
+        |  _ \  ___ _ __  _ __ ___  ___ __ _| |_ ___  __| |
+        | | | |/ _ \ '_ \| '__/ _ \/ __/ _` | __/ _ \/ _` |
+        | |_| |  __/ |_) | | |  __/ (_| (_| | ||  __/ (_| |
+        |____/ \___| .__/|_|  \___|\___\__,_|\__\___|\__,_|
+                   |_|
+        *********************************************************************
+
+        The openstack-ansible-security role is deprecated and will be retired
+        soon. Please consume the ansible-hardening role to receive the latest
+        updates:
+
+           https://github.com/openstack/ansible-hardening
+
+        *********************************************************************
+         ____                                _           _
+        |  _ \  ___ _ __  _ __ ___  ___ __ _| |_ ___  __| |
+        | | | |/ _ \ '_ \| '__/ _ \/ __/ _` | __/ _ \/ _` |
+        | |_| |  __/ |_) | | |  __/ (_| (_| | ||  __/ (_| |
+        |____/ \___| .__/|_|  \___|\___\__,_|\__\___|\__,_|
+                   |_|
+        *********************************************************************
+    tags:
+      - always
+
+  - name: Pause the playbook run to highlight the deprecation warning
+    pause:
+      seconds: 30
+    tags:
+      - always
+
   - name: Gather variables for each operating system
     include_vars: "{{ item }}"
     with_first_found: