Initial commit

This commit is contained in:
Alex Schultz 2018-07-31 17:17:51 -06:00
commit f3352cd634
30 changed files with 743 additions and 0 deletions

71
.gitignore vendored Normal file
View File

@ -0,0 +1,71 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
# C extensions
*.so
# Distribution / packaging
.Python
env/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
sdist/
var/
container_registry.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
# Translations
*.mo
*.pot
# Django stuff:
*.log
# Sphinx documentation
doc/build/
# PyBuilder
target/
# virtualenv
.venv/
# jenkins config
jenkins/config.ini
playbooks/debug.yml
# Files created by releasenotes build
releasenotes/build
# Editors
.*.sw[klmnop]
# ansible retry files
*.retry

4
.gitreview Normal file
View File

@ -0,0 +1,4 @@
[gerrit]
host=review.openstack.org
port=29418
project=openstack/ansible-role-tripleo-chrony.git

176
LICENSE Normal file
View File

@ -0,0 +1,176 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

114
README.rst Normal file
View File

@ -0,0 +1,114 @@
chrony
======
A role to manage chrony
Role Variables
--------------
.. list-table:: Variables used for chrony
:widths: auto
:header-rows: 1
* - Name
- Default Value
- Description
* - `chrony_debug`
- `False`
- Enable debug option in chrony
* - `chrony_role_action`
- `all`
- Ansible action when including the role. Should be one of: [all|install|config|upgrade]
* - `chrony_package_name`
- `chrony`
- chrony system package name
* - `chrony_service_name`
- `chronyd`
- chrony system service name
* - `chrony_manage_service`
- `True`
- Flag used to specific if the ansible role should manage the service
* - `chrony_manage_package`
- `True`
- Flag used to specific if the ansible role should manage the package
* - `chrony_service_state`
- `started`
- Default service state to configure (started|stopped)
* - `chrony_config_file_location`
- `/etc/chrony.conf`
- Chrony configuration file location.
* - `chrony_driftfile_path`
- `/var/lib/chrony/drift`
- Chrony drift file location
* - `chrony_logdir_path`
- `/var/log/chrony`
- Chrony log directory location
* - `chrony_ntp_servers`
- `[]`
- List of NTP servers. This can be a list of hashes for advanced configuration.
If using the hash format, a `server_name` and `server_settings` key should be populated with
the appropriate data. If this is a list of hostnames, the `chrony_global_server_settings`
will be appended to the configuration.
* - `chrony_global_server_settings`
- ''
- Default setting to apply to the servers configuration
* - `chrony_ntp_pools`
- `[]`
- List of NTP pools. This can be a list of hashes for advanced configuration.
If using the hash format, a `pool_name` and `pool_settings` key should be populated with
the appropriate data. If this is a list of hostnames, the `chrony_global_pool_settings`
will be appended to the configuration.
* - `chrony_global_pool_settings`
- ''
- Default setting to apply to the pools configuration
* - `chrony_ntp_peers`
- `[]`
- List of NTP peers. This can be a list of hashes for advanced configuration.
If using the hash format, a `peer_name` and `peer_settings` key should be populated with
the appropriate data. If this is a list of hostnames, the `chrony_global_peer_settings`
will be appended to the configuration.
* - `chrony_global_peer_settings`
- ''
- Default setting to apply to the peers configuration
* - `chrony_bind_addresses`
- `['127.0.0.1', '::1']`
- List of addresses to bind to to listen for command packets
* - `chrony_acl_rules`
- `[]`
- List of specific allow/deny commands for the configuration file
* - `chrony_rtc_settings`
- `['rtcsync']`
- List of specific real time lock settings
* - `chrony_makestep`
- `1.0 3`
- The chrony makestep configuration
* - `chrony_extra_options`
- `[]`
- A list of extra option strings that is added to the end of the configuraiton file. This list is joined with new lines.
Requirements
------------
- ansible >= 2.4
- python >= 2.6
Dependencies
------------
None
Example Playbooks
-----------------
.. code-block::
- hosts: localhost
become: true
roles:
- chrony
License
-------
Apache 2.0

6
ansible-requirements.txt Normal file
View File

@ -0,0 +1,6 @@
# These are required here because ansible can't be in global-requirements due
# to licensing conflicts. But we sill need to be able to pull them in for
# lint checks and want to document these as ansible specific things that may
# be required for this repository.
ansible
ansible-lint

12
ansible.cfg Normal file
View File

@ -0,0 +1,12 @@
[defaults]
gathering = smart
command_warnings = False
retry_files_enabled = False
callback_whitelist = profile_tasks
# Attempt to load custom modules whether it's installed system-wide or from a virtual environment
roles_path = roles:$VIRTUAL_ENV/usr/share/ansible/roles/chrony:$VIRTUAL_ENV/usr/local/share/
[ssh_connection]
control_path = %(directory)s/%%C

View File

@ -0,0 +1,21 @@
#!/bin/bash
# ANSIBLE0006: Using command rather than module
# we have a few use cases where we need to use curl and rsync
# ANSIBLE0007: Using command rather than an argument to e.g file
# we have a lot of 'rm' command and we should use file module instead
# ANSIBLE0010: Package installs should not use latest.
# Sometimes we need to update some packages.
# ANSIBLE0012: Commands should not change things if nothing needs doing
# ANSIBLE0013: Use Shell only when shell functionality is required
# ANSIBLE0016: Tasks that run when changed should likely be handlers
# this requires refactoring roles, skipping for now
SKIPLIST="ANSIBLE0006,ANSIBLE0007,ANSIBLE0010,ANSIBLE0012,ANSIBLE0013,ANSIBLE0016"
# Lin the role.
ansible-lint -vvv -x $SKIPLIST ./ || lint_error=1
# exit with 1 if we had a least an error or warning.
if [[ -n "$lint_error" ]]; then
exit 1;
fi

15
defaults/main.yml Normal file
View File

@ -0,0 +1,15 @@
---
chrony_debug: False
chrony_role_action: install
chrony_ntp_servers: []
chrony_ntp_pools: []
chrony_ntp_peers: []
chrony_bind_addresses:
- 127.0.0.1
- ::1
chrony_acl_rules: []
chrony_service_name: chronyd
chrony_manage_service: True
chrony_manage_package: True
chrony_service_state: started
chrony_extra_options: []

6
handlers/main.yml Normal file
View File

@ -0,0 +1,6 @@
---
- name: Restart chronyd
service:
name: "{{ chrony_service_name }}"
state: restarted
when: chrony_manage_service|bool

7
install.yml Normal file
View File

@ -0,0 +1,7 @@
---
- hosts: undercloud
gather_facts: true
become: true
tasks:
- include_role:
name: tripleo-chrony

17
meta/main.yml Normal file
View File

@ -0,0 +1,17 @@
galaxy_info:
author: OpenStack
description: chrony role
company: Red Hat
license: Apache 2.0
min_ansible_version: 2.4
platforms:
- name: EL
versions:
- 7
galaxy_tags:
- openstack
- tripleo
dependencies: []

2
requirements.txt Normal file
View File

@ -0,0 +1,2 @@
pbr>=1.6
ansible

35
setup.cfg Normal file
View File

@ -0,0 +1,35 @@
[metadata]
name = ansible-role-chrony
summary = ansible-role-chrony - Ansible chrony role
description-file =
README.rst
author = TripleO Team
author-email = openstack-dev@lists.openstack.org
home-page = https://git.openstack.org/cgit/openstack/ansible-role-chrony
classifier =
License :: OSI Approved :: Apache Software License
Development Status :: 4 - Beta
Intended Audience :: Developers
Intended Audience :: System Administrators
Intended Audience :: Information Technology
Topic :: Utilities
[global]
setup-hooks =
pbr.hooks.setup_hook
[files]
data_files =
share/ansible/roles/chrony/defaults = defaults/*
share/ansible/roles/chrony/meta = meta/*
share/ansible/roles/chrony/tasks = tasks/*
share/ansible/roles/chrony/templates = templates/*
share/ansible/roles/chrony/files = files/*
[wheel]
universal = 1
[pbr]
skip_authors = True
skip_changelog = True

19
setup.py Normal file
View File

@ -0,0 +1,19 @@
# Copyright Red Hat, Inc. All Rights Reserved.
#
# 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.
import setuptools
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

15
tasks/config.yml Normal file
View File

@ -0,0 +1,15 @@
---
- name: Install chrony configuration file
template:
src: chrony.conf.j2
dest: "{{ chrony_config_file_location }}"
owner: root
group: root
mode: 0644
notify: Restart chronyd
- name: Ensure chronyd is running
service:
name: "{{ chrony_service_name }}"
state: "{{ chrony_service_state|default('started') }}"
when: chrony_manage_service|bool

6
tasks/install.yml Normal file
View File

@ -0,0 +1,6 @@
---
- name: Install chronyd package
package:
name: "{{ chrony_package_name }}"
state: present
when: chrony_manage_package|bool

19
tasks/main.yml Normal file
View File

@ -0,0 +1,19 @@
---
- name: Load distro-specific variables
include_vars: "{{ item }}"
with_first_found:
- "{{ ansible_distribution }}.yml"
- "{{ ansible_os_family }}.yml"
- default.yml
- name: Install chronyd
include_tasks: install.yml
when: chrony_role_action in ['all', 'install']
- name: Upgrade chronyd
include_tasks: upgrade.yml
when: chrony_role_action in ['upgrade']
- name: Configure chronyd
include_tasks: config.yml
when: chrony_role_action in ['all', 'config']

7
tasks/upgrade.yml Normal file
View File

@ -0,0 +1,7 @@
---
- name: Upgrade chronyd package
package:
name: chronyd
statue: latest
when: chrony_manage_package|bool
notify: Restart chronyd

63
templates/chrony.conf.j2 Normal file
View File

@ -0,0 +1,63 @@
# Do not manually edit this file.
# Managed by ansible-role-chrony
{% for server in chrony_ntp_servers -%}
{% if server is mapping %}
server {{ server.server_host }} {{ server.server_settings }}
{% else %}
server {{ server }} {{ chrony_global_server_settings|default('') }}
{% endif %}
{% endfor -%}
{% for pool in chrony_ntp_pools -%}
{% if pool is mapping %}
pool {{ pool.pool_host }} {{ pool.pool_settings }}
{% else %}
pool {{ pool }} {{ chrony_global_pool_settings|default('') }}
{% endif %}
{% endfor -%}
{% for peer in chrony_ntp_peers -%}
{% if peer is mapping %}
peer {{ peer.peer_host }} {{ peer.peer_settings }}
{% else %}
peer {{ peer }} {{ chrony_global_peer_settings|default('') }}
{% endif %}
{% endfor -%}
{% if chrony_bind_addresses is defined and chrony_bind_addresses|length > 0 -%}
{% for bind_addr in chrony_bind_addresses %}
bindcmdaddress {{ bind_addr }}
{% endfor %}
{% endif -%}
{% if chrony_acl_rules is defined and chrony_acl_rules|length > 0 -%}
{{ chrony_acl_rules|join("\n") }}
{% endif -%}
{% if chrony_keyfile_path is defined -%}
keyfile {{ chrony_keyfile_path }}
{% endif -%}
{% if chrony_driftfile_path is defined -%}
driftfile {{ chrony_driftfile_path }}
{% endif -%}
{% if chrony_logdir_path is defined -%}
logdir {{ chrony_logdir_path }}
{% endif -%}
{% if chrony_rtc_settings is defined -%}
{{ chrony_rtc_settings|join("\n") }}
{% endif -%}
{% if chrony_log_options is defined -%}
log {{ chrony_log_options }}
{% endif -%}
{% if chrony_makestep is defined -%}
makestep {{ chrony_makestep }}
{% endif -%}
{% if chrony_extra_options -%}
{{ chrony_extra_options|join("\n") }}
{% endif -%}

2
test-requirements.txt Normal file
View File

@ -0,0 +1,2 @@
docutils
hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0

8
tests/all.yml Normal file
View File

@ -0,0 +1,8 @@
---
- hosts: all
gather_facts: true
become: true
vars:
chrony_role_action: all
roles:
- chrony

8
tests/config.yml Normal file
View File

@ -0,0 +1,8 @@
---
- hosts: all
gather_facts: true
become: true
vars:
chrony_role_action: config
roles:
- chrony

8
tests/install.yml Normal file
View File

@ -0,0 +1,8 @@
---
- hosts: all
gather_facts: true
become: true
vars:
chrony_role_action: install
roles:
- chrony

3
tests/inventory.yml Normal file
View File

@ -0,0 +1,3 @@
all:
hosts:
localhost

1
tests/roles/chrony Symbolic link
View File

@ -0,0 +1 @@
../../

8
tests/upgrade.yml Normal file
View File

@ -0,0 +1,8 @@
---
- hosts: all
gather_facts: true
become: true
vars:
chrony_role_action: upgrade
roles:
- chrony

62
tox.ini Normal file
View File

@ -0,0 +1,62 @@
[tox]
minversion = 1.6
envlist = docs, linters
skipdist = True
[testenv]
usedevelop = True
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
setenv = VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/test-requirements.txt
whitelist_externals = bash
[testenv:bindep]
# Do not install any requirements. We want this to be fast and work even if
# system dependencies are missing, since it's used to tell you what system
# dependencies are missing! This also means that bindep must be installed
# separately, outside of the requirements files.
deps = bindep
commands = bindep test
[testenv:pep8]
commands =
# Check the readme for python release
python setup.py check --strict -r
# Run hacking/flake8 check for all python files
bash -c "git ls-files | grep -v releasenotes | xargs grep --binary-files=without-match \
--files-with-match '^.!.*python$' \
--exclude-dir .tox \
--exclude-dir .git \
--exclude-dir .eggs \
--exclude-dir *.egg-info \
--exclude-dir dist \
--exclude-dir *lib/python* \
--exclude-dir doc \
| xargs flake8 --verbose"
[testenv:ansible-lint]
basepython=python2
commands =
bash ci-scripts/ansible-lint.sh
[testenv:linters]
deps =
-r{toxinidir}/test-requirements.txt
-r{toxinidir}/ansible-requirements.txt
commands =
{[testenv:pep8]commands}
{[testenv:ansible-lint]commands}
[testenv:releasenotes]
whitelist_externals = bash
commands = bash -c ci-scripts/releasenotes_tox.sh
[testenv:venv]
commands = {posargs}
[flake8]
# E123, E125 skipped as they are invalid PEP-8.
# E265 deals with spaces inside of comments
show-source = True
ignore = E123,E125,E265
builtins = _

15
vars/RedHat.yml Normal file
View File

@ -0,0 +1,15 @@
---
chrony_package_name: chrony
chrony_service_name: chronyd
chrony_ntp_servers:
- 0.rhel.pool.ntp.org
- 1.rhel.pool.ntp.org
- 2.rhel.pool.ntp.org
- 3.rhel.pool.ntp.org
chrony_global_server_settings: iburst
chrony_config_file_location: /etc/chrony.conf
chrony_driftfile_path: /var/lib/chrony/drift
chrony_logdir_path: /var/log/chrony
chrony_makestep: 1.0 3
chrony_rtc_settings:
- rtcsync

1
vars/default.yml Normal file
View File

@ -0,0 +1 @@
---

12
zuul.d/layout.yaml Normal file
View File

@ -0,0 +1,12 @@
- project:
templates:
- publish-to-pypi
check:
jobs:
- openstack-tox-linters
gate:
jobs:
- openstack-tox-linters
post:
jobs:
- publish-openstack-python-branch-tarball