Skip to content

Commit ec38371

Browse files
committed
docs: update the README file
1 parent 86096ac commit ec38371

1 file changed

Lines changed: 16 additions & 33 deletions

File tree

README.md

Lines changed: 16 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
-*- mode: markdown; mode: visual-line; -*-
2-
31
# Bind Puppet Module
42

53
[![Puppet Forge](http://img.shields.io/puppetforge/v/ULHPC/bind.svg)](https://forge.puppetlabs.com/ULHPC/bind)
@@ -8,7 +6,7 @@
86

97
Configure and manage bind
108

11-
Copyright (c) 2018 UL HPC Team <hpc-sysadmins@uni.lu>
9+
Copyright (c) 2026 UL HPC Team <hpc-sysadmins@uni.lu>
1210

1311

1412
| [Project Page](https://github.com/ULHPC/puppet-bind) | [Sources](https://github.com/ULHPC/puppet-bind) | [Issues](https://github.com/ULHPC/puppet-bind/issues) |
@@ -33,9 +31,6 @@ This module implements the following elements:
3331
All these components are configured through a set of variables you will find in
3432
[`manifests/params.pp`](manifests/params.pp).
3533

36-
_Note_: the various operations that can be conducted from this repository are piloted from a [`Rakefile`](https://github.com/ruby/rake) and assumes you have a running [Ruby](https://www.ruby-lang.org/en/) installation.
37-
See `docs/contributing.md` for more details on the steps you shall follow to have this `Rakefile` working properly.
38-
3934
## Dependencies
4035

4136
See [`metadata.json`](metadata.json). In particular, this module depends on
@@ -56,10 +51,10 @@ It accepts the following parameters:
5651

5752
Use it as follows:
5853

59-
include ' bind'
60-
61-
See also [`tests/init.pp`](tests/init.pp)
62-
54+
class { 'bind':
55+
ensure => 'present',
56+
forwarders => [ '10.28.0.5' ]
57+
}
6358

6459
### Definition `bind::resolver`
6560

@@ -72,12 +67,11 @@ This definition accepts the following parameters:
7267

7368
Example:
7469

75-
bind::resolver { 'toto':
76-
ensure => 'present',
70+
bind::resolver { 'uni.lux':
71+
nameservers => '10.28.0.5',
72+
order => 10
7773
}
7874

79-
See also [`tests/resolver.pp`](tests/resolver.pp)
80-
8175
### Definition `bind::zone`
8276

8377
The definition `bind::zone` provides ...
@@ -89,13 +83,11 @@ This definition accepts the following parameters:
8983

9084
Example:
9185

92-
bind::zone { 'toto':
93-
ensure => 'present',
86+
bind::zone { 'gaia-cluster.uni.lux':
87+
source => "puppet:///private/gaia-cluster/db.gaia-cluster.uni.lux",
88+
add_to_resolver => true
9489
}
9590

96-
See also [`tests/zone.pp`](tests/zone.pp)
97-
98-
9991
## Librarian-Puppet / R10K Setup
10092

10193
You can of course configure the bind module in your `Puppetfile` to make it available with [Librarian puppet](http://librarian-puppet.com/) or
@@ -108,26 +100,17 @@ or, if you prefer to work on the git version:
108100

109101
mod "ULHPC/bind",
110102
:git => 'https://github.com/ULHPC/puppet-bind',
111-
:ref => 'production'
112-
113-
## Issues / Feature request
103+
:ref => 'main'
114104

115-
You can submit bug / issues / feature request using the [ULHPC/bind Puppet Module Tracker](https://github.com/ULHPC/puppet-bind/issues).
116105

117-
## Developments / Contributing to the code
106+
## Developments / Issues / Contributing to the code
118107

119-
If you want to contribute to the code, you shall be aware of the way this module is organized.
120-
These elements are detailed on [`docs/contributing.md`](contributing/index.md).
108+
This Puppet Module has been implemented in the context of the [UL HPC](http://hpc.uni.lu) Platform of the [University of Luxembourg](http://www.uni.lu).
109+
It relies on [Vox Pupuli modulesync](https://github.com/voxpupuli/modulesync) for its organization.
121110

111+
You can submit bugs / issues / feature requests using the [ULHPC/bind Puppet Module Tracker](https://github.com/ULHPC/puppet-bind/issues).
122112
You are more than welcome to contribute to its development by [sending a pull request](https://help.github.com/articles/using-pull-requests).
123113

124-
## Puppet modules tests within a Vagrant box
125-
126-
The best way to test this module in a non-intrusive way is to rely on [Vagrant](http://www.vagrantup.com/).
127-
The `Vagrantfile` at the root of the repository pilot the provisioning various vagrant boxes available on [Vagrant cloud](https://atlas.hashicorp.com/boxes/search?utf8=%E2%9C%93&sort=&provider=virtualbox&q=svarrette) you can use to test this module.
128-
129-
See [`docs/vagrant.md`](vagrant.md) for more details.
130-
131114
## Licence
132115

133116
This project and the sources proposed within this repository are released under the terms of the [GPL-3.0](LICENCE) licence.

0 commit comments

Comments
 (0)