Version information
This version is compatible with:
Start using this module
Add this module to your Puppetfile:
mod 'walkamongus-pulp', '0.1.2'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with pulp
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
Overview
This module installs and configures the Pulp repository management software.
Module Description
This module specifically limits itself to the Pulp software and does not try to manage any other components that make up a Pulp server. This is to provide maximum flexibility and minimal scope.
It should be combined with web server, messaging transport, and database module to configure a working Pulp server.
Setup
What pulp affects
- Packages
- pulp-server
- pulp-selinux
- python-pulp-streamer
- python-gofer-(qpid|amqp)
- pulp-*-plugins packages
- pulp-admin-client
- pulp-*-admin-extensions packages
- pulp-puppet-tools
- python-pulp-puppet-common
- Files
- /etc/pulp/admin/admin.conf
- /etc/pulp/admin/conf.d/puppet.conf
- /etc/pki/pulp/rsa.key
- /etc/pulp/repo_auth.conf
- /etc/pulp/server/plugins.conf.d/ files
- /etc/sysconfig/pulp_workers
- Services
- pulp_celerybeat
- pulp_resource_manager
- pulp_workers
- pulp_streamer
- Execs
- pulp-gen-key-pair
- pulp-gen-ca-certificate
- pulp-manage-db
- reloading systemctl daemon
Beginning with pulp
You will need a working MongoDB database and your webserver user present before declaring the Pulp module. By default the module will attempt to connect to a database at the default location with the default credentials and run the pulp-manage-db command as the webserver user for database migrations.
class { '::pulp': }
The pulp-manage-db command can be disabled:
class { '::pulp':
exec_pulp_manage_db => false,
}
Usage
Install Pulp 2.14 with the RPM plugin enabled, repo managed, OAuth disabled, and webserver user/group management disabled:
class { '::pulp':
version => '2.14',
server_default_login => test,
server_default_password => testpass,
oauth_enabled => false,
enable_plugins => ['rpm'],
manage_http_user => false,
manage_http_group => false,
manage_repo => true,
}
Reference
Parameters
All defaults can be found in the data directory files.
version
: Version of Pulp to install and configure.pulp_packages_ensure
: Ensure value for the Pulp packages.gofer_package_ensure
: Ensure value for the gofer packages.enable_plugins
: Array of Pulp plugins to enable.http_user
: User the webserver runs under.manage_http_user
: Enable/disable management of the webserver user.http_group
: Group the webserver runs under.manage_http_group
: Enable/disable management of the webserver group.exec_pulp_manage_db
: Enable/Disable execution of the pulp-manage-db command.manage_repo
: Enable/disable management of the Pulp repo.repo_proxy
: Proxy used for connecting to the Pulp repo.proxy_host
: Proxy host for plugin configuration.proxy_port
: Proxy port for plugin configuration.proxy_username
: Proxy username for plugin configuration.proxy_password
: Proxy password for plugin configuration.number_workers
: Number of workers to set in /etc/sysconfig/pulp_workers.max_tasks_per_child
: Max tasks per child to set in /etc/sysconfig/pulp_workers.
Settings from repo_auth.conf
See https://github.com/pulp/pulp/blob/master/server/etc/pulp/repo_auth.conf
repo_auth
repo_auth_repo_url_prefixes
repo_auth_verify_ssl
repo_auth_disabled_authenticators
repo_auth_cert_location
repo_auth_global_cert_location
repo_auth_protected_repo_listing_file
repo_auth_crl_location
Settings from server.conf
See https://github.com/pulp/pulp/blob/master/server/etc/pulp/server.conf
Database section
database_name
database_seeds
database_username
database_password
database_replica_set
database_ssl
database_ssl_keyfile
database_ssl_certfile
database_verify_ssl
database_ca_path
database_unsafe_autoretry
database_write_concern
Server section
server_server_name
server_key_url
server_ks_url
server_default_login
server_default_password
server_debugging_mode
server_log_level
server_working_directory
Authentication section
authentication_rsa_key
authentication_rsa_pub
Security section
security_cacert
security_cakey
security_ssl_ca_certificate
security_user_cert_expiration
security_consumer_cert_expiration
security_serial_number_path
Consumer History section
consumer_history_lifetime
Data Reaping section
data_reaping_reaper_interval
data_reaping_archived_calls
data_reaping_consumer_history
data_reaping_repo_sync_history
data_reaping_repo_publish_history
data_reaping_repo_group_publish_history
data_reaping_task_status_history
data_reaping_task_result_history
LDAP section
ldap_enabled
ldap_uri
ldap_base
ldap_tls
ldap_default_role
ldap_filter
OAuth section
oauth_enabled
oauth_oauth_key
oauth_oauth_secret
Messaging section
messaging_url
messaging_transport
messaging_auth_enabled
messaging_cacert
messaging_clientcert
messaging_topic_exchange
messaging_event_notifications_enabled
messaging_event_notification_url
Tasks section
tasks_broker_url
tasks_celery_require_ssl
tasks_cacert
tasks_keyfile
tasks_certfile
tasks_login_method
Email section
email_enabled
email_host
email_port
email_from
Lazy Redirect section
lazy_redirect_host
lazy_redirect_port
lazy_redirect_path
lazy_https_retrieval
lazy_download_interval
lazy_download_concurrency
Profiling section
profiling_enabled
profiling_directory
Types in this module release
2017-09-11 Release 0.1.0
- Initial release 2017-09-11 Release 0.1.1
- Fix quoted nulls in importer config 2017-09-26 Release 0.1.2
- Add default .pulp/admin.conf location when HOME environment variable is not set
Dependencies
- puppetlabs-stdlib (>= 1.0.0)
- puppetlabs-concat (>= 2.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.