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.

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

Add missing steps for disabling TFTP and DNS #3509

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rh-max
Copy link
Contributor

@rh-max rh-max commented Dec 9, 2024

What changes are you introducing?

Adding missing steps for disabling TFTP and DNS for unmanaged networks.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

https://issues.redhat.com/browse/SAT-18574

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.13/Katello 4.15
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

# systemctl mask --now xinetd && yum remove xinetd
----

. For every subnet where the Capsule is set as a TFTP proxy, disable the proxies:
Copy link
Contributor

Choose a reason for hiding this comment

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

branding :)

# systemctl mask --now tftp.service tftp.socket systemd-resolved.service
----

. Optional: On RHEL7 hosts, disable the eXtended Internet Services Daemon (xinetd) and delete the `xinetd` package:
Copy link
Contributor

Choose a reason for hiding this comment

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

This procedure is about the Foreman/Katello platform which does not run on EL7/8 anymore. If you absolutely need these lines, then please create a follow-up PR that only targets the relevant X.Y branches.

@pr-processor pr-processor bot added Waiting on contributor Requires an action from the author and removed Not yet reviewed labels Dec 9, 2024
@maximiliankolb maximiliankolb added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Dec 9, 2024
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

I don't think this change is correct, but the whole file is confusing in its purpose.

If we analyze the title and the first sentence, that's:

Disabling DNS, DHCP, and TFTP for unmanaged networks

If you want to manage TFTP, DHCP, and DNS services manually, you must prevent {Project} from maintaining these services on the operating system and disable orchestration to avoid DHCP and DNS validation errors.

So the purpose is to have services installed, but managed manually by sysadmin. Then an instruction is given to disable the Foreman Proxy features (DHCP, DNS, TFTP). This effectively means the services may still run, but at least Foreman no longer orchestrates them.

If the intent was to let the sysadmin manage these services themselves, then that should be sufficient. Masking them would be part of a procedure to really remove the services, but I don't think we document that at all today.

Copy link
Member

Choose a reason for hiding this comment

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

Line 5 in this file is technically still true since it doesn't remove them, but by masking tftp you do stop it from functioning like it used to so it doesn't feel quite correct anymore.

Additionally, there's also the old line 26:

. Optional: If you use a DHCP service supplied by a third party, configure your DHCP server to pass the following options:

That procedure step is invalidated if you mask the TFTP service.

+
[options="nowrap", subs="+quotes,attributes"]
----
# systemctl mask --now tftp.service tftp.socket systemd-resolved.service
Copy link
Member

Choose a reason for hiding this comment

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

Why mask systemd-resolved? That looks really invasive because it's a service we never mention in our documentation or code.

Perhaps you're confusing it with the DNS service named?

There is also the dhcpd service for DHCP that you don't mention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective Waiting on contributor Requires an action from the author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants