Skip to content

Commit

Permalink
Added Bastion Mode instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Tejeda, Engelbert committed Oct 1, 2019
1 parent 86a0d45 commit 72f2a13
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
- [Installation](#installation)
- [More Examples](#more-examples)
- [Appendix](#appendix)
- [Bastion Mode](#bastion-mode)
- [Special Variables](#special-variables)
- [ansible_playbook_command](#ansible_playbook_command)
- [cli_provider](#cli_provider)
Expand Down Expand Up @@ -58,6 +59,8 @@ The inspiration for the tool comes from the gnu make command, which operates in
- A Makefile defines available build steps
- The make command consumes the Makefile at runtime and exposes these steps as command-line options

If you are running this tool from Windows, please read the section on [Bastion Mode](#bastion_mode)

# TL;DR

- Ever wanted to add custom switches to the `ansible-playbook` command? Something like this:<br />
Expand Down Expand Up @@ -668,7 +671,7 @@ Quick usage examples:
<a name="installation"></a>
# Installation

Ansible-tasksrunner consists of the `tasks` binary (for now), and it can be installed in a few ways:
Ansible-taskrunner consists of the `tasks` binary (for now), and it can be installed in a few ways:

1. pip install ansible-taskrunner
2. pip install git+https://github.com/berttejeda/ansible-taskrunner.git
Expand All @@ -682,6 +685,26 @@ Review the [examples](examples) directory for more hands-on usage samples.
<a name="appendix"></a>
# Appendix

<a name="bastion_mode"></a>
## Bastion Mode

If you're launching the `tasks` command from a Windows host, this tool will automatically execute in _Bastion Mode_

Under Bastion Mode, the `tasks` command will:
- Execute the `ansible-playbook` subprocess via a _bastion host_, i.e. a remote machine that has `ansible` installed
- This is done via ssh using the [paramiko](http://www.paramiko.org/) module

As you would expect, running in Bastion Mode requires a configuration file containing the ssh connection settings.

To initialize this configuration file, you can simply run `tasks init`.

For full usage options, enter in `tasks init --help`.

Once you've initialized the configuration file, you should see *sftp-config.json* in your workspace.

This configuration file is fashioned after the [sftp](https://packagecontrol.io/packages/SFTP) plugin for [Sublime Text](https://www.sublimetext.com/)
and is thus compatible.

<a name="special-variables"></a>
## Special Variables

Expand Down

0 comments on commit 72f2a13

Please sign in to comment.