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

(DOC) Update pdk-template known issues #1433

Merged
merged 4 commits into from
Jan 31, 2025
Merged

(DOC) Update pdk-template known issues #1433

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2705e13
(DOC) Update pdk-template known issues
david22swan Jan 31, 2025
8543166
Update docs/pdk_known_issues.md
david22swan Jan 31, 2025
0562c32
Update pdk_known_issues.md
david22swan Jan 31, 2025
98da387
Update pdk_known_issues.md
david22swan Jan 31, 2025
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
12 changes: 9 additions & 3 deletions docs/pdk_known_issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,35 @@ We have recently begun seeing an issue with the default bundled templates on cer
pdk (FATAL): Unable to find a valid module template to use.
```

Through investigation this has been shown to be a permssions issue regarding the `pdk-templates.git` file and unfortunately one that we have not been able to resolve in time for this release.
Through investigation this has been shown to be a permssions issue regarding the `pdk-templates.git` file, with newer versions of git not trusting it by default due to the manner in which it is copied over, something that we have not been able to resolve moving forward and will likely be unable to fully resolve at anytime soon, most likely leaving this as a permanent limitation of the code.

This error is most commonly found when creating a new module or attempting to update a module that was previously created from the default templates, within an airgapped environment. There are two possible solutions that we have found for this, with the first one being to grant the `pdk-templates.git` directory packaged with the pdk the permissions that it requires in order for it to be used, either by confirming the local user as the owner of the files through the `chown` command or by setting it as a safe.directory going forward.
This error is most commonly found when creating a new module or attempting to update a module that was previously created from the default templates, within an airgapped environment. There are two possible solutions that we have found for this, with the first one being to grant the `pdk-templates.git` directory packaged with the pdk the permissions that it requires in order for it to be used, either by confirming the local user as the owner of the files through the `chown` command or by setting it as a safe directory via git.
Please be aware however that if using the `chown` command, you will have to reapply the fix between PDK versions.

```
sudo chown -R example.user /opt/puppetlabs/pdk/share/cache/pdk-templates.git
```
```
git config --global --add safe.directory /opt/puppetlabs/pdk/share/cache/pdk-templates.git
```

The other solution is to target a seperate template location a shown below:
The other solution is to target a seperate template location as shown below:

- When creating a new module simply target either the main branch or a specified tag on the Github pdk-templates fork, or if you are airgapped a local copy of it that you have cloned down. Once the first run has been made, the PDK should store your targeted templates location and automatically go to it moving forward, until such time as you target another or clear your .pdk cache.

```
pdk new module example --template-url=file:///Users/example.user/Github/pdk-templates --template-ref=3.4.0
```
```
pdk new module example --template-url=https://github.com/puppetlabs/pdk-templates --template-ref=main
```

- For existing modules that are targeting the default bundled templates, you will instead need to either run the `pdk convert` command as shown below to retarget them at a new template location, or manually alter the Modules metadata fields to target, though I would suggest using the convert command as a preference.

```
pdk convert --template-url=file:///Users/example.user/Github/pdk-templates --template-ref=3.4.0
```
```
pdk convert --template-url=https://github.com/puppetlabs/pdk-templates --template-ref=main
```

Expand Down