Skip to content

Commit 2c903d0

Browse files
committed
First incomplete pass on PE 1.2 manual
This commit adds a partial manual for Puppet Enterprise 1.2. There are several chapters still pending at this time.
1 parent ffcc8da commit 2c903d0

16 files changed

+399
-178
lines changed

source/pe/1.2/answer_file_reference.markdown

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
Appendix A: Answer File Reference
2-
=================================
1+
---
2+
layout: default
3+
title: "PE Manual: Answer File Reference"
4+
---
5+
6+
{% include pe_nav.markdown %}
7+
8+
Answer File Reference
9+
=====================
310

411
When run with the `-a` or `-A` flag and a filename argument, the Puppet Enterprise installer will read its installation instructions from an answer file. `-a` will use the provided answer file to perform a non-interactive installation (which will fail if any required variables are not set), and `-A` will perform a partially-interactive installation, prompting the user for any missing answers.
512

-16 KB
Loading
Loading
Loading
Loading
Loading

source/pe/1.2/index.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
layout: default
3+
title: "PE Manual: Index"
4+
---
5+
6+
{% include pe_nav.markdown %}

source/pe/1.2/installing.markdown

Lines changed: 138 additions & 66 deletions
Large diffs are not rendered by default.

source/pe/1.2/intro.markdown

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ layout: default
33
title: "PE Manual: Introduction"
44
---
55

6+
{% include pe_nav.markdown %}
7+
68
Welcome to Puppet Enterprise!
79
=============================
810

@@ -22,7 +24,7 @@ System Requirements
2224

2325
Puppet Enterprise 1.2 supports the following operating system versions:
2426

25-
| Operating system | Version | Arch | Support |
27+
| Operating system | Version | Arch | Support |
2628
|------------------------------|---------------------------|-------------------|--------------|
2729
| Red Hat Enterprise Linux | 5 and 6 | x86 and x86\_64 | master/agent |
2830
| Red Hat Enterprise Linux | 4 | x86 and x86\_64 | agent |
@@ -35,31 +37,24 @@ Puppet Enterprise 1.2 supports the following operating system versions:
3537
| SUSE Linux Enterprise Server | 11 | x86 and x86\_864 | master/agent |
3638
| Solaris | 10 | SPARC and x86\_64 | agent |
3739

38-
Puppet's hardware requirements will depend heavily on the number of resources you are managing, but in general, you can expect a 2-4 CPU puppet master with 4GB of RAM to manage approximately 1,000 agent nodes. <!-- TK get this vetted -->
39-
40-
Licensing
41-
------
42-
43-
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 serving as the 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.
44-
45-
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]>.
40+
Puppet's hardware requirements will depend heavily on the number of resources you are managing, but in general, you can expect a 2-4 CPU puppet master with 4 GB of RAM to manage approximately 1,000 agent nodes. The ActiveMQ server, which runs on the puppet master, will require at least 512 MB of RAM for its Java VM instance.
4641

4742
What's New in PE 1.2
4843
----------
4944

50-
Version 1.2 is a major release of Puppet Enterprise, which adds the following high-level features:
45+
Version 1.2 is a major release of Puppet Enterprise, which adds the following new features:
5146

5247
### MCollective integration
5348

54-
Puppet Enterprise now bundles Marionette Collective, Puppet Labs' server orchestration framework. <!-- TK what version are we using? -->
49+
Puppet Enterprise now bundles version 1.2.1 of Marionette Collective, Puppet Labs' server orchestration framework.
5550

5651
### Puppet 2.6.9
5752

58-
This release updates Puppet to version 2.6.9, the latest release in the stable 2.6 series. <!--tk vet this -->
53+
This release updates Puppet to version 2.6.9, the latest release in the stable 2.6 series.
5954

6055
### Accounts 1.0 Module
6156

62-
PE now includes a ready-to-use Puppet module for managing user accounts. This module provides both a standard defined type, and a class that lets you store all account data in an external YAML file.
57+
PE now includes a ready-to-use Puppet module for managing user accounts. This module provides an account defined type and an optional wrapper class that lets you store all account data in an external YAML file.
6358

6459
### Stdlib 2.0 Module
6560

@@ -75,8 +70,13 @@ This helper module extends Puppet with:
7570
How to Get Help and Support
7671
--------------
7772

78-
<!-- TK I'm not sure what goes here. -->
73+
If you run into trouble, you can take advantage of Puppet Labs' enterprise technical support.
74+
75+
* To file a support ticket, go to [support.puppetlabs.com](http://support.puppetlabs.com).
76+
* To reach our support staff via email, contact <[email protected]>.
77+
* To speak directly to our support staff, call 1-877-575-9775.
7978

80-
### Other Documentation
79+
Other Documentation
80+
-----
8181

8282
For help with features not specific to Puppet Enterprise, please see the [main Puppet documentation][docs] and the [MCollective documentation][mco].

source/pe/1.2/overview.markdown

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,43 @@
1+
---
2+
layout: default
3+
title: "PE Manual: Overview"
4+
---
5+
6+
{% include pe_nav.markdown %}
7+
18
Overview
29
=====
310

411
What Is Puppet Enterprise?
512
-----
613

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.
815

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.
1219
- **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.
1522

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.
1724

18-
PE Roles
25+
Roles
1926
-----
2027

2128
Puppet Enterprise's features are divided into three main **roles,** any or all of which can be installed on a single computer:
2229

2330
- 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+
------
2639

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.
2741

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]>.
2943

30-
<!-- TK don't know what else goes here. -->

0 commit comments

Comments
 (0)