Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
0451dae
Move DNS, DHCP, and TFTP content to a new guide (raw)
Lennonka Dec 16, 2024
a91b191
fixup! Move DNS, DHCP, and TFTP content to a new guide (raw)
Lennonka Dec 16, 2024
7ae5a99
fixup
Lennonka Dec 16, 2024
d618db0
Rename the new guide
Lennonka Dec 18, 2024
950a500
Add guide DocURLs
Lennonka Dec 18, 2024
2706b4a
Draft structure
Lennonka Jan 24, 2025
1d150b5
Keep old structure for comparison
Lennonka Jan 26, 2025
e69c62b
Restructure content
mmuehlfeldRH Apr 3, 2025
b8c755a
Remove obsolete files
mmuehlfeldRH Apr 8, 2025
8c530c4
Add "Associating the DNS|DHCP|TFTP service with a domain|subnet" sect…
mmuehlfeldRH Apr 14, 2025
68b8bc0
Apply suggestions from code review
mmuehlfeldRH Apr 16, 2025
24065ee
SME feedback
mmuehlfeldRH Apr 16, 2025
2ba0d28
Remove {context} attribute from IDs and xrefs that link to these IDs
mmuehlfeldRH Apr 17, 2025
0134127
Rephrased some text in the new modules, added missing steps
mmuehlfeldRH Apr 17, 2025
6b7db8f
SME feedback
mmuehlfeldRH Apr 17, 2025
5b666f8
Move two appendixes to the new guide
mmuehlfeldRH Apr 17, 2025
cc0dd52
SME feedback
mmuehlfeldRH Apr 17, 2025
77c65b0
Fix broken command
mmuehlfeldRH Apr 22, 2025
c235426
SME feedback
mmuehlfeldRH Apr 22, 2025
210ffe1
Remove a unnecessary step
mmuehlfeldRH Apr 22, 2025
1e11e4e
SME feedback
mmuehlfeldRH Apr 22, 2025
e2f3b2f
Restructured nsupdate DNS sections
mmuehlfeldRH Apr 23, 2025
ca41284
Apply suggestions from code review
mmuehlfeldRH Apr 24, 2025
133a4ec
SME feedback
mmuehlfeldRH Apr 24, 2025
559ca0a
Rewrote the DNS|DHCP service providers sections to explain the scenarios
mmuehlfeldRH Apr 24, 2025
9e6c658
Minor text updates (simplified lead-in sentences of steps, split step…
mmuehlfeldRH Apr 24, 2025
792b688
Remove obsolete file about ISC dhcpd settings
mmuehlfeldRH Apr 25, 2025
f381ed1
Use a similar order of options for foreman-installer commands
mmuehlfeldRH Apr 25, 2025
08d6322
Fix broken markups
mmuehlfeldRH Apr 25, 2025
8a7cc01
Remove include of a file that no longer exists
mmuehlfeldRH Apr 25, 2025
ca50695
Vale fixes
mmuehlfeldRH Apr 25, 2025
56bb51e
Update guides/common/modules/proc_configuring-dhcpd-to-use-with-serve…
mmuehlfeldRH Apr 25, 2025
9315188
Apply suggestions from code review
mmuehlfeldRH Apr 25, 2025
70385ab
SME feedback
mmuehlfeldRH Apr 25, 2025
bb4bd19
Remove all superfluous blank lines according to the projects guidelines
mmuehlfeldRH Apr 28, 2025
63de05e
Peer review feedback
mmuehlfeldRH Apr 28, 2025
dde2214
Remove a module that is no longer needed
mmuehlfeldRH Apr 28, 2025
c6f5a96
Apply suggestions from code review
mmuehlfeldRH Apr 28, 2025
aa9c853
Remove <> from replaceables to follow the repo convention
mmuehlfeldRH Apr 28, 2025
1f7264f
Apply suggestions from code review
mmuehlfeldRH Apr 28, 2025
ccba024
Fix broken condition
mmuehlfeldRH Apr 28, 2025
1e82020
More peer review feedback
mmuehlfeldRH Apr 28, 2025
62d847e
Apply suggestions from code review
mmuehlfeldRH Apr 28, 2025
2af2d9c
Apply suggestions from code review
mmuehlfeldRH Apr 29, 2025
18facd6
Peer review feedback
mmuehlfeldRH Apr 29, 2025
fe48aad
Renamed a title
mmuehlfeldRH Apr 29, 2025
95f279e
Update block delmiter to comply with the conventions
mmuehlfeldRH Apr 30, 2025
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
23 changes: 23 additions & 0 deletions guides/common/assembly_configuring-dhcp-integration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
include::modules/con_configuring-dhcp-integration.adoc[]

include::modules/con_dhcp-service-providers.adoc[leveloffset=+1]

include::modules/proc_enabling-the-installer-managed-dhcp-service.adoc[leveloffset=+1]

include::modules/con_integrating-a-remote-isc-dhcp-server.adoc[leveloffset=+1]

include::modules/proc_configuring-isc-dhcp-to-use-with-server.adoc[leveloffset=+2]

include::modules/proc_configuring-server-or-proxy-for-use-with-isc-dhcp.adoc[leveloffset=+2]

include::modules/proc_integrating-infoblox-dhcp.adoc[leveloffset=+1]

ifndef::satellite[]
include::modules/proc_integrating-dnsmasq-dhcp-by-using-the-libvirt-api.adoc[leveloffset=+1]
endif::[]

include::modules/proc_associating-the-dhcp-service-with-a-subnet.adoc[leveloffset=+1]

include::modules/proc_disabling-dhcp-for-integration.adoc[leveloffset=+1]

include::modules/proc_troubleshooting-dhcp-problems.adoc[leveloffset=+1]
7 changes: 0 additions & 7 deletions guides/common/assembly_configuring-dns-dhcp-and-tftp.adoc

This file was deleted.

27 changes: 27 additions & 0 deletions guides/common/assembly_configuring-dns-integration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
include::modules/con_configuring-dns-integration.adoc[]

include::modules/con_dns-service-providers.adoc[leveloffset=+1]

include::modules/proc_enabling-the-installer-managed-dns-service.adoc[leveloffset=+1]

include::modules/proc_integrating-a-local-self-managed-dns-service.adoc[leveloffset=+1]

include::modules/proc_integrating-a-generic-rfc-2136-compatible-remote-dns-server.adoc[leveloffset=+1]

include::modules/proc_integrating-idm-dns-with-tsig-authentication.adoc[leveloffset=+1]

include::modules/proc_integrating-idm-dns-with-gss-tsig-authentication.adoc[leveloffset=+1]

include::modules/proc_integrating-infoblox-dns.adoc[leveloffset=+1]

ifndef::satellite[]
include::modules/proc_integrating-dnsmasq-dns-by-using-the-libvirt-api.adoc[leveloffset=+1]

include::modules/proc_integrating-powerdns.adoc[leveloffset=+1]

include::modules/proc_integrating-route-53-dns.adoc[leveloffset=+1]
endif::[]

include::modules/proc_associating-the-dns-service-with-a-domain-and-subnet.adoc[leveloffset=+1]

include::modules/proc_disabling-dns-for-integration.adoc[leveloffset=+1]
12 changes: 0 additions & 12 deletions guides/common/assembly_configuring-external-dhcp.adoc

This file was deleted.

15 changes: 0 additions & 15 deletions guides/common/assembly_configuring-external-idm-dns.adoc

This file was deleted.

20 changes: 0 additions & 20 deletions guides/common/assembly_configuring-external-services.adoc

This file was deleted.

13 changes: 13 additions & 0 deletions guides/common/assembly_configuring-tftp-integration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
include::modules/con_configuring-tftp-integration.adoc[]

include::modules/proc_enabling-the-installer-managed-tftp-service.adoc[leveloffset=+1]

include::modules/con_integrating-a-generic-tftp-server.adoc[leveloffset=+1]

//== Configuring TFTP to use with {ProductName}

include::modules/proc_configuring-server-for-use-with-tftp.adoc[leveloffset=+2]

include::modules/proc_associating-the-tftp-service-with-a-subnet.adoc[leveloffset=+1]

include::modules/proc_disabling-tftp-for-integration.adoc[leveloffset=+1]
2 changes: 0 additions & 2 deletions guides/common/assembly_deployment-path.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ include::modules/con_installing-a-project-server.adoc[leveloffset=+1]

include::modules/con_configuring-project-server-with-external-database.adoc[leveloffset=+2]

include::modules/con_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+2]

include::modules/con_deploying-project-on-aws.adoc[leveloffset=+1]

include::modules/ref_configuring-external-authentication-in-foreman.adoc[leveloffset=+1]
Expand Down
7 changes: 0 additions & 7 deletions guides/common/assembly_managing-dhcp-on-smart-proxies.adoc

This file was deleted.

11 changes: 0 additions & 11 deletions guides/common/assembly_managing-dns-on-smart-proxies.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,3 @@ endif::[]

// Enabling Power Management on Hosts
include::modules/proc_enabling-power-management-on-hosts.adoc[leveloffset=+1]

// Configuring DNS, DHCP, and TFTP on {SmartProxyServer}
include::modules/proc_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+1]
8 changes: 0 additions & 8 deletions guides/common/assembly_preparing-networking.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,16 @@ include::modules/proc_optimizing-performance-by-removing-nics-from-database.adoc

include::modules/con_network-resources.adoc[leveloffset=+1]

include::modules/con_foreman-and-dhcp-configuration.adoc[leveloffset=+1]

include::modules/ref_options-in-managed-dhcpv4.adoc[leveloffset=+2]
Copy link
Member

Choose a reason for hiding this comment

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

I think we need to do something with this as well. I'm looking at @Lennonka and @apinnick here, but IMHO the provisioning guide should end up with the persona of a user who uses Foreman to provision. An admin already used the DHCP, DNS, and TFTP guide to set it up. The provisioning guide must list DHCP, DNS or TFTP as prerequisites for workflows if they are mandatory.


include::modules/ref_options-in-unmanaged-dhcpv6.adoc[leveloffset=+2]

include::modules/proc_troubleshooting-dhcp-problems.adoc[leveloffset=+1]

ifdef::provisioning,provisioning-cloud,provisioning-virtual[]
include::modules/con_prerequisites-for-image-based-provisioning.adoc[leveloffset=+1]
endif::[]

include::modules/proc_configuring-network-services.adoc[leveloffset=+1]

include::modules/ref_multiple-subnets-or-domains-using-installer.adoc[leveloffset=+2]

include::modules/ref_dhcp-options-for-network-configuration.adoc[leveloffset=+2]

include::modules/ref_dns-options-for-network-configuration.adoc[leveloffset=+2]

include::modules/ref_tftp-options-for-network-configuration.adoc[leveloffset=+2]
Expand Down

This file was deleted.

2 changes: 2 additions & 0 deletions guides/common/attributes-base.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:BaseFilenameURL: index-{build}.html
:AdministeringDocURL: {BaseURL}Administering_Project/{BaseFilenameURL}#
:APIDocURL: {BaseURL}Project_API/{BaseFilenameURL}#
:ConfiguringDNSDHCPTFTPDocURL: {BaseURL}Configuring_DNS_DHCP_TFTP/{BaseFilenameURL}#
:ConfiguringLoadBalancerDocURL: {BaseURL}Configuring_Load_Balancer/{BaseFilenameURL}#
:ConfiguringUserAuthenticationDocURL: {BaseURL}Configuring_User_Authentication/{BaseFilenameURL}#
:ContentManagementDocURL: {BaseURL}Managing_Content/{BaseFilenameURL}#
Expand Down Expand Up @@ -79,6 +80,7 @@
:foreman-maintain: foreman-maintain
:FreeIPA: FreeIPA
:FreeIPA-context: {FreeIPA}
:freeipaserver-example-com: freeipa-server.example.com
:hammer-smart-proxy: hammer proxy
:install-on-os: {EL}
:installer-log-file: /var/log/foreman-installer/foreman.log
Expand Down
3 changes: 2 additions & 1 deletion guides/common/attributes-satellite.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// - downstream_filename_to_link.json in downstream
:AdministeringDocURL: {BaseURL}administering_red_hat_satellite/index#
:APIDocURL: {BaseURL}using_the_satellite_rest_api/index#
:ConfiguringDNSDHCPTFTPDocURL: {BaseURL}/configuring_dns_dhcp_and_tftp_integration/index#
:ConfiguringDNSDHCPTFTPDocURL: {BaseURL}configuring_dns_dhcp_and_tftp_integration/index#
:ConfiguringLoadBalancerDocURL: {BaseURL}configuring_capsules_with_a_load_balancer/index#
:ConfiguringUserAuthenticationDocURL: {BaseURL}configuring_authentication_for_red_hat_satellite_users/index#
:ConfiguringVMSubscriptionsDocURL: {BaseURL}configuring_virt_who_for_virtual_machine_subscriptions/index#
Expand Down Expand Up @@ -77,6 +77,7 @@
:foreman-maintain: satellite-maintain
:FreeIPA: Identity{nbsp}Management
:FreeIPA-context: Identity_Management
:freeipaserver-example-com: idm-server.example.com
:hammer-smart-proxy: hammer capsule
:installer-log-file: /var/log/foreman-installer/satellite.log
:installer-scenario-smartproxy: satellite-installer --scenario capsule
Expand Down
5 changes: 5 additions & 0 deletions guides/common/modules/con_configuring-dhcp-integration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[id="configuring-dhcp-integration"]
= Configuring DHCP integration

{Project} can manage IP leases on a DHCP server through a {SmartProxy}.
This includes querying for available IP addresses, adding new reservations, and deleting existing reservations from the lease database.
29 changes: 0 additions & 29 deletions guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc

This file was deleted.

5 changes: 5 additions & 0 deletions guides/common/modules/con_configuring-dns-integration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[id="configuring-dns-integration"]
= Configuring DNS integration

{Project} can manage DNS records by using {SmartProxy}.
This DNS management contains updating and removing DNS records from existing DNS zones.

This file was deleted.

This file was deleted.

This file was deleted.

4 changes: 4 additions & 0 deletions guides/common/modules/con_configuring-tftp-integration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[id="configuring-tftp-integration"]
= Configuring TFTP integration

By integrating a TFTP server, you can perform unattended installations.
23 changes: 23 additions & 0 deletions guides/common/modules/con_dhcp-service-providers.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[id="dhcp-serivce-proviers"]
= DHCP service providers

{SmartProxy} supports the following DHCP providers that you can use to integrate {Project} with your existing DHCP infrastructure or deploy a new one:

`dhcp_isc`:: Managing IP leases on an ISC DHCP server by using the Object Management Application Programming Interface (OMAPI).
See xref:enabling-the-installer-managed-dhcp-service[].

`dhcp_remote_isc`:: Managing IP leases on a remote ISC dhcpd server by using OMAPI.
This provider requires that you share the leases over the network, for example, with NFS.
See xref:integrating-a-remote-isc-dhcp-server[].

`dhcp_infoblox`:: Managing IP leases on an Infoblox DHCP server.
See xref:integrating-infoblox-dhcp[].

ifndef::satellite[]
`dhcp_libvirt`:: Managing IP leases on a dnsmasq DHCP server by using the `libvirt` API.
See xref:integrating-dnsmasq-dhcp-by-using-the-libvirt-api[].
endif::[]

ifdef::orcharhino[]
`dhcp_native_ms`:: Managing IP leases in Microsoft Active Directory.
endif::[]
27 changes: 27 additions & 0 deletions guides/common/modules/con_dns-service-providers.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[id="dns-service-providers"]
= DNS service providers

{SmartProxy} supports the following DNS providers that you can use to integrate {Project} with your existing DNS infrastructure or deploy a new one:

`dns_nsupdate`:: Dynamic DNS updates on an link:https://datatracker.ietf.org/doc/html/rfc2136[RFC 2136]-compatible DNS server by using the `nsupdate` utility.
See:
+
** xref:enabling-the-installer-managed-dns-service[]
** xref:integrating-a-local-self-managed-dns-service[]
** xref:integrating-a-generic-rfc-2136-compatible-remote-dns-server[]
** xref:integrating-idm-dns-with-tsig-authentication[].
`dns_nsupdate_gss`:: Dynamic DNS updates on an link:https://datatracker.ietf.org/doc/html/rfc2136[RFC 2136]-compatible DNS server by using the `nsupdate` utility with Generic Security Service algorithm for Transaction Signature (GSS-TSIG) authentication.
See xref:integrating-idm-dns-update-with-gss-tsig-authentication[].
`dns_infoblox`:: Dynamic DNS updates on an Infoblox DNS server.
See xref:integrating-infoblox-dns[].
ifndef::satellite[]
`dns_libvirt`:: Dynamic DNS updates on a dnsmasq DNS server by using the `libvirt` API.
See xref:integrating-dnsmasq-dns-by-using-the-libvirt-api[].
`dns_powerdns`:: Dynamic DNS updates on a PowerDNS server.
See xref:integrating-powerdns[].
`dns_route53`:: Dynamic DNS updates on an Amazon Route 53 DNS server.
See xref:integratinig-route-53[].
endif::[]
ifdef::orcharhino[]
`dns_dnscmd`:: Static DNS records in Microsoft Active Directory.
endif::[]
4 changes: 0 additions & 4 deletions guides/common/modules/con_foreman-and-dhcp-configuration.adoc

This file was deleted.

Loading
Loading