Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add header to settings.py
Browse files Browse the repository at this point in the history
wbclark committed Jul 22, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent dfd7744 commit b75c086
Showing 3 changed files with 45 additions and 0 deletions.
2 changes: 2 additions & 0 deletions manifests/config.pp
Original file line number Diff line number Diff line change
@@ -17,6 +17,8 @@
ensure_newline => true,
}

include pulpcore::header_strings

concat::fragment { 'base':
target => 'pulpcore settings',
content => template('pulpcore/settings.py.erb'),
41 changes: 41 additions & 0 deletions manifests/header_strings.pp
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# @summary Re-usable, overridable strings for file headers
#
# @param custom_installer_name
# Override installer_name in headers from "Puppet" to e.g. "foreman-installer"
#
# @param custom_settings_explanation
# Custom string providing further instructions to the user in settings.py header
class pulpcore::header_strings(
Optional[String] $custom_installer_name = undef,
Optional[String] $custom_settings_explanation = undef,
) {
if $custom_installer_name {
$installer_name = $custom_installer_name
} else {
$installer_name = 'Puppet'
}

$installer_header = "File managed by ${installer_name}.\nModule: ${module_name}"
$warning_header = '!!! WARNING: DO NOT EDIT THIS FILE !!!'

if $custom_settings_explanation {
$explanation = $custom_settings_explanation
} else {
$explanation = @("EXPLANATION"/L)
Not only are your edits likely to be overwritten, there is also a strong possibility \
of breaking your system if you change configuration here without making required \
changes elsewhere. Refer to the documentation you used to install Pulpcore to \
determine the safe and persistent way to modify the configuration.
| - EXPLANATION
}

$settings_header_content = pulpcore::generate_header_content(
[
$warning_header,
$installer_header,
$explanation,
],
80,
'#',
)
}
2 changes: 2 additions & 0 deletions templates/settings.py.erb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<%= scope['pulpcore::header_strings::settings_header_content'].join("\n") %>

CONTENT_HOST = "<%= scope['pulpcore::servername'] %>"
CONTENT_ORIGIN = "https://<%= scope['pulpcore::servername'] %>"
SECRET_KEY = "<%= scope['pulpcore::django_secret_key'] %>"

0 comments on commit b75c086

Please sign in to comment.