Merge branch 'master' of github.com:puppetlabs/puppet-docs

Author: jbondpdx

lib/puppet_references/puppet/functions_preamble.md

@@ -13,3 +13,7 @@ The `<DATA TYPE>` is a [Puppet data type value](./lang_data_type.html), like `St
 * Any arguments with an `Optional` data type can be omitted from the function call.
 * Arguments that start with an asterisk (like `*$values`) can be repeated any number of times.
 * Arguments that start with an ampersand (like `&$block`) aren't normal arguments; they represent a code block, provided with [Puppet's lambda syntax.](./lang_lambdas.html)
+
+## `undef` values in Puppet 6
+
+In Puppet 6, many Puppet types were moved out of the Puppet codebase, and into modules on the Puppet Forge. The new functions handle `undef` values more strictly than their stdlib counterparts. In Puppet 6, code that relies on `undef` values being implicitly treated as other types will return an evaluation error. For more information on which types were moved into modules, see the [Puppet 6 release notes](https://puppet.com/docs/puppet/6.0/release_notes_puppet.html#select-types-moved-to-modules).

source/puppet/5.5/known_issues.md

@@ -6,6 +6,8 @@ title: "Puppet 5.5 known issues"
 
 As known issues are discovered in Puppet 5.5 and its patch releases, they'll be added here. Once a known issue is resolved, it is listed as a resolved issue in the release notes for that release, and removed from this list.
 
+- Testing modules using rspec-puppet versions earlier than 2.7.10 results in the error "undefined local variable or method `default_env` for Puppet::Util:Module". As a workaround, update rspec-puppet to version 2.7.10. If using PDK, run `pdk bundle update rspec-puppet` or update your PDK package. If not using PDK, run `bundle update`. [PUP-10586](https://tickets.puppetlabs.com/browse/PUP-10586)
+
 - The `host` type supports only one IP address for each hostname. Because of this, you cannot use both an IPv4 and IPv6 address for the same hostname. [PUP-9480](https://tickets.puppetlabs.com/browse/PUP-9480)
 
 - Puppet 5.5.11 adds support for macOS 10.14 Mojave. However to manage users and groups, you must grant Puppet Full Disk Access. To give Puppet access on a machine running macOS 10.14, go to `System Preferences > Security & Privacy > Privacy > Full Disk Access`, and add the path to the Puppet executable. [PA-2226](https://tickets.puppetlabs.com/browse/PA-2226), [PA-2227](https://tickets.puppetlabs.com/browse/PA-2227)
@@ -15,3 +17,5 @@ As known issues are discovered in Puppet 5.5 and its patch releases, they'll be
 - [PUP-8009](https://tickets.puppetlabs.com/browse/PUP-8009): Puppet 5.1.0 introduced support for internationalized strings in Puppet modules. However, this feature can cause significant performance regressions if [environment caching](./environments_creating.markdown#environment_timeout) is disabled, for instance by setting `environment_timeout==0`, even if the module doesn't include internationalized content. Puppet 5.3.2 introduced an optional `disable_i18n` setting in `puppet.conf` to avoid using localized strings and restore degraded performance.
 
 - When specifying a deep merge behaviour in Hiera, the `knockout_prefix` identifier is effective only against values in an adjacent array, and not in hierarchies more than three levels deep. [HI-223](https://tickets.puppetlabs.com/browse/HI-223)
+
+- Puppet 5 stdlib functions handle `undef` less strictly then they should. In Puppet 6, many functions from stdlib were moved into Forge modules, and now treat `undef` more strictly. In Puppet 6, some code that relies on `undef` values being implicitly treated as other types will return an evaluation error. For more information on which functions were moved out of stdlib, see the [Puppet 6.0 release notes](https://puppet.com/docs/puppet/6.0/release_notes_puppet.html#select-types-moved-to-modules).

source/puppet/5.5/lang_data_hash.md

@@ -41,7 +41,7 @@ Hash keys can be any data type, but generally, you should use only strings. You
 
 ```
 { 'key1' => ['val1','val2'], 
-  'key2 => {  'key3' =>  'val3',  }, 
+  'key2' => {  'key3' =>  'val3',  }, 
   'key4' => true,
   'key5' => 12345,
  }

source/puppet/5.5/release_notes.markdown

@@ -34,6 +34,8 @@ Released  14 July 2020
 
 - **Zypper provider does not recognize `--no-gpg-checks` as a global option.** This release allows `--no-gpg-checks` to be passed as an item to `install_options` property for the zypper package provider. Note that for backward compatibility `--no-gpg-check` was not removed. [PUP-10433](https://tickets.puppetlabs.com/browse/PUP-10433)
 
+- **Boost and `yaml-cpp` in the SLES 15 puppet-agent package.** The boost and yaml-cpp dependencies are now vendored in the SLES 15 agent build. [PA-3006](https://tickets.puppetlabs.com/browse/PA-3006)
+
 ### Resolved issues
 
 - **Puppet agent fails to restart with configuration changes or updates.** Previously, when two agent runs were taking place at the same time, the Puppet agent could get in a `restart_requested` state. This is now fixed.  [PUP-10351](https://tickets.puppetlabs.com/browse/PUP-10351)
@@ -42,7 +44,6 @@ Released  14 July 2020
 
 - **Installer switch `service-enable true` reports wrong actions in certain conditions.** Previously, the Puppet resource command wrongly reporting the enabled state of a systemd service when the ensure parameter was also specified. This is now fixed. [PUP-10479](https://tickets.puppetlabs.com/browse/PUP-10479)
 
-
 - **The `pip` package provider does not handle `pip` executable paths with spaces.** Paths containing spaces will now be quoted in the `pip` package providers. [PUP-10485](https://tickets.puppetlabs.com/browse/PUP-10485)
 
 - **The `purge_ssh_keys` parameter requires you to set the home directory in the manifest.** The release fixes an issue where Puppet required you to manage the home directory when purging SSH keys with `purge_ssh_keys`. [PUP-10506](https://tickets.puppetlabs.com/browse/PUP-10485)
@@ -67,6 +68,10 @@ Released  14 July 2020
 
 - **User resource expiry incorrect on SLES 11.** On SLES 11, setting a user resource expiry to absent resulted in disabling the user instead. This is now fixed. [PUP-7663](https://tickets.puppetlabs.com/browse/PUP-7663)
 
+- **Puppet agent should ignore `nssm.exe` during an upgrade.** Previously, if a puppet-agent upgrade on Windows happened when `nssm.exe` was loaded by EventLog service, certain services were restarted, leading to unreachable machines. This release includes an `nssm` executable for pxp-agent (`nssm-pxp-agent.exe`) and we have remove Windows registry references to the old nssm.exe. [PA-3263](https://tickets.puppetlabs.com/browse/PA-3263)
+
+- **Puppet should ignore system Ruby settings.** Running Puppet using a wrapper script from the puppet-agent package will now ignore the following ruby related environment variables: `GEM_HOME`, `GEM_PATH`, `DLN_LIBRARY_PATH`, `RUBYLIB`, `RUBYLIB_PREFIX`, `RUBYOPT`, `RUBYPATH`, `RUBYSHELL`. [PA-3248](https://tickets.puppetlabs.com/browse/PA-3248)
+
 ## Puppet 5.5.20
 
 Released  30 April 2020

source/puppet/latest/configuration.md

@@ -298,6 +298,7 @@ Defaults to the node's fully qualified domain name.
 
 - *Default*: the Host's fully qualified domain name, as determined by Facter
 
+**Note**: For full functionality of the `puppet config print` command and other dependent commands, include the certname in the main section of the puppet.conf file.
 ### classfile
 
 The file in which puppet agent stores a list of the classes

source/puppet/latest/type.md

@@ -762,15 +762,14 @@ masters.
   filebucket resource, requires appropriate planning and management to ensure
   that sufficient disk space is available for the file backups. Generally, you
   can implement this using one of the following two options:
-  - Use a `find` command and `crontab` entry to retain only the last X days
-  of file backups. For example,
-
-  ```shell script
-  find /opt/puppetlabs/server/data/puppetserver/bucket -type f -mtime +45 -atime +45 -print0 | xargs -0 rm
-  ```
-
-  - Restrict the directory to a maximum size after which the oldest items are removed.
+  
+- Restrict the directory to a maximum size after which the oldest items are removed.
+- Use a `find` command and `crontab` entry to retain only the last X days of file backups. For example:
 
+```
+find /opt/puppetlabs/server/data/puppetserver/bucket -type f -mtime +45 -atime +45 -print0 | xargs -0 rm
+```
+  
 Default: `puppet`
 
 ([↑ Back to file attributes](#file-attributes))
@@ -1886,7 +1885,7 @@ notify
 
 <h3 id="notify-description">Description</h3>
 
-Sends an arbitrary message to the agent run-time log. It's important to note that the notify resource type is not idempotent. As a result, notifications are shown as a change on every Puppet run.
+Sends an arbitrary message, specified as a string, to the agent run-time log. It's important to note that the notify resource type is not idempotent. As a result, notifications are shown as a change on every Puppet run.
 
 <h3 id="notify-attributes">Attributes</h3>
 
@@ -1909,7 +1908,7 @@ An arbitrary tag for your own reference; the name of the message.
 
 _(**Property:** This attribute represents concrete state on the target system.)_
 
-The message to be sent to the log.
+The message to be sent to the log. Note that the value specified must be a string.
 
 ([↑ Back to notify attributes](#notify-attributes))
 

source/puppet/latest/types/notify.md

@@ -14,7 +14,7 @@ notify
 
 <h3 id="notify-description">Description</h3>
 
-Sends an arbitrary message to the agent run-time log. It's important to note that the notify resource type is not idempotent. As a result, notifications are shown as a change on every Puppet run.
+Sends an arbitrary message, specified as a string, to the agent run-time log. It's important to note that the notify resource type is not idempotent. As a result, notifications are shown as a change on every Puppet run.
 
 <h3 id="notify-attributes">Attributes</h3>
 
@@ -37,7 +37,7 @@ An arbitrary tag for your own reference; the name of the message.
 
 _(**Property:** This attribute represents concrete state on the target system.)_
 
-The message to be sent to the log.
+The message to be sent to the log. Note that the value specified must be a string.
 
 ([↑ Back to notify attributes](#notify-attributes))
 
@@ -58,4 +58,4 @@ Allowed values:
 
 
 
-> **NOTE:** This page was generated from the Puppet source code on 2020-06-30 08:58:23 +0100
+> **NOTE:** This page was generated from the Puppet source code on 2020-06-30 08:58:23 +0100