Skip to content
This repository has been archived by the owner on Aug 18, 2022. It is now read-only.

(docs) Add note about long file names during install #61

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ This module is available on the [Puppet Forge](https://forge.puppetlabs.com/pupp
puppet module install puppetlabs-dsc
~~~

**NOTE**

When installing the module on Windows you may run into an issue regarding long file names (LFN), this is due to the generated schema files. If you are running in a master environment and installing the module on your master this will not be an issue, however if you are running masterless then you may run into this during installation depending on the length of the username it is ran from. One way to get around this is to download the `.tar.gz` and install using the file rather than directly from the forge. For more info see [PUP-4866](https://tickets.puppetlabs.com/browse/PUP-4866)
Copy link
Contributor

Choose a reason for hiding this comment

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

After closer inspection, this isn't quite right. We've provided a fix in https://tickets.puppetlabs.com/browse/PUP-4854 that will switch to using TEMP directory in Puppet 3.8.2 and 4.2.2. That means then you may run into this issue based on username and how they access temp, but before it was to C:\ProgramData\ etc etc. - it may help to review puppetlabs/puppet#4090

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So would it be safer to say, if using < 3.8.2 in or > 4 and less than 4.2.2 you may get this issue otherwise it has been fixed?

Copy link
Contributor

Choose a reason for hiding this comment

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

It hasn't been fixed though. We still don't support LFN, we've just attempted to ease the likelihood of if happening in PUP-4854.

I think this should actually go into known issues.


~~~
Error: No such file or directory @ rb_sysopen - C:/ProgramData/PuppetLabs/puppet/cache/puppet-module/cache/tmp-unpacker20150713-...mof
Error: Try 'puppet help module install' for usage
~~~

## Usage

You can use a DSC Resource by prefixing each DSC Resource name and parameter with 'dsc_'.
Expand Down