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

Jump to bottom

Clean up external links in procedure to manage hosts using Cockpit #3382

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Clean up external links in procedure to manage hosts using Cockpit #3382

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
26b161c
Group cockpit links under Additional resources
asteflova Oct 18, 2024
598a6f3
Drop a few links from Cockpit prereqs
asteflova Oct 18, 2024
17d5c40
Reword Cockpit links to be generic references
asteflova Oct 24, 2024
32d747e
Use attribute to reference Cockpit
asteflova Oct 24, 2024
0cb4f36
Note that Project ships with a template for enabling Cockpit
asteflova Oct 25, 2024
7bc6714
Simplify reference to Web Console job template
asteflova Oct 25, 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
27 changes: 16 additions & 11 deletions guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,10 @@ You can access the {Cockpit} UI through the {ProjectWebUI} and use the functiona

.Prerequisites
* You have enabled {the-Cockpit} in {Project}.
* You have installed {the-Cockpit} on the host that you want to view:
ifndef::satellite,orcharhino[]
** For more information, see https://cockpit-project.org/running.html[Running Cockpit].
endif::[]
ifdef::satellite[]
** For {RHEL}{nbsp}8, see {RHELDocsBaseURL}8/html/managing_systems_using_the_rhel_8_web_console/getting-started-with-the-rhel-8-web-console_system-management-using-the-rhel-8-web-console#installing-the-web-console_getting-started-with-the-rhel-8-web-console[Installing the web console] in _Managing systems using the RHEL{nbsp}8 web console_.
** For {RHEL}{nbsp}7, see {RHELDocsBaseURL}7/html/managing_systems_using_the_rhel_7_web_console/getting-started-with-the-rhel-web-console_system-management-using-the-rhel-7-web-console#installing-the-web-console_getting-started-with-the-web-console[Installing the web console] in _Managing systems using the RHEL{nbsp}7 web console_.
endif::[]
* You have installed {the-Cockpit} on the host that you want to view.
asteflova marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* You have installed {the-Cockpit} on the host that you want to view.
* You have installed {the-Cockpit} on the host that you want to manage and monitor.

"view" is probably not doing Web Console any justice. I've copied the verbs from the heading. Does this make sense? Or maybe just "manage"? Or "interact with"?

+
{Project} provides a job template named *Service Action {endash} Enable Web Console* under the *Ansible Services* job category that you can use to install {the-Cockpit}.
For more information about using remote jobs, see xref:Configuring_and_Setting_Up_Remote_Jobs_{context}[].
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For more information about using remote jobs, see xref:Configuring_and_Setting_Up_Remote_Jobs_{context}[].
For more information about running remote jobs, see xref:Configuring_and_Setting_Up_Remote_Jobs_{context}[].

Or "execute" like https://docs.theforeman.org/nightly/Managing_Hosts/index-katello.html#executing-a-remote-job_managing-hosts?

* {Project} or {SmartProxy} can authenticate to the host with SSH keys.
For more information, see xref:Distributing_SSH_Keys_for_Remote_Execution_{context}[].

Expand All @@ -22,8 +18,17 @@ For more information, see xref:Distributing_SSH_Keys_for_Remote_Execution_{conte

You can now access the full range of features available for host monitoring and management, for example, {LoraxCompose}, through {the-Cockpit}.

.Additional resources
ifndef::satellite,orcharhino[]
* For more information about {the-Cockpit}, see https://cockpit-project.org/documentation.html[Cockpit documentation].
endif::[]
ifdef::satellite[]
For more information about getting started with Red Hat web console, see {RHELDocsBaseURL}8/html/managing_systems_using_the_rhel_8_web_console/index[_Managing systems using the RHEL{nbsp}8 web console_] or {RHELDocsBaseURL}7/html/managing_systems_using_the_rhel_7_web_console/getting-started-with-the-rhel-web-console_system-management-using-the-rhel-7-web-console#installing-the-web-console_getting-started-with-the-web-console[_Managing systems using the RHEL 7 web console_].

For more information about using {LoraxCompose} through {the-Cockpit}, see {RHELDocsBaseURL}8/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-web-console-interface_composing-a-customized-rhel-system-image#accessing-composer-gui-in-the-rhel-8-web-console_creating-system-images-with-composer-web-console-interface[_Accessing Image Builder GUI in the RHEL{nbsp}8 web console_] or {RHELDocsBaseURL}7/html/image_builder_guide/chap-documentation-image_builder-test_chapter_4#sect-Documentation-Image_Builder-Chapter4[_Accessing Image Builder GUI in the RHEL{nbsp}7 web console_].
* For more information about using {the-Cockpit}, see the following documents:
** {RHELDocsBaseURL}9/html/managing_systems_using_the_rhel_9_web_console/index[_Managing systems using the RHEL{nbsp}9 web console_]
** {RHELDocsBaseURL}8/html/managing_systems_using_the_rhel_8_web_console/index[_Managing systems using the RHEL{nbsp}8 web console_]
** {RHELDocsBaseURL}7/html/managing_systems_using_the_rhel_7_web_console/getting-started-with-the-rhel-web-console_system-management-using-the-rhel-7-web-console#installing-the-web-console_getting-started-with-the-web-console[_Managing systems using the RHEL 7 web console_]
* For more information about using {LoraxCompose} through {the-Cockpit}, see the following documents:
** {RHELDocsBaseURL}9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-web-console-interface_composing-a-customized-rhel-system-image#accessing-composer-gui-in-the-rhel-8-web-console_creating-system-images-with-composer-web-console-interface[_Accessing Image Builder GUI in the RHEL{nbsp}9 web console_]
** {RHELDocsBaseURL}8/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-web-console-interface_composing-a-customized-rhel-system-image#accessing-composer-gui-in-the-rhel-8-web-console_creating-system-images-with-composer-web-console-interface[_Accessing Image Builder GUI in the RHEL{nbsp}8 web console_]
** {RHELDocsBaseURL}7/html/image_builder_guide/chap-documentation-image_builder-test_chapter_4#sect-Documentation-Image_Builder-Chapter4[_Accessing Image Builder GUI in the RHEL{nbsp}7 web console_]
endif::[]
Loading