Merge "Doc: Update and add IP address"

Author: Jenkins

doc/source/command-objects/ip-fixed.rst

@@ -0,0 +1,45 @@
+========
+ip fixed
+========
+
+Compute v2
+
+ip fixed add
+------------
+
+Add fixed IP address to server
+
+.. program:: ip fixed add
+.. code:: bash
+
+    os ip fixed add
+        <network>
+        <server>
+
+.. describe:: <network>
+
+    Network to fetch an IP address from (name or ID)
+
+.. describe:: <server>
+
+    Server to receive the IP address (name or ID)
+
+ip fixed remove
+---------------
+
+Remove fixed IP address from server
+
+.. program:: ip fixed remove
+.. code:: bash
+
+    os ip fixed remove
+        <ip-address>
+        <server>
+
+.. describe:: <ip-address>
+
+    IP address to remove from server (name only)
+
+.. describe:: <server>
+
+    Server to remove the IP address from (name or ID)

doc/source/command-objects/ip-floating-pool.rst

@@ -0,0 +1,15 @@
+================
+ip floating pool
+================
+
+Compute v2
+
+ip floating pool list
+---------------------
+
+List pools of floating IP addresses
+
+.. program:: ip floating pool list
+.. code:: bash
+
+    os ip floating pool list

doc/source/command-objects/floatingip.rst …c/source/command-objects/ip-floating.rstdoc/source/command-objects/floatingip.rst renamed to doc/source/command-objects/ip-floating.rst doc/source/command-objects/floatingip.rst renamed to doc/source/command-objects/ip-floating.rst

@@ -1,24 +1,24 @@
-==========
-floatingip
-==========
+===========
+ip floating
+===========
 
 Compute v2
 
 ip floating add
 ---------------
 
-Add floating-ip to server
+Add floating IP address to server
 
 .. program:: ip floating add
 .. code:: bash
 
     os ip floating add
-        <ip_address>
+        <ip-address>
         <server>
 
-.. describe:: <ip_address>
+.. describe:: <ip-address>
 
-    IP address to add to server
+    IP address to add to server (name only)
 
 .. describe:: <server>
 
@@ -27,7 +27,7 @@ Add floating-ip to server
 ip floating create
 ------------------
 
-Create new floating-ip
+Create new floating IP address
 
 .. program:: ip floating create
 .. code:: bash
@@ -37,27 +37,27 @@ Create new floating-ip
 
 .. describe:: <pool>
 
-    Pool to fetch floating IP from
+    Pool to fetch IP address from (name or ID)
 
 ip floating delete
 ------------------
 
-Delete a floating-ip
+Delete a floating IP address
 
 .. program:: ip floating delete
 .. code:: bash
 
     os ip floating delete
-        <ip_address>
+        <ip-address>
 
-.. describe:: <ip_address>
+.. describe:: <ip-address>
 
-    IP address to delete
+    IP address to delete (ID only)
 
 ip floating list
 ----------------
 
-List floating-ips
+List floating IP addresses
 
 .. program:: ip floating list
 .. code:: bash
@@ -67,18 +67,18 @@ List floating-ips
 ip floating remove
 ------------------
 
-Remove floating-ip from server
+Remove floating IP address from server
 
 .. program:: ip floating remove
 .. code:: bash
 
     os ip floating remove
-        <ip_address>
+        <ip-address>
         <server>
 
-.. describe:: <ip_address>
+.. describe:: <ip-address>
 
-    IP address to remove from server
+    IP address to remove from server (name only)
 
 .. describe:: <server>
 

doc/source/commands.rst

@@ -91,13 +91,14 @@ referring to both Compute and Volume quotas.
 * ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes
 * ``identity provider``: (**Identity**) a source of users and authentication
 * ``image``: (**Image**) a disk image
-* ``ip fixed``: Compute, Network - an internal IP address assigned to a server
-* ``ip floating``: Compute, Network - a public IP address that can be mapped to a server
+* ``ip fixed``: (**Compute**, **Network**) - an internal IP address assigned to a server
+* ``ip floating``: (**Compute**, **Network**) - a public IP address that can be mapped to a server
+* ``ip floating pool``: (**Compute**, **Network**) - a pool of public IP addresses
 * ``keypair``: (**Compute**) an SSH public key
 * ``limits``: (**Compute**, **Volume**) resource usage limits
 * ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts
 * ``module``: internal - installed Python modules in the OSC process
-* ``network``: Network - a virtual network for connecting servers and other resources
+* ``network``: (**Network**) - a virtual network for connecting servers and other resources
 * ``object``: (**Object Store**) a single file in the Object Store
 * ``policy``: (**Identity**) determines authorization
 * ``project``: (**Identity**) owns a group of resources
@@ -106,8 +107,8 @@ referring to both Compute and Volume quotas.
 * ``request token``: (**Identity**) temporary OAuth-based token
 * ``role``: (**Identity**) a policy object used to determine authorization
 * ``role assignment``: (**Identity**) a relationship between roles, users or groups, and domains or projects
-* ``security group``: Compute, Network - groups of network access rules
-* ``security group rule``: Compute, Network - the individual rules that define protocol/IP/port access
+* ``security group``: (**Compute**, **Network**) - groups of network access rules
+* ``security group rule``: (**Compute**, **Network**) - the individual rules that define protocol/IP/port access
 * ``server``: (**Compute**) virtual machine instance
 * ``server image``: (**Compute**) saved server disk image
 * ``service``: (**Identity**) a cloud service

openstackclient/compute/v2/fixedip.py

@@ -23,7 +23,7 @@
 
 
 class AddFixedIP(command.Command):
-    """Add fixed-ip command"""
+    """Add fixed IP address to server"""
 
     log = logging.getLogger(__name__ + ".AddFixedIP")
 
@@ -32,12 +32,12 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "network",
             metavar="<network>",
-            help="Name of the network to fetch an IP address from",
+            help="Network to fetch an IP address from (name or ID)",
         )
         parser.add_argument(
             "server",
             metavar="<server>",
-            help="Name of the server to receive the IP address",
+            help="Server to receive the IP address (name or ID)",
         )
         return parser
 
@@ -56,7 +56,7 @@ def take_action(self, parsed_args):
 
 
 class RemoveFixedIP(command.Command):
-    """Remove fixed-ip command"""
+    """Remove fixed IP address from server"""
 
     log = logging.getLogger(__name__ + ".RemoveFixedIP")
 
@@ -65,12 +65,12 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to remove from server",
+            help="IP address to remove from server (name only)",
         )
         parser.add_argument(
             "server",
             metavar="<server>",
-            help="Name of the server to remove the IP address from",
+            help="Server to remove the IP address from (name or ID)",
         )
         return parser
 

openstackclient/compute/v2/floatingip.py

@@ -26,7 +26,7 @@
 
 
 class AddFloatingIP(command.Command):
-    """Add floating-ip to server"""
+    """Add floating IP address to server"""
 
     log = logging.getLogger(__name__ + ".AddFloatingIP")
 
@@ -35,7 +35,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to add to server",
+            help="IP address to add to server (name only)",
         )
         parser.add_argument(
             "server",
@@ -56,7 +56,7 @@ def take_action(self, parsed_args):
 
 
 class CreateFloatingIP(show.ShowOne):
-    """Create new floating-ip"""
+    """Create new floating IP address"""
 
     log = logging.getLogger(__name__ + '.CreateFloatingIP')
 
@@ -65,7 +65,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'pool',
             metavar='<pool>',
-            help='Pool to fetch floating IP from',
+            help='Pool to fetch IP address from (name or ID)',
         )
         return parser
 
@@ -80,7 +80,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteFloatingIP(command.Command):
-    """Delete a floating-ip"""
+    """Delete a floating IP address"""
 
     log = logging.getLogger(__name__ + '.DeleteFloatingIP')
 
@@ -89,7 +89,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to delete",
+            help="IP address to delete (ID only)",
         )
         return parser
 
@@ -107,7 +107,7 @@ def take_action(self, parsed_args):
 
 
 class ListFloatingIP(lister.Lister):
-    """List floating-ips"""
+    """List floating IP addresses"""
 
     log = logging.getLogger(__name__ + '.ListFloatingIP')
 
@@ -127,7 +127,7 @@ def take_action(self, parsed_args):
 
 
 class RemoveFloatingIP(command.Command):
-    """Remove floating-ip from server"""
+    """Remove floating IP address from server"""
 
     log = logging.getLogger(__name__ + ".RemoveFloatingIP")
 
@@ -136,7 +136,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to remove from server",
+            help="IP address to remove from server (name only)",
         )
         parser.add_argument(
             "server",

openstackclient/compute/v2/floatingippool.py

@@ -23,7 +23,7 @@
 
 
 class ListFloatingIPPool(lister.Lister):
-    """List floating-ip-pools"""
+    """List pools of floating IP addresses"""
 
     log = logging.getLogger(__name__ + '.ListFloatingIPPool')