ansible-development-environ.../roles/reboot/robertdebock.reboot/README.md

144 lines
3.9 KiB
Markdown

reboot
=========
<img src="https://docs.ansible.com/ansible-tower/3.2.4/html_ja/installandreference/_static/images/logo_invert.png" width="10%" height="10%" alt="Ansible logo" align="right"/>
<a href="https://travis-ci.org/robertdebock/ansible-role-reboot"><img src="https://travis-ci.org/robertdebock/ansible-role-reboot.svg?branch=master" alt="Build status" align="left"/></a>
The purpose of this role is to reboot your system.
Example Playbook
----------------
This example is taken from `molecule/resources/playbook.yml`:
```yaml
---
- name: Converge
hosts: all
become: yes
gather_facts: yes
roles:
- robertdebock.reboot
```
The machine you are running this on, may need to be prepared.
```yaml
---
- name: Prepare
hosts: all
gather_facts: no
become: yes
roles:
- robertdebock.bootstrap
```
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
Role Variables
--------------
These variables are set in `defaults/main.yml`:
```yaml
---
# defaults file for reboot
# Some operating systems can determine if a reboot is required. This
# parameter can be set to always reboot.
reboot_always: no
# How long to wait before sending a reboot.
reboot_delay: 4
# Number of seconds to wait before checking if the machine is up.
reboot_up_delay: 8
# You can specify a message for rebooting, easier for auditing.
reboot_message: "Ansible role robertdebock.reboot initiated a reboot."
```
Requirements
------------
- Access to a repository containing packages, likely on the internet.
- A recent version of Ansible. (Tests run on the current, previous and next release of Ansible.)
The following roles can be installed to ensure all requirements are met, using `ansible-galaxy install -r requirements.yml`:
```yaml
---
- robertdebock.bootstrap
```
Context
-------
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
Here is an overview of related roles:
![dependencies](https://raw.githubusercontent.com/robertdebock/drawings/artifacts/reboot.png "Dependency")
Compatibility
-------------
This role has been tested against the following distributions and Ansible version:
|distribution|ansible 2.7|ansible 2.8|ansible devel|
|------------|-----------|-----------|-------------|
|alpine-edge*|yes|yes|yes*|
|alpine-latest|yes|yes|yes*|
|archlinux|no|yes|yes*|
|centos-6|yes|yes|yes*|
|centos-latest|yes|yes|yes*|
|debian-stable|yes|yes|yes*|
|debian-unstable*|yes|yes|yes*|
|fedora-latest|yes|yes|yes*|
|fedora-rawhide*|yes|yes|yes*|
|opensuse-leap|yes|yes|yes*|
|ubuntu-devel*|yes|yes|yes*|
|ubuntu-latest|yes|yes|yes*|
|ubuntu-rolling|yes|yes|yes*|
A single star means the build may fail, it's marked as an experimental build.
Exceptions
----------
Some variarations of the build matrix do not work. These are the variations and reasons why the build won't work:
| variation | reason |
|---------------------------|------------------------|
| Archlinux & Ansible 2.7 | New-style module did not handle its own exit |
Testing
-------
[Unit tests](https://travis-ci.org/robertdebock/ansible-role-reboot) are done on every commit and periodically.
If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-reboot/issues)
To test this role locally please use [Molecule](https://github.com/ansible/molecule):
```
pip install molecule
molecule test
```
To test on Amazon EC2, configure [~/.aws/credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) and set a region using `export AWS_REGION=eu-central-1` before running `molecule test --scenario-name ec2`.
There are many specific scenarios available, please have a look in the `molecule/` directory.
License
-------
Apache-2.0
Author Information
------------------
[Robert de Bock](https://robertdebock.nl/)