Puppet
Prerequisites
Before you start working with Puppet, make sure that the Puppet Support plugin is enabled. The plugin is bundled with PyCharm and is activated by default. If the plugin is not activated, enable it on the Plugins settings page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.
Also, puppet
gem should be installed on your Ruby SDK.
Puppet support
Puppet files are marked with .
Puppet support in PyCharm includes:
- Compliance with the Puppet Style Guide.
- Syntax and error highlighting.
- Ability to rename Puppet elements.
- Code completion in
*.pp
files. - Configuring code style for Puppet files.
- Structure view:
- Code completion:
Moreover, with the dependencies installed, navigation and completion for each module work in strict accordance with the dependencies. For example, if you are editing a module depending on
puppetlabs-apache
, then you seeapache
in code completion: - Navigation to a class definition, symbol, class or a usage is available:
- Future parser.
- Support for the EPP template language.
- PyCharm correctly identifies the
epp
files, recognizes the native EPP syntax and auto-completes expressions and parameter tags:Moreover, PyCharm allows you to navigate between a manifest and a template called.
- Rename refactoring is available for the variables and parameters in the
epp
files: - Finding usages is available for template files (Alt+F7.)
For more information, see the blog post here.
- PyCharm correctly identifies the
Creating a Puppet module
The project is created in the specified location. So doing, the created project features the structure of a Puppet module. Refer the Puppet documentation for details.
Installing dependencies
There is an action in the Project tool window that enables installing dependencies into a Puppet module:
Puppet modules recognize dependencies from 3 different sources:
- If the file
.fixtures.yml
exists in a Puppet module, then the dependencies are installed into the directoryspec/fixtures/modules
, no other sources being checked. - If a
Puppetfile
exists in a Puppet module, then the dependencies are installed usinglibrarian-puppet
into.dependencies
directory. If aPuppetfile
exists,librarian-puppet
ignores dependencies specified inmetadata.json
. - If a
metadata.json
file exists in a Puppet module, then the dependencies are installed usinglibrarian-puppet
into.dependencies
directory.
Typical workflow
Here’s how it works...
To work with a Puppet project, follow these general steps:
- Open or create a Puppet module.
- If installing dependencies from the files
Puppetfile
ormetadata.json
, make sure that the gem librarian-puppet is installed. If the gem is not yet installed, PyCharm notifies you about the missing gem and suggests to install it:(If the dependencies are installed from
.fixtures.yml
file, this gem is not required, and no notification will be shown.)PyCharm can find all modules/environments in a project automatically, based on dependencies files, and updates the project structure accordingly, if anything has changed. Even if PyCharm fails to update your project structure after installing additional modules into the project using the terminal, you can manually rescan the directory for modules or environments by using Scan for modules and environments action on the context menu.
- Having placed the dependencies in the file
.fixtures.yml
,Puppetfile
ormetadata.json
, right-click the Project Tool Window, and then choose Install dependencies for module <module name> on the context menu.So doing, the dependencies are taken from the files
.fixtures.yml
,Puppetfile
ormetadata.json
, located in the project root. The folder.dependencies
(in case of creating dependencies fromPuppetfile
ormetadata.json
) orspec/fixtures/modules/
(in case of creating dependencies from.fixtures.yml
) is created under the project root, if it didn't exist before.If you want to add more dependencies, invoke this command again.