|
| 1 | +--- |
| 2 | +layout: default |
| 3 | +title: "PE Manual: Overview" |
| 4 | +--- |
| 5 | + |
| 6 | +{% include pe_nav.markdown %} |
| 7 | + |
1 | 8 | Overview
|
2 | 9 | =====
|
3 | 10 |
|
4 | 11 | What Is Puppet Enterprise?
|
5 | 12 | -----
|
6 | 13 |
|
7 |
| -Puppet Enterprise is a fully supported software distribution that bundles the Puppet family of systems management tools, adds several premium enterprise-only features, and deploys all of it in a highly scalable default configuration. |
| 14 | +Puppet Enterprise is a fully supported software distribution of the Puppet family of systems management tools. It adds several premium enterprise-only features, and deploys out-of-the-box into a highly scalable production-ready configuration. |
8 | 15 |
|
9 |
| -- **Puppet** is an industry-leading configuration management platform that lets you describe a desired system state as code and enforce that state on any number of machines. |
10 |
| -- **MCollective** is a message-based server orchestration framework for fast parallel command execution. |
11 |
| -- **Puppet Dashboard** is a web interface to Puppet. It can view and analyze Puppet's reports, and can simplify the process of assigning your existing Puppet classes to nodes. |
| 16 | +- **Puppet** (version 2.6.9) is an industry-leading configuration management platform that lets you describe a desired system state as code and enforce that state on any number of machines. |
| 17 | +- **MCollective** (version 1.2.1) is a message-based server orchestration framework for fast parallel command execution. |
| 18 | +- **Puppet Dashboard** (version 1.2) is a web interface to Puppet. It can view and analyze Puppet's reports, and can simplify the process of assigning your existing Puppet classes to nodes. |
12 | 19 | - **Puppet Compliance** is an enterprise-only extension to Puppet Dashboard that enables a new auditing workflow for unmanaged resources.
|
13 |
| -- **Facter** is a system data discovery utility used by both Puppet and MCollective. |
14 |
| -- **Accounts** is a ready-to-use Puppet module for managing user accounts. |
| 20 | +- **Facter** (version 1.6.0) is a system data discovery utility used by both Puppet and MCollective. |
| 21 | +- **Accounts** (version 1.0.0) is a ready-to-use Puppet module for managing user accounts. |
15 | 22 |
|
16 |
| -To get maximum compatibility and performance on your existing systems, PE bundles and maintains its own versions of Ruby, Apache, and all required libraries, and sequesters all included software in the `/opt/puppet` directory. This lets us enable advanced features while still shielding users from dependency conflicts, and it offers a relatively seamless transition path for users migrating from a manually maintained Puppet installation. |
| 23 | +To get maximum compatibility and performance on your existing systems, PE bundles and maintains its own versions of Ruby, Apache, and all required libraries, and installs all included software in the `/opt/puppet` directory. This lets us enable advanced features while still shielding users from dependency conflicts, and it offers a relatively seamless transition path for users migrating from a manually maintained Puppet installation. |
17 | 24 |
|
18 |
| -PE Roles |
| 25 | +Roles |
19 | 26 | -----
|
20 | 27 |
|
21 | 28 | Puppet Enterprise's features are divided into three main **roles,** any or all of which can be installed on a single computer:
|
22 | 29 |
|
23 | 30 | - The **puppet agent** role should be installed on every node Puppet will be managing; it installs Puppet, and enables the puppet agent service (`pe-puppet`) that checks in with the puppet master every half-hour and applies the node's catalog. This role also installs (but doesn't automatically enable) the MCollective server, which listens and responds to messages on the ActiveMQ Stomp bus; to enable MCollective on a node, use Puppet to assign the `mcollectivepe` class to it.
|
24 |
| -- The **puppet master** role should be installed on exactly one server at your site[^multi]; it installs Puppet, Apache, the ActiveMQ server, and the MCollective control client. Servers with this role will respond to catalog requests from puppet agent nodes (using instances of puppet master managed by the `pe-httpd` Apache service), and will act as the hub for all MCollective traffic at the site. Puppet master can be configured during installation to submit reports to and request node classifications from Puppet Dashboard. |
25 |
| -- The **Puppet Dashboard** role should be installed on exactly one server at your site; it installs Puppet Dashboard (with the Puppet Compliance extension), Puppet, and Apache, and configures them to respond to requests from the puppet master, serve a web interface to your site's administrators, and act as a machine inventory browser and file content viewer. The Dashboard role should usually be installed on the same machine as the puppet master role; splitting the two roles between different machines can increase performance in some situations, but will require some additional configuration. |
| 31 | +- The **puppet master** role should be installed on exactly one<!-- [^multi] --> server at your site; it installs Puppet, Apache, the ActiveMQ server, and the MCollective control client. Servers with this role will respond to catalog requests from puppet agent nodes (using instances of puppet master managed by the `pe-httpd` Apache service), and will act as the hub for all MCollective traffic at the site. Puppet master can be configured during installation to submit reports to and request node classifications from Puppet Dashboard. |
| 32 | +- The **Puppet Dashboard** role should be installed on exactly one server at your site; it installs Puppet Dashboard (with the Puppet Compliance extension), Puppet, and Apache, and configures them to respond to requests from the puppet master, serve a web interface to your site's administrators, and act as a machine inventory browser and file content viewer. Unlike the other two roles, Puppet Dashboard is an optional component of your site. The Dashboard role should usually be installed on the same machine as the puppet master role; splitting the two roles between different machines can increase performance in some situations, but will require some additional configuration. |
| 33 | + |
| 34 | +<!-- For future releases: [^multi]: A future release of PE may add support for multi-master ecosystems, but for the time being, they require significant extra configuration which won't be covered in this manual. --> |
| 35 | + |
| 36 | + |
| 37 | +Licensing |
| 38 | +------ |
26 | 39 |
|
| 40 | +Puppet Enterprise can be evaluated with a complementary ten-node license; beyond that, a commercial per-node license is required for use. A license key file will have been emailed to you after your purchase, and the puppet master <!-- Notes for future versions where we allow multi-masters: licensing happens on the master that serves as the site's certificate authority --> will look for this key at `/etc/puppetlabs/license.key`. Puppet will log warnings if the license is expired or exceeded, and you can view the status of your license by running `puppet license` at the command line on the puppet master. |
27 | 41 |
|
28 |
| -[^multi]: A future release of PE may add support for multi-master ecosystems, but for the time being, they require significant extra configuration which won't be covered in this manual. |
| 42 | +To purchase a license, please see the [Puppet Enterprise pricing page](http://www.puppetlabs.com/puppet/how-to-buy/), or contact Puppet Labs at <[email protected]> or (877) 575-9775. For more information on licensing terms, please see [the licensing FAQ](http://www.puppetlabs.com/licensing-faq/). If you have misplaced or never received your license key, please contact <[email protected]>. |
29 | 43 |
|
30 |
| -<!-- TK don't know what else goes here. --> |
|
0 commit comments