runinterval - is it seconds or minutes? Docs are incomplete!

[Tim Schaefer]

OK so is it minutes or seconds for runinterval?

And what's the correct format!!!!

Please put an example in the docs!!!!!

Do I use 15m for 15 minutes or is it 900 for 900 seconds?????  

I hate ambiguity in documentation!!!!!  Be precise!

[Eric Sorenson]

http://docs.puppetlabs.com/references/latest/configuration.html

Top of the page, just under the headers:

Settings that represent time intervals should be specified in duration format: an integer immediately followed by one of the units ‘y’ (years of 365 days), ‘d’ (days), ‘h’ (hours), ‘m’ (minutes), or ‘s’ (seconds). The unit cannot be combined with other units, and defaults to seconds when omitted. Examples are ‘3600’ which is equivalent to ‘1h’ (one hour), and ‘1825d’ which is equivalent to ‘5y’ (5 years).

[Tim Schaefer]

Item 175:

runinterval

How often puppet agent applies the client configuration; in seconds. Note that a runinterval of 0 means “run continuously” rather than “never run.” If you want puppet agent to never run, you should start it with the --no-client option. Can be specified as a duration.

• Default: 30m

So, do I put 15m? 900?  900s?  There is nothing there that says anything you just said.  

None of what you said is in the runinterval documentation.  This is the first I've ever seen it.  You need to update your docs.

And don't tell me to go over to forge, that's a lazy, inexcusable response.  You can do better.  I don't mind hacking but really when there is no where else to find this information you have a responsibility to document in a clear, unambiguous form.

Thanks,

Tim

--
You received this message because you are subscribed to a topic in the Google Groups "Puppet Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/puppet-users/fBC1VXt9nPA/unsubscribe?hl=en.
To unsubscribe from this group and all its topics, send an email to puppet-users...@googlegroups.com.
To post to this group, send email to puppet...@googlegroups.com.
Visit this group at http://groups.google.com/group/puppet-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

--
Tim Schaefer

iphone 650-839-3277 

voip     650-646-9636

email   asysar...@gmail.com

web     A System Architect

skype asystemarchitect

[Matthew Kennedy]

It is there, just where Eric said it was. No need to get upset.

It might be helpful to mention where the time notation format can be found in the sections where it is used. Would preempt issues like this in the future.

Matt

You received this message because you are subscribed to the Google Groups "Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-users...@googlegroups.com.

[Tim Schaefer]

Puppet docs are the last place I look not the first place, and that's my annoyance with the documentation.

Clear, complete, unambiguous, working docs with real-world examples are what we need.  It gets really annoying to have to download modules from forge and have to wade through code to see what is the correct approach is, especially when so many modules don't have documentation either.  pe_accounts is a classic example of incomplete, confusing documentation.  Some of it just makes no sense at all, especially since it has no authoritative examples that are complete enough to use.  No docs on how to set up external data sources. Very annoying and ironic, since Puppet is supposed to save me time.  Instead I find myself constantly hunting for examples.

Anyway I did find the snippet of information at the top of the doc, where I would never expect to see it.    

Tim

 

[Matthew Burgess]

On 28 May 2013 21:42, Tim Schaefer <asysar...@gmail.com> wrote:

Puppet docs are the last place I look not the first place, and that's my annoyance with the documentation.

​That just sounds...odd.  Where would you expect to find things documented, if not in the documentation?​

 

 

Anyway I did find the snippet of information at the top of the doc, where I would never expect to see it.  

​

Again, maybe I've just got a different mindset, but the parameter you need information on is a configuration setting.  An explanation for the valid values for that setting is in a section titled 'Configuration Settings' and somehow that's not where you would expect to see it?  Where do you think a better place would be?

Thanks,

Matt.

[Ellison Marks]

Well, it's an open source project. If you feel the docs aren't clear enough, you can file a ticket or submit a pull request via git.

http://docs.puppetlabs.com/contribute.html

[Tim Schaefer]

Thanks for your response, and I'm sorry for ranting, but I remain
unhappy with the docs. My expectations do remain high for Puppet
Enterprise, and the open source product, I am certainly a huge fan.

But I don't think it's unreasonable to have complete docs that include
working examples of code and even diagrams to show the overall
architecture. I wish I had the bandwidth to work on the docs myself,
but too busy with my regular work to do that.

Anyway... Anything you can do to make end users more capable of using
your product is a win for you and not your competition.

Thanks,

Tim

[Eric Sorenson]

Absolutely true Tim and while I thank the folks on the thread who chimed in, I totally understand your frustration.

Sure docs are never perfect but the fact is you were looking for something specific and couldn't find it, and that sucks.

Were you looking at the output of 'puppet master --genconfig' or 'puppet man master', (or something else?) when you ran into the 'duration' term and couldn't find where that was defined?

Eric Sorenson - eric.s...@puppetlabs.com
irc.freenode.net #puppet: eric0
Join us at PuppetConf 2013, August 22-23 in San Francisco - http://bit.ly/pupconf13

[Steve F]

My puppet documentation from running

# puppet master --genconfig 

reveals:

    # How often puppet agent applies the client configuration; in seconds.

    # Note that a runinterval of 0 means "run continuously" rather than

    # "never run." If you want puppet agent to never run, you should start

    # it with the `--no-client` option.

    # The default value is '1800'.

    # runinterval = 1800

Pretty clearly defined there, I think.

[Tim Schaefer]

On Tuesday, May 28, 2013 11:03:26 PM UTC-7, Eric Sorenson wrote:

Absolutely true Tim and while I thank the folks on the thread who chimed in, I totally understand your frustration.

Sure docs are never perfect but the fact is you were looking for something specific and couldn't find it, and that sucks.

Were you looking at the output of 'puppet master --genconfig' or 'puppet man master', (or something else?) when you ran into the 'duration' term and couldn't find where that was defined?

No, I was simply trying to change the behavior of the runinterval so that I could get more frequent updates than the 30 minute default.

I think my frustration is based on speed and pressure to make things work.  I have your competition nipping at my heels and I don't have time to search high and low for answers.  Speed matters.  I would even go so far <gasp> to say that IBM's online docs are a better format than Puppet because it's all in one place, no flipping around various pages.  There is great value in tree-style dialogs, with a tree on the left, and content on the right.  Very fast to work with this kind of documentation.  Just sayin...