Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation about parameter port. #84

Merged
merged 1 commit into from
Jul 13, 2020
Merged

Fix documentation about parameter port. #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,15 +112,9 @@ class { '::chrony':
```puppet
class { '::chrony':
queryhosts => [ '192.168/16', ],
port => 123,
}
```

#### Note

The parameter `port` is also set here,
module default is `0` to ensure server mode is not activated accidentally.

### How to configure leap second

```puppet
Expand Down
5 changes: 3 additions & 2 deletions REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ class { 'chrony':
```puppet
class { 'chrony':
queryhosts => ['192.168/16'],
port => 123,
}
```

Expand Down Expand Up @@ -379,7 +378,9 @@ Default value: []

Data type: `Stdlib::Port`

Port the service should listen on, to be used in combination with `queryhosts`.
Port the service should listen on. Module default is `undef` which means that port isn't
added to chrony.conf, and chrony listens to the default ntp port 123 if `queryhosts` is
used.

Default value: `undef`

Expand Down
7 changes: 3 additions & 4 deletions manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
# @example Allow some hosts
# class { 'chrony':
# queryhosts => ['192.168/16'],
# port => 123,
# }
# @example Configure the leap second mode
# class { 'chrony':
Expand Down Expand Up @@ -136,10 +135,10 @@
# Also see [`makestep_seconds`](#makestep_seconds).
# @param queryhosts
# This adds the networks, hosts that are allowed to query the daemon.
# Note that `port` needs to be set for this to work.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reference is generated by calling bundle exec rake strings:generate:reference and it looks like this isn't reflected there.

Copy link
Contributor Author

@chrekh chrekh Jul 12, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that the docstring in init.pp is correct now, neither of init.pp or REFERENCE.md
has that note anymore. Probably the reference shoult be regenerated anyway?

# @param port
# Port the service should listen on, to be used in combination with `queryhosts`.
# Module default is `0` to prevent accidental activation of server mode.
# Port the service should listen on. Module default is `undef` which means that port
# isn't added to chrony.conf, and chrony listens to the default ntp port 123 if
# `queryhosts` is used.
# @param service_enable
# This determines if the service should be enabled at boot.
# @param service_ensure
Expand Down