Move DNS, DHCP, and TFTP content to a new guide #3530
Conversation
guides/common/attributes-titles.adoc
Outdated
| @@ -2,6 +2,7 @@ | |||
|
|
|||
| :AdministeringDocTitle: Administering {ProjectName} | |||
| :AdministeringAnsibleDocTitle: Managing {Project} with Ansible | |||
| :AdministeringNetworkDocTitle: Administering network services | |||
There was a problem hiding this comment.
I think we should go for a more specific title because there are aspects of networking that are not in this new guide. I recommend either "Configuring DNS, DHCP, and TFTP" or possibly "Configuring external network services." What do you think?
There was a problem hiding this comment.
I'd say it's more like Integrating network services because I think it should also cover configuring using an external network service. Taking upstream as an example, there's Amazon Route53 integration and for sure you're not administrating that service yourself but only integrate with it. Less extreme I'd say the same thing can be true for Infoblox or PowerDNS (which another department in your org can run).
Something I haven't made up my mind about is focusing it more on provisioning. At least DHCP and TFTP are solely used when you provision. DNS can also be used when a host is renamed, but it's a bit of an edge case IMHO.
Taking a step back, you could look at making the provisioning guide aimed at users where this new guide is aimed at admins.
There was a problem hiding this comment.
This guide currently includes setting up DNS, etc, internally within the Sat environment. I am not sure that could be considered integration. Should we use this guide only for integration with external services?
There was a problem hiding this comment.
This guide currently includes setting up DNS, etc, internally within the Sat environment. I am not sure that could be considered integration. Should we use this guide only for integration with external services?
It's very limiting. You will have setting up DNS integration in one or two guides (like Installing Server and Installing Proxy) and then some variants of DNS integration in this new guide.
What I would like to see is a guide that says "here's how you set up DNS integration and these are your options", like I already laid out in #2957. And then do the same for DHCP.
I also think we should drop the chapters that set up all integrations at the same time because it gives the impression you must run them together, which is completely false.
There was a problem hiding this comment.
I also think we should drop the chapters that set up all integrations at the same time because it gives the impression you must run them together, which is completely false.
@ekohl Agree. Since that is outside the scope of this PR, I will create a task to split apart those chapters.
There was a problem hiding this comment.
@Lennonka Re: title. How about "Configuring DNS, DHCP, and TFTP integration"? I recommend keeping titles fairly specific. I think "Administering" sounds odd because we don't administer external services; we configure them. What do you think?
There was a problem hiding this comment.
I like "Configuring DNS, DHCP, and TFTP integration" because AFAIK it's about adding entries for those services to Foreman, hence "integration" works nicely, and eventually configuring those services when they are managed by Foreman.
|
@Lennonka I looked at your draft PR and thought about possible structure. Please see the new "Proposed TOC 2" frame in the Miro board and let me know what you think. Here's a screenshot for anyone who does not have access to the Miro board. |
What changes are you introducing?
Extracting DNS, DHCP, and TFTP configuration from Installing guides to a special new guide
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
The network services can be configured at any later time. They don't have to be configured during installation. The installation guides are too long.
https://issues.redhat.com/browse/SAT-27225
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: