puppet enterprise

Download puppet enterprise

Post on 27-Nov-2015




7 download

Embed Size (px)


user guide for puppet enterprise


<ul><li><p>Puppet Enterprise 2.8 User's Guide(Generated on July 01, 2013, from git revision 46784ac1656bd7b57fcfb51d0865ec765533d9)</p></li><li><p>Puppet Enterprise User's GuideWelcome! This is the users guide for Puppet Enterprise 2.8.</p><p>If you are new to Puppet Enterprise, begin with the quick start guide to create a small proof-of-concept deployment and experience the core Puppet Enterprise tools and workows. Thisguided walkthrough will take approximately 30 minutes.To install Puppet Enterprise, see the following pages:</p><p>System RequirementsInstalling PEInstalling Windows AgentsPuppet Enterprise Downloads</p><p>To see whats new since the last release, see New Features.The Deployment Guide has a ton of information to help you set up and deploy Puppet Enterprisein accordance with the best practices and methods used by Puppet Labs professional servicesengineers.</p><p>Otherwise, use the navigation to the left to move between this guides sections and chapters.</p><p>About Puppet EnterpriseThank you for choosing Puppet Enterprise, IT automation software that allows systemadministrators to programmatically provision, congure, and manage servers, network devices andstorage, in the data center or in the cloud.</p><p>Puppet Enterprise (PE) oers:</p><p>Conguration management tools that let sysadmins dene a desired state for their infrastructureand then automatically enforce that state.A web-based console UI, for analyzing reports, managing your Puppet systems and users, andediting resources on the y.Powerful orchestration capabilities.An alternate compliance workow for auditing changes to unmanaged resources.Cloud provisioning tools for creating and conguring new VM instances.</p><p>This users guide will help you start using Puppet Enterprise 2.8, and will serve as a reference asyou gain more experience. It covers PE-specic features and oers brief introductions to Puppetand MCollective. Use the navigation at left to move between the guides sections and chapters.</p><p>Puppet Enterprise 2.8 User's Guide Puppet Enterprise User's Guide 2/210</p></li><li><p>About PuppetPuppet is the leading open source conguration management tool. It allows system congurationmanifests to be written in a high-level DSL, and can compose modular chunks of conguration tocreate a machines unique conguration. By default, Puppet Enterprise uses a client/server Puppetdeployment, where agent nodes fetch congurations from a central puppet master.</p><p>About OrchestrationPuppet Enterprise includes distributed task orchestration features. Nodes managed by PE will listenfor commands over a message bus, and independently take action when they hear an authorizedrequest. This lets you investigate and command your infrastructure in real time without relying on acentral inventory.</p><p>About the ConsolePEs console is the web front-end for managing your systems. The console can:</p><p>Trigger immediate Puppet runs on an arbitrary subset of your nodesBrowse and edit resources on your nodes in real timeAnalyze reports to help visualize your infrastructure over timeBrowse inventory data and backed-up le contents from your nodesGroup similar nodes and control the Puppet classes they receive in their catalogsRun advanced tasks powered by MCollective plugins</p><p>For New UsersIf youve never used Puppet before and want to evaluate Puppet Enterprise, follow the PuppetEnterprise quick start guide. This walkthrough will guide you through creating a smallproof-of-concept deployment while demonstrating the core features and workows ofPuppet Enterprise.</p><p>For Returning UsersSee the whats new page for the new features in this release of Puppet Enterprise. You cannd detailed release notes for updates within the 2.8.x series in the appendix of this guide.</p><p> NOTE: Orchestration and live management are not yet supported on Windows nodes.</p><p>Puppet Enterprise 2.8 User's Guide Puppet Enterprise User's Guide 3/210</p></li><li><p>About the Cloud Provisioning ToolsPE includes command line tools for building new nodes, which can create new VMware, Openstackand Amazon EC2 instances, install PE on any virtual or physical machine, and classify newlyprovisioned nodes within your Puppet infrastructure.</p><p>LicensingPE can be evaluated with a complimentary ten node license; beyond that, a commercial per-nodelicense is required for use. A license key le will have been emailed to you after your purchase, andthe puppet master will look for this key at /etc/puppetlabs/license.key . Puppet will log warningsif the license is expired or exceeded, and you can view the status of your license by running puppetlicense at the command line on the puppet master.</p><p>To purchase a license, please see the Puppet Enterprise pricing page, or contact Puppet Labs atsales@puppetlabs.com or (877) 575-9775. For more information on licensing terms, please see thelicensing FAQ. If you have misplaced or never received your license key, please contactsales@puppetlabs.com.</p><p>Next: New Features</p><p>New Features in PE 2.8Version 2.8.2PE 2.8.2 is a maintenance release that patches a critical security vulnerability. For details, check therelease notes.</p><p>Version 2.8.1PE 2.8.1 is a maintenance release. It includes a x for a bug that caused Live Management andMCollective ltering failures. Some other minor bug xes are also included. For details, check therelease notes. Users of 2.8.0 are strongly encouraged to upgrade to 2.8.1. If you applied the 2.8.0hotx that predates the 2.8.1 release, you should still upgrade to 2.8.1 in order to get all of thelatest xes.</p><p>Version 2.8.0PE 2.8.0 is a feature and maintenance release. Specically, the 2.8.0 release includes:</p><p>1. New Support for AIX The puppet agent can now be installed on nodes running AIX so you canmanage them using PE. To help you congure AIX nodes, support for AIX package providers, RPM,NIM and BFF, has been added as well. For information on installation on AIX nodes, check thesystem requirements and the installing PE page. In addition, the type reference has detailedinformation on AIX package providers.Puppet Enterprise 2.8 User's Guide New Features in PE 2.8 4/210</p></li><li><p>2. Component Version Bumps Several of the components that comprise PE have been bumped tonewer versions in 2.8. The updates include bug xes and performance improvements. With PE 2.8,most users should notice faster compiliation times and better performance. The updatedcomponents include:</p><p>Puppet 2.7.21Facter 1.6.17Hiera 1.1.2Hiera-Puppet 1.0.0Stomp 1.2.3</p><p>3. Security Patch A vulnerability in the PE installer has been patched. For details, check the releasenotes.</p><p>Next: Getting Support</p><p>Getting Support for Puppet EnterpriseGetting support for Puppet Enterprise is easy, both from Puppet Labs and the community of PuppetEnterprise users. We provide responsive, dependable, quality support to resolve any issuesregarding the installation, operation and use of Puppet.</p><p>There are three primary ways to get support for Puppet Enterprise:</p><p>Reporting issues to the Puppet Labs customer support portalJoining the Puppet Enterprise user group.Seeking help from the Puppet open source community.</p><p>Reporting Issues to the customer support portalPaid SupportPuppet Labs provides two levels of commercial support oerings for Puppet Enterprise: Standardand Premium. Both oerings allow you to report your support issues to our condential customersupport portal. You will receive an account and log-on for this portal when you purchase PuppetEnterprise.</p><p>Customer support portal: https://support.puppetlabs.comTHE PE SUPPORT SCRIPTWhen seeking support, you may be asked to run the information-gathering support script includedwith in the Puppet Enterprise installer tarball. This script is located in the root of the unzippedtarball and is named simply support .</p><p>Puppet Enterprise 2.8 User's Guide Getting Support for Puppet Enterprise 5/210</p></li><li><p>This script will collect a large amount of system information, compress it, and print the location ofthe zipped tarball when it nishes running; an uncompressed directory (named support )containing the same data will be left in the same directory the compressed copy. We recommendthat you examine the collected data before forwarding it to Puppet Labs, as it may contain sensitiveinformation that you will wish to redact.</p><p>The information collected by the support script includes:</p><p>iptables info (is it loaded? what are the inbound and outbound rules?) (both ipv4 and ipv6)a full run of facter (if installed)selinux statusthe amount of free disk and memory on the systemhostname info (/etc/hosts and the output of hostname--fqdn )the umask of the systemntp conguration (what servers are available, the oset from them)a listing (no content) of the les in /opt/puppet , /var/opt/lib/pe-puppet and</p><p>/var/opt/lib/pe-puppetmaster</p><p>the os and kernela list of installed packagesthe current process lista listing of puppet certsa listing of all services (except on Debian, which lacks the equivalent command)current environment variableswhether the puppet master is reachablethe output of mcoping and mcoinventory</p><p>It also copies the following les:</p><p>system logsthe contents of /etc/puppetlabsthe contents of /var/log/pe-*</p><p>Free SupportIf you are evaluating Puppet Enterprise, we also oer support during your evaluation period. Duringthis period you can report issues with Puppet Enterprise to our public support portal. Please beaware that all issues led here are viewable by all other users.</p><p>Public support portal: http://projects.puppetlabs.com/projects/puppet-enterprise</p><p>Join the Puppet Enterprise user groupPuppet Enterprise 2.8 User's Guide Getting Support for Puppet Enterprise 6/210</p></li><li><p>http://groups.google.com/a/puppetlabs.com/group/pe-users</p><p>Click on Sign in and apply for membershipClick on Enter your email address to access the documentEnter your email address.</p><p>Your request to join will be sent to Puppet Labs for authorization and you will receive an emailwhen youve been added to the user group.</p><p>Getting support from the existing Puppet CommunityAs a Puppet Enterprise customer you are more than welcome to participate in our large and helpfulopen source community as well as report issues against the open source project.</p><p>Puppet open source user group:</p><p>http://groups.google.com/group/puppet-usersPuppet Developers group:</p><p>http://groups.google.com/group/puppet-devReport issues with the open source Puppet project:</p><p>http://projects.puppetlabs.com/projects/puppet</p><p>Next: Quick Start</p><p>Quick Start: Using PE 2.8Welcome to the PE 2.8 quick start guide. This document is a short walkthrough to help you evaluatePuppet Enterprise and become familiar with its features. Follow along to learn how to:</p><p>Install a small proof-of-concept deploymentAdd nodes to your deploymentExamine nodes in real time with live managementInstall a third-party Puppet moduleApply Puppet classes to nodes with the console</p><p>Creating a DeploymentA standard Puppet Enterprise deployment consists of:</p><p>Following this walkthrough will take approximately 30 minutes.</p><p>Puppet Enterprise 2.8 User's Guide Quick Start: Using PE 2.8 7/210</p></li><li><p>Many agent nodes, which are computers managed by Puppet.At least one puppet master server, which serves congurations to agent nodes.At least one console server, which analyzes agent reports and presents a GUI for managing yoursite.</p><p>For this deployment, the puppet master and the console will be the same machine, and we will haveone additional agent node.</p><p>Preparing Your Proof-of-Concept SystemsTo create this small deployment, you will need the following:</p><p>At least two computers (nodes) running a *nix operating system supported by PuppetEnterprise.</p><p>These can be virtual machines or physical servers.One of these nodes (the puppet master server) should have at least 1 GB of RAM. Note:For actual production use, a puppet master node should have at least 4 GB of RAM.</p><p>Optionally, a computer running a version of Microsoft Windows supported by PuppetEnterprise.Puppet Enterprise installer tarballs suitable for the OS and architecture your nodes areusing.A network all of your nodes should be able to reach each other.An internet connection or a local mirror of your operating systems package repositories,for downloading additional software that Puppet Enterprise may require.Properly congured rewalls.</p><p>For demonstration purposes, all nodes should allow all trac on ports 8140, 61613,and 443. (Production deployments can and should partially restrict this trac.)</p><p>Properly congured name resolution.Each node needs a unique hostname, and they should be on a shared domain. For therest of this walkthrough, we will refer to the puppet master as master.example.com ,the rst agent node as agent1.example.com , and the Windows node as</p><p>windows.example.com . You can use any hostnames and any domain; simply substitutethe names as needed throughout this document.All nodes must know their own hostnames. This can be done by properly conguringreverse DNS on your local DNS server, or by setting the hostname explicitly. Setting thehostname usually involves the hostname command and one or more congurationles, while the exact method varies by platform.All nodes must be able to reach each other by name. This can be done with a local DNSserver, or by editing the /etc/hosts le on each node to point to the proper IPaddresses. Test this by running pingmaster.example.com and pingagent1.example.com on every node, including the Windows node if present.</p><p>Puppet Enterprise 2.8 User's Guide Quick Start: Using PE 2.8 8/210</p></li><li><p>Installing the Puppet MasterOn the puppet master node, log in as root or with a root shell. (Use sudo-s to get a root shell ifyour operating systems root account is disabled, as on Debian and Ubuntu.)Download the Puppet Enterprise tarball, extract it, and navigate to the directory it creates.Run ./puppet-enterprise-installer . The installer will ask a series of questions about whichcomponents to install, and how to congure them.</p><p>Install the puppet master and console roles; the cloud provisioner role is not required, butmay be useful if you later promote this machine to production.Make sure that the unique certname matches the hostname you chose for this node. (Forexample, master.example.com .)You will need the email address and console password it requests in order to use the console;choose something memorable.None of the other passwords are relevant to this quick start guide. Choose somethingrandom.Accept the default responses for every other question by hitting enter.</p><p>The installer will then install and congure Puppet Enterprise. It will probably need to installadditional packages from your OSs repository, including Java and MySQL.</p><p>Installing the Agent NodeOn the agent node, log in as root or with a root shell. (Use sudo-s to get a root shell if youroperating systems root account is disabled.)Download the Puppet Enterprise tarball, extract it, and navigate to the directory it creates.Run ./puppet-enterprise-installer . The installer will ask a series of questions about whichcomponents to install, and how to congure them.</p><p>Skip the puppet master and console roles; install the puppet agent role. The cloud provisionerrole is optional and is not used in this e...</p></li></ul>