Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upstreamize Hammer guide #3197

Merged
merged 19 commits into from
Aug 26, 2024
+1,409 −14
Merged

Upstreamize Hammer guide #3197

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
cca6e16
Add Hammer CLI files
Lennonka Aug 7, 2024
3f89541
Run the upstreamize script
Lennonka Aug 7, 2024
1790381
Upstreamize manually
Lennonka Aug 7, 2024
06e1903
Reset generated reference to empty
Lennonka Aug 7, 2024
4261e29
fixup! Upstreamize manually
Lennonka Aug 7, 2024
2d65b15
fixup! Upstreamize manually
Lennonka Aug 7, 2024
85b6aff
fixup! Upstreamize manually
Lennonka Aug 7, 2024
dba7726
Update header
Lennonka Aug 8, 2024
042c496
Incorporate suggestions
Lennonka Aug 12, 2024
e97feed
fixup! Incorporate suggestions
Lennonka Aug 12, 2024
45e2545
fixup! Incorporate suggestions
Lennonka Aug 12, 2024
2d2cc23
Change guide title
Lennonka Aug 16, 2024
6f55673
Improve the generate script
Lennonka Aug 16, 2024
0f72942
Move README
Lennonka Aug 16, 2024
5b2767f
Move assembly and modules to common folder
Lennonka Aug 16, 2024
a3f8fca
Fix a Vale error
Lennonka Aug 16, 2024
5183c45
Fix a Vale error
Lennonka Aug 16, 2024
125aec7
Incorporate feedback
Lennonka Aug 19, 2024
90dc266
Replace RH with Team
Lennonka Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions guides/common/assembly_hammer-reference.adoc
View file
Open in desktop
Copy link
Contributor Author

@Lennonka Lennonka Aug 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what to do with this file.

The problem is that the reference should be generated separately for Foreman, Katello, orcharhino, and Satellite because of branding and presence of Katello functionality in hammer help.
If I generate it in downstream and keep this file in upstream, our sync will overwrite it from upstream again. Therefore, it would be better to remove it in upstream.
However, if I don't include it in upstream, the build will not pass because it's required by master.adoc.

So the solution might be to exclude this file from syncing in downstream. Will you be able to do that in your sync too, @maximiliankolb?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I can handle this. No worries.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// DO NOT EDIT MANUALLY
// Use the generate-hammer-reference.sh script to update

include::modules/con_hammer-reference.adoc[]

// Placeholder
1 change: 1 addition & 0 deletions guides/common/attributes-base.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:AdministeringDocURL: {BaseURL}Administering_Project/{BaseFilenameURL}#
:ConfiguringLoadBalancerDocURL: {BaseURL}Configuring_Load_Balancer/{BaseFilenameURL}#
:ContentManagementDocURL: {BaseURL}Managing_Content/{BaseFilenameURL}#
:HammerDocURL: {BaseURL}Hammer_CLI/{BaseFilenameURL}#
:InstallingServerDisconnectedDocURL: {BaseURL}Installing_Server_Disconnected/{BaseFilenameURL}#
:InstallingServerDocURL: {BaseURL}Installing_Server/{BaseFilenameURL}#
:InstallingSmartProxyDocURL: {BaseURL}Installing_Proxy/{BaseFilenameURL}#
Expand Down
1 change: 1 addition & 0 deletions guides/common/attributes-foreman-el.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Overrides for foreman-el build
:dnf-module: foreman:el8
:dnf-module-utils: {dnf-module}

// Some documents are not ready for stable releases, but can be published on nightly
ifeval::["{DocState}" != "nightly"]
Expand Down
1 change: 1 addition & 0 deletions guides/common/attributes-katello.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:client-content-apt:
:client-content-zypper:
:dnf-module: katello:el8
:dnf-module-utils: {dnf-module}
:foreman-installer-package: foreman-installer-katello
:installer-log-file: /var/log/foreman-installer/katello.log
:installer-scenario-smartproxy: foreman-installer --scenario foreman-proxy-content
Expand Down
1 change: 1 addition & 0 deletions guides/common/attributes-orcharhino.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
:customrpmtitle: Custom RPM
:customssl: custom SSL
:dnf-module: orcharhino:el8
:dnf-module-utils: {dnf-module}
:foreman-example-com: orcharhino.example.com
:installer-log-file: /var/log/foreman-installer/katello.log
:installer-scenario-smartproxy: foreman-installer --scenario foreman-proxy-content
Expand Down
3 changes: 2 additions & 1 deletion guides/common/attributes-satellite.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
:InstallingServerDisconnectedDocURL: {BaseURL}installing_satellite_server_in_a_disconnected_network_environment/index#
:InstallingServerDocURL: {BaseURL}installing_satellite_server_in_a_connected_network_environment/index#
:InstallingSmartProxyDocURL: {BaseURL}installing_capsule_server/index#
:HammerDocURL: {BaseURL}using_the_hammer_cli_tool/index#
:ManagingConfigurationsAnsibleDocURL: {BaseURL}managing_configurations_by_using_ansible_integration/index#
:ManagingConfigurationsPuppetDocURL: {BaseURL}managing_configurations_by_using_puppet_integration/index#
:ManagingHostsDocURL: {BaseURL}managing_hosts/index#
Expand All @@ -35,7 +36,6 @@
// Not upstreamed
:ReleaseNotesDocURL: {BaseURL}release_notes/index#
:APIDocURL: {BaseURL}api_guide/index#
:HammerDocURL: {BaseURL}hammer_cli_guide/index#
:ConfiguringVMSubscriptionsDocURL: {BaseURL}configuring_virtual_machine_subscriptions/index#
:ConversionsToolkitDocURL: {BaseURL}converting_hosts_to_rhel_by_using_satellite_conversions_toolkit/index#

Expand Down Expand Up @@ -165,3 +165,4 @@
:project-client-RHEL7-url: {RepoRHEL7ServerSatelliteToolsProjectVersion}
:project-client-RHEL8-url: {RepoRHEL8ServerSatelliteToolsProjectVersion}
:dnf-module: satellite:el8
:dnf-module-utils: satellite-utils:el8
2 changes: 1 addition & 1 deletion guides/common/attributes-titles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
:ContentManagementDocTitle: Managing content
:ConvertingHostRHELDocTitle: Converting a host to RHEL
:DeployingAWSDocTitle: Deploying {ProjectName} on Amazon Web Services
:HammerDocTitle: Using the Hammer CLI tool
:InstallingServerDocTitle: Installing {ProjectServerTitle} {ProjectVersion} on {install-on-os}
// Installing Disconnected - defined for Satellite only
:InstallingServerDisconnectedDocTitle: Installing {ProjectServerTitle} in a disconnected network environment
Expand All @@ -32,7 +33,6 @@

// Not upstreamed
:APIDocTitle: API guide
:HammerDocTitle: Hammer CLI guide
:ConfiguringVMSubscriptionsDocTitle: Configuring virtual machine subscriptions
:ConversionsToolkitDocTitle: Converting hosts to RHEL by using Satellite conversions toolkit

Expand Down
6 changes: 6 additions & 0 deletions guides/common/modules/con_hammer-cheat-sheet.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[id='hammer-cheat-sheet']
= Hammer cheat sheet

Hammer is a command-line tool provided with {ProjectNameX}.
You can use Hammer to configure and manage a {ProjectServer} by using either CLI commands or shell script automation.
The following cheat sheet provides a condensed overview of essential Hammer commands.
12 changes: 12 additions & 0 deletions guides/common/modules/con_hammer-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[id="hammer-reference"]
= Hammer reference

You can review the usage of Hammer statements.

ifeval::[ "{ProjectVersion}" == "nightly" ]
The reference is not provided for Nightly.
Select a stable release to view the reference.
endif::[]
ifeval::[ "{ProjectVersion}" != "nightly" ]
This reference is up to date with the versions of Hammer components released for {ProjectXY}.
endif::[]
Loading