Skip to content

Commit 0ed1222

Browse files
committed
Update README boilerplate for this Ansible role
1 parent c848889 commit 0ed1222

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
[![GitHub Build Status](https://github.com/cisagov/ansible-role-systemd-resolved/workflows/build/badge.svg)](https://github.com/cisagov/ansible-role-systemd-resolved/actions)
44
[![CodeQL](https://github.com/cisagov/ansible-role-systemd-resolved/workflows/CodeQL/badge.svg)](https://github.com/cisagov/ansible-role-systemd-resolved/actions/workflows/codeql-analysis.yml)
55

6-
This is a skeleton project that can be used to quickly get a new
7-
[cisagov](https://github.com/cisagov) Ansible role GitHub project
8-
started. This skeleton project contains
9-
[licensing information](LICENSE), as well as
10-
[pre-commit hooks](https://pre-commit.com) and
11-
[GitHub Actions](https://github.com/features/actions) configurations
12-
appropriate for an Ansible role.
6+
This is an Ansible role that installs and configures
7+
[`systemd-resolved`](https://wiki.archlinux.org/title/systemd-resolved).
8+
It performs the following actions:
9+
10+
- Installs `systemd-resolved` and ensures that `resolvconf` is not
11+
installed.
12+
- Creates an `/etc/resolv.conf` symlink that results in the
13+
`systemd-resolved` stub DNS resolver being used by default for all
14+
system DNS lookups.
1315

1416
## Requirements ##
1517

@@ -42,7 +44,7 @@ where `requirements.yml` looks like:
4244

4345
```yaml
4446
---
45-
- name: skeleton
47+
- name: systemd_resolved
4648
src: https://github.com/cisagov/ansible-role-systemd-resolved
4749
```
4850
@@ -61,18 +63,11 @@ Here's how to use it in a playbook:
6163
become: true
6264
become_method: sudo
6365
tasks:
64-
- name: Include skeleton
66+
- name: Include systemd-resolved
6567
ansible.builtin.include_role:
66-
name: skeleton
68+
name: systemd_resolved
6769
```
6870

69-
## New Repositories from a Skeleton ##
70-
71-
Please see our [Project Setup guide](https://github.com/cisagov/development-guide/tree/develop/project_setup)
72-
for step-by-step instructions on how to start a new repository from
73-
a skeleton. This will save you time and effort when configuring a
74-
new repository!
75-
7671
## Contributing ##
7772

7873
We welcome contributions! Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for
@@ -93,4 +88,4 @@ with this waiver of copyright interest.
9388

9489
## Author Information ##
9590

96-
First Last - <first.last@gwe.cisa.dhs.gov>
91+
Shane Frasier - <jeremy.frasier@gwe.cisa.dhs.gov>

0 commit comments

Comments
 (0)