Rename package lists (and related vars) appropriately

In order to make it easier to differentiate between the lists of python packages, distribution packages, downloaded packages, package pins and other similar variables the variable names are being changed to ensure that they have a more explicit suffix that defines the purpose and makes the naming more consistent. This is to facilitate a lookup plugin which will be able to look up all the package lists and present them as a consolidated piece of data which may be used for artifact preparation. Change-Id: Ia9a7f3c237cc58d00c351a3393e5a723323b6890
2016-08-30 18:50:06 +01:00 · 2016-08-30 18:50:06 +01:00 · 2b8aa0703c
commit 2b8aa0703c
parent 4edb378b1e
9 changed files with 64 additions and 65 deletions
--- a/releasenotes/notes/os_keystone-centos7-support-0a5d97f81ac42e44.yaml
+++ b/releasenotes/notes/os_keystone-centos7-support-0a5d97f81ac42e44.yaml
@ -2,9 +2,3 @@
 features:
  - CentOS7/RHEL support has been added to the os_keystone
    role.
-deprecations:
-  - The following variables have been deprecated.
-    `keystone_developer_apt_packages`, `keystone_sp_apt_packages`,
-    `keystone_idp_apt_packages`, and `keystone_apt_packages`. While
-    these options are still available when deploying on Ubuntu
-    14.04, they will be removed during the Ocata cycle.
--- a/releasenotes/notes/package-list-name-changes-007cacee4faf8ee6.yaml
+++ b/releasenotes/notes/package-list-name-changes-007cacee4faf8ee6.yaml
@ -0,0 +1,10 @@
+---
+upgrade:
+  - The variable ``keystone_apt_packages`` has been renamed to
+    ``keystone_distro_packages``.
+  - The variable ``keystone_idp_apt_packages`` has been renamed to
+    ``keystone_idp_distro_packages``.
+  - The variable ``keystone_sp_apt_packages`` has been renamed to
+    ``keystone_sp_distro_packages``.
+  - The variable ``keystone_developer_apt_packages`` has been renamed to
+    ``keystone_developer_mode_distro_packages``.
--- a/tasks/keystone_idp_setup.yml
+++ b/tasks/keystone_idp_setup.yml
@ -14,19 +14,19 @@
 # limitations under the License.

 - include: keystone_idp_self_signed_create.yml
-  when: >
-    inventory_hostname == groups['keystone_all'][0]
+  when:
+    - inventory_hostname == groups['keystone_all'][0]

 - include: keystone_idp_self_signed_store.yml
-  when: >
-    inventory_hostname == groups['keystone_all'][0]
+  when:
+    - inventory_hostname == groups['keystone_all'][0]

 - include: keystone_idp_self_signed_distribute.yml
-  when: >
-    inventory_hostname != groups['keystone_all'][0]
+  when:
+    - inventory_hostname != groups['keystone_all'][0]

 - include: keystone_idp_metadata.yml

 - include: keystone_idp_sp_setup.yml
  when:
-    - keystone_service_setup | bool
+    - keystone_service_setup | bool
--- a/tasks/keystone_install_apt.yml
+++ b/tasks/keystone_install_apt.yml
@ -30,7 +30,7 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_packages }}"
+  with_items: "{{ keystone_distro_packages }}"

 - name: Install Apache apt packages
  apt:
@ -40,8 +40,9 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_apache_packages }}"
-  when: keystone_apache_mod_wsgi_enabled | bool
+  with_items: "{{ keystone_apache_distro_packages }}"
+  when:
+    - keystone_apache_mod_wsgi_enabled | bool

 - name: Install Nginx apt packages
  apt:
@ -51,8 +52,9 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_nginx_packages }}"
-  when: not keystone_apache_mod_wsgi_enabled | bool
+  with_items: "{{ keystone_nginx_distro_packages }}"
+  when:
+    - not keystone_apache_mod_wsgi_enabled | bool

 - name: Install IdP apt packages
  apt:
@ -62,7 +64,7 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_idp_packages }}"
+  with_items: "{{ keystone_idp_distro_packages }}"
  when:
    - keystone_apache_mod_wsgi_enabled | bool
    - keystone_idp != {}
@ -75,7 +77,7 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_sp_packages }}"
+  with_items: "{{ keystone_sp_distro_packages }}"
  when:
    - keystone_apache_mod_wsgi_enabled | bool
    - keystone_sp != {}
@ -88,6 +90,6 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_developer_packages }}"
+  with_items: "{{ keystone_developer_distro_packages }}"
  when:
    - keystone_developer_mode | bool
--- a/tasks/keystone_install_yum.yml
+++ b/tasks/keystone_install_yum.yml
@ -44,7 +44,7 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: keystone_packages
+  with_items: "{{ keystone_distro_packages }}"

 - name: Install Apache yum packages
  yum:
@ -54,8 +54,9 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_apache_packages }}"
-  when: keystone_apache_mod_wsgi_enabled | bool
+  with_items: "{{ keystone_apache_distro_packages }}"
+  when:
+    - keystone_apache_mod_wsgi_enabled | bool

 - name: Install Nginx yum packages
  yum:
@ -65,8 +66,9 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: "{{ keystone_nginx_packages }}"
-  when: not keystone_apache_mod_wsgi_enabled | bool
+  with_items: "{{ keystone_nginx_distro_packages }}"
+  when:
+    - not keystone_apache_mod_wsgi_enabled | bool

 - name: Install IdP yum packages
  yum:
@ -76,8 +78,9 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: keystone_idp_packages
-  when: keystone_idp is defined
+  with_items: "{{ keystone_idp_distro_packages }}"
+  when:
+    - keystone_idp is defined

 #TODO(cloudnull) Remove this task once we move to Ansible 2.1
 # where we can leverage the `yum_repository` module:
@ -99,7 +102,8 @@
  delay: 2
  with_items:
    - "{{ keystone_shibboleth_repo }}"
-  when: keystone_sp is defined
+  when:
+    - keystone_sp is defined

 - name: Install SP yum packages
  yum:
@ -109,8 +113,9 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: keystone_sp_packages
-  when: keystone_sp is defined
+  with_items: "{{ keystone_sp_distro_packages }}"
+  when:
+    - keystone_sp is defined

 - name: Install developer mode yum packages
  yum:
@ -120,6 +125,6 @@
  until: install_packages|success
  retries: 5
  delay: 2
-  with_items: keystone_developer_packages
+  with_items: "{{ keystone_developer_distro_packages }}"
  when:
    - keystone_developer_mode | bool
--- a/tasks/keystone_token_cleanup.yml
+++ b/tasks/keystone_token_cleanup.yml
@ -18,4 +18,4 @@
    name: "Clear out stale keystone tokens"
    minute: 0
    job: "{{ keystone_bin }}/keystone-manage token_flush"
-    user: "{{ keystone_system_user_name }}"
+    user: "{{ keystone_system_user_name }}"
--- a/vars/redhat-7.yml
+++ b/vars/redhat-7.yml
@ -21,7 +21,7 @@ keystone_shibboleth_repo:
  baseurl: "http://download.opensuse.org/repositories/security:/shibboleth/CentOS_7/"
  gpgkey: "http://download.opensuse.org/repositories/security:/shibboleth/CentOS_7//repodata/repomd.xml.key"

-keystone_packages:
+keystone_distro_packages:
  - ca-certificates
  - cronie
  - cronie-anacron
@ -38,20 +38,20 @@ keystone_packages:
  - python-devel
  - rsync

-keystone_apache_packages:
+keystone_apache_distro_packages:
  - httpd
  - httpd-tools

-keystone_nginx_packages:
+keystone_nginx_distro_packages:
  - nginx

-keystone_idp_packages:
+keystone_idp_distro_packages:
  - xmlsec1

-keystone_sp_packages:
+keystone_sp_distro_packages:
  - shibboleth

-keystone_developer_packages:
+keystone_developer_distro_packages:
  - '@Development Tools'

 keystone_apache_default_sites:
--- a/vars/ubuntu-14.04.yml
+++ b/vars/ubuntu-14.04.yml
@ -13,9 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-# Common apt packages
-# The old name has been deprecated, remove the variables with the deprecation filers and change the package variable names.
-_keystone_packages:
+keystone_distro_packages:
  - debhelper
  - dh-apparmor
  - docutils-common
@ -31,35 +29,24 @@ _keystone_packages:
  - python-dev
  - rsync

-keystone_packages: '{{ _keystone_packages | deprecated(keystone_apt_packages, "keystone_apt_packages", "keystone_packages", "ocata", keystone_fatal_deprecations) }}'
-
-keystone_apache_packages:
+keystone_apache_distro_packages:
  - apache2
  - apache2-utils
  - libapache2-mod-wsgi

-keystone_nginx_packages:
+keystone_nginx_distro_packages:
  - nginx-full

-# The old name has been deprecated, remove the variables with the deprecation filers and change the package variable names.
-_keystone_idp_packages:
+keystone_idp_distro_packages:
  - ssl-cert
  - xmlsec1

-keystone_idp_packages: '{{ _keystone_idp_packages | deprecated(keystone_idp_apt_packages, "keystone_idp_apt_packages", "keystone_idp_packages", "ocata", keystone_fatal_deprecations) }}'
-
-# The old name has been deprecated, remove the variables with the deprecation filers and change the package variable names.
-_keystone_sp_packages:
+keystone_sp_distro_packages:
  - libapache2-mod-shib2

-keystone_sp_packages: '{{ _keystone_sp_packages | deprecated(keystone_sp_apt_packages, "keystone_sp_apt_packages", "keystone_sp_packages", "ocata", keystone_fatal_deprecations) }}'
-
-# The old name has been deprecated, remove the variables with the deprecation filers and change the package variable names.
-_keystone_developer_packages:
+keystone_developer_distro_packages:
  - build-essential

-keystone_developer_packages: '{{ _keystone_developer_packages | deprecated(keystone_developer_apt_packages, "keystone_developer_apt_packages", "keystone_developer_packages", "ocata", keystone_fatal_deprecations) }}'
-
 keystone_apache_default_sites:
  - "/etc/apache2/sites-enabled/000-default.conf"

--- a/vars/ubuntu-16.04.yml
+++ b/vars/ubuntu-16.04.yml
@ -13,8 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-# Common apt packages
-keystone_packages:
+keystone_distro_packages:
  - debhelper
  - dh-apparmor
  - docutils-common
@ -30,30 +29,32 @@ keystone_packages:
  - python-dev
  - rsync

-keystone_apache_packages:
+keystone_apache_distro_packages:
  - apache2
  - apache2-utils
  - libapache2-mod-wsgi

-keystone_nginx_packages:
+keystone_nginx_distro_packages:
  - nginx-full

-keystone_idp_packages:
+keystone_idp_distro_packages:
  - ssl-cert
  - xmlsec1

-keystone_sp_packages:
+keystone_sp_distro_packages:
  - libapache2-mod-shib2

-keystone_developer_packages:
+keystone_developer_distro_packages:
  - build-essential

 keystone_apache_default_sites:
  - "/etc/apache2/sites-enabled/000-default.conf"
+
 keystone_apache_site_available: "/etc/apache2/sites-available/keystone-httpd.conf"
 keystone_apache_site_enabled: "/etc/apache2/sites-enabled/keystone-httpd.conf"
 keystone_apache_conf: "/etc/apache2/apache2.conf"
 keystone_apache_security_conf: "/etc/apache2/conf-available/security.conf"
+
 keystone_apache_configs:
  - { src: "keystone-ports.conf.j2", dest: "/etc/apache2/ports.conf" }
  - { src: "keystone-httpd.conf.j2", dest: "/etc/apache2/sites-available/keystone-httpd.conf" }