ansible-role-prompt

KO | EN

gitlite — search

#python #ai #go #android #machine-learning #rust #linux #cli #vue #pytorch #security #mcp #ios #open-source

ansible-role-prompt

(★ 12)

Ansible plugin for messaging and prompting the user during a playbook.

ansible-role-prompt 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Prompt

[![Version][version-image]][github-release]
[![License][license-image]][github-license]
[![Build Status][build-image]][travis-detail]
[![Coverage][coverage-image]][coveralls-detail]

This [Ansible][ansible] module provides support to display simple messages to the user running a Playbook.  This
provides a cleaner way to present messages to the user than with the built-in [debug][ansible-debug] task.
Optionally, the message can also be treated as a prompt to await user feedback.  The response for these prompts can
be registered as Ansible variables.

## Installation

This plugin is made available in [Ansible Galaxy](https://galaxy.ansible.com/).  Once Ansible Galaxy is installed, you
may install this plugin with the following command:

```bash
ansible-galaxy install andrewvaughan.prompt
```

To use this plugin, simply add the role to your playbook file with the following addition:

```yml
roles:
- andrewvaughan.prompt
```

Once completed, you may use the entire plugin as described in the [Usage Guidelines](#usage)

### Manual Installation

To add this plugin to your project, simply copy the `/action_plugins/prompt.py` file to a folder named
`action_plugins` in your playbook root directory.  Ansible will automatically find and enable all commands made
available by the plugin, as detailed in the [Usage Guidelines](#usage).

### Dependencies

This module has been tested with [Ansibe][ansible] v2.0 and above.  It may work with other versions, but they are not
formally supported.  Once Ansible and it's dependencies have been installed, this plugin should be usable.

## Usage

Functionality is currently very limited for the Ansible Prompt module.  At this point, only messaging the user is
supported.

The Ansible Prompt plugin takes a single parameter, `msg`, which can contain one-or-more messages for the user.
Examples tasks are as follows:

```yaml
- name: Simple Message
  prompt:
    msg: Hello World

- name: Multiple Messages
  prompt:
    msg:
      - Hello World
      - Hello Universe
```

### Alignment

> The `align` option does **not** work in tandem with the `ask` option

Messages can be aligned when presented to either `left` (default), `center`, or `right` justification:

```yaml
- name: Alignment Messages
    msg:
      - say: Left Alignment
        align: left
      - say: Center Alignment
        align: center
      - say: Right Alignment
        align: right
```

### Preventing Trailing Newline

> The `newline` option does **not** work in tandem with the `ask` option

In order to prevent the Ansible Prompt module from automatically adding a newline to the end of a message, simply
set the optional `newline` value to `false`:

```yaml
# Outputs "Start of line...middle of line...end of line" followed by newline
- name: No Newline Message
  prompt:
    msg:
      - say: "Start of line..."
        newline: false
      - say: "middle of line"
        newline: false
      - say: "...end of line"
```

### Gathering Facts From User Input

The strength of the prompt plugin comes from its ability to gather Ansible facts, as a task, during the run of a
playbook.  To turn your prompt into a question, provide a `say` and `ask` set of variables for each question you wish
to ask.

The `say` variable contains the message you wish to present, while the `ask` variable is the Ansible variable to
set globally from the user's input:

```yaml
- name: Simple Question
  prompt:
    msg:
      say: "What is your first name?"
      ask: first_name

- debug:
    var: first_name
```

As you can see, a `first_name` variable is set with the user's input during playback.

You may optionally ask multiple questions in the same prompt:

```yaml
- name: Address Information
  prompt:
    msg:
      - say: "Street Address:"
        ask: address
      - say: "City:"
        ask: city
      - say: "State:"
        ask: state
      - say: "Zip Code:"
        ask: zipcode
```

At this time, all variables are created upon the task completion.  Note that variables *cannot* be used until the task
is completed, so this will not work:

```yaml
- name: Address Information
  prompt:
    msg:
      - say: "First Name:"
        ask: first_name
      - say: "Hello {{ first_name }}!  What's your favorite color?"
        ask: color
```

Instead, these questions should be split into two separate `prompt` tasks.

## Frequently Asked Questions

### Why not just use Ansible debug and/or prompt_vars?

While Ansible does provide some basic messaging and reporting functionality, the built in `debug` and `prompt_vars`
methods have some drawbacks.  Specifically:

* `debug` is intended only for debugging, and thus does not present output in a presentation-formatted manner
* `prompt_vars` can only be used at the beginning of the script, limiting options for users that wish to wish to gather input during task playback
* `prompt_vars` has limited, if any, support for conditional logic

## Contributing

There are many ways to contribute to this project!  If you have an idea, or have discovered a bug, please
[open an issue][github-issue] so it can be addressed.

If you are interested in contributing to the project through design or development, please read our
[Contribution Guidelines][github-contribute].

### Testing

A `Makefile` is provided to assist with linting, testing, and code coverage generation.  Dependencies will be managed
automatically during testing:

```bash
make test      # Runs linting and test suites
make coverage  # Runs linting, tests, and generates an HTML coverage report
```

*Please note that full tests must be provided when making contributions to this project.*

## Release Policy

Releases of this project follow [Semantic Versioning][semver] standards in a `MAJOR.MINOR.PATCH`
versioning scheme of the following format:

* `MAJOR` - modified when major, incompatible changes are made to the application,
* `MINOR` - modified when functionality is added in a backwards-compatible manner, and
* `PATCH` - patches to existing functionality, such as documentation and bug fixes.

## License

This project is made available under the [MIT License][github-license].

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

[version-image]:     http://img.shields.io/badge/release-0.3.0-blue.svg?style=flat
[license-image]:     http://img.shields.io/badge/license-MIT-blue.svg?style=flat
[build-image]:       https://travis-ci.org/andrewvaughan/ansible-role-prompt.svg?branch=master
[coverage-image]:    https://coveralls.io/repos/github/andrewvaughan/ansible-role-prompt/badge.svg?branch=master

[github-contribute]: https://github.com/andrewvaughan/ansible-role-prompt/blob/master/.github/CONTRIBUTING.md
[github-issue]:      https://github.com/andrewvaughan/ansible-role-prompt/issues
[github-license]:    https://github.com/andrewvaughan/ansible-role-prompt/blob/master/LICENSE
[github-release]:    https://github.com/andrewvaughan/ansible-role-prompt/releases

[travis-detail]:     https://travis-ci.org/andrewvaughan/ansible-role-prompt
[coveralls-detail]:  https://coveralls.io/github/andrewvaughan/ansible-role-prompt?branch=master

[ansible]:           https://www.ansible.com/
[ansible-debug]:     http://docs.ansible.com/ansible/latest/debug_module.html
[semver]:            http://semver.org/

ansible-role-prompt

ansible-role-prompt 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

ansible-role-prompt

ansible-role-prompt 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README