foreman_theme_satellite 16.1.0 → 16.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -12
- data/app/controllers/concerns/documentation_controller_branding.rb +18 -6
- data/app/overrides/satellite_name_override.rb +1 -1
- data/lib/foreman_theme_satellite/documentation.rb +55 -55
- data/lib/foreman_theme_satellite/engine.rb +10 -16
- data/lib/foreman_theme_satellite/version.rb +1 -1
- data/package.json +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 163343ae67522de8d9cf9ae884a4ce4828aeb5e5118779094d7fd29077e18357
|
|
4
|
+
data.tar.gz: 7d0e0710022784af3c3cc3137c1188df4920a8d7137749739c0b67b29329813b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 99582773fe98527d78f30410320054e9f32614d1162ae8c6185a064b420d9cd30c8a4570fa81576f4131f316bdd5a19094cebce7dc95f57cae73cfb97b318763
|
|
7
|
+
data.tar.gz: 68d956140e9ee904ce6f710612d34d30fd3b88a59f574132f91db2be5adc1fd2122b0ed2e20573b70ed17708575b4b93ba9eba158053e8d544839255b3f54f32
|
data/README.md
CHANGED
|
@@ -90,16 +90,10 @@ to change that, we need to add a downstream documentation link to [`documentatio
|
|
|
90
90
|
``` ruby
|
|
91
91
|
USER_GUIDE_DICTIONARY = {
|
|
92
92
|
# ...
|
|
93
|
-
'LDAPAuthentication' => "#
|
|
93
|
+
'LDAPAuthentication' => "configuring_authentication_for_red_hat_satellite_users/index#configuring-an-ldap-server-as-an-external-identity-provider-for-project_authentication",
|
|
94
94
|
# ...
|
|
95
95
|
}
|
|
96
96
|
```
|
|
97
|
-
notice the use of
|
|
98
|
-
``` ruby
|
|
99
|
-
ForemanThemeSatellite.documentation_root
|
|
100
|
-
```
|
|
101
|
-
this constant is maintained by the theme and always point to the correct
|
|
102
|
-
documentation version.
|
|
103
97
|
|
|
104
98
|
### Fixing links checker failures
|
|
105
99
|
|
|
@@ -314,7 +308,7 @@ Deface::Override.new(:virtual_path => "about/index",
|
|
|
314
308
|
:text => " <div class=\"stats-well\"><h4><%= _(\"Support\") %></h4> <p>Visit the <%= link_to _('Customer Portal'), \"https://access.redhat.com/\",
|
|
315
309
|
:rel => \"external\" %> to get support, find solutions to common questions, and more.</p><h6><%= _(\"Documentation\") %></h6>
|
|
316
310
|
<ul>
|
|
317
|
-
<li><%= link_to _('Complete Product Documentation for Red Hat Satellite')
|
|
311
|
+
<li><%= link_to _('Complete Product Documentation for Red Hat Satellite'), documentation_url, :rel => \"external\" %></li>
|
|
318
312
|
<li><%= link_to _('API Resources'), apipie_apipie_path, :title => _('Automate Satellite via a simple and powerful API') %></li>
|
|
319
313
|
</ul>
|
|
320
314
|
<h6><%= _(\"Blog\") %></h6>
|
|
@@ -420,13 +414,11 @@ a specialized yaml file.
|
|
|
420
414
|
Setting up ENV variables:
|
|
421
415
|
``` bash
|
|
422
416
|
SATELLITE_VERSION='6.8.000'
|
|
423
|
-
SATELLITE_DOCUMENTATION_SERVER=http://access.redhat.com
|
|
424
417
|
SATELLITE_DOCUMENTATION_VERSION=6.6
|
|
425
418
|
```
|
|
426
419
|
Setting up the metadata file:
|
|
427
420
|
``` yaml
|
|
428
421
|
version: '6.8.000'
|
|
429
|
-
documentation_server: "http://access.redhat.com"
|
|
430
422
|
documentation_version: "6.6"
|
|
431
423
|
```
|
|
432
424
|
the metadata file should be called `/usr/share/satellite/metadata.yml` for
|
|
@@ -445,14 +437,12 @@ need to test the links against different documentation version or instance.
|
|
|
445
437
|
These parameters are cofigurable by either setting `ENV` variables:
|
|
446
438
|
|
|
447
439
|
``` sh
|
|
448
|
-
SATELLITE_DOCUMENTATION_SERVER=http://access.redhat.com
|
|
449
440
|
SATELLITE_DOCUMENTATION_VERSION=6.6
|
|
450
441
|
```
|
|
451
442
|
|
|
452
443
|
Another option is to add or change keys in `/usr/share/satellite/metadata.yml`:
|
|
453
444
|
|
|
454
445
|
``` yaml
|
|
455
|
-
documentation_server: "http://access.redhat.com"
|
|
456
446
|
documentation_version: "6.6"
|
|
457
447
|
```
|
|
458
448
|
|
|
@@ -8,14 +8,14 @@ module DocumentationControllerBranding
|
|
|
8
8
|
unless section.nil?
|
|
9
9
|
dictionary = ForemanThemeSatellite::Documentation::USER_GUIDE_DICTIONARY
|
|
10
10
|
matched_key = dictionary.keys.sort_by(&:length).reverse.find {|key| section.include? key}
|
|
11
|
-
url = dictionary[matched_key] if matched_key
|
|
11
|
+
url = "#{documentation_root}/#{dictionary[matched_key]}" if matched_key
|
|
12
12
|
end
|
|
13
13
|
if url.empty?
|
|
14
14
|
upstream_url = super(section, options)
|
|
15
15
|
url = if (upstream_url =~ /redhat.com/)
|
|
16
16
|
upstream_url
|
|
17
17
|
else
|
|
18
|
-
|
|
18
|
+
documentation_root_url
|
|
19
19
|
end
|
|
20
20
|
end
|
|
21
21
|
url
|
|
@@ -30,7 +30,7 @@ module DocumentationControllerBranding
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
def support_url
|
|
33
|
-
'https://access.redhat.com/products/red-hat-satellite#get-support'
|
|
33
|
+
'https://access.redhat.com/products/red-hat-satellite#get-support' # This is not included in RHOKP
|
|
34
34
|
end
|
|
35
35
|
|
|
36
36
|
# For new documentation at docs.theforeman.org
|
|
@@ -38,16 +38,28 @@ module DocumentationControllerBranding
|
|
|
38
38
|
# rubocop:disable Lint/UnusedMethodArgument
|
|
39
39
|
def docs_url(guide:, flavor:, chapter: nil)
|
|
40
40
|
url = ForemanThemeSatellite::Documentation::DOCS_GUIDES_LINKS.dig(guide, chapter)
|
|
41
|
-
url
|
|
41
|
+
url ? "#{documentation_root}/#{url}" : "#{documentation_root}/#{guide.downcase}/#{chapter}"
|
|
42
42
|
end
|
|
43
43
|
|
|
44
44
|
def upgrade_url(section)
|
|
45
45
|
case section
|
|
46
46
|
when 'documentation'
|
|
47
|
-
"#{
|
|
47
|
+
"#{unversioned_documentation_root}#Upgrade"
|
|
48
48
|
when 'helper'
|
|
49
|
-
'https://access.redhat.com/labs/satelliteupgradehelper'
|
|
49
|
+
'https://access.redhat.com/labs/satelliteupgradehelper' # This is not included in RHOKP
|
|
50
50
|
end
|
|
51
51
|
end
|
|
52
|
+
|
|
53
|
+
def documentation_root_url
|
|
54
|
+
"#{unversioned_documentation_root}/#{ForemanThemeSatellite.documentation_version}"
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
def documentation_root
|
|
58
|
+
"#{unversioned_documentation_root}/#{ForemanThemeSatellite.documentation_version}/html-single"
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
def unversioned_documentation_root
|
|
62
|
+
"#{Setting[:satellite_documentation_url]}/documentation/en-us/red_hat_satellite"
|
|
63
|
+
end
|
|
52
64
|
# rubocop:enable Lint/UnusedMethodArgument
|
|
53
65
|
end
|
|
@@ -37,7 +37,7 @@ Deface::Override.new(:virtual_path => "about/index",
|
|
|
37
37
|
:text => " <div class=\"stats-well\"><h4><%= _(\"Support\") %></h4> <p>Visit the <%= link_to _('Customer Portal'), \"https://access.redhat.com/\",
|
|
38
38
|
:rel => \"external\" %> to get support, find solutions to common questions, and more.</p><h6><%= _(\"Documentation\") %></h6>
|
|
39
39
|
<ul>
|
|
40
|
-
<li><%= link_to _('Complete Product Documentation for Red Hat Satellite')
|
|
40
|
+
<li><%= link_to _('Complete Product Documentation for Red Hat Satellite'), documentation_url, :rel => \"external\" %></li>
|
|
41
41
|
<li><%= link_to _('API Resources'), apipie_apipie_path, :title => _('Automate Satellite via a simple and powerful API') %></li>
|
|
42
42
|
<li><%= link_to _('Templates DSL'), apipie_dsl_apipie_dsl_path, :title => _('Get DSL reference for templates writing') %></li>
|
|
43
43
|
</ul>
|
|
@@ -5,87 +5,87 @@ module ForemanThemeSatellite
|
|
|
5
5
|
module Documentation
|
|
6
6
|
USER_GUIDE_DICTIONARY = {
|
|
7
7
|
# Managing Hosts
|
|
8
|
-
'ForemanRemoteExecution' => "
|
|
9
|
-
'ExecutingaJob' => "
|
|
10
|
-
'JobTemplates' => "
|
|
11
|
-
'ReportTemplates' => "
|
|
12
|
-
'Reports' => "
|
|
8
|
+
'ForemanRemoteExecution' => "managing_hosts/index#configuring-and-setting-up-remote-jobs",
|
|
9
|
+
'ExecutingaJob' => "managing_hosts/index#configuring-the-global-capsule-remote-execution-setting-by-using-web-ui",
|
|
10
|
+
'JobTemplates' => "managing_hosts/index#customizing-job-templates",
|
|
11
|
+
'ReportTemplates' => "managing_hosts/index#Using_Report_Templates_to_Monitor_Hosts_managing-hosts",
|
|
12
|
+
'Reports' => "managing_hosts/index#Using_Report_Templates_to_Monitor_Hosts_managing-hosts",
|
|
13
13
|
|
|
14
14
|
# Provisioning Hosts
|
|
15
|
-
'Architectures' => "
|
|
16
|
-
'Provisioning' => "
|
|
17
|
-
'InstallationMedia' => "
|
|
18
|
-
'PartitionTables' => "
|
|
19
|
-
'ProvisioningTemplates' => "
|
|
20
|
-
'OperatingSystems' => "
|
|
21
|
-
'UsingComputeProfiles' => "
|
|
22
|
-
'ComputeResources' => "
|
|
23
|
-
'NoVNC' => "
|
|
24
|
-
'VMwareNotes' => "
|
|
25
|
-
'OpenStackNotes' => "
|
|
26
|
-
'LibvirtNote' => "
|
|
27
|
-
'EC2' => "
|
|
28
|
-
'GoogleComputeEngineNotes' => "
|
|
29
|
-
'Networking' => "
|
|
15
|
+
'Architectures' => "provisioning_hosts/index#creating-architectures-by-using-web-ui",
|
|
16
|
+
'Provisioning' => "provisioning_hosts/index",
|
|
17
|
+
'InstallationMedia' => "provisioning_hosts/index#adding-installation-media-by-using-web-ui",
|
|
18
|
+
'PartitionTables' => "provisioning_hosts/index#creating-partition-tables-by-using-web-ui",
|
|
19
|
+
'ProvisioningTemplates' => "provisioning_hosts/index#provisioning-templates",
|
|
20
|
+
'OperatingSystems' => "provisioning_hosts/index#creating-operating-systems-by-using-web-ui",
|
|
21
|
+
'UsingComputeProfiles' => "provisioning_hosts/index#creating-compute-profiles-by-using-web-ui",
|
|
22
|
+
'ComputeResources' => "provisioning_hosts/index",
|
|
23
|
+
'NoVNC' => "provisioning_hosts/index#using-novnc-to-access-virtual-machines_provisioning",
|
|
24
|
+
'VMwareNotes' => "provisioning_hosts/index#Provisioning_Virtual_Machines_in_VMware_vmware-provisioning",
|
|
25
|
+
'OpenStackNotes' => "provisioning_hosts/index#Provisioning_Cloud_Instances_OpenStack_openstack-provisioning",
|
|
26
|
+
'LibvirtNote' => "provisioning_hosts/index#Provisioning_Virtual_Machines_on_KVM_kvm-provisioning",
|
|
27
|
+
'EC2' => "provisioning_hosts/index#provisioning-cloud-instances-on-amazon-ec2",
|
|
28
|
+
'GoogleComputeEngineNotes' => "provisioning_hosts/index#Provisioning_Cloud_Instances_on_Google_Compute_Engine_gce-provisioning",
|
|
29
|
+
'Networking' => "provisioning_hosts/index#adding-a-subnet-to-server-by-using-web-ui",
|
|
30
30
|
|
|
31
31
|
# Puppet Guide
|
|
32
|
-
'FactsandtheENC' => "
|
|
33
|
-
'using-config-groups' => "
|
|
34
|
-
'SmartMatchers' => "
|
|
35
|
-
'Parameters' => "
|
|
36
|
-
'Classes' => "
|
|
37
|
-
'Environments' => "
|
|
32
|
+
'FactsandtheENC' => "managing_configurations_by_using_puppet_integration/index#performing-configuration-management_managing-configurations-puppet",
|
|
33
|
+
'using-config-groups' => "managing_configurations_by_using_puppet_integration/index#creating-a-puppet-config-group_managing-configurations-puppet",
|
|
34
|
+
'SmartMatchers' => "managing_configurations_by_using_puppet_integration/index#Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet",
|
|
35
|
+
'Parameters' => "managing_configurations_by_using_puppet_integration/index#Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet",
|
|
36
|
+
'Classes' => "managing_configurations_by_using_puppet_integration/index#Importing_Puppet_Classes_and_Environments_managing-configurations-puppet",
|
|
37
|
+
'Environments' => "managing_configurations_by_using_puppet_integration/index#Creating_a_Custom_Puppet_Environment_managing-configurations-puppet",
|
|
38
38
|
|
|
39
39
|
# Administering
|
|
40
|
-
'ConfigurationOptions' => "
|
|
41
|
-
'PuppetReports' => "
|
|
42
|
-
'Mail_Notifications' => "
|
|
43
|
-
'Realm' => "
|
|
44
|
-
'Searching' => "
|
|
45
|
-
'RolesandPermissions' => "
|
|
46
|
-
'LDAPAuthentication' => "
|
|
47
|
-
'ExternalAuthentication' => "
|
|
48
|
-
'Bookmarks' => "
|
|
49
|
-
'Policydeploymentoptions' => "
|
|
50
|
-
'CreatingSCAPcontent' => "
|
|
40
|
+
'ConfigurationOptions' => "administering_red_hat_satellite/index",
|
|
41
|
+
'PuppetReports' => "administering_red_hat_satellite/index#Using_the_Project_Content_Dashboard_admin",
|
|
42
|
+
'Mail_Notifications' => "administering_red_hat_satellite/index#Configuring_Email_Notifications_admin",
|
|
43
|
+
'Realm' => "installing_satellite_server_in_a_connected_network_environment/index#configuring-project-to-manage-the-lifecycle-of-a-host-registered-to-a-freeipa-realm_satellite",
|
|
44
|
+
'Searching' => "administering_red_hat_satellite/index#Searching_and_Bookmarking_admin",
|
|
45
|
+
'RolesandPermissions' => "administering_red_hat_satellite/index#Managing_Users_and_Roles_admin",
|
|
46
|
+
'LDAPAuthentication' => "configuring_authentication_for_red_hat_satellite_users/index#configuring-an-ldap-server-as-an-external-identity-provider-for-project_authentication",
|
|
47
|
+
'ExternalAuthentication' => "configuring_authentication_for_red_hat_satellite_users/index",
|
|
48
|
+
'Bookmarks' => "administering_red_hat_satellite/index#Searching_and_Bookmarking_admin",
|
|
49
|
+
'Policydeploymentoptions' => "managing_security_compliance/index#compliance-policy-deployment-options_security-compliance",
|
|
50
|
+
'CreatingSCAPcontent' => "managing_security_compliance/index#Configuring_SCAP_Contents_security-compliance",
|
|
51
51
|
|
|
52
52
|
# Planning
|
|
53
|
-
'SmartProxies' => "
|
|
54
|
-
'Auditing' => "
|
|
53
|
+
'SmartProxies' => "overview_concepts_and_deployment_considerations/index#Major-Satellite-Components_planning",
|
|
54
|
+
'Auditing' => "overview_concepts_and_deployment_considerations/index#glossary-of-terms-used-in-satellite_planning",
|
|
55
55
|
|
|
56
56
|
# Install
|
|
57
|
-
'HTTP(S)Proxy' => "
|
|
57
|
+
'HTTP(S)Proxy' => "installing_satellite_server_in_a_connected_network_environment/index#Configuring_Server_with_an_HTTP_Proxy_satellite",
|
|
58
58
|
|
|
59
59
|
# Misc
|
|
60
60
|
'GettingHelp' => "https://access.redhat.com/products/red-hat-satellite/#support",
|
|
61
61
|
|
|
62
62
|
# Managing Security Compliance
|
|
63
|
-
'Monitoring_Compliance_security-compliance' => "
|
|
64
|
-
'Managing_Compliance_Policies_security-compliance' => "
|
|
65
|
-
'Configuring_SCAP_Contents_security-compliance' => "
|
|
66
|
-
'tailoring-xccdf-profiles_security-compliance' => "
|
|
67
|
-
'deploying-compliance-policies_security-compliance' => "
|
|
63
|
+
'Monitoring_Compliance_security-compliance' => "managing_security_compliance/index#Monitoring_Compliance_security-compliance",
|
|
64
|
+
'Managing_Compliance_Policies_security-compliance' => "managing_security_compliance/index#Managing_Compliance_Policies_security-compliance",
|
|
65
|
+
'Configuring_SCAP_Contents_security-compliance' => "managing_security_compliance/index#Configuring_SCAP_Contents_security-compliance",
|
|
66
|
+
'tailoring-xccdf-profiles_security-compliance' => "managing_security_compliance/index#tailoring-xccdf-profiles_security-compliance",
|
|
67
|
+
'deploying-compliance-policies_security-compliance' => "managing_security_compliance/index#deploying-compliance-policies_security-compliance",
|
|
68
68
|
}.freeze
|
|
69
69
|
|
|
70
70
|
PLUGINS_DOCUMENTATION = {
|
|
71
|
-
'foreman_azure' => "
|
|
72
|
-
'foreman_discovery' => "
|
|
73
|
-
'foreman_kubevirt' => "
|
|
71
|
+
'foreman_azure' => "provisioning_hosts/index#Provisioning_Cloud_Instances_on_Microsoft_Azure_Resource_Manager_azure-provisioning",
|
|
72
|
+
'foreman_discovery' => "provisioning_hosts/index#discovering-hosts-on-a-network",
|
|
73
|
+
'foreman_kubevirt' => "provisioning_hosts/index#Provisioning_Virtual_Machines_Kubevirt_kubevirt-provisioning",
|
|
74
74
|
}.freeze
|
|
75
75
|
|
|
76
76
|
DOCS_GUIDES_LINKS = {
|
|
77
77
|
'Managing_Content' => {
|
|
78
|
-
'Products_and_Repositories_content-management' => "
|
|
78
|
+
'Products_and_Repositories_content-management' => "managing_content/index#Products_and_Repositories_content-management",
|
|
79
79
|
},
|
|
80
80
|
'Managing_Hosts' => {
|
|
81
|
-
'creating-a-job-template_managing-hosts' => "
|
|
82
|
-
'executing-a-remote-job_managing-hosts' => "
|
|
83
|
-
'registering-a-host_managing-hosts' => "
|
|
84
|
-
'setting-minimal-data-collection' => "
|
|
81
|
+
'creating-a-job-template_managing-hosts' => "managing_hosts/index#creating-a-job-template-by-using-web-ui",
|
|
82
|
+
'executing-a-remote-job_managing-hosts' => "managing_hosts/index#Remote-Execution-in-Satellite_managing-hosts",
|
|
83
|
+
'registering-a-host_managing-hosts' => "managing_hosts/index#Registering_Hosts_by_Using_Global_Registration_managing-hosts",
|
|
84
|
+
'setting-minimal-data-collection' => "managing_hosts/index#data-control-settings",
|
|
85
85
|
},
|
|
86
86
|
'Managing_Configurations_Ansible' => {
|
|
87
|
-
'Importing_Ansible_Roles_and_Variables_ansible' => "
|
|
88
|
-
'Overriding_Ansible_Variables_in_foreman_ansible' => "
|
|
87
|
+
'Importing_Ansible_Roles_and_Variables_ansible' => "managing_configurations_by_using_ansible_integration/index#Importing_Ansible_Roles_and_Variables_ansible",
|
|
88
|
+
'Overriding_Ansible_Variables_in_foreman_ansible' => "managing_configurations_by_using_ansible_integration/index#Overriding_Ansible_Variables_in_satellite_ansible",
|
|
89
89
|
}
|
|
90
90
|
}.freeze
|
|
91
91
|
|
|
@@ -25,6 +25,16 @@ module ForemanThemeSatellite
|
|
|
25
25
|
full_name: N_('Show unsupported provisioning templates')
|
|
26
26
|
)
|
|
27
27
|
end
|
|
28
|
+
category(:general) do
|
|
29
|
+
setting('satellite_documentation_url',
|
|
30
|
+
type: :string,
|
|
31
|
+
default: "https://docs.redhat.com",
|
|
32
|
+
description: N_('Defaults to Red Hat online documentation. '\
|
|
33
|
+
'Override this setting to your Red Hat Offline Knowledge Portal instance URL for offline documentation support. '\
|
|
34
|
+
'Supports only HTTP and HTTPS schemes.'),
|
|
35
|
+
full_name: N_('Red Hat documentation server URL'),
|
|
36
|
+
validate: :http_url)
|
|
37
|
+
end
|
|
28
38
|
end
|
|
29
39
|
|
|
30
40
|
tests_to_skip ({
|
|
@@ -127,26 +137,10 @@ module ForemanThemeSatellite
|
|
|
127
137
|
Foreman::Version.new(SATELLITE_VERSION).short
|
|
128
138
|
end
|
|
129
139
|
|
|
130
|
-
def self.documentation_server
|
|
131
|
-
@documentation_server ||= metadata_field('documentation_server', 'https://docs.redhat.com')
|
|
132
|
-
end
|
|
133
|
-
|
|
134
140
|
def self.documentation_version
|
|
135
141
|
@documentation_version ||= metadata_field('documentation_version', ForemanThemeSatellite::SATELLITE_SHORT_VERSION)
|
|
136
142
|
end
|
|
137
143
|
|
|
138
|
-
def self.documentation_root
|
|
139
|
-
@documentation_root ||= begin
|
|
140
|
-
"#{unversioned_documentation_root}/#{documentation_version}/html-single"
|
|
141
|
-
end
|
|
142
|
-
end
|
|
143
|
-
|
|
144
|
-
def self.unversioned_documentation_root
|
|
145
|
-
@unversioned_documentation_root ||= begin
|
|
146
|
-
"#{documentation_server}/documentation/en-us/red_hat_satellite"
|
|
147
|
-
end
|
|
148
|
-
end
|
|
149
|
-
|
|
150
144
|
# this file indicates the satellite version that will be represented on the login page.
|
|
151
145
|
SATELLITE_VERSION = get_satellite_version
|
|
152
146
|
|
data/package.json
CHANGED