Skip to content
Snippets Groups Projects
Commit 5812e846 authored by Hannes Braun's avatar Hannes Braun :upside_down:
Browse files

Update README.md for v1.0 release

parent ef3d99cd
Branches
No related tags found
No related merge requests found
Role Name
=========
# role-configure-ssh-server
A brief description of the role goes here.
## Name
Requirements
------------
Configure and restart the sshd server.
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.
## Description
Role Variables
--------------
An ansible role to replace the sshd_config file. It by default restricts access to the server only to users of the group ssh with ssh key authentication.
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.
## Installation
Dependencies
------------
Either refer to the role via a requirements.yml, dependecies inside a meta.yml or via cloning the repository.
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.
**Requirements.yml - Example**
Example Playbook
----------------
```yaml
---
roles:
- name: role-configure-ssh-server
src: https://25_read_ansible_roles:glpat-5Ci385Nui9Uvyy8dQcuC@git.slub-dresden.de/ansible/referat25/role-configure-ssh-server.git
scm: git
version: v1.0
```
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
```bash
ansible-galaxy install -r requirements.yml
```
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
## Usage
License
-------
Provide valid sshd_config or use the default and include role inside your playbook.
BSD
For variables see `defaults/main.yml`.
Author Information
------------------
## License
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
For open source projects, say how it is licensed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment