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

(CAT-2148) Update bundled templates known issue #1431

Merged
merged 2 commits into from
Jan 30, 2025
Merged

(CAT-2148) Update bundled templates known issue #1431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb2b0a3
(CAT-2148) Update bundled templates known issue
david22swan Jan 30, 2025
90f4a2d
(maint) Add reference to inbuilt templates issue to the readme
david22swan Jan 30, 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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,19 @@ This command runs all available unit tests.

PDK encourages community contributions. See the [CONTRIBUTING.md](CONTRIBUTING.md) file for development notes.

## Known Issues

Prevelant known issues with the PDK, for more detailed information, please check the PDK documentation on [puppet.com](https://www.puppet.com/docs/pdk/3.x/pdk).

### v3.4.0

Moving forward, if you are using the installed version of the PDK, if you wish to utilize the inbuilt templates you will have to manually fix their permissions, either by changing their ownership to your local user or by setting them as a safe directory.

```
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
```

## License

This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.
Expand Down
1 change: 1 addition & 0 deletions docs/pdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ validate, and test modules.
<ul>
<li><a class="xref" href="pdk_overview.md">PDK overview and workflow</a></li>
<li><a class="xref" href="pdk_release_notes.md">Release notes</a></li>
<li><a class="xref" href="pdk_known_issues.md">Known issues</a></li>
<li><a class="xref" href="pdk_overview.md#pdk-package">Tools included in PDK</a></li>
</ul>
</p>
Expand Down
4 changes: 3 additions & 1 deletion docs/pdk_known_issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ 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.

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, this can be done with the below command:
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.
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
```

Expand Down