From fbf7ab1c4a710ee223aa862dba9200c80f4a4994 Mon Sep 17 00:00:00 2001 From: Kevin Carter Date: Thu, 8 Mar 2018 16:57:04 -0600 Subject: [PATCH] Convert role to use a common systemd service role This removes the systemd service templates and tasks from this role and leverages a common systemd service role instead. This change removes a lot of code duplication across all roles all without sacrificing features or functionality. The intention of this change is to ensure uniformity and reduce the maintenance burden on the community when sweeping changes are needed. In converting this role to use the common systemd_service role a keystone_service dictionary was created in the defaults main.yml file. This change follows the pattern of other services. Change-Id: I65902f2483ef2f18ac2d229c5ebd9d090b6ae040 Signed-off-by: Kevin Carter --- defaults/main.yml | 18 ++++++-- handlers/main.yml | 4 +- tasks/keystone_db_setup.yml | 2 +- tasks/keystone_init_systemd.yml | 59 ------------------------ tasks/keystone_install.yml | 2 +- tasks/keystone_nginx.yml | 4 +- tasks/keystone_uwsgi.yml | 28 ++++++++++- templates/keystone-systemd-tempfiles.j2 | 6 --- templates/keystone-uwsgi_systemd-init.j2 | 34 -------------- tests/ansible-role-requirements.yml | 4 ++ 10 files changed, 49 insertions(+), 112 deletions(-) delete mode 100644 tasks/keystone_init_systemd.yml delete mode 100644 templates/keystone-systemd-tempfiles.j2 delete mode 100644 templates/keystone-uwsgi_systemd-init.j2 diff --git a/defaults/main.yml b/defaults/main.yml index e417928c..2283e6a2 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -201,11 +201,7 @@ keystone_wsgi_threads: 1 ## Cap the maximun number of processes when a user value is unspecified. keystone_wsgi_processes_max: 16 keystone_wsgi_processes: "{{ [[ansible_processor_vcpus|default(1), 1] | max * 2, keystone_wsgi_processes_max] | min }}" -keystone_wsgi_public_program_name: keystone-wsgi-public -keystone_wsgi_admin_program_name: keystone-wsgi-admin -keystone_wsgi_program_names: - - "{{ keystone_wsgi_public_program_name }}" - - "{{ keystone_wsgi_admin_program_name }}" + keystone_uwsgi_ports: keystone-wsgi-public: http: 37358 @@ -213,6 +209,7 @@ keystone_uwsgi_ports: keystone-wsgi-admin: http: 37359 socket: 5001 + keystone_uwsgi_ini_overrides: {} # set keystone_ssl to true to enable SSL configuration on the keystone containers @@ -465,6 +462,17 @@ keystone_required_secrets: keystone_uwsgi_init_overrides: {} +## Service Name-Group Mapping +keystone_services: + keystone-wsgi-public: + service_name: "keystone-wsgi-public" + init_config_overrides: "{{ keystone_uwsgi_init_overrides }}" + execstarts: "{{ keystone_bin }}/uwsgi --ini /etc/uwsgi/keystone-wsgi-public.ini" + keystone-wsgi-admin: + service_name: "keystone-wsgi-admin" + init_config_overrides: "{{ keystone_uwsgi_init_overrides }}" + execstarts: "{{ keystone_bin }}/uwsgi --ini /etc/uwsgi/keystone-wsgi-admin.ini" + ## Extra HTTP headers for Keystone # Add any additional headers here that Keystone should return. # diff --git a/handlers/main.yml b/handlers/main.yml index 5c0e9b1e..872a3b5c 100644 --- a/handlers/main.yml +++ b/handlers/main.yml @@ -46,7 +46,7 @@ until: _stop | success retries: 5 delay: 2 - with_items: "{{ keystone_wsgi_program_names }}" + with_items: "{{ keystone_services.keys() | list }}" listen: "Restart uWSGI" # Note (odyssey4me): @@ -77,7 +77,7 @@ until: _start | success retries: 5 delay: 2 - with_items: "{{ keystone_wsgi_program_names }}" + with_items: "{{ keystone_services.keys() | list }}" listen: "Restart uWSGI" - name: Wait for uWSGI socket to be ready diff --git a/tasks/keystone_db_setup.yml b/tasks/keystone_db_setup.yml index 9b2235be..8d655642 100644 --- a/tasks/keystone_db_setup.yml +++ b/tasks/keystone_db_setup.yml @@ -50,7 +50,7 @@ name: "{{ item }}" check_mode: yes register: keystone_service_exists - with_items: "{{ keystone_wsgi_program_names }}" + with_items: "{{ keystone_services.keys() | list }}" - name: Ensure keystone service is stopped service: diff --git a/tasks/keystone_init_systemd.yml b/tasks/keystone_init_systemd.yml deleted file mode 100644 index 3d9c8ec9..00000000 --- a/tasks/keystone_init_systemd.yml +++ /dev/null @@ -1,59 +0,0 @@ ---- -# Copyright 2016, Rackspace US, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -- name: Create TEMP run dir - file: - path: "/var/run/{{ item }}" - state: directory - owner: "{{ keystone_system_user_name }}" - group: "{{ keystone_system_group_name }}" - mode: "02755" - with_items: "{{ keystone_wsgi_program_names }}" - -- name: Create TEMP lock dir - file: - path: "/var/lock/{{ item }}" - state: directory - owner: "{{ keystone_system_user_name }}" - group: "{{ keystone_system_group_name }}" - mode: "02755" - with_items: "{{ keystone_wsgi_program_names }}" - -- name: Create tempfile.d entry - template: - src: "keystone-systemd-tempfiles.j2" - dest: "/etc/tmpfiles.d/keystone.conf" - mode: "0644" - owner: "root" - group: "root" - notify: - - Manage LB - - Restart uWSGI - - Restart web server - -- name: Place the systemd init script - config_template: - src: "keystone-uwsgi_systemd-init.j2" - dest: "/etc/systemd/system/{{ item }}.service" - mode: "0644" - owner: "root" - group: "root" - config_overrides: "{{ keystone_uwsgi_init_overrides }}" - config_type: "ini" - with_items: "{{ keystone_wsgi_program_names }}" - notify: - - Manage LB - - Restart uWSGI - - Restart web server diff --git a/tasks/keystone_install.yml b/tasks/keystone_install.yml index bb6e9375..5ba36750 100644 --- a/tasks/keystone_install.yml +++ b/tasks/keystone_install.yml @@ -58,7 +58,7 @@ name: "{{ (keystone_web_server == 'nginx') | ternary(keystone_system_service_name, 'nginx') }}" enabled: no state: stopped - daemon_reload: "{{ (ansible_service_mgr == 'systemd') | ternary('yes', omit) }}" + daemon_reload: "yes" failed_when: false - name: Remove other web server distro packages and mod_wsgi diff --git a/tasks/keystone_nginx.yml b/tasks/keystone_nginx.yml index cb5dc63a..1df89e65 100644 --- a/tasks/keystone_nginx.yml +++ b/tasks/keystone_nginx.yml @@ -48,7 +48,7 @@ template: src: keystone_nginx.conf.j2 dest: "/etc/nginx/{{ keystone_nginx_conf_path }}/{{ item }}.conf" - with_items: "{{ keystone_wsgi_program_names }}" + with_items: "{{ keystone_services.keys() | list }}" notify: - Manage LB - Restart web server @@ -58,7 +58,7 @@ src: "/etc/nginx/sites-available/{{ item }}.conf" path: "/etc/nginx/sites-enabled/{{ item }}.conf" state: link - with_items: "{{ keystone_wsgi_program_names }}" + with_items: "{{ keystone_services.keys() | list }}" when: ansible_os_family == "Debian" notify: - Manage LB diff --git a/tasks/keystone_uwsgi.yml b/tasks/keystone_uwsgi.yml index e961d9a1..81523bdc 100644 --- a/tasks/keystone_uwsgi.yml +++ b/tasks/keystone_uwsgi.yml @@ -25,9 +25,33 @@ mode: "0744" config_overrides: "{{ keystone_uwsgi_ini_overrides }}" config_type: ini - with_items: "{{ keystone_wsgi_program_names }}" + with_items: "{{ keystone_services.keys() | list }}" notify: - Manage LB - Restart uWSGI -- include_tasks: "keystone_init_{{ ansible_service_mgr }}.yml" +- name: Run the systemd service role + include_role: + name: systemd_service + private: true + vars: + systemd_user_name: "{{ keystone_system_user_name }}" + systemd_group_name: "{{ keystone_system_group_name }}" + systemd_tempd_prefix: openstack + systemd_slice_name: keystone + system_lock_path: /var/lock/keystone + systemd_CPUAccounting: true + systemd_BlockIOAccounting: true + systemd_MemoryAccounting: true + systemd_TasksAccounting: true + systemd_services: + - service_name: "{{ service_var.service_name }}" + enabled: yes + state: started + execstarts: "{{ service_var.execstarts }}" + config_overrides: "{{ service_var.init_config_overrides }}" + with_items: "{{ keystone_services.values() | list }}" + loop_control: + loop_var: service_var + tags: + - keystone-config diff --git a/templates/keystone-systemd-tempfiles.j2 b/templates/keystone-systemd-tempfiles.j2 deleted file mode 100644 index 9df02a36..00000000 --- a/templates/keystone-systemd-tempfiles.j2 +++ /dev/null @@ -1,6 +0,0 @@ -# {{ ansible_managed }} - -{% for program_name in keystone_wsgi_program_names %} -D /var/lock/{{ program_name }} 2755 {{ keystone_system_user_name }} {{ keystone_system_group_name }} -D /var/run/{{ program_name }} 2755 {{ keystone_system_user_name }} {{ keystone_system_group_name }} -{% endfor %} diff --git a/templates/keystone-uwsgi_systemd-init.j2 b/templates/keystone-uwsgi_systemd-init.j2 deleted file mode 100644 index cb021d96..00000000 --- a/templates/keystone-uwsgi_systemd-init.j2 +++ /dev/null @@ -1,34 +0,0 @@ -# {{ ansible_managed }} - -[Unit] -Description=OpenStack Keystone service -After=syslog.target -After=network.target - -[Service] -Type=simple -User={{ keystone_system_user_name }} -Group={{ keystone_system_group_name }} - -{% if program_override is defined %} -ExecStart={{ program_override }} --ini /etc/uwsgi/{{ item }}.ini --logto /var/log/keystone/{{ item }}.log {{ program_config_options|default('') }} -{% else %} -ExecStart={{ keystone_bin }}/uwsgi --ini /etc/uwsgi/{{ item }}.ini --logto /var/log/keystone/{{ item }}.log {{ program_config_options|default('') }} -{% endif %} - -# Give a reasonable amount of time for the server to start up/shut down -TimeoutSec=120 -Restart=on-failure -RestartSec=2 - -# This creates a specific slice which all services will operate from -# The accounting options give us the ability to see resource usage through -# the `systemd-cgtop` command. -Slice=keystone.slice -CPUAccounting=true -BlockIOAccounting=true -MemoryAccounting=false -TasksAccounting=true - -[Install] -WantedBy=multi-user.target diff --git a/tests/ansible-role-requirements.yml b/tests/ansible-role-requirements.yml index 31666fb0..47824584 100644 --- a/tests/ansible-role-requirements.yml +++ b/tests/ansible-role-requirements.yml @@ -54,3 +54,7 @@ src: https://git.openstack.org/openstack/ansible-role-python_venv_build scm: git version: master +- name: systemd_service + src: https://github.com/openstack/ansible-role-systemd_service + scm: git + version: master