Revision cad1cd0f
Added by Ewoud Kohl van Wijngaarden about 5 years ago
| manifests/admin.pp | ||
|---|---|---|
|
#
|
||
|
# == Class: pulp::admin
|
||
|
#
|
||
|
# Install and configure Pulp admin
|
||
|
#
|
||
|
# === Parameters:
|
||
|
#
|
||
|
# $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.
|
||
|
#
|
||
|
# $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
|
||
|
#
|
||
|
# $ca_path:: This is a path to a file of concatenated trusted CA certificates, or to a directory of trusted
|
||
|
# CA certificates (with openssl-style hashed symlinks, one certificate per file).
|
||
|
# @param ca_path
|
||
|
# This is a path to a file of concatenated trusted CA certificates, or to a
|
||
|
# directory of trusted CA certificates (with openssl-style hashed symlinks,
|
||
|
# one certificate per file).
|
||
|
#
|
||
|
# $upload_chunk_size:: upload_chunk_size
|
||
|
# @param upload_chunk_size
|
||
|
# upload_chunk_size
|
||
|
#
|
||
|
# $role:: The client role.
|
||
|
# @param role
|
||
|
# The client role.
|
||
|
#
|
||
|
# $extensions_dir:: The location of admin client extensions.
|
||
|
# @param extensions_dir
|
||
|
# The location of admin client extensions.
|
||
|
#
|
||
|
# $id_cert_dir:: The location of the directory where the Pulp user ID certificate is stored.
|
||
|
# @param id_cert_dir
|
||
|
# The location of the directory where the Pulp user ID certificate is stored.
|
||
|
#
|
||
|
# $id_cert_filename:: The name of the file containing the PEM encoded client private key and X.509
|
||
|
# certificate. This file is downloaded and stored here during login.
|
||
|
# @param id_cert_filename
|
||
|
# The name of the file containing the PEM encoded client private key and
|
||
|
# X.509 certificate. This file is downloaded and stored here during login.
|
||
|
#
|
||
|
# $upload_working_dir:: Directory where status files for in progress uploads will be stored
|
||
|
# @param upload_working_dir
|
||
|
# Directory where status files for in progress uploads will be stored
|
||
|
#
|
||
|
# $log_filename:: The location of the admin client log file.
|
||
|
# @param log_filename
|
||
|
# The location of the admin client log file.
|
||
|
#
|
||
|
# $call_log_filename:: If present, the raw REST responses will be logged to the given file.
|
||
|
# @param 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.
|
||
|
#
|
||
|
# $enable_puppet:: Install puppet extension. Defaults to false.
|
||
|
# @param enable_puppet
|
||
|
# Install puppet extension. Defaults to false.
|
||
|
#
|
||
|
# $enable_deb:: Install deb extension. Defaults to false.
|
||
|
# @param enable_deb
|
||
|
# Install deb extension. Defaults to false.
|
||
|
#
|
||
|
# $enable_docker:: Install docker extension. Defaults to false.
|
||
|
# @param enable_docker
|
||
|
# Install docker extension. Defaults to false.
|
||
|
#
|
||
|
# $enable_nodes:: Install nodes extension. Defaults to false.
|
||
|
# @param enable_nodes
|
||
|
# Install nodes extension. Defaults to false.
|
||
|
#
|
||
|
# $enable_python:: Install python extension. Defaults to false.
|
||
|
# @param enable_python
|
||
|
# Install python extension. Defaults to false.
|
||
|
#
|
||
|
# $enable_ostree:: Install ostree extension. Defaults to false.
|
||
|
# @param enable_ostree
|
||
|
# Install ostree extension. Defaults to false.
|
||
|
#
|
||
|
# $enable_rpm:: Install rpm extension. Defaults to true.
|
||
|
# @param enable_rpm
|
||
|
# Install rpm extension. Defaults to true.
|
||
|
#
|
||
|
# $enable_iso:: Install ISO extension. Defaults to true.
|
||
|
# @param enable_iso
|
||
|
# Install ISO extension. Defaults to true.
|
||
|
#
|
||
|
# $puppet_upload_working_dir:: Directory where status files for in progress uploads will be stored
|
||
|
# @param puppet_upload_working_dir
|
||
|
# Directory where status files for in progress uploads will be stored
|
||
|
#
|
||
|
# $puppet_upload_chunk_size:: Maximum amount of data (in bytes) sent for an upload in a single request
|
||
|
# @param puppet_upload_chunk_size
|
||
|
# Maximum amount of data (in bytes) sent for an upload in a single request
|
||
|
#
|
||
|
# $login_method:: The method to ensure root can use pulp-admin. Choose none to disable this behaviour.
|
||
|
# @param login_method
|
||
|
# The method to ensure root can use pulp-admin. Choose none to disable this
|
||
|
# behaviour.
|
||
|
#
|
||
|
# $username:: The username to login with
|
||
|
# @param username
|
||
|
# The username to login with
|
||
|
#
|
||
|
# $password:: The password to login with. If left undefined then no login will be performed.
|
||
|
# @param password
|
||
|
# The password to login with. If left undefined then no login will be
|
||
|
# performed.
|
||
|
#
|
||
|
class pulp::admin (
|
||
|
String $version = $pulp::admin::params::version,
|
||
Also available in: Unified diff
Convert documentation to yardoc
This allows easy generation of reference documentation
(rake strings:generate:reference).