Merge lp:~jtv/maas/cap-ipv6-deployment-ubuntu into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Define and document a new capability: ipv6-deployment-ubuntu.

Also, move the link to the IPv6 documentation to a more appropriate place in the documentation index. Right below ‘networks’ is wrong because that document is about networks for placement-constraint purposes, not about setting up networking.

It's tempting to call the capability just “ipv6,” but I think a capability of that name would make more sense for the point where the whole basic feature works. Instead I went with something more specific for what is now possible: deploy Ubuntu nodes with IPv6 enabled.

We may at some point support deploying over IPv6, which might create confusion with deployment of IPv6-capable nodes. A capability for exclusively IPv6-based deployment might be called something like pure-ipv6-deployment, or it might come with pure IPv6 commissioning as well, in which case it might be ipv6-provisioning.

Jeroen

[Newell Jensen (newell-jensen)]

Looks good to me. Not sure if this is going to create more work for you or someone else later when the "whole basic feature works" if it would need to be changed to not be as specific as what you have here.

[Newell Jensen (newell-jensen)]

review: Approve

[Jeroen T. Vermeulen (jtv)]

Thanks! As we get more IPv6 features working, we can just add capabilities for them. Once we feel confident in answering "yes, we support IPv6!" the time will be right for a plain "ipv6" capability.

=== modified file 'docs/capabilities.rst'
--- docs/capabilities.rst	2014-08-22 00:13:24 +0000
+++ docs/capabilities.rst	2014-09-17 02:43:26 +0000
@@ -29,3 +29,9 @@
   Passive modelling of the network environment that cluster controllers
   nodes are in, including network interfaces, subnets, VLAN tags, and
   connectivity between them. See :ref:`networks` for more information.
+
+.. _cap-ipv6-deployment-ubuntu:
+
+``ipv6-deployment-ubuntu``
+  Deploy Ubuntu nodes with IPv6 networking enabled.  See :ref:`ipv6` for more
+  about this feature.

=== modified file 'docs/index.rst'
--- docs/index.rst	2014-09-16 07:24:19 +0000
+++ docs/index.rst	2014-09-17 02:43:26 +0000
@@ -54,11 +54,11 @@
    install
    configure
    cluster-configuration
+   ipv6
    bootsources
    nodes
    hardware-enablement-kernels
    networks
-   ipv6
    kernel-options
    installing-ubuntu
 

=== modified file 'docs/ipv6.rst'
--- docs/ipv6.rst	2014-09-16 11:35:02 +0000
+++ docs/ipv6.rst	2014-09-17 02:43:26 +0000
@@ -8,7 +8,9 @@
 .. note::
 
   This feature is available in MAAS versions 1.7 and above, starting with
-  lp:maas revision 2992.
+  lp:maas revision 2992.  If you're writing a client application that makes use
+  of this feature, you can query the region-server API for the
+  ``ipv6-deployment-ubuntu`` :ref:`capability<cap-ipv6-deployment-ubuntu>`.
 
 MAAS has limited IPv6 support for networking nodes.  It works much like IPv4
 support, but with a number of limitations:

=== modified file 'src/maasserver/api/version.py'
--- src/maasserver/api/version.py	2014-08-18 13:18:46 +0000
+++ src/maasserver/api/version.py	2014-09-17 02:43:26 +0000
@@ -24,10 +24,12 @@
 # MAAS capabilities. See docs/capabilities.rst for documentation.
 CAP_NETWORKS_MANAGEMENT = 'networks-management'
 CAP_STATIC_IPADDRESSES = 'static-ipaddresses'
+CAP_IPv6_DEPLOYMENT_UBUNTU = 'ipv6-deployment-ubuntu'
 
 API_CAPABILITIES_LIST = [
     CAP_NETWORKS_MANAGEMENT,
     CAP_STATIC_IPADDRESSES,
+    CAP_IPv6_DEPLOYMENT_UBUNTU,
     ]