Skip to content

Commit

Permalink
Update meta information and README
Browse files Browse the repository at this point in the history
  • Loading branch information
johnmaguire committed May 24, 2023
1 parent f9acbaf commit fa4c649
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 27 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,35 @@
Role Name
Ansible Role: `johnmaguire.dnclient`
=========

A brief description of the role goes here.
Installs [dnclient](https://defined.net) on some servers.

Requirements
------------

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.
None

Role Variables
--------------

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.
You can override the dnclient download URL with the following variable:

```
dnclient_latest_url: "https://dl.defined.net/02c6d0f9/v0.1.9/linux/amd64/dnclient"
```

Otherwise the latest version will be downloaded.

Dependencies
------------

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.
None

Example Playbook
----------------

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

- hosts: servers
roles:
- { role: username.rolename, x: 42 }
- { role: johnmaguire.dnclient }

License
-------
Expand Down
23 changes: 4 additions & 19 deletions meta/main.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,11 @@
galaxy_info:
author: your name
description: your role description
company: your company (optional)

# If the issue tracker for your role is not on github, uncomment the
# next line and provide a value
# issue_tracker_url: http://example.com/issue/tracker

# Choose a valid license ID from https://spdx.org - some suggested licenses:
# - BSD-3-Clause (default)
# - MIT
# - GPL-2.0-or-later
# - GPL-3.0-only
# - Apache-2.0
# - CC-BY-4.0
license: license (GPL-2.0-or-later, MIT, etc)
role_name: dnclient
author: John Maguire
description: Installs dnclient from Defined Networking.
license: MIT

min_ansible_version: 2.1

# If this a Container Enabled role, provide the minimum Ansible Container version.
# min_ansible_container_version:

#
# Provide a list of supported platforms, and for each platform a list of versions.
# If you don't wish to enumerate all versions for a particular platform, use 'all'.
Expand Down

0 comments on commit fa4c649

Please sign in to comment.