Skip to content

Commit

Permalink
Remove deprecated katello-agent (theforeman#2508)
Browse files Browse the repository at this point in the history
* State that pull-based remote execution uses MQTT
* Remove more mentions of Katello Agent
* Remove related open ports
* Remove links to Upgrading Content Hosts
* Remove qpid and qdrouterd mentions
  • Loading branch information
bangelic committed Dec 6, 2023
1 parent 3c0349d commit 0e4dbcc
Show file tree
Hide file tree
Showing 48 changed files with 9 additions and 485 deletions.
2 changes: 0 additions & 2 deletions guides/common/assembly_building_cloud-images.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ include::modules/proc_configuring-a-host-for-registration.adoc[leveloffset=+1]

include::modules/proc_registering-a-host.adoc[leveloffset=+1]

include::modules/proc_installing-the-katello-agent.adoc[leveloffset=+1]

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

include::modules/proc_completing-the-rhel7-image.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@ Use this chapter to configure additional settings on your {SmartProxyServer}.
// Configuring SmartProxy for Host Registration and Provisioning
include::modules/proc_configuring-smart-proxy-for-host-registration-and-provisioning.adoc[leveloffset=+1]

ifdef::katello,orcharhino,satellite[]
// Enabling Katello Agent Infrastructure
include::modules/proc_enabling-katello-agent.adoc[leveloffset=+1]
endif::[]

ifdef::foreman-el,foreman-deb,katello[]
include::modules/proc_enabling-remote-execution.adoc[leveloffset=+1]
endif::[]
Expand Down
2 changes: 0 additions & 2 deletions guides/common/assembly_registering-hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ include::modules/proc_providing-an-alternative-fqdn-for-the-host.adoc[leveloffse
endif::[]

// Host tools
include::modules/proc_installing-the-katello-agent.adoc[leveloffset=+1]

include::modules/proc_installing-tracer.adoc[leveloffset=+1]

include::modules/proc_installing-and-configuring-puppet-agent-during-host-registration.adoc[leveloffset=+1]
Expand Down
6 changes: 0 additions & 6 deletions guides/common/modules/con_applying-errata-to-hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,4 @@ For more information, see {ManagingHostsDocURL}Registering_Hosts_managing-hosts[
* Configure the host for remote execution.
For more information about running remote execution jobs, see {ManagingHostsDocURL}Configuring_and_Setting_Up_Remote_Jobs_managing-hosts[Configuring and Setting Up Remote Jobs] in _{ManagingHostsDocTitle}_.

[NOTE]
====
If the host is already configured to receive content updates with the deprecated Katello Agent, migrate to remote execution instead.
For more information, see {ManagingHostsDocURL}Migrating_Hosts_From_Katello_Agent_to_Remote_Execution_managing-hosts[Migrating From Katello Agent to Remote Execution] in _{ManagingHostsDocTitle}_.
====

The procedure to apply an erratum to a managed host depends on its operating system.
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,8 @@ When you complete all the options for the new host, submit the new host request.
. The installer requests the provisioning template from {Project}.
. {Project} renders the provision template and returns the result to the host.
. The installer performs installation of the operating system.
ifdef::foreman-el,katello[]
* When Katello plugin is installed, the installer registers the host to {Project} using Subscription Manager.
* When Katello plugin is installed, management tools such as `katello-agent` and `puppet` are installed.
endif::[]
ifdef::satellite[]
ifdef::katello,satellite,orcharhino[]
* The installer registers the host to {Project} using Subscription Manager.
* The installer installs management tools such as `katello-agent` and `puppet`.
endif::[]
ifdef::orcharhino[]
* The installer registers the host to {Project} using orcharhino client.
* The installer installs management tools such as `katello-agent` and `puppet`.
endif::[]
* The installer notifies {Project} of a successful build in the `postinstall` script.
. The PXE configuration files revert to a local boot template.
Expand Down
2 changes: 0 additions & 2 deletions guides/common/modules/con_qdrouterd-and-qpid-tuning.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ include::snip_deprecated-entitlement-subscriptions.adoc[]
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_the_Katello_Agent_{context}[]
* xref:Installing_Tracer_{context}[]
* xref:installing-and-configuring-puppet-agent-during-host-registration_{context}[]
* xref:Installing_and_Configuring_Puppet_Agent_Manually_{context}[]
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,12 @@ ifdef::katello,orcharhino,satellite[]
* To enable pull mode on an existing host, continue with xref:Configuring_a_Host_to_Use_the_Pull_Client_{context}[].
endif::[]
ifdef::managing-hosts[]
* To migrate a host from Katello Agent, see xref:Migrating_Hosts_From_Katello_Agent_to_Remote_Execution_{context}[].
* To enable pull mode on a new host, continue with either of the following procedures:

** xref:Creating_a_Host_{context}[]
** xref:Registering_Hosts_by_Using_Global_Registration_{context}[].
endif::[]
ifndef::managing-hosts[]
* To migrate a host from Katello Agent, see {ManagingHostsDocURL}Migrating_Hosts_From_Katello_Agent_to_Remote_Execution_managing-hosts[Migrating from Katello Agent to Remote Execution] in _{ManagingHostsDocTitle}_.
* To enable pull mode on a new host, continue with either of the following procedures in _{ManagingHostsDocTitle}_:

** {ManagingHostsDocURL}Creating_a_Host_managing-hosts[Creating a Host]
Expand Down
1 change: 0 additions & 1 deletion guides/common/modules/proc_adding-errata-to-a-host.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ Use the following procedure to add errata to a host.
. Select the errata you want to add to the host, or select the checkbox at the top of the list to add all installable errata.
Click the checkbox next to any errata you wish to remove from a full list.
. Using the vertical ellipsis icon next to the errata you want to add to the host, select *Apply via Remote Execution* to use Remote Execution, or select *Apply via customized remote execution* if you want to customize the remote execution.
Select *Apply via Katello agent* if you have no connectivity to the target host using SSH.
. Click *Submit*.
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,3 @@
--inputs errata=_ERRATUM_ID1_,_ERRATUM_ID2_,... \
--search-query "host_collection = _HOST_COLLECTION_NAME_"
----

.Using `Katello Agent` (deprecated)
[options="nowrap" subs="+quotes"]
----
# hammer host-collection erratum install \
--errata "_erratum_ID1_,_erratum_ID2_,..." \
--name "_host_collection_name_"\
--organization "_My_Organization_"
----
9 changes: 0 additions & 9 deletions guides/common/modules/proc_applying-errata-to-hosts-el7.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,3 @@ Using `Remote Execution`
--inputs errata=_ERRATUM_ID1_,_ERRATUM_ID2_ \
--search-query "name = client.example.com"
----
+
Using `Katello Agent` (deprecated)
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
# hammer host errata apply \
--errata-ids _ERRATUM_ID1_,_ERRATUM_ID2_... \
--host "client.example.com"
----
16 changes: 0 additions & 16 deletions guides/common/modules/proc_applying-errata-to-multiple-hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@ For more information, see {ManagingHostsDocURL}Registering_Hosts_managing-hosts[
* Configure the host for remote execution.
For more information about running remote execution jobs, see {ManagingHostsDocURL}Configuring_and_Setting_Up_Remote_Jobs_managing-hosts[Configuring and Setting Up Remote Jobs] in _{ManagingHostsDocTitle}_.

[NOTE]
====
If the host is already configured to receive content updates with the deprecated Katello Agent, migrate to remote execution instead.
For more information, see {ManagingHostsDocURL}Migrating_Hosts_From_Katello_Agent_to_Remote_Execution_managing-hosts[Migrating From Katello Agent to Remote Execution] in _{ManagingHostsDocTitle}_.
====

.Procedure
. In the {ProjectWebUI}, navigate to *Content* > *Content Types* > *Errata*.
. Click the name of an erratum you want to apply.
Expand Down Expand Up @@ -45,16 +39,6 @@ Using `Remote Execution`
--search-query "applicable_errata = _ERRATUM_ID_"
----
+
Using `Katello Agent` (deprecated)
+
Identify the erratum you want to use and list the hosts that this erratum is applicable to:
+
[options="nowrap" subs="+quotes"]
----
# hammer host list \
--search "applicable_errata = _ERRATUM_ID_" \
--organization "_Default Organization_"
----
The following Bash script applies an erratum to each host for which this erratum is available:
+
[source, Bash, subs="+quotes"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Use the following procedure to view a list of installable errata and select erra
. On the *Content* tab, *Errata* displays installable errata for the chosen host.
. Click the checkbox for any errata you wish to install.
. Using the vertical ellipsis icon next to the errata you want to add to the host, select *Apply via Remote Execution* to use Remote Execution.
Select *Apply via customized remote execution* if you want to customize the remote execution, or select *Apply via Katello agent* if you have no connectivity to the target host using SSH.
Select *Apply via customized remote execution* if you want to customize the remote execution.
. Click *Submit*.

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion guides/common/modules/proc_cloning_satellite_server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Ensure that you understand the following terms:
. Clone the source server to the target server.
. Power off the source server.
. Update the network configuration on the target server to match the target server’s IP address with its new host name.
. If any content hosts use the deprecated Katello Agent, restart the `goferd` service on all those content hosts and their {SmartProxies} to refresh the connection.
. Test the new target server.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ For more information, see {InstallingSmartProxyDocURL}configuring-remote-executi
* The host is able to communicate with its {SmartProxy} over MQTT using port `1883`.
* The host is able to communicate with its {SmartProxy} over HTTPS.

NOTE: The `katello-pull-transport-migrate` package was created to help users migrate from Katello Agent to remote execution with the pull client.
However, having Katello Agent installed on the host is not a requirement.
You can use `katello-pull-transport-migrate` regardless of whether Katello Agent is installed.

.Procedure
. Install the `katello-pull-transport-migrate` package on your host:
ifdef::client-content-dnf[]
Expand Down Expand Up @@ -54,6 +50,3 @@ The host's `subscription-manager` configuration and consumer certificates are us
----
# systemctl status yggdrasild
----
. Optional: After the package is installed, you can remove `katello-agent` from the host.
+
WARNING: If your host is installed on {oVirt} version 4.4 or lower, do not remove the `katello-agent` package because the removed dependencies corrupt the host.
4 changes: 0 additions & 4 deletions guides/common/modules/proc_configuring-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ An internal label that matches the value is also created and cannot be changed a
If you do not specify a value, an organization called *Default Organization* with the label *Default_Organization* is created.
You can rename the organization name but not the label.

ifdef::satellite,katello[]
* Remote Execution is the primary method of managing packages on Content Hosts. If you want to use the deprecated Katello Agent instead of Remote Execution SSH, use the `--foreman-proxy-content-enable-katello-agent=true` option to enable it. The same option should be given on any {SmartProxyServer} as well as {ProjectServer}.
endif::[]

* By default, all configuration files configured by the installer are managed by Puppet.
When `{foreman-installer}` runs, it overwrites any manual changes to the Puppet managed files with the initial values.
By default, {ProjectServer} is installed with the Puppet agent running as a service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ By default, Remote Execution uses SSH as the transport mechanism for the Script
However, Remote Execution also offers pull-based transport, which you can use if your infrastructure prohibits outgoing connections from {Project} to hosts.

This comprises `pull-mqtt` mode on {Project} in combination with a pull client running on hosts.
If you still use Katello Agent, configure the `pull-mqtt` mode for migration which is a deprecated method of pull-based transport.

[NOTE]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ By default, Remote Execution uses SSH as the transport mechanism for the Script
However, Remote Execution also offers pull-based transport, which you can use if your infrastructure prohibits outgoing connections from {SmartProxy} to hosts.

This is comprised of `pull-mqtt` mode on {SmartProxy} in combination with a pull client running on hosts.
Configure the `pull-mqtt` mode to migrate from Katello Agent, which is a deprecated method of pull-based transport.

NOTE: The `pull-mqtt` mode works only with the Script provider.
Ansible and other providers will continue to use their default transport settings.
Expand Down

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion guides/common/modules/proc_creating-an-activation-key.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ If you want unlimited hosts to register with the activation key, ensure the *Unl
. Optional: In the *Description* field, enter a description for the activation key.
. From the *Environment* list, select the environment to use.
. From the *Content View* list, select a Content View to use.
If you intend to use the deprecated `Katello Agent` instead of `Remote Execution`, the Content View must contain the {project-client-name} repository because it contains the `katello-agent` package.
ifndef::orcharhino[]
. If Simple Content Access (SCA) is enabled:
.. In the *Repository Sets* tab, ensure only your named repository is enabled.
Expand Down
15 changes: 0 additions & 15 deletions guides/common/modules/proc_enabling-katello-agent.adoc

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id="Enabling_the_Client_Repository_{context}"]
= Enabling the {project-client-name} Repository

The {project-client-name} repository provides the `katello-agent`, `katello-host-tools`, and `puppet` packages for clients registered to {ProjectServer}.
The {project-client-name} repository provides the `katello-host-tools` and `puppet` packages for clients registered to {ProjectServer}.
You must enable the repository for each {RHEL} version that you need to manage hosts.
Continue with a procedure below according to the operating system version for which you want to enable the {project-client-name} repository.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ A full backup requires space to store the following data:
100G {postgresql-data-dir}
100G /var/lib/pulp
# du -csh /var/lib/qpidd /var/lib/tftpboot /etc /root/ssl-build \
# du -csh /var/lib/tftpboot /etc /root/ssl-build \
/var/www/html/pub /opt/puppetlabs
886M /var/lib/qpidd
16M /var/lib/tftpboot
37M /etc
900K /root/ssl-build
Expand Down Expand Up @@ -53,8 +52,7 @@ The following table describes the compression ratio of all data items included i
|100 GB

|Configuration files
a|`/var/lib/qpidd` +
`/var/lib/tftpboot` +
a|`/var/lib/tftpboot` +
`/etc` +
`/root/ssl-build` +
`/var/www/html/pub` +
Expand Down

0 comments on commit 0e4dbcc

Please sign in to comment.