Writing custom functions

Open source Puppet 6.10

• Welcome to Puppet 6.10
  • Puppet architecture
  • Puppet packages and versions
  • Puppet language and code
  • Glossary
• Release notes
  • Puppet release notes
  • Puppet known issues
• Getting started with Puppet
  • Managing NTP
  • Managing DNS
  • Managing sudo
  • Manage firewall rules
• Installing and upgrading
  • System requirements
  • Using the Puppet platform
  • Installing Puppet
  • Installing agents
  • Upgrading
• Configuring Puppet
  • Puppet settings
  • Key configuration settings
  • Puppet's configuration files
    • puppet.conf: The main config file
    • environment.conf: Per-environment settings
    • fileserver.conf: Custom fileserver mount points
    • puppetdb.conf: PuppetDB server locations
    • hiera.yaml: Data lookup configuration
    • autosign.conf: Basic certificate autosigning  
    • csr_attributes.yaml: Certificate extensions 
    • custom_trusted_oid_mapping.yaml: Short names for cert extension OIDs
    • device.conf: Network hardware access
    • routes.yaml: Advanced plugin routing
  • Configuring Puppet Server
    • Puppet Server's config files
    • puppetserver.conf: Main config file
    • auth.conf: Access control
    • webserver.conf: Jetty web server config
    • web-routes.conf: Mount points for component services
    • global.conf: Trapperkeeper settings
    • ca.conf: CA service access control (deprecated)
    • master.conf: Authorization by HTTP header (deprecated)
    • product.conf: Configuring Product-level Interactions (optional)
    • logback.xml: Logging level and location
    • Advanced logging configuration
    • Bootstrap upgrade notes
  • Adding file server mount points
  • Checking the values of settings
  • Editing settings on the command line
  • Configuration settings reference
  • Settings that differ under Puppet Server
• Important directories and files
  • Code and data directory (codedir)
  • Config directory (confdir)
  • Main manifest directory
  • The modulepath
  • SSL directory (ssldir)
  • Cache directory (vardir)
• Environments
  • About environments
  • Creating environments
  • Environment isolation
• Modules
  • Module fundamentals
  • Plug-ins in modules
  • Module cheat sheet
  • Installing and managing modules from the command line
  • Beginner's guide to writing modules
  • Module metadata
  • Documenting modules
  • Documenting modules with Puppet Strings
  • Puppet Strings style guide
  • Publishing modules
  • Contributing to Puppet modules
• Puppet services and tools
  • Puppet commands
  • Running Puppet commands on Windows
  • Puppet master
    • Puppet Server
  • Puppet agent on *nix systems
  • Puppet agent on Windows
  • Puppet apply
  • Puppet device
• Puppet Server
  • Index
  • About Puppet Server
  • Release Notes
  • Deprecated features
  • Compatibility with Puppet agent
  • Installing Puppet Server
  • Configuring Puppet Server
  • Differing behavior in puppet.conf
  • Using and extending Puppet Server
    • Subcommands
    • Using Ruby gems
    • Using an external certificate authority
    • Intermediate CA
    • Infrastructure certificate revocation list
    • External SSL termination
    • Monitoring Puppet Server metrics
      • HTTP client metrics
    • Tuning guide
    • Applying metrics to improve performance
    • Scaling Puppet Server
    • Restarting Puppet Server
  • Known issues and workarounds
    • Known issues
    • SSL problems with load-balanced PuppetDB servers (“Server Certificate Change” error)
  • Administrative API endpoints
    • Environment cache
    • JRuby pool
  • CA v1 API
    • Certificate
    • Certificate signing requests
    • Certificate status
    • Certificate revocation list
  • Server-specific Puppet API endpoints
    • Environment classes
    • Environment modules
    • Static file content
  • Status API endpoints
    • Status services
  • Metrics API endpoints
    • v1 metrics
    • v2 (Jolokia) metrics
  • Developer information
    • Developer debugging
    • Running from source
    • Tracing code events
• The Puppet language
  • Language visual index
  • The Puppet language style guide
  • Files and paths on Windows
  • Code comments
  • Variables
  • Resources
  • Relationships and ordering
  • Classes
  • Defined resource types
  • Bolt tasks
  • Type aliases
  • Expressions and operators
  • Conditional statements and expressions
  • Function calls
  • Built-in functions
  • Node definitions
  • Facts and built-in variables
  • Reserved words and acceptable names
  • Custom resources
    • Develop types and providers with the Resource API
    • Resource API reference
    • Low-level method for developing types and providers
      • Type development
      • Provider development
  • Values and data types
    • Strings
    • Numbers
    • Booleans
    • Arrays
    • Hashes
    • Regular expressions
    • Sensitive
    • Time-related data types
    • Undef
    • Default
    • Resource and class references
    • Resource types
    • Data type syntax
    • Abstract data types
  • Templates
    • Creating templates using Embedded Puppet
    • Creating templates using Embedded Ruby
  • Advanced constructs
    • Iteration and loops
    • Lambdas
    • Resource default statements
    • Resource collectors
    • Virtual resources
    • Exported resources
    • Tags
    • Run stages
  • Details of complex behaviors
    • Containment of resources
    • Scope
    • Namespaces and autoloading
• Writing custom functions
  • Custom functions
  • Custom Puppet functions
  • Writing custom functions in Ruby
    • Overview
    • Ruby function signatures
    • Using special features in implementation methods
    • Iterative functions
    • Refactoring legacy 3.x functions
  • Secrets store integrations and agent-side data retrieval
  • Write a Puppet function to store secrets
• Hiera
  • About Hiera
  • Getting started with Hiera
  • Configuring Hiera
  • Creating and editing data
  • Looking up data with Hiera
  • Writing new data backends
  • Upgrading to Hiera 5
• Facter
  • Facter release notes
  • Core facts
  • Custom facts
  • Custom facts walkthrough
  • External facts
  • Configuring Facter with facter.conf
• Resource types
  • All resource types
  • Core types cheat sheet
  • Optional resource types for Windows
  • exec
  • Using exec on Windows
  • file
  • Using file on Windows
  • filebucket
  • group
  • Using user and group on Windows
  • index
  • notify
  • package
  • Using package on Windows
  • resources
  • schedule
  • service
  • Using service
  • stage
  • tidy
  • user
• Tracking Puppet activity with reports
  • Reporting
  • Report reference
  • Writing custom report processors
  • Report format
• Writing external node classifiers
• References (settings, functions, etc.)
  • Configuration settings reference
  • Functions
  • Metaparameters
  • Built-in report processors
  • Ruby API for developing extensions
• Man pages
  • Index
  • Core tools
    • puppet agent
    • puppet apply
    • puppet module
    • puppet resource
    • puppet lookup
  • Occasionally useful
    • puppet config
    • puppet describe
    • puppet device
    • puppet doc
    • puppet help
    • puppet man
    • puppet node
    • puppet parser
    • puppet plugin
  • Niche
    • puppet catalog
    • puppet facts
    • puppet filebucket
    • puppet key
    • puppet report
    • puppet status
• HTTP API
  • Puppet Server HTTP API
  • PSON
  • Puppet v4 API
    • Catalog
  • Puppet v3 API
    • Catalog
    • Node
    • File bucket file
    • File content
    • File metadata
    • Report
    • Environments
    • Status
  • CA v1 API
    • Certificate
    • Certificate signing requests
    • Certificate status
    • Certificate revocation list
  • Schemas (JSON)
• Certificate authority and SSL
  • Puppet Server CA commands
  • Intermediate CA
  • Autosigning certificate requests
  • CSR attributes and certificate extensions
  • Regenerating certificates in a Puppet deployment
  • External CA
  • External SSL termination with Puppet Server
• Puppet's internals
  • Agent-master HTTPS communications
  • Catalog compilation
• Experimental features
  • Msgpack support