[Openstack-docs] Basic OS configuration chapter in installation guide
Tom Fifield
tom at openstack.org
Mon Mar 24 01:53:57 UTC 2014
This is true - we did indeed have one guide with a lack of information.
However, we did also have one guide with entirely too much information,
which was full of random notes and branching points ... it attempted to
cover All The Things.
I do share your view that we need to explain things well, and don't want
to see removal of explanations become a general sentiment :)
However, for this very specific case, I believe that there is good
existing documentation out there for configuring network interfaces. I
believe we should be linking to it, rather than maintaining a duplicate
that we have to maintain :) This way, those who need extra depth at this
point in their reading can easily move to their distro doco which will
have much fuller explanations than it would be reasonable for us to
provide, read up and come back :)
Regards,
Tom
On 24/03/14 09:33, Nick Chase wrote:
> I disagree with the overall sentiment, but I agree that we shouldn't
> clutter up the guide with os-specific instructions. The fact is that
> you might have someone who understands networking but comes from the
> Windows world, or whose expertise lies in a different area of OpenStack
> - related technologies. I think it's disingenuous at best to say "if
> you can't set up networking you have no business being here." We might
> as well say "Not an expert in all things OpenStack? Go get a distro,
> this isn't for you."
>
> The whole point of revisiting the install and admin guides was to FIX
> THIS PROBLEM, in which the guides don't provide enough information for
> someone who hasn't done this before.
>
> Now, again, not saying we should clutter up the guide with
> conditionals. I'm in favor of taking the specifics and devoting them to
> an appendix if necessary.
>
> ---- Nick
>
> On Mar 23, 2014 9:10 PM, "Tom Fifield" <tom at openstack.org
> <mailto:tom at openstack.org>> wrote:
>
> On 24/03/14 02:55, Andreas Jaeger wrote:
>
> On 03/22/2014 11:45 PM, Matt Kassawara wrote:
>
> While updating the networking section of the basic OS
> configuration
> chapter in the installation guide, I found my step-by-step
> instructions
> quickly making the source file rather large and complex with
> plenty of
> "os" conditionals. Do we really need to provide step-by-step
> instructions for basic OS configuration including network
> interfaces,
> name resolution, etc? I would much rather include more
> generic steps and
> let users reference their distribution's documentation for
> specific
> instructions.
>
> For example:
>
> Use this...
>
> Compute node
>
> 1) Configure the network interfaces:
> a) Management (eth0)
>
> IP address: 10.0.0.31
> Netmask: 255.255.255.0
> Gateway: 10.0.0.1
>
> b) External (eth1) ...
>
>
> I agree, let's be more generic. We still might need to add one
> or two
> sentences per distro overall - like saying do not use
> NetworkManager on
> Fedora - but that's overall and not specific to each single step.
>
>
> Andreas
>
>
> +1 - I agree, that without the understanding to do these basic
> networking steps, your ability to perform the rest of the install
> guide is limited. Though, if anything there is "complex", some hints
> might be worthy. For example, maybe not everyone is used to dealing
> with multiple interfaces.
>
>
> _________________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.__openstack.org
> <mailto:Openstack-docs at lists.openstack.org>
> http://lists.openstack.org/__cgi-bin/mailman/listinfo/__openstack-docs
> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>
>
More information about the Openstack-docs
mailing list