Conventions

In this book you will find a number of styles of text that distinguish between different kinds of information. Here are some examples of these styles, and an explanation of their meaning.

Code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles are shown as follows: "For inline documentation about a resource, use the describe subcommand."

A block of code is set as follows:

:backends:
  - http
:http:
  :host: 127.0.0.1
  :port: 5984
  :output: json
  :failure: graceful
  :paths:
    - /configuration/%{fqdn}
    - /configuration/%{env}
    - /configuration/common

Any command-line input or output is written as follows:

puppet agent -t
puppet resource package
puppet resource service

New terms and important words are shown in bold. Words that you see on the screen, in menus or dialog boxes for example, appear in the text like this: "At the end of a Puppet run, we can have metrics that let us understand how much time the Master spent in compiling and delivering the catalog (Config retrieval time)."

Note

Warnings or important notes appear in a box like this.

Tip

Tips and tricks appear like this.