Merge lp:~dannf/maas/network-docs into lp:~maas-committers/maas/trunk

[Mike Pontillo]

docs: networking: Describe "Interface IP Address Types" and "Reserved Ranges"

[Andres Rodriguez (andreserl)]

lgtm! Just one comment inline. Also, pelase backport to lp:maas/2.0

review: Approve

[Andres Rodriguez (andreserl)]

btw, Please fix the comment before landing.

[dann frazier (dannf)]

fixed, resubmitting.

review: Needs Resubmitting

[Andres Rodriguez (andreserl)]

review: Approve

[Andres Rodriguez (andreserl)]

@dan, could you please put up a branch against lp:maas/2.0 too ?

[Sean Feole (sfeole)]

+1 Dann, looks good here, A new user really needs to read this slowly and thoroughly to make sense of it. Thanks

[dann frazier (dannf)]

On Fri, Jul 8, 2016 at 8:55 AM, Andres Rodriguez
<email address hidden> wrote:
> @dan, could you please put up a branch against lp:maas/2.0 too ?

Happy to. Would you rather i wait till the doc changes are merged into
trunk, so that the backported revs are recorded in bzr, or just do
cherrypicks from my branch?

[Gavin Panella (allenap)]

Dann, yes, please backport from trunk.

[Gavin Panella (allenap)]

Dann, I suspect your Resumbit vote is causing the lander to skip this merge proposal. If you change your vote to Abstain I think it'll pick it up.

[Mike Pontillo (mpontillo)]

Re-approving.

review: Approve

[Mike Pontillo (mpontillo)]

It wasn't landing because there was no commit message. (d'oh.)

=== modified file 'docs/networking.rst'
--- docs/networking.rst	2016-01-25 14:10:29 +0000
+++ docs/networking.rst	2016-07-13 16:03:08 +0000
@@ -58,6 +58,27 @@
 Subnets are considered managed if a cluster interface specifies the cluster
 network range.
 
+**IP Ranges**
+
+MAAS assumes it can allocate all unreserved IPs in a subnet. For example,
+MAAS will assign IPs out of the unreserved pool to node interfaces configured
+"IP Address" type "Auto assign". You can reserve IPs for other purposes by
+adding one or more "reserved ranges" in your subnet configuration.
+
+There are two kinds of reserved ranges: "Reserved Range" and "Reserved Dynamic
+Range". Use a "Reserved Range" to block out a set of static IPs that you plan
+to use for other devices on your network (e.g. managed switches or routers).
+
+Use a "Reserved Dynamic Range" to block out a set of IP addresses that you
+plan to hand out using a DHCP server. If you enable DHCP on your subnet's
+VLAN, MAAS will provide a DHCP for IPs in this range, otherwise you are
+responsible for proving an external DHCP server for this range.
+
+Note that a "Reserved Dynamic Range" with active DHCP is *required* if you
+have nodes that require DHCP to network boot (e.g. PXE clients), or if you
+have configured any node interfaces as "IP Address" type "DHCP".
+
+
 VLANs
 ^^^^^
 
@@ -221,3 +242,29 @@
     $ maas admin node-interface delete node-d83ce230-4b50-11e5-a267-00163eb185eb 41
     Success.
 
+Machine Interface Configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Auto Assign**
+
+Interfaces configured as "Auto assign" will be deployed with a static
+(non-DHCP) network configuration. MAAS will choose an IP from the subnet
+that does not fall into a defined reserved range.
+
+**Static**
+
+When you configure an interfaces as "Static", you will provide an IP address
+for that interface to use when deployed.
+
+**DHCP**
+
+Interfaces configured as "DHCP" will be configured to use DHCP to request
+configuration information at boot. In order for the interface to successfully
+configure, you will need to insure that a "Dynamic Range" has been reserved
+on the associated subnet, and that either you have configured MAAS to provide
+DHCP services on the associated VLAN, or that you have provided an external
+DHCP server to do so.
+
+**(Unconfigured)**
+
+These interfaces will be left unconfigured.