From bd3e88a5fe9c65b20626d221ca8061b444c520f5 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Mon, 16 Dec 2024 23:24:22 +0100 Subject: [PATCH 1/5] Move DNS, DHCP, and TFTP content to a new guide (raw) --- ...ssembly_configuring-external-services.adoc | 6 ---- guides/common/attributes-titles.adoc | 1 + .../con_configuring-dns-dhcp-and-tftp.adoc | 2 +- ...onfiguring-project-with-external-dhcp.adoc | 2 +- ...con_managing-dhcp-by-using-smartproxy.adoc | 6 ++-- .../con_managing-dns-by-using-smartproxy.adoc | 2 +- ...ng-infoblox-as-dhcp-and-dns-providers.adoc | 2 +- .../Makefile | 1 + .../doc-Administering_Network_Services/common | 1 + .../docinfo.html | 1 + .../docinfo.xml | 19 +++++++++++++ .../images/common | 1 + .../master.adoc | 28 +++++++++++++++++++ guides/doc-Installing_Proxy/master.adoc | 9 ------ guides/doc-Installing_Server/master.adoc | 6 ++-- .../master.adoc | 7 ++--- 16 files changed, 63 insertions(+), 31 deletions(-) create mode 100644 guides/doc-Administering_Network_Services/Makefile create mode 120000 guides/doc-Administering_Network_Services/common create mode 120000 guides/doc-Administering_Network_Services/docinfo.html create mode 100644 guides/doc-Administering_Network_Services/docinfo.xml create mode 120000 guides/doc-Administering_Network_Services/images/common create mode 100644 guides/doc-Administering_Network_Services/master.adoc diff --git a/guides/common/assembly_configuring-external-services.adoc b/guides/common/assembly_configuring-external-services.adoc index 55bd05c345a..0d40f84ceb9 100644 --- a/guides/common/assembly_configuring-external-services.adoc +++ b/guides/common/assembly_configuring-external-services.adoc @@ -6,15 +6,9 @@ include::modules/proc_configuring-external-dns.adoc[leveloffset=+1] include::assembly_configuring-external-dhcp.adoc[leveloffset=+1] -ifeval::[ "{context}" == "{project-context}" ] -include::assembly_using-infoblox-as-dhcp-and-dns-providers.adoc[leveloffset=+1] -endif::[] - include::modules/proc_configuring-external-tftp.adoc[leveloffset=+1] include::assembly_configuring-external-idm-dns.adoc[leveloffset=+1] -include::assembly_configuring-project-to-manage-the-lifecycle-of-a-host-registered-to-a-freeipa-realm.adoc[leveloffset=+1] - ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc index 2d5f1c4dd12..c1f4c57f2d2 100644 --- a/guides/common/attributes-titles.adoc +++ b/guides/common/attributes-titles.adoc @@ -2,6 +2,7 @@ :AdministeringDocTitle: Administering {ProjectName} :AdministeringAnsibleDocTitle: Managing {Project} with Ansible +:AdministeringNetworkDocTitle: Administering network services :APIDocTitle: Using the {Project} REST API :AppCentricDeploymentDocTitle: Deploying hosts by using application centric approach :ConfiguringLoadBalancerDocTitle: Configuring {SmartProxies} with a load balancer diff --git a/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc b/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc index 241259a9e07..0d35e59a00b 100644 --- a/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc +++ b/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc @@ -1,4 +1,4 @@ -[id="configuring-dns-dhcp-and-tftp_{context}"] +[id="configuring-dns-dhcp-and-tftp"] = Configuring DNS, DHCP, and TFTP You can manage DNS, DHCP, and TFTP centrally within the {Project} environment, or you can manage them independently after disabling their maintenance on {Project}. diff --git a/guides/common/modules/con_configuring-project-with-external-dhcp.adoc b/guides/common/modules/con_configuring-project-with-external-dhcp.adoc index d51012be13f..c0770fce3d7 100644 --- a/guides/common/modules/con_configuring-project-with-external-dhcp.adoc +++ b/guides/common/modules/con_configuring-project-with-external-dhcp.adoc @@ -1,4 +1,4 @@ -[id="configuring-external-dhcp_{context}"] +[id="configuring-external-dhcp"] = Configuring {ProductName} with external DHCP To configure {ProductName} with external DHCP, you must complete the following procedures: diff --git a/guides/common/modules/con_managing-dhcp-by-using-smartproxy.adoc b/guides/common/modules/con_managing-dhcp-by-using-smartproxy.adoc index 965a5944922..c83654e2826 100644 --- a/guides/common/modules/con_managing-dhcp-by-using-smartproxy.adoc +++ b/guides/common/modules/con_managing-dhcp-by-using-smartproxy.adoc @@ -7,11 +7,11 @@ You can use the DHCP module of {SmartProxy} to query for available IP addresses, Note that your {SmartProxy} cannot manage subnet declarations. .Available DHCP providers -* `dhcp_infoblox` {endash} For more information, see xref:Using_Infoblox_as_DHCP_and_DNS_Providers_{smart-proxy-context}[]. +* `dhcp_infoblox` {endash} For more information, see xref:Using_Infoblox_as_DHCP_and_DNS_Providers[]. * `dhcp_isc` {endash} ISC DHCP server over OMAPI. -For more information, see xref:configuring-dns-dhcp-and-tftp-on-productname_{smart-proxy-context}[]. +For more information, see xref:configuring-dns-dhcp-and-tftp[]. * `dhcp_remote_isc` {endash} ISC DHCP server over OMAPI with leases mounted through networking. -For more information, see xref:configuring-external-dhcp_{smart-proxy-context}[]. +For more information, see xref:configuring-external-dhcp[]. ifndef::satellite[] * `dhcp_libvirt` {endash} dnsmasq DHCP via libvirt API endif::[] diff --git a/guides/common/modules/con_managing-dns-by-using-smartproxy.adoc b/guides/common/modules/con_managing-dns-by-using-smartproxy.adoc index dbf5d3035c0..822d176dbb3 100644 --- a/guides/common/modules/con_managing-dns-by-using-smartproxy.adoc +++ b/guides/common/modules/con_managing-dns-by-using-smartproxy.adoc @@ -12,7 +12,7 @@ Other providers provide more direct integration, such as `dns_infoblox` for http ifdef::orcharhino[] * `dns_dnscmd` {endash} Static DNS records in Microsoft Active Directory. endif::[] -* `dhcp_infoblox` {endash} For more information, see xref:Using_Infoblox_as_DHCP_and_DNS_Providers_{smart-proxy-context}[]. +* `dhcp_infoblox` {endash} For more information, see xref:Using_Infoblox_as_DHCP_and_DNS_Providers[]. ifndef::satellite[] * `dns_libvirt` {endash} Dnsmasq DNS via libvirt API. For more information, see xref:configuring_dns_libvirt_{context}[]. diff --git a/guides/common/modules/con_using-infoblox-as-dhcp-and-dns-providers.adoc b/guides/common/modules/con_using-infoblox-as-dhcp-and-dns-providers.adoc index 3f8cc7c239f..86ebb08ea50 100644 --- a/guides/common/modules/con_using-infoblox-as-dhcp-and-dns-providers.adoc +++ b/guides/common/modules/con_using-infoblox-as-dhcp-and-dns-providers.adoc @@ -1,4 +1,4 @@ -[id="Using_Infoblox_as_DHCP_and_DNS_Providers_{context}"] +[id="Using_Infoblox_as_DHCP_and_DNS_Providers"] = Using Infoblox as DHCP and DNS providers You can use {ProductName} to connect to your Infoblox application to create and manage DHCP and DNS records, and to reserve IP addresses. diff --git a/guides/doc-Administering_Network_Services/Makefile b/guides/doc-Administering_Network_Services/Makefile new file mode 100644 index 00000000000..dd1e5be8557 --- /dev/null +++ b/guides/doc-Administering_Network_Services/Makefile @@ -0,0 +1 @@ +include ../common/Makefile diff --git a/guides/doc-Administering_Network_Services/common b/guides/doc-Administering_Network_Services/common new file mode 120000 index 00000000000..60d3b0a6a8f --- /dev/null +++ b/guides/doc-Administering_Network_Services/common @@ -0,0 +1 @@ +../common \ No newline at end of file diff --git a/guides/doc-Administering_Network_Services/docinfo.html b/guides/doc-Administering_Network_Services/docinfo.html new file mode 120000 index 00000000000..e037c37244a --- /dev/null +++ b/guides/doc-Administering_Network_Services/docinfo.html @@ -0,0 +1 @@ +../common/docinfo.html \ No newline at end of file diff --git a/guides/doc-Administering_Network_Services/docinfo.xml b/guides/doc-Administering_Network_Services/docinfo.xml new file mode 100644 index 00000000000..7ce4ef0da2d --- /dev/null +++ b/guides/doc-Administering_Network_Services/docinfo.xml @@ -0,0 +1,19 @@ +{AdministeringNetworkDocTitle} +Red Hat Satellite +{ProjectVersion} +Administer network services, such as DNS, DHCP, and TFTP + + + + TODO + + + + + + Red Hat Satellite + Documentation Team + satellite-doc-list@redhat.com + + + diff --git a/guides/doc-Administering_Network_Services/images/common b/guides/doc-Administering_Network_Services/images/common new file mode 120000 index 00000000000..53d0c7f575d --- /dev/null +++ b/guides/doc-Administering_Network_Services/images/common @@ -0,0 +1 @@ +../common/images \ No newline at end of file diff --git a/guides/doc-Administering_Network_Services/master.adoc b/guides/doc-Administering_Network_Services/master.adoc new file mode 100644 index 00000000000..255eb0ea882 --- /dev/null +++ b/guides/doc-Administering_Network_Services/master.adoc @@ -0,0 +1,28 @@ +include::common/attributes.adoc[] +include::common/header.adoc[] +:context: admin-network +:admin-network: + += {AdministeringNetworkDocTitle} + +// This guide is not ready for stable releases +ifdef::HideDocumentOnStable[] +include::common/modules/snip_guide-not-ready.adoc[] +endif::[] +ifndef::HideDocumentOnStable[] + +ifdef::satellite[] +include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] +endif::[] + +include::common/assembly_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+1] + +:ProductName: {SmartProxy} +include::common/assembly_configuring-external-services.adoc[leveloffset=+1] + +include::common/assembly_managing-dhcp-on-smart-proxies.adoc[leveloffset=+1] + +include::common/assembly_managing-dns-on-smart-proxies.adoc[leveloffset=+1] + +include::common/assembly_using-infoblox-as-dhcp-and-dns-providers.adoc[leveloffset=+1] +endif::[] diff --git a/guides/doc-Installing_Proxy/master.adoc b/guides/doc-Installing_Proxy/master.adoc index d6207a5e686..4db6ff816ea 100644 --- a/guides/doc-Installing_Proxy/master.adoc +++ b/guides/doc-Installing_Proxy/master.adoc @@ -26,15 +26,6 @@ include::common/assembly_installing-capsule-server.adoc[leveloffset=+1] include::common/assembly_performing-additional-configuration-on-smart-proxy-server.adoc[leveloffset=+1] -// Configuring {SmartProxyServer} with External Services -include::common/assembly_configuring-external-services.adoc[leveloffset=+1] - -include::common/assembly_managing-dhcp-on-smart-proxies.adoc[leveloffset=+1] - -include::common/assembly_managing-dns-on-smart-proxies.adoc[leveloffset=+1] - -include::common/assembly_using-infoblox-as-dhcp-and-dns-providers.adoc[leveloffset=+1] - :numbered!: // {SmartProxyServer} Scalability Considerations diff --git a/guides/doc-Installing_Server/master.adoc b/guides/doc-Installing_Server/master.adoc index f4658a3b763..54f2166a0d5 100644 --- a/guides/doc-Installing_Server/master.adoc +++ b/guides/doc-Installing_Server/master.adoc @@ -45,10 +45,10 @@ include::common/assembly_configuring-satellite-with-an-http-proxy.adoc[leveloffs include::common/modules/proc_enabling-power-management-on-hosts.adoc[leveloffset=+2] -include::common/assembly_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+2] - include::common/modules/proc_configuring-satellite-for-outgoing-emails.adoc[leveloffset=+2] +include::common/assembly_configuring-project-to-manage-the-lifecycle-of-a-host-registered-to-a-freeipa-realm.adoc[leveloffset=+2] + ifdef::katello,orcharhino,satellite[] include::common/assembly_configuring-an-alternate-cname.adoc[leveloffset=+2] @@ -59,8 +59,6 @@ include::common/modules/proc_resetting-custom-ssl-certificate-to-default-self-si include::common/assembly_using-external-databases.adoc[leveloffset=+2] endif::[] -include::common/assembly_configuring-external-services.adoc[leveloffset=+1] - :numbered!: ifdef::katello[] diff --git a/guides/doc-Installing_Server_Disconnected/master.adoc b/guides/doc-Installing_Server_Disconnected/master.adoc index 905598a1c5a..c59703985a3 100644 --- a/guides/doc-Installing_Server_Disconnected/master.adoc +++ b/guides/doc-Installing_Server_Disconnected/master.adoc @@ -30,19 +30,16 @@ include::common/modules/proc_configuring-pull-based-transport-for-remote-executi include::common/modules/proc_enabling-power-management-on-hosts.adoc[leveloffset=+2] -include::common/assembly_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+2] - include::common/modules/proc_configuring-satellite-for-outgoing-emails.adoc[leveloffset=+2] +include::common/assembly_configuring-project-to-manage-the-lifecycle-of-a-host-registered-to-a-freeipa-realm.adoc[leveloffset=+2] + ifdef::katello,orcharhino,satellite[] include::common/assembly_configuring-satellite-custom-server-certificate.adoc[leveloffset=+2] include::common/assembly_using-external-databases.adoc[leveloffset=+2] endif::[] - -include::common/assembly_configuring-external-services.adoc[leveloffset=+1] - :numbered!: [appendix] From 095d388f71587a82220007eaaa690b74e1e92a12 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Mon, 16 Dec 2024 23:36:01 +0100 Subject: [PATCH 2/5] fixup! Move DNS, DHCP, and TFTP content to a new guide (raw) --- ...forming-additional-configuration-on-smart-proxy-server.adoc | 3 --- 1 file changed, 3 deletions(-) diff --git a/guides/common/assembly_performing-additional-configuration-on-smart-proxy-server.adoc b/guides/common/assembly_performing-additional-configuration-on-smart-proxy-server.adoc index 4092a7339aa..a32895dcade 100644 --- a/guides/common/assembly_performing-additional-configuration-on-smart-proxy-server.adoc +++ b/guides/common/assembly_performing-additional-configuration-on-smart-proxy-server.adoc @@ -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] From 81b0ffe6139932920206b2a15c90c4779faa112e Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Mon, 16 Dec 2024 23:39:20 +0100 Subject: [PATCH 3/5] fixup --- guides/doc-Administering_Network_Services/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/doc-Administering_Network_Services/master.adoc b/guides/doc-Administering_Network_Services/master.adoc index 255eb0ea882..92288ca6d7b 100644 --- a/guides/doc-Administering_Network_Services/master.adoc +++ b/guides/doc-Administering_Network_Services/master.adoc @@ -15,9 +15,9 @@ ifdef::satellite[] include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] endif::[] +:ProductName: {SmartProxy} include::common/assembly_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+1] -:ProductName: {SmartProxy} include::common/assembly_configuring-external-services.adoc[leveloffset=+1] include::common/assembly_managing-dhcp-on-smart-proxies.adoc[leveloffset=+1] From 6fe02b317a0082e9b10ba06b92c6508617ce0140 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Wed, 18 Dec 2024 21:20:35 +0100 Subject: [PATCH 4/5] Rename the new guide --- guides/common/attributes-titles.adoc | 2 +- .../Makefile | 0 .../common | 0 .../docinfo.html | 0 .../docinfo.xml | 2 +- .../images/common | 0 .../master.adoc | 2 +- 7 files changed, 3 insertions(+), 3 deletions(-) rename guides/{doc-Administering_Network_Services => doc-Configuring_DNS_DHCP_TFTP}/Makefile (100%) rename guides/{doc-Administering_Network_Services => doc-Configuring_DNS_DHCP_TFTP}/common (100%) rename guides/{doc-Administering_Network_Services => doc-Configuring_DNS_DHCP_TFTP}/docinfo.html (100%) rename guides/{doc-Administering_Network_Services => doc-Configuring_DNS_DHCP_TFTP}/docinfo.xml (92%) rename guides/{doc-Administering_Network_Services => doc-Configuring_DNS_DHCP_TFTP}/images/common (100%) rename guides/{doc-Administering_Network_Services => doc-Configuring_DNS_DHCP_TFTP}/master.adoc (95%) diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc index c1f4c57f2d2..6ad87db0cc9 100644 --- a/guides/common/attributes-titles.adoc +++ b/guides/common/attributes-titles.adoc @@ -2,9 +2,9 @@ :AdministeringDocTitle: Administering {ProjectName} :AdministeringAnsibleDocTitle: Managing {Project} with Ansible -:AdministeringNetworkDocTitle: Administering network services :APIDocTitle: Using the {Project} REST API :AppCentricDeploymentDocTitle: Deploying hosts by using application centric approach +:ConfiguringDNSDHCPTFTPDocTitle: Configuring DNS, DHCP, and TFTP integration :ConfiguringLoadBalancerDocTitle: Configuring {SmartProxies} with a load balancer :ConfiguringUserAuthenticationDocTitle: Configuring authentication for {ProjectName} users :ContentManagementDocTitle: Managing content diff --git a/guides/doc-Administering_Network_Services/Makefile b/guides/doc-Configuring_DNS_DHCP_TFTP/Makefile similarity index 100% rename from guides/doc-Administering_Network_Services/Makefile rename to guides/doc-Configuring_DNS_DHCP_TFTP/Makefile diff --git a/guides/doc-Administering_Network_Services/common b/guides/doc-Configuring_DNS_DHCP_TFTP/common similarity index 100% rename from guides/doc-Administering_Network_Services/common rename to guides/doc-Configuring_DNS_DHCP_TFTP/common diff --git a/guides/doc-Administering_Network_Services/docinfo.html b/guides/doc-Configuring_DNS_DHCP_TFTP/docinfo.html similarity index 100% rename from guides/doc-Administering_Network_Services/docinfo.html rename to guides/doc-Configuring_DNS_DHCP_TFTP/docinfo.html diff --git a/guides/doc-Administering_Network_Services/docinfo.xml b/guides/doc-Configuring_DNS_DHCP_TFTP/docinfo.xml similarity index 92% rename from guides/doc-Administering_Network_Services/docinfo.xml rename to guides/doc-Configuring_DNS_DHCP_TFTP/docinfo.xml index 7ce4ef0da2d..5a8ec93db83 100644 --- a/guides/doc-Administering_Network_Services/docinfo.xml +++ b/guides/doc-Configuring_DNS_DHCP_TFTP/docinfo.xml @@ -1,4 +1,4 @@ -{AdministeringNetworkDocTitle} +{ConfiguringDNSDHCPTFTPDocTitle} Red Hat Satellite {ProjectVersion} Administer network services, such as DNS, DHCP, and TFTP diff --git a/guides/doc-Administering_Network_Services/images/common b/guides/doc-Configuring_DNS_DHCP_TFTP/images/common similarity index 100% rename from guides/doc-Administering_Network_Services/images/common rename to guides/doc-Configuring_DNS_DHCP_TFTP/images/common diff --git a/guides/doc-Administering_Network_Services/master.adoc b/guides/doc-Configuring_DNS_DHCP_TFTP/master.adoc similarity index 95% rename from guides/doc-Administering_Network_Services/master.adoc rename to guides/doc-Configuring_DNS_DHCP_TFTP/master.adoc index 92288ca6d7b..862f606080e 100644 --- a/guides/doc-Administering_Network_Services/master.adoc +++ b/guides/doc-Configuring_DNS_DHCP_TFTP/master.adoc @@ -3,7 +3,7 @@ include::common/header.adoc[] :context: admin-network :admin-network: -= {AdministeringNetworkDocTitle} += {ConfiguringDNSDHCPTFTPDocTitle} // This guide is not ready for stable releases ifdef::HideDocumentOnStable[] From c105b202b2558729699e40f36abb49d095e356a6 Mon Sep 17 00:00:00 2001 From: Zuzana Lena Ansorgova Date: Wed, 18 Dec 2024 21:20:51 +0100 Subject: [PATCH 5/5] Add guide DocURLs --- guides/common/attributes-base.adoc | 1 + guides/common/attributes-satellite.adoc | 1 + 2 files changed, 2 insertions(+) diff --git a/guides/common/attributes-base.adoc b/guides/common/attributes-base.adoc index 05258590a98..49cd1acaf13 100644 --- a/guides/common/attributes-base.adoc +++ b/guides/common/attributes-base.adoc @@ -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}# diff --git a/guides/common/attributes-satellite.adoc b/guides/common/attributes-satellite.adoc index 58e2fcc1ada..8569d0e4d42 100644 --- a/guides/common/attributes-satellite.adoc +++ b/guides/common/attributes-satellite.adoc @@ -14,6 +14,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# :ConfiguringLoadBalancerDocURL: {BaseURL}configuring_capsules_with_a_load_balancer/index# :ConfiguringUserAuthenticationDocURL: {BaseURL}configuring_authentication_for_red_hat_satellite_users/index# :ContentManagementDocURL: {BaseURL}managing_content/index#