Skip to content

Commit

Permalink
Add known_issue to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
david22swan committed Nov 29, 2024
1 parent 05e4e29 commit 8195705
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion docs/pdk_known_issues.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# PDK known issues

## PDK 3.4.0 - Issue with utilising bundled templates

We have recently begun seeing an issue with the default bundled templates on certain OSs, with the pdk failing to see them as valid as shown in the below error.

```
pdk (FATAL): Unable to find a valid module template to use.
```

Through investigation this seems most likely to be an issue with a dependency brought in throught Git 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 is a relatively simple solution to get around this however, though it does require a few extra steps and that is to clone down the pdk-template repo onto your machine and target it manually as shown below.

```
pdk new module example --template-url=file:///Users/example.user/Github/pdk-templates --template-ref=3.4.0
pdk update --template-url=file:///Users/example.user/Github/pdk-templates --template-ref=3.4.0
```

Once the first run has been made, the PDK will store your targeted templates location and so your next run should automatically go to it moving forward, until such time as you target another or clear your .pdk cache.

## PDK v3.3.0 requires puppet-modulebuilder

With the v3.3.0 release of the PDK, it has been updated to utilise the [puppet-modulebuilder](https://github.com/puppetlabs/puppet-modulebuilder) with the previously existing duplicated internal code having been removed. As such anyone who uses `PDK::Module::Build` in their setup will need to update their own code to do the same.
Expand All @@ -14,4 +35,4 @@ For more information on how to correct this known issue see the [PDK Troubleshoo

## PDK v3.0.1 Cert expired

This issue was resolved and shipped in PDK v3.1.0, if you are seeing an issue in relation to an expired cert, please upgrade the PDK.
This issue was resolved and shipped in PDK v3.1.0, if you are seeing an issue in relation to an expired cert, please upgrade the PDK.

0 comments on commit 8195705

Please sign in to comment.