Adding Puppet Forge Modules as Git Submodules

Locate Module on the Forge

Locate the module in question on the forge. The next step is to identify any other unmet dependancies for the forge module and make note of them as well. For example the Chocolatey forge module requires windows_env and powershell as dependancies. Typically googling for the module author, module name, and the word Puppet will turn up the appropriate github result.


Add The Submodule

Adding the submodule is done via the CLI on your local instance.

git submodule add <path to clone from git> <path within Puppet repo>

Generally speaking the path within the Puppet will be modules/<module name>


The below example is for Chocolatey:

git submodule add modules/chocolatey



Init and Update The Submodule

Once you have added the git submodule you will need to initialize and update it using the following commands:

Initialize Submodule
git submodule init
Submodule Update
git submodule update


Commit to Origin

The next step in the process is to commit the changes to our Github instance. Depending on the preferred workflow of the team this can either be done as a Pull Request or committed straight into prod.

Your git status should show changes to the .gitmodules directory.


Pulling to Puppet Master

Pull production to the production environment. This will not initialize or update the module, this will simply update the git module. The steps below will initialize and update the submodule within the production master.

Initialize Submodule
git submodule init
Submodule Update
git submodule update <modulename>

Leave a Reply

Your email address will not be published. Required fields are marked *

12 + 15 =