Revision cad1cd0f
Added by Ewoud Kohl van Wijngaarden about 5 years ago
| manifests/consumer.pp | ||
|---|---|---|
|
#
|
||
|
# == Class: pulp::consumer
|
||
|
#
|
||
|
# Install and configure Pulp consumers
|
||
|
#
|
||
|
# === Parameters:
|
||
|
#
|
||
|
# $ca_path:: Path to use for the CA
|
||
|
# @param ca_path
|
||
|
# Path to use for the CA
|
||
|
#
|
||
|
# $version:: pulp admin package version, it's passed to ensure parameter of package resource
|
||
|
# can be set to specific version number, 'latest', 'present' etc.
|
||
|
# @param version
|
||
|
# pulp admin package version, it's passed to ensure parameter of package
|
||
|
# resource can be set to specific version number, 'latest', 'present' etc.
|
||
|
#
|
||
|
# $enable_puppet:: Install puppet extension. Only available on pulp 2.6 and higher
|
||
|
# @param enable_puppet
|
||
|
# Install puppet extension
|
||
|
#
|
||
|
# $enable_nodes:: Install nodes extension
|
||
|
# @param enable_nodes
|
||
|
# Install nodes extension
|
||
|
#
|
||
|
# $enable_rpm:: Install rpm extension
|
||
|
# @param enable_rpm
|
||
|
# Install rpm extension
|
||
|
#
|
||
|
# $host:: The pulp server hostname
|
||
|
# @param host
|
||
|
# The pulp server hostname
|
||
|
#
|
||
|
# $port:: The port providing the RESTful API
|
||
|
# @param port
|
||
|
# The port providing the RESTful API
|
||
|
#
|
||
|
# $api_prefix:: The REST API prefix.
|
||
|
# @param api_prefix
|
||
|
# The REST API prefix.
|
||
|
#
|
||
|
# $verify_ssl:: Set this to False to configure the client not to verify that the server's SSL cert is signed by
|
||
|
# a trusted authority
|
||
|
# @param verify_ssl
|
||
|
# Set this to False to configure the client not to verify that the server's
|
||
|
# SSL cert is signed by a trusted authority
|
||
|
#
|
||
|
# $rsa_server_pub:: The pulp server public key used for authentication.
|
||
|
# @param rsa_server_pub
|
||
|
# The pulp server public key used for authentication.
|
||
|
#
|
||
|
# $rsa_key:: The RSA private key used for authentication.
|
||
|
# @param rsa_key
|
||
|
# The RSA private key used for authentication.
|
||
|
#
|
||
|
# $rsa_pub:: The RSA public key used for authentication.
|
||
|
# @param rsa_pub
|
||
|
# The RSA public key used for authentication.
|
||
|
#
|
||
|
# $role:: The client role.
|
||
|
# @param role
|
||
|
# The client role.
|
||
|
#
|
||
|
# $extensions_dir:: The location of consumer client extensions.
|
||
|
# @param extensions_dir
|
||
|
# The location of consumer client extensions.
|
||
|
#
|
||
|
# $repo_file:: The location of the YUM repository file managed by pulp.
|
||
|
# @param repo_file
|
||
|
# The location of the YUM repository file managed by pulp.
|
||
|
#
|
||
|
# $mirror_list_dir:: The location of the directory containing YUM mirror list files that are managed by Pulp.
|
||
|
# @param mirror_list_dir
|
||
|
# The location of the directory containing YUM mirror list files that are
|
||
|
# managed by Pulp.
|
||
|
#
|
||
|
# $gpg_keys_dir:: The location of downloaded GPG keys stored by Pulp. The path to the
|
||
|
# keys stored here are referenced by Pulp's YUM repository file.
|
||
|
# @param gpg_keys_dir
|
||
|
# The location of downloaded GPG keys stored by Pulp. The path to the keys
|
||
|
# stored here are referenced by Pulp's YUM repository file.
|
||
|
#
|
||
|
# $cert_dir:: The location of downloaded X.509 certificates stored by Pulp. The path to
|
||
|
# the certificates stored here are referenced by Pulp's YUM repository file.
|
||
|
# @param cert_dir
|
||
|
# The location of downloaded X.509 certificates stored by Pulp. The path to
|
||
|
# the certificates stored here are referenced by Pulp's YUM repository file.
|
||
|
#
|
||
|
# $id_cert_dir:: The location of the directory where the Pulp consumer ID certificate is stored.
|
||
|
# @param id_cert_dir
|
||
|
# The location of the directory where the Pulp consumer ID certificate is stored.
|
||
|
#
|
||
|
# $id_cert_filename:: The name of the file containing the PEM encoded consumer private key and X.509
|
||
|
# certificate. This file is downloaded and stored here during registration.
|
||
|
# @param id_cert_filename
|
||
|
# The name of the file containing the PEM encoded consumer private key and
|
||
|
# X.509 certificate. This file is downloaded and stored here during
|
||
|
# registration.
|
||
|
#
|
||
|
# $reboot_permit:: Permit reboots after package installs if requested.
|
||
|
# @param reboot_permit
|
||
|
# Permit reboots after package installs if requested.
|
||
|
#
|
||
|
# $reboot_delay:: The reboot delay (minutes).
|
||
|
# @param reboot_delay
|
||
|
# The reboot delay (minutes).
|
||
|
#
|
||
|
# $logging_filename:: The location of the consumer client log file.
|
||
|
# @param logging_filename
|
||
|
# The location of the consumer client log file.
|
||
|
#
|
||
|
# $logging_call_log_filename:: If present, the raw REST responses will be logged to the given file.
|
||
|
# @param logging_call_log_filename
|
||
|
# If present, the raw REST responses will be logged to the given file.
|
||
|
#
|
||
|
# $poll_frequency_in_seconds:: Number of seconds between requests for any operation that repeatedly polls
|
||
|
# the server for data.
|
||
|
# @param poll_frequency_in_seconds
|
||
|
# Number of seconds between requests for any operation that repeatedly polls
|
||
|
# the server for data.
|
||
|
#
|
||
|
# $enable_color:: Set this to false to disable all color escape sequences
|
||
|
# @param enable_color
|
||
|
# Set this to false to disable all color escape sequences
|
||
|
#
|
||
|
# $wrap_to_terminal:: If wrap_to_terminal is true, any text wrapping will use the current width of
|
||
|
# the terminal. If false, the value in wrap_width is used.
|
||
|
# @param wrap_to_terminal
|
||
|
# If wrap_to_terminal is true, any text wrapping will use the current width
|
||
|
# of the terminal. If false, the value in wrap_width is used.
|
||
|
#
|
||
|
# $wrap_width:: The number of characters written before wrapping to the next line.
|
||
|
# @param wrap_width
|
||
|
# The number of characters written before wrapping to the next line.
|
||
|
#
|
||
|
# $messaging_scheme:: The broker URL scheme. Either 'tcp' or 'ssl' can be used. The default is 'tcp'.
|
||
|
# @param messaging_scheme
|
||
|
# The broker URL scheme. Either 'tcp' or 'ssl' can be used. The default is 'tcp'.
|
||
|
#
|
||
|
# $messaging_host:: The broker host (default: host defined in [server]).
|
||
|
# @param messaging_host
|
||
|
# The broker host (default: host defined in [server]).
|
||
|
#
|
||
|
# $messaging_port:: The broker port number. The default is 5672.
|
||
|
# @param messaging_port
|
||
|
# The broker port number. The default is 5672.
|
||
|
#
|
||
|
# $messaging_transport:: The AMQP transport name. Valid options are 'qpid' or 'rabbitmq'. The default is 'qpid'.
|
||
|
# @param messaging_transport
|
||
|
# The AMQP transport name. Valid options are 'qpid' or 'rabbitmq'. The
|
||
|
# default is 'qpid'.
|
||
|
#
|
||
|
# $messaging_vhost:: The (optional) broker vhost. This is only valid when using 'rabbitmq' as the messaging_transport.
|
||
|
# @param messaging_vhost
|
||
|
# The (optional) broker vhost. This is only valid when using 'rabbitmq' as
|
||
|
# the messaging_transport.
|
||
|
#
|
||
|
# $messaging_version:: Determines the version of packages related to the 'messaging transport protocol'.
|
||
|
# @param messaging_version
|
||
|
# Determines the version of packages related to the 'messaging transport
|
||
|
# protocol'.
|
||
|
#
|
||
|
# $messaging_cacert:: The (optional) absolute path to a PEM encoded CA certificate to validate the identity of the
|
||
|
# broker.
|
||
|
# @param messaging_cacert
|
||
|
# The (optional) absolute path to a PEM encoded CA certificate to validate
|
||
|
# the identity of the broker.
|
||
|
#
|
||
|
# $messaging_clientcert:: The optional absolute path to PEM encoded key & certificate used to authenticate to the broker
|
||
|
# with. The id_cert_dir and id_cert_filename are used if this is not defined.
|
||
|
# @param messaging_clientcert
|
||
|
# The optional absolute path to PEM encoded key & certificate used to
|
||
|
# authenticate to the broker with. The id_cert_dir and id_cert_filename are
|
||
|
# used if this is not defined.
|
||
|
#
|
||
|
# $profile_minutes:: The interval in minutes for reporting the installed content profiles.
|
||
|
# @param profile_minutes
|
||
|
# The interval in minutes for reporting the installed content profiles.
|
||
|
#
|
||
|
# $package_profile_enabled:: Updates package profile information for a registered consumer on pulp server
|
||
|
# @param package_profile_enabled
|
||
|
# Updates package profile information for a registered consumer on pulp server
|
||
|
#
|
||
|
# $package_profile_verbose:: Set logging level
|
||
|
# @param package_profile_verbose
|
||
|
# Set logging level
|
||
|
#
|
||
|
class pulp::consumer (
|
||
|
String $version = $pulp::consumer::params::version,
|
||
Also available in: Unified diff
Convert documentation to yardoc
This allows easy generation of reference documentation
(rake strings:generate:reference).