Jira (PUP-9972) Improve comments / documentation about which section a Puppet environment should be set within the puppet.conf file

16 views
Skip to first unread message

Joel Weierman (JIRA)

unread,
Aug 21, 2019, 5:24:03 PM8/21/19
to puppe...@googlegroups.com
Joel Weierman created an issue
 
Puppet / Improvement PUP-9972
Improve comments / documentation about which section a Puppet environment should be set within the puppet.conf file
Issue Type: Improvement Improvement
Assignee: Unassigned
Created: 2019/08/21 2:23 PM
Priority: Normal Normal
Reporter: Joel Weierman

Puppet Version: 4.x and above
Puppet Server Version: NA
OS Name/Version: NA

There is some confusion around the proper place to set a Puppet environment in the puppet.conf file. An older (now fixed) bug (PUP-6739) highlighted problems with placing the environment in the [user] or [agent] section of the puppet.conf. Some documentation (e.g. https://puppet.com/docs/puppet/5.3/config_file_main.html#example-agent-config) shows an example of setting the environment in main, while the defaults.rb file under environment states to not set this globally.

Desired Behavior: Documentation about where to set the Puppet environment in the puppet.conf should be consistent with the code base and what is recommended as well as other existing documentation.  **

Actual Behavior:

Defaults.rb has this in the comments under environment:

"Given that the context and effects vary depending on the [config section](https://puppet.com/docs/puppet/latest/config_file_main.html#config-sections) in which the `environment` setting is defined, do not set it globally."

 

 

Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo

Josh Cooper (JIRA)

unread,
Aug 21, 2019, 6:31:02 PM8/21/19
to puppe...@googlegroups.com
Josh Cooper commented on Improvement PUP-9972
 
Re: Improve comments / documentation about which section a Puppet environment should be set within the puppet.conf file

I think we should remove environment from puppet.conf in the default case. AFAIK the only time setting the environment in puppet.conf makes sense is when using agent-specified environments. In that case, it should be set in the [agent] section, which won't require that the environment directory exist locally.

Josh Cooper (JIRA)

unread,
Aug 21, 2019, 6:31:03 PM8/21/19
to puppe...@googlegroups.com

Josh Cooper (JIRA)

unread,
Aug 21, 2019, 6:31:03 PM8/21/19
to puppe...@googlegroups.com

Joel Weierman (JIRA)

unread,
Aug 21, 2019, 6:34:02 PM8/21/19
to puppe...@googlegroups.com

Josh Cooper (JIRA)

unread,
Oct 1, 2019, 1:19:04 AM10/1/19
to puppe...@googlegroups.com

Jean Bond (JIRA)

unread,
Jan 3, 2020, 5:10:03 PM1/3/20
to puppe...@googlegroups.com

Jean Bond (JIRA)

unread,
Jan 3, 2020, 5:14:04 PM1/3/20
to puppe...@googlegroups.com

Kate Medred (JIRA)

unread,
Jan 29, 2020, 7:27:04 PM1/29/20
to puppe...@googlegroups.com
Kate Medred commented on Improvement PUP-9972
 
Re: Improve comments / documentation about which section a Puppet environment should be set within the puppet.conf file

Update: "environment" has been removed from the code examples on https://puppet.com/docs/puppet/latest/config_file_main.html. However, no caveat/ extra explanation was added as we deemed it unnecessary given the context. 

Reply all
Reply to author
Forward
0 new messages