Puppet Core

https://help.puppet.com/core/current/
Admin
Perforce Puppet Core is an enterprise-ready platform built on open source Puppet, providing...
Tokens:449,832
Snippets:5,555
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Verify firewall module installation

Source: https://help.puppet.com/core/current/Content/PuppetCore/quick_start_firewall.htm

Example output showing the successful installation of the firewall module.

```text
Preparing to install into /etc/puppetlabs/puppet/environments/production/modules ...  
    Notice: Downloading from https://forgeapi.puppetlabs.com ...  
    Notice: Installing -- do not interrupt ...  
    /etc/puppetlabs/puppet/environments/production/modules  
    └── puppetlabs-firewall (v1.6.0)
```

--------------------------------

### Example of command line installer syntax

Source: https://help.puppet.com/core/current/Content/PuppetCore/resources_package_windows.htm

This shows the raw command line syntax for a self-extracting executable installer.

```text
./installer.exe /s /v"MANAGEMENT_SERVER=1.1.1.1 /l*v! c:\temp\log.txt /qn"
```

--------------------------------

### View module installation output

Source: https://help.puppet.com/core/current/Content/PuppetCore/quick_start_ntp.htm

Example output confirming the successful installation of the puppetlabs-ntp module.

```text
 Preparing to install into /etc/puppetlabs/puppet/modules ...  
    Notice: Downloading from http://forgeapi.puppetlabs.com ...  
    Notice: Installing -- do not interrupt ...  
    /etc/puppetlabs/puppet/environments/production/modules  
    └── puppetlabs-ntp (v3.1.2)
```

--------------------------------

### View module installation output

Source: https://help.puppet.com/core/current/Content/PuppetCore/quick_start_sudo.htm

Example output confirming the successful installation of the saz-sudo module and its dependencies.

```text
Preparing to install into /etc/puppetlabs/code/environments/production/modules …  
Notice: Downloading from http://forgeapi.puppetlabs.com ...  
    Notice: Installing -- do not interrupt ...  
    /etc/puppetlabs/puppet/modules  
    └── saz-sudo (v2.3.6)  
          └── puppetlabs-stdlib (3.2.2) [/opt/puppet/share/puppet/modules]
```

--------------------------------

### reduce with start memo examples

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/function.htm

Demonstrates using an explicit start memo value for array and hash reduction.

```puppet
# Reduce the array $data, returning the sum of all values in the array and starting  
# with $memo set to an arbitrary value instead of $data's first value.  
$data = [1, 2, 3]  
$sum = $data.reduce(4) |$memo, $value| { $memo + $value }  
# At the start of the lambda's first iteration, $memo contains 4 and $value contains 1.  
# After all iterations, $sum contains 10.  
  
# Reduce the hash $data, returning the sum of all values and concatenated string of  
# all keys, and starting with $memo set to an arbitrary array instead of $data's first  
# key-value pair.  
$data = {a => 1, b => 2, c => 3}  
$combine = $data.reduce( [d, 4] ) |$memo, $value| {  
  $string = "${memo[0]}${value[0]}"  
  $number = $memo[1] + $value[1]  
  [$string, $number]  
}  
# At the start of the lambda's first iteration, $memo contains [d, 4] and $value  
# contains [a, 1].  
# $combine contains [dabc, 10]
```

--------------------------------

### Manage Windows packages with MSI and EXE

Source: https://help.puppet.com/core/current/Content/PuppetCore/resources_package_windows.htm

Examples of installing MSI and EXE packages using the windows provider with specific install options.

```puppet
package { 'mysql':  
  ensure          => '5.5.16',  
  source          => 'N:\packages\mysql-5.5.16-winx64.msi',  
  install_options => ['INSTALLDIR=C:\mysql-5.5'],  
}  
  
package { "Git version 1.8.4-preview20130916":  
 ensure          => present,  
 source          => 'C:\code\puppetlabs\temp\windowsexample\Git-1.8.4-preview20130916.exe',  
 install_options => ['/VERYSILENT']  
}
```

--------------------------------

### Environments Request and Response Example

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/http_api/http_environments.htm

Example of a successful GET request and the resulting JSON response body.

```http
GET /puppet/v3/environments  
  
HTTP 200 OK  
Content-Type: application/json  
  
{  
  "search_paths": ["/etc/puppetlabs/code/environments"]  
  "environments": {  
    "production": {  
      "settings": {  
        "modulepath": ["/etc/puppetlabs/code/environments/production/modules", "/etc/puppetlabs/code/environments/development/modules"],  
        "manifest": ["/etc/puppetlabs/code/environments/production/manifests"]  
        "environment_timeout": 180,  
        "config_version": "/version/of/config"  
      }  
    }  
  }  
}
```

--------------------------------

### Using install_options for Windows packages

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/package.htm

Demonstrates how to pass additional installation options to a package, such as silent installation flags and custom installation directories for Windows MSI packages.

```puppet
package { 'mysql':  
  ensure          => installed,  
  source          => 'N:/packages/mysql-5.5.16-winx64.msi',  
  install_options => [ '/S', { 'INSTALLDIR' => 'C:\\mysql-5.5' } ],  
}
```

--------------------------------

### Install a specific module version

Source: https://help.puppet.com/core/current/Content/PuppetCore/modules_command_reference.htm

Example command to install a specific version of a module into a testing environment while ignoring dependencies.

```bash
puppet module install --environment testing --ignore-dependencies --version 1.0.0-pre1 --strict-semver false puppetlabs-apache
```

--------------------------------

### Install the agent package

Source: https://help.puppet.com/core/current/Content/PuppetCore/install-macos-agents-from-the-command-line-osp.htm

Runs the installer package to install the Puppet agent on the system.

```bash
sudo installer -pkg puppet-agent-installer.pkg -target /
```

--------------------------------

### Example puppet:/// URL

Source: https://help.puppet.com/core/current/Content/PuppetCore/module_structure.htm

Example URL for a file located at my_module/files/service.conf.

```text
puppet:///modules/my_module/service.conf
```

--------------------------------

### Start interactive Ruby REPL

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/subcommands.htm

Launches the JRuby REPL for experimenting with Puppet and installed gems.

```bash
$ puppetserver irb  
irb(main):001:0> require 'puppet'  
=> true  
irb(main):002:0> puts Puppet[:certname]  
centos6-64.localdomain  
=> nil
```

```bash
$ lein irb -c /path/to/puppetserver.conf -- --version  
irb 0.9.6(09/06/30)
```

--------------------------------

### Define the module installation class

Source: https://help.puppet.com/core/current/Content/PuppetCore/bgtm.htm

The install class handles software installation resources and is typically kept private.

```puppet
class ntp::install {  
  
  if $ntp::package_manage {  
    package { $ntp::package_name:  
      ensure => $ntp::package_ensure,  
    }  
  }  
}
```

--------------------------------

### Install gems using the Gem client

Source: https://help.puppet.com/core/current/Content/PuppetCore/install_gems.htm

Standard command to install a gem after configuring the source.

```bash
gem install puppet
```

--------------------------------

### Basic String conversion examples

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/function.htm

Simple examples of converting an Integer and an Array to strings.

```puppet
$str = String(10)     # produces '10'  
$str = String([10])    # produces '["10"]'
```

--------------------------------

### Install puppetlabs-firewall module

Source: https://help.puppet.com/core/current/Content/PuppetCore/quick_start_firewall.htm

Command to install the firewall module from the PuppetForge.

```bash
puppet module install puppetlabs-firewall
```

--------------------------------

### Retrieving a file example

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/http_api/http_file_bucket_file.htm

Example request and response for retrieving a file from the bucket.

```http
> GET /puppet/v3/file_bucket_file/md5/4949e56d376cc80ce5387e8e89a75396//home/user/myfile.txt?environment=production HTTP/1.1  
> Accept: application/octet-stream  
  
  
< HTTP/1.1 200 OK  
< Content-Length: 24  
  
< This is the file content
```

--------------------------------

### Install a module

Source: https://help.puppet.com/core/current/Content/PuppetCore/modules_command_reference.htm

Installs a module from the Forge using the username-module_name format.

```bash
puppet module install                       puppetlabs-apache
```

--------------------------------

### Start Puppet Server service

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/install_from_packages.htm

Start the Puppet Server service using systemctl.

```bash
sudo systemctl start puppetserver
```

--------------------------------

### Saving a file example

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/http_api/http_file_bucket_file.htm

Example request and response for saving a file to the bucket.

```http
> PUT /puppet/v3/file_bucket_file/md5/eb61eead90e3b899c6bcbe27ac581660//home/user/myfile.txt?environment=production HTTP/1.1  
  
> Content-Type: application/octet-stream  
> Content-Length: 24  
  
> This is the file content  
  
  
< HTTP/1.1 200 OK
```

--------------------------------

### Numeric conversion examples

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/function.htm

Examples showing how different inputs are converted to Numeric values.

```puppet
$a_number = Numeric(true)        # results in 1  
$a_number = Numeric("0xFF")      # results in 255  
$a_number = Numeric("010")       # results in 8  
$a_number = Numeric("3.14")      # results in 3.14 (a float)  
$a_number = Numeric(-42.3, true) # results in 42.3  
$a_number = Numeric(-42, true)   # results in 42  
```

--------------------------------

### Common puppet apply command examples

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/apply.htm

Examples demonstrating how to execute Puppet code, apply manifests from files, use module paths, and apply pre-compiled JSON catalogs.

```bash
$ puppet apply -e 'notify { "hello world": }'  
$ puppet apply -l /tmp/manifest.log manifest.pp  
$ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"  
$ puppet apply --catalog catalog.json  
```

--------------------------------

### Configure install_options for Windows MSI

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/type.htm

Demonstrates passing installation options as an array of strings and hashes to a package resource. Note that backslashes in paths must be escaped in double-quoted strings.

```puppet
package { 'mysql':  
  ensure          => installed,  
  source          => 'N:/packages/mysql-5.5.16-winx64.msi',  
  install_options => [ '/S', { 'INSTALLDIR' => 'C:\mysql-5.5' } ],  
}
```

--------------------------------

### Example routes.yaml configuration

Source: https://help.puppet.com/core/current/Content/PuppetCore/config_file_routes.htm

A basic configuration example showing how to set a terminus and cache for facts.

```yaml
---
server:
facts:
terminus: puppetdb
cache: yaml
```

--------------------------------

### Install gems using the Bundle client

Source: https://help.puppet.com/core/current/Content/PuppetCore/install_gems.htm

Execute the installation command to fetch gems from the configured source.

```bash
bundle install
```

--------------------------------

### GET /status/v1/simple request and response

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/http_api/status-api/v1/simple.htm

Example of a successful GET request to the simple status endpoint returning a plain text status.

```http
GET /status/v1/simple  
  
HTTP/1.1 200 OK  
Content-Type: application/json  
  
running
```

--------------------------------

### Define Module Impact

Source: https://help.puppet.com/core/current/Content/PuppetCore/modules_readme.htm

Example of documenting potential side effects or file overwrites in the setup section.

```markdown
## Setup  
  
### What cat affects  
  
* Your dog door might be overwritten if not secured before installation.
```

--------------------------------

### Manage SSH with package, file, and service resources

Source: https://help.puppet.com/core/current/Content/PuppetCore/the_trifecta.htm

Demonstrates the standard pattern of installing a package, configuring its file, and ensuring the associated service is running. Uses notify and require metaparameters to manage resource ordering and service restarts.

```puppet
package { 'openssh-server':  
  ensure => installed,  
}  
  
file { '/etc/ssh/sshd_config':  
  source  => 'puppet:///modules/sshd/sshd_config',  
  owner   => 'root',  
  group   => 'root',  
  mode    => '0640',  
  notify  => Service['sshd'], # sshd restarts whenever you edit this file.  
  require => Package['openssh-server'],  
}  
  
service { 'sshd':  
  ensure    => running,  
  enable    => true,  
}
```

--------------------------------

### Example resource state hash

Source: https://help.puppet.com/core/current/Content/PuppetCore/writing_the_type_and_provider.htm

The get method returns an array of hashes representing the current state of resources on the system.

```ruby
[  
  {  
    name: 'a',  
    ensure: 'present',  
  },  
  {  
    name: 'b',  
    ensure: 'present',  
  },  
]
```

--------------------------------

### GET /status/v1/services debug request

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/http_api/status-api/v1/services.htm

Example of a debug-level request to the services endpoint and the corresponding JSON response containing JVM metrics.

```http
GET /status/v1/services?level=debug  
  
HTTP/1.1 200 OK  
Content-Type: application/json  
  
{  
  "status-service": {  
    "detail_level": "debug",  
      "service_status_version": 1,  
      "service_version": "0.3.5",  
      "state": "running",  
      "status": {  
        "experimental": {  
          "jvm-metrics": {  
            "heap-memory": {  
              "committed": 1049100288,  
              "init": 268435456,  
              "max": 1908932608,  
              "used": 216512656  
            },  
            "non-heap-memory": {  
              "committed": 256466944,  
              "init": 2555904,  
              "max": -1,  
              "used": 173201432  
            },  
            "start-time-ms": 1472496731281,  
            "up-time-ms": 538974  
          }  
        }  
      }  
    }  
}
```

--------------------------------

### Example node retrieval request and response

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/http_api/http_node.htm

Demonstrates a successful GET request to the node endpoint and the resulting JSON response structure.

```http
> GET /puppet/v3/node/mycertname?environment=production&transaction_uuid=aff261a2-1a34-4647-8c20-ff662ec11c4c&configured_environment=production HTTP/1.1  
> Accept: application/json, text/pson  
  
< HTTP/1.1 200 OK  
< Content-Type: application/json  
< Content-Length: 4630  
  
{  
	"name":"thinky.corp.puppetlabs.net",  
	"parameters":{  
		"architecture":"amd64",  
		"kernel":"Linux",  
		"blockdevices":"sda,sr0",  
		"clientversion":"3.3.1",  
		"clientnoop":"false",  
		"environment":"production",  
		...  
	},  
	"environment":"production"  
}
```

--------------------------------

### Defining a weekday-restricted schedule

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/type.htm

Example of a schedule restricted to a specific day of the week, noting that ranges spanning midnight match the start day.

```puppet
schedule { 'maintenance_window':  
	range   => '22:00 - 04:00',  
	weekday => 'Saturday',  
}
```

--------------------------------

### Specify configuration settings on the command line

Source: https://help.puppet.com/core/current/Content/PuppetCore/config_about_settings.htm

Demonstrates equivalent ways to pass configuration values via command-line arguments.

```text
--certname=temporary-name.example.com
```

```text
--certname temporary-name.example.com
```

```text
--certname "temporary-name.example.com"
```

--------------------------------

### Example puppet.conf file

Source: https://help.puppet.com/core/current/Content/PuppetCore/config_set.htm

A sample configuration file structure showing main, agent, and server sections.

```ini
[main]  
certname = agent01.example.com  
server = server.example.com  
vardir = /var/opt/lib/pe-puppet  
  
[agent]  
report = true  
graph = true  
pluginsync = true  
  
[server]  
dns_alt_names = server,server.example.com,puppet,puppet.example.com
```

--------------------------------

### Install YARD gem

Source: https://help.puppet.com/core/current/Content/PuppetCore/puppet_strings_install.htm

Install the required YARD dependency before installing Puppet Strings.

```bash
gem install yard
```

--------------------------------

### Verify the installation

Source: https://help.puppet.com/core/current/Content/PuppetCore/install-macos-agents-from-the-command-line-osp.htm

Checks the installed version of the Puppet agent to confirm successful installation.

```bash
/opt/puppetlabs/bin/puppet --version
```

--------------------------------

### Example environment.conf configuration

Source: https://help.puppet.com/core/current/Content/PuppetCore/config_file_environment.htm

Defines the module path and config version script for a specific environment.

```ini
# /etc/puppetlabs/code/environments/test/environment.conf  
  
# Puppet Enterprise requires $basemodulepath; see note below under "modulepath".  
modulepath = site:dist:modules:$basemodulepath  
  
# Use our custom script to get a git commit for the current state of the code:  
config_version = get_environment_commit.sh
```

--------------------------------

### Puppet syntax for complex install options

Source: https://help.puppet.com/core/current/Content/PuppetCore/resources_package_windows.htm

This demonstrates how to split strings with spaces into an array for the install_options attribute.

```puppet
install_options => [ '/s',  
    "/v\"MANAGEMENT_SERVER=${management_server}",  
    '/l*v!',  
    "${install_log}",  
    '/qn',  
    '"'  
  ],
```

--------------------------------

### Install Facter via RubyGems

Source: https://help.puppet.com/core/current/Content/PuppetCore/facter.htm

Use this command to install the Facter gem if Ruby is already installed on your system.

```bash
gem install facter
```

--------------------------------

### Implement prefix function calls

Source: https://help.puppet.com/core/current/Content/PuppetCore/lang_functions_syntax.htm

Example demonstrating the use of template, include, and each functions using prefix syntax.

```puppet
file {"/etc/ntp.conf":  
  ensure  => file,  
  content => template("ntp/ntp.conf.erb"), # function call; resolves to a string  
}  
  
include apache # function call; modifies catalog  
  
$binaries = [  
  "facter",  
  "hiera",  
  "mco",  
  "puppet",  
  "puppetserver",  
]  
  
# function call with lambda; runs block of code several times  
each($binaries) |$binary| {  
  file {"/usr/bin/$binary":  
    ensure => link,  
    target => "/opt/puppetlabs/bin/$binary",  
  }  
}
```

--------------------------------

### List installed gems

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/gems.htm

Commands to view gems installed in the Puppet Server environment, including a variant for source installations.

```bash
$ puppetserver gem list
```

```bash
$ lein gem -c ~/.puppetserver/puppetserver.conf list
```

--------------------------------

### Install ruby-debug gem

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/dev_debugging.htm

Commands to install the ruby-debug gem for either a standard Puppet Server installation or when running from source.

```bash
$ sudo puppetserver gem install ruby-debug
```

```bash
$ lein gem -c /path/to/puppetserver.conf install ruby-debug
```

--------------------------------

### Download and install the release package

Source: https://help.puppet.com/core/current/Content/PuppetCore/enable_the_puppet_platform_apt.htm

Use these commands to download the repository release package and install it using dpkg.

```bash
wget --content-disposition <PACKAGE_URL>  
sudo dpkg -i <FILE_NAME>.deb
```

```bash
wget --content-disposition https://apt-puppetcore.puppet.com/public/puppet8-release-focal.deb  
sudo dpkg -i puppet8-release-focal.deb
```

--------------------------------

### Install Puppet module from tarball

Source: https://help.puppet.com/core/current/Content/PuppetCore/modules_installing_from_commandline.htm

Use the puppet module install command to install a downloaded tarball directly into a specified module path.

```bash
puppet module install ./puppetlabs-cem_linux-1.6.1.tar.gz --ignore-dependencies --modulepath </path/to/your/modules>
```

--------------------------------

### Example Hiera 4 configuration file

Source: https://help.puppet.com/core/current/Content/PuppetCore/convert_experimental_hiera_yaml.htm

A sample configuration file using the experimental Hiera 4 format.

```yaml
# /etc/puppetlabs/code/environments/production/hiera.yaml  
---  
version: 4  
datadir: data  
hierarchy:  
  - name: "Nodes"  
    backend: yaml  
    path: "nodes/%{trusted.certname}"  
  
  - name: "Exported JSON nodes"  
    backend: json  
    paths:  
      - "nodes/%{trusted.certname}"  
      - "insecure_nodes/%{facts.networking.fqdn}"  
  
  - name: "virtual/%{facts.virtual}"  
    backend: yaml  
  
  - name: "common"  
    backend: yaml
```

--------------------------------

### Install a module

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/module.htm

Installs a module from the Puppet Forge.

```bash
$ puppet module install puppetlabs-vcsrepo Preparing to install into /etc/puppetlabs/code/modules ... Downloading from https://forgeapi.puppet.com ... Installing -- do not interrupt ... /etc/puppetlabs/code/modules └── puppetlabs-vcsrepo (v0.0.4)
```

--------------------------------

### Complete Hiera 5 Configuration Example

Source: https://help.puppet.com/core/current/Content/PuppetCore/convert_hiera_yaml.htm

A full example of a version 5 hiera.yaml file incorporating legacy backends, eyaml, and standard YAML hierarchy levels.

```yaml
version: 5  
defaults:  
  datadir: data  
  data_hash: yaml_data  
hierarchy:  
  - name: "Per-node data (yaml version)"  
    path: "nodes/%{trusted.certname}.yaml" # Add file extension  
    # Omitting datadir and data_hash to use defaults.  
  
  - name: "Per-node data (MongoDB version)"  
    path: "nodes/%{trusted.certname}"      # No file extension  
    hiera3_backend: mongodb  
    options:    # Use old backend-specific options, changing keys to plain strings  
      connections:  
        dbname: hdata  
        collection: config  
        host: localhost  
  
  - name: "Per-group secrets"  
    path: "groups/%{facts.group}.eyaml"  
    lookup_key: eyaml_lookup_key  
    options:  
      pkcs7_private_key: /etc/puppetlabs/puppet/eyaml/private_key.pkcs7.pem  
      pkcs7_public_key:  /etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem  
  
  - name: "Other YAML hierarchy levels"  
    paths: # Can specify an array of paths instead of a single one.  
      - "location/%{facts.whereami}/%{facts.group}.yaml"  
      - "groups/%{facts.group}.yaml"  
      - "os/%{facts.os.family}.yaml"  
      - "common.yaml"
```

--------------------------------

### Generate documentation for specific manifest files

Source: https://help.puppet.com/core/current/Content/PuppetCore/puppet_strings_reference.htm

Example of generating documentation for only the specified manifest files.

```bash
puppet strings generate manifest1.pp manifest2.pp
```

--------------------------------

### Install hiera-eyaml

Source: https://help.puppet.com/core/current/Content/PuppetCore/securing-sensitive-data.htm

Install the hiera-eyaml gem using the puppetserver command.

```bash
puppetserver gem install hiera-eyaml
```

--------------------------------

### Example fileserver.conf mount point

Source: https://help.puppet.com/core/current/Content/PuppetCore/file_serving.htm

A concrete example of mapping a local directory to a Puppet mount point.

```text
[installer_files]  
path /etc/puppetlabs/puppet/installer_files 
```

--------------------------------

### Regexp Data Type Examples

Source: https://help.puppet.com/core/current/Content/PuppetCore/lang_data_regexp_type.htm

Examples showing how to match any regular expression or a specific one.

```puppet
Regexp
```

```puppet
Regexp[/<regex>/]
```

--------------------------------

### List installed modules

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/module.htm

Lists all modules currently installed in the modulepath.

```bash
$ puppet module list /etc/puppetlabs/code/modules ├── bodepd-create_resources (v0.0.1) ├── puppetlabs-bacula (v0.0.2) ├── puppetlabs-mysql (v0.0.1) ├── puppetlabs-sqlite (v0.0.1) └── puppetlabs-stdlib (v2.2.1) /opt/puppetlabs/puppet/modules (no modules installed)
```

--------------------------------

### Example Hiera 3 configuration file

Source: https://help.puppet.com/core/current/Content/PuppetCore/convert_hiera_yaml.htm

A sample version 3 hiera.yaml file using Ruby symbols as keys and legacy backend configurations.

```yaml
:backends:  
  - mongodb  
  - eyaml  
  - yaml  
:yaml:  
  :datadir: "/etc/puppetlabs/code/environments/%{environment}/hieradata"  
:mongodb:  
  :connections:  
    :dbname: hdata  
    :collection: config  
    :host: localhost  
:eyaml:  
  :datadir: "/etc/puppetlabs/code/environments/%{environment}/hieradata"  
  :pkcs7_private_key: /etc/puppetlabs/puppet/eyaml/private_key.pkcs7.pem  
  :pkcs7_public_key:  /etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem  
:hierarchy:  
  - "nodes/%{trusted.certname}"  
  - "location/%{facts.whereami}/%{facts.group}"  
  - "groups/%{facts.group}"  
  - "os/%{facts.os.family}"  
  - "common"  
:logger: console  
:merge_behavior: native  
:deep_merge_options: {}
```

--------------------------------

### Start Puppet agent service

Source: https://help.puppet.com/core/current/Content/PuppetCore/clear_regenerate_certs_on_primary_server.htm

Starts the Puppet agent service.

```bash
sudo puppet resource service puppet ensure=running
```

--------------------------------

### Verify Puppet Server installation

Source: https://help.puppet.com/core/current/Content/PuppetCore/server/install_from_packages.htm

Check the installed version of Puppet Server.

```bash
puppetserver -v
```

--------------------------------

### Instantiate SemVer objects

Source: https://help.puppet.com/core/current/Content/PuppetCore/lang_data_abstract_flexible.htm

Examples of creating SemVer instances using different input formats.

```puppet
SemVer.new("1.2.3")
```

```puppet
SemVer.new(1, 2, 3, "rc4",                                                   "5")
```

```puppet
SemVer.new(major => 1,                                                   minor => 2, patch => 3, prerelease => "rc4", build                                                   =>"5")
```

--------------------------------

### Install a module from the Forge

Source: https://help.puppet.com/core/current/Content/PuppetCore/modules_installing_from_commandline.htm

Installs a module and its dependencies into the default modulepath directory.

```bash
puppet module install puppetlabs-apache
```

--------------------------------

### Compare Hiera 3 and Hiera 5 Configuration

Source: https://help.puppet.com/core/current/Content/PuppetCore/legacy_hiera_3_backends.htm

Example showing the translation of a legacy v3 hiera.yaml configuration into the equivalent v5 format using the hiera3_backend key.

```yaml
# hiera.yaml v3  
---  
:backends:  
  - mongodb  
  - xml  
  
:mongodb:  
  :connections:  
    :dbname: hdata  
    :collection: config  
    :host: localhost  
  
:xml:  
  :datadir: /some/other/dir  
  
:hierarchy:  
  - "%{trusted.certname}"  
  - "common"  
  
  
# hiera.yaml v5  
---  
version: 5  
hierarchy:  
  - name: MongoDB  
    hiera3_backend: mongodb  
    paths:  
      - "%{trusted.certname}"  
      - common  
    options:  
      connections:  
        dbname: hdata  
        collection: config  
        host: localhost  
  
  - name: Data in XML  
    hiera3_backend: xml  
    datadir: /some/other/dir  
    paths:  
      - "%{trusted.certname}.xml"  
      - common.xml
```

--------------------------------

### Apply puppet configuration

Source: https://help.puppet.com/core/current/Content/PuppetCore/lang_scope_override.htm

Shows the output of the variable override example when applied.

```bash
$ puppet apply site.pp  
notice: Message from here: Hi, I'm local!
```

--------------------------------

### Install a module to a specific environment

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/module.htm

Installs a module into a designated environment directory.

```bash
$ puppet module install puppetlabs-vcsrepo --environment development Preparing to install into /etc/puppetlabs/code/environments/development/modules ... Downloading from https://forgeapi.puppet.com ... Installing -- do not interrupt ... /etc/puppetlabs/code/environments/development/modules └── puppetlabs-vcsrepo (v0.0.4)
```

--------------------------------

### puppet module install

Source: https://help.puppet.com/core/current/Content/PuppetCore/Markdown/module.htm

Installs a module from the Puppet Forge or a release archive.

```APIDOC
## puppet module install

### Description
Installs a module from the Puppet Forge or from a release archive file.

### Parameters
- **name** (string) - Required - The name of the module to install.
- **--force | -f** (flag) - Optional - Force overwrite of existing module.
- **--ignore-dependencies** (flag) - Optional - Do not attempt to install dependencies.
- **--target-dir DIR | -i DIR** (string) - Optional - The directory into which modules are installed.
- **--version VER | -v VER** (string) - Optional - Module version to install.

### Returns
- Pathname object representing the path to the installed module.
```
Tokens:
Raw