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

Consolidate Tracer procedures #3442

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

Consolidate Tracer procedures #3442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f440b7
Consolidate Tracer procedures
rh-max Nov 8, 2024
eb4dfe1
Add a specific context for multiple module inclusion
rh-max Nov 8, 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
5 changes: 4 additions & 1 deletion guides/common/assembly_administering-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ include::modules/proc_changing-the-environment-of-a-host.adoc[leveloffset=+1]

include::modules/proc_changing-the-managed-status-of-a-host.adoc[leveloffset=+1]

include::modules/proc_enabling-tracer-on-a-host.adoc[leveloffset=+1]
:parent-context: {context}
:context: administering-hosts
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there any particular reason to change the context for this procedure?
Unless it's absolutely necessary to change the context, I would avoid it. Generally, it prevents problems with broken links in the web UI.

include::modules/proc_configuring-tracer-on-a-host.adoc[leveloffset=+1]
:context: {parent-context}

include::modules/proc_restarting-applications-on-a-host.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion guides/common/assembly_registering-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ include::modules/proc_providing-an-alternative-fqdn-for-the-host.adoc[leveloffse
endif::[]

// Host tools
include::modules/proc_installing-tracer.adoc[leveloffset=+1]
include::modules/proc_configuring-tracer-on-a-host.adoc[leveloffset=+1]

include::modules/proc_installing-and-configuring-puppet-agent-during-host-registration.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/con_registering-hosts-and-setting-up-host-integration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ You can register hosts through {ProjectServer} or {SmartProxyServer}.
You must also install and configure tools on your hosts, depending on which integration features you want to use.
Use the following procedures to install and configure host tools:

* xref:Installing_Tracer_{context}[]
* xref:Configuring_Tracer_on_a_host_{context}[]
* xref:installing-and-configuring-puppet-agent-during-host-registration_{context}[]
* xref:Installing_and_Configuring_Puppet_Agent_Manually_{context}[]
21 changes: 17 additions & 4 deletions ...dules/proc_enabling-tracer-on-a-host.adoc → ...es/proc_configuring-tracer-on-a-host.adoc
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice to have would be to find out on what operating systems Tracer can be installed if there are any apart from RHEL and add this info to the introduction of the procedure.

Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
[id="enabling-tracer-on-a-host_{context}"]
= Enabling Tracer on a host
[id="Configuring_Tracer_on_a_host_{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
[id="Configuring_Tracer_on_a_host_{context}"]
[id="configuring-tracer-on-a-host"]

If we already change it, we could drop "context" too which we've not decided but done in the past regularly.

Very much option/not blocking your PR.

= Configuring Tracer on a host

Use this procedure to enable Tracer on {Project} and access Traces.
Tracer displays a list of services and applications that need to be restarted.
You can install Tracer on {ProjectName} and access Traces.
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 can install Tracer on {ProjectName} and access Traces.
You can install Tracer on hosts and access Traces on {Project}.

Tracer displays a list of services and applications that are outdated and need to be restarted.
Traces is the output generated by Tracer in the {ProjectWebUI}.

.Prerequisites
* The host is registered to {ProjectName}.
include::snip_prerequisite-project-client-repository-enabled.adoc[]
* Remote execution is enabled.

.Procedure

. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
. Click the name of the host you want to modify.
. On the *Traces* tab, click *Enable Traces*.
. Select the provider to install `katello-host-tools-tracer` from the list.
+
Alternatively, install Tracer using the CLI:
Copy link
Contributor

Choose a reason for hiding this comment

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

do we really want to document this?

If so, it'd probably just be the same commands as the template. Also, "yum" only works for EL7+.

Copy link
Contributor

Choose a reason for hiding this comment

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

We can, but then we should use the proper heading for a CLI procedure:

Suggested change
Alternatively, install Tracer using the CLI:
[id="cli-Configuring..."]
.CLI procedure

Copy link
Contributor

Choose a reason for hiding this comment

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

But with ".CLI procedure", we generally refer to Foreman/Smart Proxies, not commands on hosts. I like that there's abstraction for the commands on hosts through the REX job templates.

+
----
# yum install katello-host-tools-tracer
----
. Click *Enable Tracer*.
You get a REX job notification after the remote execution job is complete.
Comment on lines 25 to 26
Copy link
Contributor

Choose a reason for hiding this comment

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

This step looks like it doesn't belong to the CLI procedure. It should probably go above, together with the web UI procedure.

. Upload the Tracer data to the {ProjectName} server:
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
. Upload the Tracer data to the {ProjectName} server:
. Upload the Tracer data to your {ProjectServer}:

+
----
# katello-tracer-upload
----
25 changes: 0 additions & 25 deletions guides/common/modules/proc_installing-tracer.adoc
View file
Open in desktop

This file was deleted.