Skip to content

Commit b2bf46d

Browse files
committed
Add README
1 parent ed47dae commit b2bf46d

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

README.md

+51-11
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,78 @@
1-
Role Name
1+
Ansible Role: Install Python on Ubuntu machines that do not have Python pre-installed
22
=========
3+
[![Build Status][travis-badge]][travis-link]
34

4-
A brief description of the role goes here.
5+
An ansible role that gets Ansible to work on bare Ubuntu machines that do not have Python pre-installed. It checks if python is installed, if not, it installs it via the [raw](https://docs.ansible.com/ansible/latest/modules/raw_module.html) module.
56

67
Requirements
78
------------
89

9-
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
10+
None.
11+
12+
13+
Installation
14+
------------
15+
`ansible-galaxy install jasonheecs.ubuntu-python-raw`
16+
1017

1118
Role Variables
1219
--------------
1320

14-
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
21+
Available variables are listed below, along with default values (see defaults/main.yml):
22+
23+
```yaml
24+
python_version: 3
25+
```
1526
1627
Dependencies
1728
------------
1829
19-
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
30+
None
31+
2032
2133
Example Playbook
2234
----------------
2335
24-
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
36+
```yaml
37+
- name: Setup
38+
hosts: all
39+
become: yes
40+
gather_facts: false # You must disable the gather of facts for this role to work as intended
41+
roles:
42+
- { role: ansible-ubuntu-python-raw }
43+
```
44+
45+
46+
Tests
47+
---------------
48+
Testing is done via [Test Kitchen](https://github.com/test-kitchen/test-kitchen), [Kitchen Ansible](https://github.com/neillturner/kitchen-ansible) and [Kitchen Docker](https://github.com/test-kitchen/kitchen-docker)
2549
26-
- hosts: servers
27-
roles:
28-
- { role: username.rolename, x: 42 }
50+
To run the tests, make sure [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and [Docker](https://docs.docker.com/installation/#installation) are installed and run the following:
51+
52+
```
53+
gem install bundler && bundle exec kitchen test
54+
```
55+
56+
Refer to the [travis.yml](.travis.yml) file and [Travis build logs][travis-link] for details on the test build process and expected outputs.
57+
58+
59+
Supported Platforms
60+
-------
61+
This ansible role has been tested against the following platforms:
62+
- Ubuntu 18.04
63+
- Ubuntu 16.04
64+
- Ubuntu 14.04
2965

3066
License
3167
-------
3268

33-
BSD
69+
MIT
70+
3471

3572
Author Information
3673
------------------
3774

38-
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
75+
[Jason Hee](https://jasonhee.com)
76+
77+
[travis-badge]: https://travis-ci.com/jasonheecs/ansible-ubuntu-python-raw.svg?branch=master
78+
[travis-link]: https://travis-ci.com/jasonheecs/ansible-ubuntu-python-raw

0 commit comments

Comments
 (0)