A newer version of PuppetDB has been released, and this documentation is no longer maintained.
2 | 6 | -------------------------------------------------------------------------------- /source/_includes/de_pe.html: -------------------------------------------------------------------------------- 1 |A newer version of Puppet Enterprise has been released!
2 || Puppet Collection | puppet-agent | puppetserver | puppetdb | 5 |
|---|---|---|---|
| PC 1 | 1.3.2 | 2.2.0 | 3.2 |
USAGE: puppet help action
10 | 11 |Display Puppet help.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | help Display help about Puppet subcommands and their actions.
20 | 21 |See 'puppet help help' or 'man puppet-help' for full help.
22 | 23 |USAGE: puppet help action
10 | 11 |Display Puppet help.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | help Display help about Puppet subcommands and their actions.
20 | 21 |See 'puppet help help' or 'man puppet-help' for full help.
22 | 23 |USAGE: puppet generate action
10 | 11 |Generates Puppet code from Ruby definitions.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | types Generates Puppet code for custom types
20 | 21 |See 'puppet help generate' or 'man puppet-generate' for full help.
22 | 23 |USAGE: puppet generate action
10 | 11 |Generates Puppet code from Ruby definitions.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | types Generates Puppet code for custom types
20 | 21 |See 'puppet help generate' or 'man puppet-generate' for full help.
22 | 23 |USAGE: puppet plugin action
10 | 11 |This subcommand provides network access to the puppet master's store of 12 | plugins.
13 | 14 |OPTIONS: 15 | --render-as FORMAT - The rendering format to use. 16 | --verbose - Whether to log verbosely. 17 | --debug - Whether to log debug information.
18 | 19 |ACTIONS: 20 | download Download plugins from the puppet master.
21 | 22 |See 'puppet help plugin' or 'man puppet-plugin' for full help.
23 | 24 |USAGE: puppet plugin action
10 | 11 |This subcommand provides network access to the puppet master's store of 12 | plugins.
13 | 14 |OPTIONS: 15 | --render-as FORMAT - The rendering format to use. 16 | --verbose - Whether to log verbosely. 17 | --debug - Whether to log debug information.
18 | 19 |ACTIONS: 20 | download Download plugins from the puppet master.
21 | 22 |See 'puppet help plugin' or 'man puppet-plugin' for full help.
23 | 24 |USAGE: puppet parser action
10 | 11 |Interact directly with the parser.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | dump Outputs a dump of the internal parse tree for debugging 20 | validate Validate the syntax of one or more Puppet manifests.
21 | 22 |See 'puppet help parser' or 'man puppet-parser' for full help.
23 | 24 |USAGE: puppet parser action
10 | 11 |Interact directly with the parser.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | dump Outputs a dump of the internal parse tree for debugging 20 | validate Validate the syntax of one or more Puppet manifests.
21 | 22 |See 'puppet help parser' or 'man puppet-parser' for full help.
23 | 24 |USAGE: puppet epp action
10 | 11 |Interact directly with the EPP template parser/renderer.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | dump Outputs a dump of the internal template parse tree for debugging 20 | render Renders an epp template as text 21 | validate Validate the syntax of one or more EPP templates.
22 | 23 |See 'puppet help epp' or 'man puppet-epp' for full help.
24 | 25 |USAGE: puppet epp action
10 | 11 |Interact directly with the EPP template parser/renderer.
12 | 13 |OPTIONS: 14 | --render-as FORMAT - The rendering format to use. 15 | --verbose - Whether to log verbosely. 16 | --debug - Whether to log debug information.
17 | 18 |ACTIONS: 19 | dump Outputs a dump of the internal template parse tree for debugging 20 | render Renders an epp template as text 21 | validate Validate the syntax of one or more EPP templates.
22 | 23 |See 'puppet help epp' or 'man puppet-epp' for full help.
24 | 25 |.deb`. (For Ubuntu releases, the code name is the adjective, not the animal.)
5 | * Architecture is handled automatically; there is only one package per OS version.
6 | 2. Install the package by running `dpkg -i `.
7 | 3. Run `apt-get update` to get the new list of available packages.
8 |
9 | For example, to enable the repository for Ubuntu 12.04 Precise Pangolin:
10 |
11 | wget https://apt.puppetlabs.com/puppetlabs-release-precise.deb
12 | sudo dpkg -i puppetlabs-release-precise.deb
13 | sudo apt-get update
14 |
15 | To enable the repository for Ubuntu 14.04 Trusty Tahr:
16 |
17 | wget https://apt.puppetlabs.com/puppetlabs-release-trusty.deb
18 | sudo dpkg -i puppetlabs-release-trusty.deb
19 | sudo apt-get update
20 |
--------------------------------------------------------------------------------
/source/_includes/learning_nav.html:
--------------------------------------------------------------------------------
1 |
2 | - Introduction
3 | - Part one: Serverless Puppet
4 |
5 | - Resources and the RAL
6 | - Manifests
7 | - Ordering
8 | - Variables, Conditionals, Facts
9 | - Modules and Classes
10 | - Templates
11 | - Class Parameters
12 | - Defined Types
13 |
14 |
15 | - Part two: Master/Agent Puppet
16 |
17 | - Preparing an Agent VM
18 | - Basic Agent/Master Puppet
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/source/_includes/pup40_platforms_windows.markdown:
--------------------------------------------------------------------------------
1 | We publish and test official `puppet-agent` packages for the following versions of Windows:
2 |
3 | * Windows Server 2012 R2 (also supported by [Puppet Enterprise][peinstall])
4 | * Windows Server 2008 R2 (also supported by [Puppet Enterprise][peinstall])
5 | * Windows Server 2003 R2 (also supported by [Puppet Enterprise][peinstall])
6 |
7 | We also publish, but do not automatically test, `puppet-agent` packages for the following versions of Windows:
8 |
9 | * Windows Server 2012 (also supported by [Puppet Enterprise][peinstall])
10 | * Windows Server 2008 (also supported by [Puppet Enterprise][peinstall])
11 | * Windows Server 2003 (also supported by [Puppet Enterprise][peinstall])
12 | * Windows 7 and 8 (also supported by [Puppet Enterprise][peinstall])
13 | * Windows 8.1 (also supported by [Puppet Enterprise][peinstall])
14 | * Windows Vista
15 |
16 | [peinstall]: /pe/latest/install_windows.html
17 |
--------------------------------------------------------------------------------
/source/_includes/pup42_platforms_windows.markdown:
--------------------------------------------------------------------------------
1 | We publish and test official `puppet-agent` packages for the following versions of Windows:
2 |
3 | * Windows Server 2012 R2 (also supported by [Puppet Enterprise][peinstall])
4 | * Windows Server 2008 R2 (also supported by [Puppet Enterprise][peinstall])
5 | * Windows Server 2003 R2 (also supported by [Puppet Enterprise][peinstall])
6 |
7 | We also publish, but do not automatically test, `puppet-agent` packages for the following versions of Windows:
8 |
9 | * Windows Server 2012 (also supported by [Puppet Enterprise][peinstall])
10 | * Windows Server 2008 (also supported by [Puppet Enterprise][peinstall])
11 | * Windows Server 2003 (also supported by [Puppet Enterprise][peinstall])
12 | * Windows 7 and 8 (also supported by [Puppet Enterprise][peinstall])
13 | * Windows 8.1 (also supported by [Puppet Enterprise][peinstall])
14 | * Windows Vista
15 |
16 | [peinstall]: /pe/latest/install_windows.html
17 |
--------------------------------------------------------------------------------
/source/_includes/pup43_platforms_windows.markdown:
--------------------------------------------------------------------------------
1 | We publish and test official [`puppet-agent`](/puppet/latest/reference/about_agent.html) packages for the following versions of Windows:
2 |
3 | * Windows Server 2012 R2 (also supported by [Puppet Enterprise][peinstall])
4 | * Windows Server 2008 R2 (also supported by [Puppet Enterprise][peinstall])
5 |
6 | We also publish, but do not automatically test, `puppet-agent` packages for the following versions of Windows:
7 |
8 | * Windows Server 2012 (also supported by [Puppet Enterprise][peinstall])
9 | * Windows Server 2008 (also supported by [Puppet Enterprise][peinstall])
10 | * Windows 8.1 (also supported by [Puppet Enterprise][peinstall])
11 | * Windows 8 (also supported by [Puppet Enterprise][peinstall])
12 | * Windows 7 (also supported by [Puppet Enterprise][peinstall])
13 | * Windows Vista (also supported by [Puppet Enterprise][peinstall])
14 |
15 | [peinstall]: /pe/latest/install_windows.html
16 |
--------------------------------------------------------------------------------
/lib/puppet_references/facter/core_facts.rb:
--------------------------------------------------------------------------------
1 | require 'puppet_references'
2 | module PuppetReferences
3 | module Facter
4 | class CoreFacts < PuppetReferences::Reference
5 | OUTPUT_DIR = PuppetReferences::OUTPUT_DIR + 'facter'
6 | PREAMBLE_FILE = Pathname.new(__FILE__).dirname + 'core_facts_preamble.md'
7 | PREAMBLE = PREAMBLE_FILE.read
8 |
9 | def initialize(*args)
10 | @latest = '/puppet/latest'
11 | super(*args)
12 | end
13 |
14 | def build_all
15 | puts 'Core facts: building reference.'
16 | OUTPUT_DIR.mkpath
17 | raw_text = `ruby #{PuppetReferences::FACTER_DIR}/lib/docs/generate.rb`
18 | header_data = {title: 'Facter: Core Facts',
19 | toc: 'columns',
20 | canonical: "#{@latest}/core_facts.html"}
21 | content = make_header(header_data) + PREAMBLE + raw_text
22 | filename = OUTPUT_DIR + 'core_facts.md'
23 | filename.open('w') {|f| f.write(content)}
24 | puts 'Core facts: done!'
25 | end
26 |
27 | end
28 | end
29 | end
--------------------------------------------------------------------------------
/source/_includes/puppet-collections/_puppet_collection_1_yum.md:
--------------------------------------------------------------------------------
1 | To enable the Puppet Collection 1 repository, first choose the package based on your operating system and version. The packages are located in the [`yum.puppetlabs.com`](https://yum.puppetlabs.com) repository and named using the following convention:
2 |
3 | puppetlabs-release---.noarch.rpm
4 |
5 | For instance, the package for Puppet Collection 1 on Red Hat Enterprise Linux 7 (RHEL 7) is `puppetlabs-release-pc1-el-7.noarch.rpm`.
6 |
7 | Next, use the `rpm` tool as root with the `upgrade` (`-U`) flag, and optionally the `verbose` (`-v`), and `hash` (`-h`) flags:
8 |
9 | sudo rpm -Uvh https://yum.puppetlabs.com/puppetlabs-release-pc1-el-7.noarch.rpm
10 |
11 | The `rpm` tool outputs its progress:
12 |
13 | Retrieving https://yum.puppetlabs.com/puppetlabs-release-pc1-el-7.noarch.rpm
14 | Preparing... ################################# [100%]
15 | Updating / installing...
16 | 1:puppetlabs-release-pc1-0.9.2-1.el################################# [100%]
--------------------------------------------------------------------------------
/source/puppet/6.y/schemas/facts.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "http://json-schema.org/draft-04/schema#",
3 | "title": "Catalog facts",
4 | "description": "Facts parameter in a POST to retrieve a catalog",
5 | "type": "object",
6 | "properties": {
7 | "name": {
8 | "type": "string"
9 | },
10 | "values": {
11 | "description": "The facts for the specified node",
12 | "type": "object",
13 | "patternProperties": {
14 | "^[a-z][a-z0-9_]*$": {}
15 | },
16 | "additionalProperties": false
17 | },
18 | "timestamp": {
19 | "description": "When the facts were gathered; NB doesn't adhere to json 'date-time' format.",
20 | "type": "string"
21 | },
22 | "expiration": {
23 | "description": "When the facts will expire; NB doesn't adhere to json 'date-time' format",
24 | "type": "string"
25 | }
26 | },
27 | "required": ["name", "values", "timestamp", "expiration"],
28 | "additionalProperties": false
29 | }
30 |
--------------------------------------------------------------------------------
/source/puppet/6.y/http_api/http_status.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 922313f3b1cc7f14c799bddb4e354e45b29be180
4 | title: 'Puppet HTTP API: Status'
5 | canonical: "/puppet/latest/http_api/http_status.html"
6 | ---
7 |
8 | Status
9 | =============
10 |
11 | The `status` endpoint provides information about a running master.
12 |
13 | Find
14 | ----
15 |
16 | Get status for a master
17 |
18 | GET /puppet/v3/status/:name?environment=:environment
19 |
20 | The `environment` parameter and the `:name` are both required, but have no
21 | effect on the response. The `environment` must be a valid environment.
22 |
23 | ### Supported HTTP Methods
24 |
25 | GET
26 |
27 | ### Supported Response Formats
28 |
29 | `application/json`, `text/pson`
30 |
31 | ### Parameters
32 |
33 | None
34 |
35 | ### Example Response
36 |
37 | GET /puppet/v3/status/whatever?environment=env
38 |
39 | HTTP 200 OK
40 | Content-Type: application/json
41 |
42 | {"is_alive":true,"version":"3.3.2"}
43 |
44 | Schema
45 | ------
46 |
47 | A status response body conforms to [the status schema.](../schemas/status.json)
48 |
--------------------------------------------------------------------------------
/source/puppet/latest/schemas/facts.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "http://json-schema.org/draft-04/schema#",
3 | "title": "Catalog facts",
4 | "description": "Facts parameter in a POST to retrieve a catalog",
5 | "type": "object",
6 | "properties": {
7 | "name": {
8 | "type": "string"
9 | },
10 | "values": {
11 | "description": "The facts for the specified node",
12 | "type": "object",
13 | "patternProperties": {
14 | "^[a-z][a-z0-9_]*$": {}
15 | },
16 | "additionalProperties": false
17 | },
18 | "timestamp": {
19 | "description": "When the facts were gathered; NB doesn't adhere to json 'date-time' format.",
20 | "type": "string"
21 | },
22 | "expiration": {
23 | "description": "When the facts will expire; NB doesn't adhere to json 'date-time' format",
24 | "type": "string"
25 | }
26 | },
27 | "required": ["name", "values", "timestamp", "expiration"],
28 | "additionalProperties": false
29 | }
30 |
--------------------------------------------------------------------------------
/source/_includes/ja_learning_nav.html:
--------------------------------------------------------------------------------
1 |
2 | - Puppet Labs 日本語ホーム
3 | - Puppetを学ぶ
4 |
- パート1：サーバレス方式のPuppet
5 |
6 | - リソースとRAL
7 | - マニフェスト
8 | - 順序性
9 | - 変数、条件、Facts
10 | - モジュールとクラス(パート1)
11 | - テンプレート
12 | - パラメータ化クラス(パート2)
13 | - 定義型
14 |
15 |
16 | - パート2：Master/Agent方式のPuppet
17 |
18 | - Agent用VMの準備
19 | - Agent/Master方式Puppetの基礎
20 |
21 |
22 |
--------------------------------------------------------------------------------
/source/puppet/6.y/man/config.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet config'
5 | canonical: "/puppet/latest/man/config.html"
6 | ---
7 |
8 |
9 | USAGE: puppet config action [--section SECTION_NAME]
10 |
11 | This subcommand can inspect and modify settings from Puppet's
12 | 'puppet.conf' configuration file. For documentation about individual settings,
13 | see https://puppet.com/docs/puppet/latest/configuration.html.
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --section SECTION_NAME - The section of the configuration file to
20 | interact with.
21 |
22 | ACTIONS:
23 | delete Delete a Puppet setting.
24 | print Examine Puppet's current settings.
25 | set Set Puppet's settings.
26 |
27 | See 'puppet help config' or 'man puppet-config' for full help.
28 |
29 |
30 |
--------------------------------------------------------------------------------
/source/puppet/latest/man/config.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 221ddc1eb591dc76585f70699c4f5848396204fb
4 | title: 'Man Page: puppet config'
5 | canonical: "/puppet/latest/man/config.html"
6 | ---
7 |
8 |
9 | USAGE: puppet config action [--section SECTION_NAME]
10 |
11 | This subcommand can inspect and modify settings from Puppet's
12 | 'puppet.conf' configuration file. For documentation about individual settings,
13 | see https://puppet.com/docs/puppet/latest/configuration.html.
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --section SECTION_NAME - The section of the configuration file to
20 | interact with.
21 |
22 | ACTIONS:
23 | delete Delete a Puppet setting.
24 | print Examine Puppet's current settings.
25 | set Set Puppet's settings.
26 |
27 | See 'puppet help config' or 'man puppet-config' for full help.
28 |
29 |
30 |
--------------------------------------------------------------------------------
/source/_includes/pup45_platforms_windows.markdown:
--------------------------------------------------------------------------------
1 | We publish and test official [`puppet-agent`](/puppet/latest/reference/about_agent.html) packages for the following versions of Windows:
2 |
3 | * Windows Server 2012 R2 (also supported by [Puppet Enterprise][peinstall])
4 | * Windows Server 2008 R2 (also supported by [Puppet Enterprise][peinstall])
5 | * Windows 10 Enterprise (also supported by [Puppet Enterprise][peinstall])
6 |
7 | We also publish, but do not automatically test, `puppet-agent` packages for the following versions of Windows:
8 |
9 | * Windows Server 2012 (also supported by [Puppet Enterprise][peinstall])
10 | * Windows Server 2008 (also supported by [Puppet Enterprise][peinstall])
11 | * Windows 8.1 (also supported by [Puppet Enterprise][peinstall])
12 | * Windows 8 (also supported by [Puppet Enterprise][peinstall])
13 | * Windows 7 (also supported by [Puppet Enterprise][peinstall])
14 | * Windows Vista (also supported by [Puppet Enterprise][peinstall])
15 |
16 | [peinstall]: /pe/latest/install_windows.html
17 |
18 |
--------------------------------------------------------------------------------
/source/puppet/6.y/man/report.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet report'
5 | canonical: "/puppet/latest/man/report.html"
6 | ---
7 |
8 |
9 | USAGE: puppet report action [--terminus _TERMINUS] [--extra HASH]
10 |
11 | Create, display, and submit reports.
12 |
13 | OPTIONS:
14 | --render-as FORMAT - The rendering format to use.
15 | --verbose - Whether to log verbosely.
16 | --debug - Whether to log debug information.
17 | --extra HASH - Extra arguments to pass to the indirection
18 | request
19 | --terminus _TERMINUS - The indirector terminus to use.
20 |
21 | ACTIONS:
22 | info Print the default terminus class for this face.
23 | save API only: submit a report.
24 | submit API only: submit a report with error handling.
25 |
26 | TERMINI: json, msgpack, processor, rest, yaml
27 |
28 | See 'puppet help report' or 'man puppet-report' for full help.
29 |
30 |
31 |
--------------------------------------------------------------------------------
/source/files/errors/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | Not found
7 |
25 |
26 |
27 |
28 |
29 | Not found
30 |
31 | We tried to find that page, but 404. Sorry about that.
32 |
33 | If you got here by jumping to a different version of a manual, you were probably on a page that doesn't exist in this version. The first link below will take you to this version's start page, and you can use the navigation sidebar to find your way from there.
34 |
35 | Where next?
36 |
37 | - ↩ ︎Start page for this version
38 | - ⇧ Up a directory
39 | - Front page
40 |
41 |
42 |
43 |
44 |
--------------------------------------------------------------------------------
/source/puppet/6.y/man/status.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet status'
5 | canonical: "/puppet/latest/man/status.html"
6 | ---
7 |
8 |
9 | Warning: 'puppet status' is deprecated and will be removed in a future release.
10 |
11 | USAGE: puppet status action [--terminus _TERMINUS] [--extra HASH]
12 |
13 | View puppet server status.
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --extra HASH - Extra arguments to pass to the indirection
20 | request
21 | --terminus _TERMINUS - The indirector terminus to use.
22 |
23 | ACTIONS:
24 | find Check status of puppet master server.
25 | info Print the default terminus class for this face.
26 |
27 | TERMINI: local, rest
28 |
29 | See 'puppet help status' or 'man puppet-status' for full help.
30 |
31 |
32 |
--------------------------------------------------------------------------------
/source/puppet/latest/man/report.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 221ddc1eb591dc76585f70699c4f5848396204fb
4 | title: 'Man Page: puppet report'
5 | canonical: "/puppet/latest/man/report.html"
6 | ---
7 |
8 |
9 | USAGE: puppet report action [--terminus _TERMINUS] [--extra HASH]
10 |
11 | Create, display, and submit reports.
12 |
13 | OPTIONS:
14 | --render-as FORMAT - The rendering format to use.
15 | --verbose - Whether to log verbosely.
16 | --debug - Whether to log debug information.
17 | --extra HASH - Extra arguments to pass to the indirection
18 | request
19 | --terminus _TERMINUS - The indirector terminus to use.
20 |
21 | ACTIONS:
22 | info Print the default terminus class for this face.
23 | save API only: submit a report.
24 | submit API only: submit a report with error handling.
25 |
26 | TERMINI: json, msgpack, processor, rest, yaml
27 |
28 | See 'puppet help report' or 'man puppet-report' for full help.
29 |
30 |
31 |
--------------------------------------------------------------------------------
/source/puppet/latest/man/status.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 6988b84f7eb7f5bb89766a9ca36b0b431685b03b
4 | title: 'Man Page: puppet status'
5 | canonical: "/puppet/latest/man/status.html"
6 | ---
7 |
8 |
9 | Warning: 'puppet status' is deprecated and will be removed in a future release.
10 |
11 | USAGE: puppet status action [--terminus _TERMINUS] [--extra HASH]
12 |
13 | View puppet server status.
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --extra HASH - Extra arguments to pass to the indirection
20 | request
21 | --terminus _TERMINUS - The indirector terminus to use.
22 |
23 | ACTIONS:
24 | find Check status of puppet master server.
25 | info Print the default terminus class for this face.
26 |
27 | TERMINI: local, rest
28 |
29 | See 'puppet help status' or 'man puppet-status' for full help.
30 |
31 |
32 |
--------------------------------------------------------------------------------
/source/_includes/hiera30.html:
--------------------------------------------------------------------------------
1 | {% capture hiera_version %}3.0{% endcapture %}
2 |
3 | Hiera {{ hiera_version }}
4 |
5 |
6 | - Overview
7 | - Configuration and hiera.yaml
8 | - Hierarchies
9 | - Lookup Types
10 | - Writing Data Sources
11 | - Interpolation Tokens, Variables, and Lookup Functions
12 | - Usage with Puppet
13 | - Complete Example
14 | - Usage on the Command Line
15 | - Writing New Backends
16 | - Release Notes
17 |
18 |
19 |
--------------------------------------------------------------------------------
/lib/puppet_docs/versions.rb:
--------------------------------------------------------------------------------
1 | require 'versionomy'
2 |
3 | module PuppetDocs
4 | # This is a module of utility functions that take and return pure strings (and groups of strings),
5 | # to avoid contaminating other code with Versionomy objects.
6 | module Versions
7 | # The versions array must be an array of strings.
8 | # It can safely contain any number of "garbage" versions, though it shouldn't.
9 | # This doesn't account for lock_latest. Use a simple || operator to handle that.
10 | def self.latest(versions_array)
11 | sort_descending(versions_array).first
12 | end
13 |
14 | # Given an array of parseable and unparseable versions, return the same array sorted in
15 | # newest-first order.
16 | def self.sort_descending(versions_array)
17 | parsed_versions = versions_array.map {|ver|
18 | begin
19 | Versionomy.parse(ver)
20 | rescue
21 | nil
22 | end
23 | }.compact
24 | sorted_normal_versions = parsed_versions.sort {|x,y| y <=> x }.map{|ver| ver.to_s}
25 | special_versions = versions_array - sorted_normal_versions
26 |
27 | sorted_normal_versions + special_versions
28 | end
29 | end
30 | end
31 |
--------------------------------------------------------------------------------
/source/facter/3.10/release_notes.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Facter release notes"
4 | ---
5 |
6 | This page documents the history of the Facter 3.10 series.
7 |
8 | ## Facter 3.10.0
9 |
10 | Released February 14, 2018.
11 |
12 | This is a bug-fix release that shipped with Puppet Platform 5.4.0, and includes support for FIPS-enabled systems.
13 |
14 | - [All issues resolved in Facter 3.10.0](https://tickets.puppetlabs.com/issues/?jql=fixVersion+%3D+%27FACT+3.10.0%27)
15 |
16 | ### Bug fixes
17 |
18 | - Previous versions of Facter reported errors when a hostname was exactly 64 bytes long (`HOST_NAME_MAX`) on Linux hosts. Facter 3.10.0 resolves this issue.
19 |
20 | - Facter 3.10.0 updates Facter's cmake configuration to allow for a specific `libdir` target with a suffix, such as "lib64", instead of relying on a hardcoded value.
21 |
22 | - Facter 3.10.0 logs an info message instead of a warning when reporting that SMBIOS serial lookup via `kenv` fails on FreeBSD, where the serial isn't available.
23 |
24 | ### New features
25 |
26 | - This versions adds a new `fips_enabled` Boolean fact, which checks `/proc/sys/crypto/fips_enabled` to determine whether the system is running in FIPS mode.
--------------------------------------------------------------------------------
/source/_includes/deploy_guide.html:
--------------------------------------------------------------------------------
1 | {% comment %}
2 |
3 | Format:
4 |
5 | - section label
6 |
7 | - page if-links...
8 |
9 |
10 |
11 |
12 |
13 | {% endcomment %}
14 |
15 | Puppet Enterprise Deployment Guide
16 |
17 |
18 | - Chapters
19 |
24 |
25 | - Other Resources
26 |
27 | - Glossary of Puppet Terminology
28 | - Puppet Reference Manual
29 | - PE User Manual
30 | - Quick Start: Using PE
31 | - Quick Start: Writing Modules
32 |
33 |
34 |
35 |
36 |
37 |
--------------------------------------------------------------------------------
/source/_includes/agent_lifecycle.md:
--------------------------------------------------------------------------------
1 | [//]: # (WARNING! THIS IS AN OLD FILE, ONLY USED IN PE2015 docs and OLDER, IF YOU WANT TO UPDATE THIS CONTENT, UPDATE IN APPROPRIATE OSP OR PE SECTIONS)
2 |
3 | ## Puppet agent and operating system support life cycles
4 |
5 | In PE 2015.2 and open source Puppet 4.0 and onward, we use the same Puppet agent packages in our open source and Puppet Enterprise ecosystems. Because of this, we've set guidelines for how we manage Puppet agent life cycles.
6 |
7 | * Community-supported operating systems:
8 |
9 | On community-supported operating systems, we support Puppet agent for the OS's life cycle. Essentially, Puppet stops publishing packages for a platform 30 days after its end-of-life (EOL) date. For example, Fedora 20 reached its EOL on June 23, 2015. This means on or around July 23, Puppet stopped providing fixes, updates, or support for either the Puppet Enterprise or open source versions of that agent package.
10 |
11 | * Enterprise-class operating systems:
12 |
13 | On enterprise-class operating systems, we support Puppet agent for _at least_ the OS's life cycle. In Puppet Enterprise, Puppet continues to support certain enterprise-class agent platforms after their EOL, though we do so solely at our own discretion.
14 |
--------------------------------------------------------------------------------
/source/facter/3.7/release_notes.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Facter Release notes"
4 | ---
5 |
6 | This page documents the history of the Facter 3.7 series.
7 |
8 | ## Facter 3.7.1
9 |
10 | Released July 19, 2017.
11 |
12 | This is a minor bug fix release to Facter, containing only two issues.
13 |
14 | * [All issues resolved in Facter 3.7.1](https://tickets.puppetlabs.com/issues/?jql=fixVersion%20%3D%20%27FACT%203.7.1%27)
15 |
16 |
17 | ## Facter 3.7.0
18 |
19 | Released June 26, 2017.
20 |
21 | This version of Facter is included in the Puppet agent 5.0.0 release.
22 |
23 | ### Bug fixes
24 |
25 | * [FACT-1579](https://tickets.puppetlabs.com/browse/FACT-1579): Running on Devuan, the `operatingsystem` fact would return `Linux`. It now properly returns `Devuan`.
26 |
27 | * [FACT-1268](https://tickets.puppetlabs.com/browse/FACT-1268): Timeout for retrieving EC2 facts has been increased from 200ms to 600ms.
28 |
29 | * [FACT-1544](https://tickets.puppetlabs.com/browse/FACT-1544): Cache files are now deleted once their associated entry in the TTL list in the config file is removed.
30 |
31 | * [FACT-1455](https://tickets.puppetlabs.com/browse/FACT-1455): Facter now correctly returns the `id` fact when a group file entry is larger than 1KiB.
32 |
--------------------------------------------------------------------------------
/source/puppet/6.y/_hiera.yaml_v5.md:
--------------------------------------------------------------------------------
1 | ``` yaml
2 | ---
3 | version: 5
4 | defaults: # Used for any hierarchy level that omits these keys.
5 | datadir: data # This path is relative to hiera.yaml's directory.
6 | data_hash: yaml_data # Use the built-in YAML backend.
7 |
8 | hierarchy:
9 | - name: "Per-node data" # Human-readable name.
10 | path: "nodes/%{trusted.certname}.yaml" # File path, relative to datadir.
11 | # ^^^ IMPORTANT: include the file extension!
12 |
13 | - name: "Per-datacenter business group data" # Uses custom facts.
14 | path: "location/%{facts.whereami}/%{facts.group}.yaml"
15 |
16 | - name: "Global business group data"
17 | path: "groups/%{facts.group}.yaml"
18 |
19 | - name: "Per-datacenter secret data (encrypted)"
20 | lookup_key: eyaml_lookup_key # Uses non-default backend.
21 | path: "secrets/%{facts.whereami}.eyaml"
22 | options:
23 | pkcs7_private_key: /etc/puppetlabs/puppet/eyaml/private_key.pkcs7.pem
24 | pkcs7_public_key: /etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
25 |
26 | - name: "Per-OS defaults"
27 | path: "os/%{facts.os.family}.yaml"
28 |
29 | - name: "Common data"
30 | path: "common.yaml"
31 | ```
32 |
--------------------------------------------------------------------------------
/source/puppet/latest/_hiera.yaml_v5.md:
--------------------------------------------------------------------------------
1 | ``` yaml
2 | ---
3 | version: 5
4 | defaults: # Used for any hierarchy level that omits these keys.
5 | datadir: data # This path is relative to hiera.yaml's directory.
6 | data_hash: yaml_data # Use the built-in YAML backend.
7 |
8 | hierarchy:
9 | - name: "Per-node data" # Human-readable name.
10 | path: "nodes/%{trusted.certname}.yaml" # File path, relative to datadir.
11 | # ^^^ IMPORTANT: include the file extension!
12 |
13 | - name: "Per-datacenter business group data" # Uses custom facts.
14 | path: "location/%{facts.whereami}/%{facts.group}.yaml"
15 |
16 | - name: "Global business group data"
17 | path: "groups/%{facts.group}.yaml"
18 |
19 | - name: "Per-datacenter secret data (encrypted)"
20 | lookup_key: eyaml_lookup_key # Uses non-default backend.
21 | path: "secrets/%{facts.whereami}.eyaml"
22 | options:
23 | pkcs7_private_key: /etc/puppetlabs/puppet/eyaml/private_key.pkcs7.pem
24 | pkcs7_public_key: /etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
25 |
26 | - name: "Per-OS defaults"
27 | path: "os/%{facts.os.family}.yaml"
28 |
29 | - name: "Common data"
30 | path: "common.yaml"
31 | ```
32 |
--------------------------------------------------------------------------------
/source/wiki_redirect.markdown:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: Information for Puppet Wiki readers
4 | toc: false
5 | ---
6 |
7 | The Puppet Wiki is closed
8 | -----
9 | You got here from a link, bookmark, or search result that points to the now-defunct Puppet Wiki.
10 |
11 | ## Use the Puppet docs site instead
12 |
13 | Current and supported versions of the information that was once kept on the wiki are available on the Puppet documentation site at [docs.puppet.com](https://docs.puppet.com). Use search or the navigation to find what you're looking for.
14 |
15 | ## Can't find something? Don't panic.
16 |
17 | There are plenty of community resources with people who can help:
18 |
19 | - [Ask Puppet](https://ask.puppet.com/)
20 | - #puppet and #puppet-dev channels on [IRC](http://webchat.freenode.net/?channels=puppet)
21 | - The [Puppet Community Slack](http://puppetcommunity.slack.com/)
22 | - Google groups for [Puppet users](http://groups.google.com/group/puppet-users), [Puppet Enterprise users](https://groups.google.com/a/puppet.com/forum/#!forum/pe-users), [Puppet developers](http://groups.google.com/group/puppet-dev), [MCollective users](https://groups.google.com/forum/#!forum/mcollective-users), or [Razor users](http://groups.google.com/group/puppet-razor)
23 |
24 |
25 |
--------------------------------------------------------------------------------
/source/_includes/pup38_platforms_windows.markdown:
--------------------------------------------------------------------------------
1 | Puppet publishes and tests open-source Puppet 3.8 agent installers for the following versions of Microsoft Windows to [downloads.puppetlabs.com/windows](https://downloads.puppetlabs.com/windows):
2 |
3 | - Windows Server 2012 R2
4 | - Windows Server 2008 R2
5 | - Windows Server 2003 R2
6 |
7 | Puppet also publishes, but does not automatically test, open-source Puppet 3.8 packages for the following versions of Windows:
8 |
9 | - Windows Server 2012
10 | - Windows Server 2008
11 | - Windows Server 2003
12 | - Windows 7
13 | - Windows 8
14 | - Windows 8.1
15 | - Windows Vista
16 |
17 | The Puppet master service is not available on any version of Windows.
18 |
19 | > **Puppet Enterprise support:** [PE 3.8](/pe/3.8/) supports agents on 32-bit versions of Windows Server 2003 and 2003 R2, and on both 32-bit and 64-bit versions of Windows Server 2008, 2008 R2, 2012, and 2012 R2; Windows 7 Ultimate SP 1; and Windows 8 and 8.1 Pro. It does not support agents on any version of Windows Vista. [Newer versions of Puppet Enterprise](/pe/latest/) support more recent versions of Windows.
20 |
21 |
22 |
--------------------------------------------------------------------------------
/source/_includes/es_hiera1.html:
--------------------------------------------------------------------------------
1 | Hiera 1
2 |
3 |
4 | - Vista general
5 | - Instalación
6 | - El archivo de configuración hiera.yaml
7 | - Crear jerarquías
8 | - Tipos de búsqueda
9 | - Escribir fuentes de información
10 | - Variables e Interpolación
11 | - Usar Hiera con Puppet
12 | - Ejemplo completo
13 | - Uso en la línea de comandos
14 | - Writing New Backends (en Inglés)
15 | - Release Notes (en Inglés)
16 |
17 |
18 | Documentación en Español
19 |
20 |
21 | - Documentación de Puppet Labs
22 | - Aprende Puppet
23 |
24 |
--------------------------------------------------------------------------------
/util/bbedit_tools/copy-kramdown-link.rb:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 |
3 | # Put this in BBEdit's scripts folder, at ~/Application Support/BBEdit/Scripts
4 | # Select the text of a Markdown header in one of our source files, and run the filter. It will leave the selection alone, but will copy a link to the anchor, including the post-conversion (*.html) filename, to the clipboard.
5 | # This could probably be easily munged to work with other editors, but is for BBEdit because that's what Nick and Fred use.
6 | # The generate_id function is ripped directly out of the kramdown source code, minus the part where it keeps track of duplicates and disambiguates them with numbers. So it won't work with headers that are duped within a page, but you should only be using dupe headers if you don't plan to link to them anyway.
7 |
8 | selection = %x{osascript -e 'tell app "BBEdit" to get selection as text'}
9 | filename = ENV['BB_DOC_NAME']
10 |
11 | def generate_id(str)
12 | gen_id = str.gsub(/^[^a-zA-Z]+/, '')
13 | gen_id.tr!('^a-zA-Z0-9 -', '')
14 | gen_id.tr!(' ', '-')
15 | gen_id.downcase!
16 | gen_id
17 | end
18 |
19 | converted_filename = filename.sub(/\.(markdown|md|textile)$/, '.html')
20 | full_link = converted_filename + '#' + generate_id(selection)
21 | IO.popen('pbcopy', 'w').print full_link
22 |
--------------------------------------------------------------------------------
/lib/puppet_references/facter/core_facts_preamble.md:
--------------------------------------------------------------------------------
1 | This is a list of all of the built-in facts that ship with Facter, which includes both legacy facts and newer structured facts.
2 |
3 | Not all of them apply to every system, and your site might also use [custom facts](custom_facts.dita) delivered via Puppet modules. To see the full list of structured facts and values on a given system (including plugin facts), run `puppet facts` at the command line. If you are using Puppet Enterprise, you can view all of the facts for any node on the node's page in the console.
4 |
5 | You can access facts in your Puppet manifests as `$fact_name` or `$facts[fact_name]`. For more information, see [the Puppet docs on facts and built-in variables.](lang_facts_and_builtin_vars.dita)
6 |
7 | > **Legacy Facts Note:** As of Facter 3, legacy facts such as `architecture` are hidden by default to reduce noise in Facter's default command-line output. These older facts are now part of more useful structured facts; for example, `architecture` is now part of the `os` fact and accessible as `os.architecture`. You can still use these legacy facts in Puppet manifests (`$architecture`), request them on the command line (`facter architecture`), and view them alongside structured facts (`facter --show-legacy`).
8 |
9 | * * *
10 |
11 |
--------------------------------------------------------------------------------
/source/puppet/6.y/man/man.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet man'
5 | canonical: "/puppet/latest/man/man.html"
6 | ---
7 |
8 |
9 | Warning: 'puppet man' is deprecated and will be removed in a future release.
10 |
11 | USAGE: puppet man action
12 |
13 | Please use the command 'puppet help subcommand' or the system manpage system
14 | 'man puppet-subcommand' to display information about Puppet subcommands. The
15 | deprecated man subcommand displays manual pages for all Puppet subcommands. If
16 | the ronn gem (https://github.com/rtomayko/ronn/) is installed on your
17 | system, puppet man will display fully-formatted man pages. If ronn is not [...]
18 |
19 | OPTIONS:
20 | --render-as FORMAT - The rendering format to use.
21 | --verbose - Whether to log verbosely.
22 | --debug - Whether to log debug information.
23 |
24 | ACTIONS:
25 | man Display the manual page for a Puppet subcommand.
26 |
27 | See 'puppet help man' or 'man puppet-man' for full help.
28 |
29 |
30 |
--------------------------------------------------------------------------------
/source/puppet/latest/man/man.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 6988b84f7eb7f5bb89766a9ca36b0b431685b03b
4 | title: 'Man Page: puppet man'
5 | canonical: "/puppet/latest/man/man.html"
6 | ---
7 |
8 |
9 | Warning: 'puppet man' is deprecated and will be removed in a future release.
10 |
11 | USAGE: puppet man action
12 |
13 | Please use the command 'puppet help subcommand' or the system manpage system
14 | 'man puppet-subcommand' to display information about Puppet subcommands. The
15 | deprecated man subcommand displays manual pages for all Puppet subcommands. If
16 | the ronn gem (https://github.com/rtomayko/ronn/) is installed on your
17 | system, puppet man will display fully-formatted man pages. If ronn is not [...]
18 |
19 | OPTIONS:
20 | --render-as FORMAT - The rendering format to use.
21 | --verbose - Whether to log verbosely.
22 | --debug - Whether to log debug information.
23 |
24 | ACTIONS:
25 | man Display the manual page for a Puppet subcommand.
26 |
27 | See 'puppet help man' or 'man puppet-man' for full help.
28 |
29 |
30 |
--------------------------------------------------------------------------------
/lib/puppet_references/puppet/strings.rb:
--------------------------------------------------------------------------------
1 | require 'puppet_references'
2 | require 'json'
3 |
4 | module PuppetReferences
5 | module Puppet
6 | class Strings < Hash
7 | STRINGS_JSON_FILE = PuppetReferences::OUTPUT_DIR + 'puppet/strings.json'
8 | @@strings_data_cached = false
9 |
10 | def initialize(force_cached = false)
11 | super()
12 | if force_cached
13 | @@strings_data_cached = true
14 | end
15 | unless @@strings_data_cached
16 | generate_strings_data
17 | end
18 | self.merge!(JSON.load(File.read(STRINGS_JSON_FILE)))
19 | # We can't keep the actual data hash in an instance variable, because if you duplicate the main hash, all its
20 | # deeply nested members will be assigned by reference to the new hash, and you'll get leakage across objects.
21 | end
22 |
23 | def generate_strings_data
24 | puts 'Generating Puppet Strings JSON data...'
25 | rubyfiles = Dir.glob("#{PuppetReferences::PUPPET_DIR}/lib/puppet/**/*.rb")
26 | system("bundle exec puppet strings generate --format json --out #{STRINGS_JSON_FILE} #{rubyfiles.join(' ')}")
27 | puts "Strings data: Done! (#{STRINGS_JSON_FILE})"
28 | @@strings_data_cached = true
29 | end
30 | end
31 | end
32 | end
--------------------------------------------------------------------------------
/source/puppet/6.y/schemas/host.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "http://json-schema.org/draft-04/schema#",
3 | "title": "Host",
4 | "description": "SSL Host information",
5 | "type": "object",
6 | "properties": {
7 | "name": {
8 | "type": "string"
9 | },
10 | "state": {
11 | "type": "string",
12 | "enum": [
13 | "requested",
14 | "signed",
15 | "revoked"
16 | ]
17 | },
18 | "desired_state": {
19 | "type": "string",
20 | "enum": [
21 | "signed",
22 | "revoked"
23 | ]
24 | },
25 | "fingerprint": {
26 | "type": "string"
27 | },
28 | "fingerprints": {
29 | "type": "object",
30 | "patternProperties": {
31 | "^[A-Za-z0-9_]*$": {}
32 | },
33 | "additionalProperties": false
34 | },
35 | "dns_alt_names": {
36 | "type": "array",
37 | "items": {
38 | "type": "string"
39 | }
40 | }
41 | },
42 | "required": ["name", "state", "fingerprint", "fingerprints", "dns_alt_names"],
43 | "additionalProperties": false
44 | }
45 |
--------------------------------------------------------------------------------
/source/puppet/latest/schemas/host.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "http://json-schema.org/draft-04/schema#",
3 | "title": "Host",
4 | "description": "SSL Host information",
5 | "type": "object",
6 | "properties": {
7 | "name": {
8 | "type": "string"
9 | },
10 | "state": {
11 | "type": "string",
12 | "enum": [
13 | "requested",
14 | "signed",
15 | "revoked"
16 | ]
17 | },
18 | "desired_state": {
19 | "type": "string",
20 | "enum": [
21 | "signed",
22 | "revoked"
23 | ]
24 | },
25 | "fingerprint": {
26 | "type": "string"
27 | },
28 | "fingerprints": {
29 | "type": "object",
30 | "patternProperties": {
31 | "^[A-Za-z0-9_]*$": {}
32 | },
33 | "additionalProperties": false
34 | },
35 | "dns_alt_names": {
36 | "type": "array",
37 | "items": {
38 | "type": "string"
39 | }
40 | }
41 | },
42 | "required": ["name", "state", "fingerprint", "fingerprints", "dns_alt_names"],
43 | "additionalProperties": false
44 | }
45 |
--------------------------------------------------------------------------------
/source/_includes/template/language_switcher.html:
--------------------------------------------------------------------------------
1 |
2 | {% comment %}Requires variables: include.current_language {% endcomment %}
3 |
4 |
8 |
23 |
24 |
--------------------------------------------------------------------------------
/source/facter/3.8/release_notes.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Facter Release notes"
4 | ---
5 |
6 | This page documents the history of the Facter 3.8 series.
7 |
8 | ## Facter 3.8.0
9 |
10 | Released August 17, 2017.
11 |
12 | This is a feature and improvement release of Facter that includes several bug fixes.
13 |
14 | * [All issues resolved in Facter 3.8.0](https://tickets.puppetlabs.com/issues/?jql=fixVersion%20%3D%20%27FACT%203.8.0%27)
15 |
16 | ### New Features
17 |
18 | * New facts, ZFS and ZPool have been aded to Facter's FreeBSD resolvers. Previously, these were only reported on Solaris.
19 |
20 | * Added Go bindings. This release includes a function to gather default facts for Linux machines only.
21 |
22 |
23 | ### Improvements
24 |
25 | * BSDs now report hardware architecture.
26 |
27 | * Virtualization detection for FreeBSD Jails has been added.
28 |
29 | * Backward support added for zpool feature flags prior to verion 28.
30 |
31 |
32 | ### Bug fixes
33 |
34 | These bugs have been fixed in this release:
35 |
36 | * Free BSD OS release and Kernel release are now reported independently
37 |
38 | * Memory reporting on FreeBSD now reports accurately.
39 |
40 | * Facter is now compatible with OpenSSL 1.1.0
41 |
42 | * Integers from feature descriptions are no longer reported as zpool feature numbers.
43 |
44 |
45 |
--------------------------------------------------------------------------------
/source/puppetserver/index.markdown:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Puppet Server Documentation"
4 | toc: false
5 | ---
6 |
7 | Puppet Server is the next-generation application for managing Puppet agents.
8 |
9 | For the most part, we've integrated the Puppet Server documentation into [the Puppet documentation](/puppet/latest/). For a list of all documentation related to Puppet Server, or for information about an older version of Puppet Server, see one of the links below.
10 |
11 | ## Versions
12 |
13 | > **Note:** The Puppet Server 2.x series supports Puppet 4.x, and the 1.x series supports later versions of Puppet 3.x. See the release notes for each version for full compatibility details.
14 |
15 |
16 | {% assign this_doc = "puppetserver" %}
17 |
18 | {% assign real_name = site.document_names[this_doc] %}
19 | {% for base_url in site.document_version_order[this_doc] %}
20 | {% if site.document_version_index[this_doc].latest == base_url %}{% assign past_latest = true %}{% endif %}
21 | -
22 | {{real_name}} {{site.document_list[base_url].version}}
23 | {% unless past_latest %}(not yet released){% endunless %}
24 | {% if site.document_list[base_url].my_versions.pe != "latest" %}(Included in Puppet Enterprise {{site.document_list[base_url].my_versions.pe}}){% endif %}
25 |
26 | {% endfor %}
27 |
28 |
29 |
--------------------------------------------------------------------------------
/source/pdk/1.0/pdk_troubleshooting.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Troubleshooting Puppet Development Kit"
4 | canonical: "/pdk/1.0/pdk_troubleshooting.html"
5 | description: "Troubleshooting Puppet Development Kit, the shortest path to developing better Puppet code."
6 | ---
7 |
8 | {:.concept}
9 | ## PDK not in ZShell PATH on OS X
10 |
11 | With ZShell on OS X, PDK is not automatically added to the PATH. To fix this, add the PATH by adding the line `eval (/usr/libexec/path_helper -s)` to the zsh resource file (`~/.zshrc`).
12 |
13 | {:.concept}
14 | ## Windows: Execution policy restrictions
15 |
16 |
17 | In some Windows installations, trying to run the `pdk` command is prohibited by the default execution policy restrictions.
18 |
19 | To fix this issue, set your script execution policy to at least [RemoteSigned](https://msdn.microsoft.com/en-us/powershell/reference/5.1/microsoft.powershell.security/set-executionpolicy) by running `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned`
20 |
21 | Alternatively, you can change the `Scope` parameter of the `ExecutionPolicy` to the current session only by running `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
22 |
23 | For more information about PowerShell execution policies or how to change them, see Microsoft documentation [about_Execution_Policies](http://go.microsoft.com/fwlink/?LinkID=135170).
24 |
--------------------------------------------------------------------------------
/source/puppet/6.y/resources_scheduled_task_windows.markdown:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Resource tips and examples: Scheduled task on Windows"
4 | toc: false
5 | ---
6 |
7 | [scheduledtask]: ./type.html#scheduledtask
8 |
9 | Puppet can create, edit, and delete scheduled tasks, which are a Windows-only resource type.
10 |
11 | Puppet can manage the task name, the enabled/disabled status, the command, any arguments, the working directory, the user and password, and triggers. A complete scheduled task resource looks something like this:
12 |
13 | ``` puppet
14 | scheduled_task { 'An every-other-day task':
15 | ensure => present,
16 | enabled => true,
17 | command => 'C:\path\to\command.exe',
18 | arguments => '/flags /to /pass',
19 | trigger => {
20 | schedule => daily,
21 | every => 2, # Specifies every other day. Defaults to 1 (every day).
22 | start_date => '2011-08-31', # Defaults to 'today'
23 | start_time => '08:00', # Must be specified
24 | minutes_interval => '60', # Repeat this task every 60 minutes
25 | minutes_duration => '300', # The task will run for a total of five hours
26 | }
27 | }
28 | ```
29 |
30 | For more information, see [the reference documentation for the `scheduled_task` type][scheduledtask].
31 |
32 | ## Errata
33 |
34 | ### Known issues prior to Puppet 3.8.0
35 |
36 | Puppet did not support "every X minutes" type triggers.
--------------------------------------------------------------------------------
/source/_includes/puppet_general.html:
--------------------------------------------------------------------------------
1 | Installing/Upgrading Open Source Puppet
2 |
3 |
4 | - Pre-Install Tasks
5 | - Installing Puppet
6 |
7 | - On Linux Systems
8 | - On Mac OS X
9 | - On Microsoft Windows
10 |
11 |
12 | - Upgrading Puppet
13 | - Updating 3.x Manifests for Puppet 4.x
14 | - Using the Puppet Package Repositories
15 |
16 |
17 | General Puppet Info
18 |
19 |
20 | - History of Language Features
21 |
22 |
23 | Other Puppet Docs
24 |
25 |
26 | - Puppet Reference Manual
27 | - The Resource Type Reference
28 | - Learning Puppet
29 |
30 |
--------------------------------------------------------------------------------
/source/puppet/latest/resources_scheduled_task_windows.markdown:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | title: "Resource tips and examples: Scheduled task on Windows"
4 | toc: false
5 | ---
6 |
7 | [scheduledtask]: ./type.html#scheduledtask
8 |
9 | Puppet can create, edit, and delete scheduled tasks, which are a Windows-only resource type.
10 |
11 | Puppet can manage the task name, the enabled/disabled status, the command, any arguments, the working directory, the user and password, and triggers. A complete scheduled task resource looks something like this:
12 |
13 | ``` puppet
14 | scheduled_task { 'An every-other-day task':
15 | ensure => present,
16 | enabled => true,
17 | command => 'C:\path\to\command.exe',
18 | arguments => '/flags /to /pass',
19 | trigger => {
20 | schedule => daily,
21 | every => 2, # Specifies every other day. Defaults to 1 (every day).
22 | start_date => '2011-08-31', # Defaults to 'today'
23 | start_time => '08:00', # Must be specified
24 | minutes_interval => '60', # Repeat this task every 60 minutes
25 | minutes_duration => '300', # The task will run for a total of five hours
26 | }
27 | }
28 | ```
29 |
30 | For more information, see [the reference documentation for the `scheduled_task` type][scheduledtask].
31 |
32 | ## Errata
33 |
34 | ### Known issues prior to Puppet 3.8.0
35 |
36 | Puppet did not support "every X minutes" type triggers.
--------------------------------------------------------------------------------
/source/puppet/6.y/man/node.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet node'
5 | canonical: "/puppet/latest/man/node.html"
6 | ---
7 |
8 |
9 | USAGE: puppet node action [--terminus _TERMINUS] [--extra HASH]
10 |
11 | This subcommand interacts with node objects, which are used by Puppet to
12 | build a catalog. A node object consists of the node's facts, environment,
13 | node parameters (exposed in the parser as top-scope variables), and classes.
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --extra HASH - Extra arguments to pass to the indirection
20 | request
21 | --terminus _TERMINUS - The indirector terminus to use.
22 |
23 | ACTIONS:
24 | clean Clean up signed certs, cached facts, node objects, and reports for a
25 | node stored by the puppetmaster
26 | find Retrieve a node object.
27 | info Print the default terminus class for this face.
28 |
29 | TERMINI: exec, json, memory, msgpack, plain, rest, store_configs, yaml
30 |
31 | See 'puppet help node' or 'man puppet-node' for full help.
32 |
33 |
34 |
--------------------------------------------------------------------------------
/source/puppet/latest/man/node.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 221ddc1eb591dc76585f70699c4f5848396204fb
4 | title: 'Man Page: puppet node'
5 | canonical: "/puppet/latest/man/node.html"
6 | ---
7 |
8 |
9 | USAGE: puppet node action [--terminus _TERMINUS] [--extra HASH]
10 |
11 | This subcommand interacts with node objects, which are used by Puppet to
12 | build a catalog. A node object consists of the node's facts, environment,
13 | node parameters (exposed in the parser as top-scope variables), and classes.
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --extra HASH - Extra arguments to pass to the indirection
20 | request
21 | --terminus _TERMINUS - The indirector terminus to use.
22 |
23 | ACTIONS:
24 | clean Clean up signed certs, cached facts, node objects, and reports for a
25 | node stored by the puppetmaster
26 | find Retrieve a node object.
27 | info Print the default terminus class for this face.
28 |
29 | TERMINI: exec, json, memory, msgpack, plain, rest, store_configs, yaml
30 |
31 | See 'puppet help node' or 'man puppet-node' for full help.
32 |
33 |
34 |
--------------------------------------------------------------------------------
/source/_includes/es_learning_nav.html:
--------------------------------------------------------------------------------
1 | Aprende Puppet
2 |
3 | - Aprende Puppet – Índice
4 | - Parte uno: Puppet sin servidor
5 |
6 | - Recursos y la RAL
7 | - Manifiestos
8 | - Orden de recursos
9 | - Variables, Conditionals, Facts
10 | - Módulos y clases
11 | - Templates
12 | - Parámetros de clase
13 | - Tipos de recurso definidos
14 |
15 |
16 | - Parte dos: Puppet Master/Agente
17 |
21 |
22 |
23 |
24 | Documentación en Español
25 |
26 |
27 | - Documentación de Puppet Labs
28 | - Hiera
29 |
30 |
--------------------------------------------------------------------------------
/source/puppet/latest/man/facts.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 221ddc1eb591dc76585f70699c4f5848396204fb
4 | title: 'Man Page: puppet facts'
5 | canonical: "/puppet/latest/man/facts.html"
6 | ---
7 |
8 |
9 | USAGE: puppet facts action [--terminus _TERMINUS] [--extra HASH]
10 |
11 | This subcommand manages facts, which are collections of normalized system
12 | information used by Puppet. It can read facts directly from the local system
13 | (with the default facter terminus).
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --extra HASH - Extra arguments to pass to the indirection
20 | request
21 | --terminus _TERMINUS - The indirector terminus to use.
22 |
23 | ACTIONS:
24 | find Retrieve a node's facts.
25 | info Print the default terminus class for this face.
26 | save API only: create or overwrite an object.
27 | show Retrieve current node's facts.
28 | upload Upload local facts to the puppet master.
29 |
30 | TERMINI: facter, json, memory, network_device, rest, store_configs, yaml
31 |
32 | See 'puppet help facts' or 'man puppet-facts' for full help.
33 |
34 |
35 |
--------------------------------------------------------------------------------
/source/puppetdb/index.markdown:
--------------------------------------------------------------------------------
1 | ---
2 | title: "PuppetDB » Overview"
3 | layout: default
4 | toc: false
5 | ---
6 |
7 | PuppetDB is the fast, scalable, and reliable data warehouse for Puppet. It caches data generated by Puppet, and gives you advanced features at awesome speed with a powerful API.
8 |
9 | ## Versions
10 |
11 | > **Note:** PuppetDB 3.0 and higher are only compatible with Puppet 4.x, and PuppetDB 2.2 and earlier are only compatible with Puppet 3.x. PuppetDB 2.3 is the transitional version that supports both Puppet 4.x and 3.x.
12 |
13 |
14 | {% assign this_doc = "puppetdb" %}
15 |
16 | {% assign real_name = site.document_names[this_doc] %}
17 | {% for base_url in site.document_version_order[this_doc] %}
18 | {% if site.document_version_index[this_doc].latest == base_url %}{% assign past_latest = true %}{% endif %}
19 | -
20 | {{real_name}} {{site.document_list[base_url].version}}
21 | {% unless past_latest %}(not yet released){% endunless %}
22 | {% if site.document_list[base_url].my_versions.pe != "latest" %}(Included in Puppet Enterprise {{site.document_list[base_url].my_versions.pe}}){% endif %}
23 |
24 | {% endfor %}
25 |
26 |
27 | > **Note:** The special "[master](./master)" docs version isn't tied to a specific version number; instead, it's whatever is currently in the `master` branch in the PuppetDB repository on GitHub. We've included it as a preview for PuppetDB developers and testers.
28 |
--------------------------------------------------------------------------------
/config/deploy.rb:
--------------------------------------------------------------------------------
1 | set :application, "docs.puppet.com"
2 | set :repository, "git://github.com/puppetlabs/puppet-docs.git"
3 | set :user, "docsdeploy"
4 |
5 | task :mirror0 do
6 | set :domain, "#{user}@staticweb1-prod.puppetlabs.com"
7 | set :deploy_to, "/var/www/#{application}"
8 | end
9 |
10 | task :mirror1 do
11 | set :domain, "#{user}@staticweb2-prod.puppetlabs.com"
12 | set :deploy_to, "/var/www/#{application}"
13 | end
14 |
15 | task :preview1 do
16 | set :domain, "#{user}@staticweb1-dev.puppetlabs.com"
17 | set :deploy_to, "/var/www/docspreview1.ops.puppetlabs.net"
18 | end
19 |
20 | task :preview2 do
21 | set :domain, "#{user}@staticweb1-dev.puppetlabs.com"
22 | set :deploy_to, "/var/www/docspreview2.ops.puppetlabs.net"
23 | end
24 |
25 | task :preview3 do
26 | set :domain, "#{user}@staticweb1-dev.puppetlabs.com"
27 | set :deploy_to, "/var/www/docspreview3.ops.puppetlabs.net"
28 | end
29 |
30 | namespace :vlad do
31 |
32 | desc "Release the documentation site"
33 | remote_task :release do
34 | Rake::Task['check_build_version'].invoke
35 | puts "DEPLOYING TO: #{domain}"
36 |
37 | stage_dir = deploy_to + '/stage'
38 |
39 | sh "rsync -crlpv --delete --force output/ #{domain}:#{stage_dir}/"
40 |
41 | # Create tarball, move everything into place, and reload NGINX. Rake has
42 | # trouble mixing stdout and stderr, so we combine them on the remote host.
43 | run "sh #{stage_dir}/install.sh #{deploy_to} 2>&1"
44 | end
45 |
46 | end
47 |
--------------------------------------------------------------------------------
/source/puppet/6.y/man/facts.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet facts'
5 | canonical: "/puppet/latest/man/facts.html"
6 | ---
7 |
8 |
9 | USAGE: puppet facts action [--terminus _TERMINUS] [--extra HASH]
10 |
11 | This subcommand manages facts, which are collections of normalized system
12 | information used by Puppet. It can read facts directly from the local system
13 | (with the default facter terminus).
14 |
15 | OPTIONS:
16 | --render-as FORMAT - The rendering format to use.
17 | --verbose - Whether to log verbosely.
18 | --debug - Whether to log debug information.
19 | --extra HASH - Extra arguments to pass to the indirection
20 | request
21 | --terminus _TERMINUS - The indirector terminus to use.
22 |
23 | ACTIONS:
24 | diff Compare Facter 3 output with Facter 4 output
25 | find Retrieve a node's facts.
26 | info Print the default terminus class for this face.
27 | save API only: create or overwrite an object.
28 | show Retrieve current node's facts.
29 | upload Upload local facts to the puppet master.
30 |
31 | TERMINI: facter, json, memory, network_device, rest, store_configs, yaml
32 |
33 | See 'puppet help facts' or 'man puppet-facts' for full help.
34 |
35 |
36 |
--------------------------------------------------------------------------------
/source/puppet/6.y/man/describe.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet describe'
5 | canonical: "/puppet/latest/man/describe.html"
6 | ---
7 |
8 |
9 | NAME
10 |
11 | puppet-describe - Display help about resource types
12 |
13 |
14 | SYNOPSIS
15 |
16 | Prints help about Puppet resource types, providers, and metaparameters.
17 |
18 | USAGE
19 |
20 | puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
21 |
22 | OPTIONS
23 |
24 |
25 | - --help
Print this help text
- --providers
Describe providers in detail for each type
- --list
List all types
- --meta
List all metaparameters
- --short
List only parameters without detail
31 |
32 |
33 | EXAMPLE
34 |
35 | $ puppet describe --list
36 | $ puppet describe file --providers
37 | $ puppet describe user -s -m
38 |
39 |
40 | AUTHOR
41 |
42 | David Lutterkort
43 |
44 | COPYRIGHT
45 |
46 | Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
47 |
48 |
49 |
--------------------------------------------------------------------------------
/source/_includes/template/version_note.html:
--------------------------------------------------------------------------------
1 | {% if page.doc %}
2 |
3 | {% if page.doc.doc != "pe" and page.doc.doc != "pdk" %}
4 | {% if page.doc.my_versions.pe == "latest" %}{% comment %}...then no SPECIFIC PE version has claimed this version.{% endcomment %}
5 | {% assign ver_in_latest_pe = site.document_list[site.document_version_index.pe.latest].my_versions[page.doc.doc] %}
6 | This version of {{site.document_names[page.doc.doc]}} is not included in Puppet Enterprise. The latest version of PE includes {{site.document_names[page.doc.doc]}} {{ver_in_latest_pe}}.
7 | {% else %}
8 | Included in Puppet Enterprise {{page.doc.my_versions.pe}}.
9 | {% endif %}
10 | {% assign ver_note_open = "true" %}
11 | {% endif %}
12 |
13 | {% if site.document_version_index[page.doc.doc]["latest"] != page.doc.base_url %}
14 | {% unless ver_note_open %}
{% endunless %}{% assign ver_note_open = "true" %}
15 | A newer version is available; see the version menu above for details.
16 | {% endif %}
17 |
18 | {% if page.doc.draft %}
19 | {% unless ver_note_open %}
{% endunless %}{% assign ver_note_open = "true" %}
20 | Draft document: This is an unedited, potentially incomplete draft.
21 | {% endif %}
22 |
23 | {% if ver_note_open %}
{% endif %}
24 |
25 | {% endif %}
26 |
--------------------------------------------------------------------------------
/source/puppet/6.y/man/key.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | built_from_commit: 40229a5d238c1fae86d2a4acfe88860091f3728a
4 | title: 'Man Page: puppet key'
5 | canonical: "/puppet/latest/man/key.html"
6 | ---
7 |
8 |
9 | Warning: 'puppet key' is deprecated and will be removed in a future release.
10 |
11 | USAGE: puppet key action [--terminus _TERMINUS] [--extra HASH]
12 |
13 | This subcommand manages certificate private keys. Keys are created
14 | automatically by puppet agent and when certificate requests are generated
15 | with 'puppet ssl submit_request'; it should not be necessary to use this
16 | subcommand directly.
17 |
18 | OPTIONS:
19 | --render-as FORMAT - The rendering format to use.
20 | --verbose - Whether to log verbosely.
21 | --debug - Whether to log debug information.
22 | --extra HASH - Extra arguments to pass to the indirection
23 | request
24 | --terminus _TERMINUS - The indirector terminus to use.
25 |
26 | ACTIONS:
27 | destroy Delete an object.
28 | find Retrieve an object by name.
29 | info Print the default terminus class for this face.
30 | save API only: create or overwrite an object.
31 | search Search for an object or retrieve multiple objects.
32 |
33 | TERMINI: file, memory
34 |
35 | See 'puppet help key' or 'man puppet-key' for full help.
36 |
37 |
38 |
--------------------------------------------------------------------------------