summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2015-06-26 10:58:37 -0400
committerMonty Taylor <mordred@inaugust.com>2015-06-26 17:10:41 -0400
commit65dd84515be415fe9f0c5751ecb8b6c51e3fabcb (patch)
tree81428dc86fd2283796078595dae0aca6d05fc9da /README.rst
parentb631da86fee360533111eb9993e215d6cb64f522 (diff)
downloados-client-config-65dd84515be415fe9f0c5751ecb8b6c51e3fabcb.tar.gz
Add support for indicating preference for IPv6
People, such as Infra, would like to use IPv6 when it's there, but don't want to need to write the "if ipv6, awesome, else, ipv4" code all the time. Change-Id: I870955863f1e8851c684dc604584c1ef3e20dd6b
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 9cdda45..b265341 100644
--- a/README.rst
+++ b/README.rst
@@ -185,6 +185,37 @@ are connecting to OpenStack can share a cache should you desire.
dns_service_type: hpext:dns
+IPv6
+----
+
+IPv6 may be a thing you would prefer to use not only if the cloud supports it,
+but also if your local machine support it. A simple boolean flag is settable
+either in an environment variable, `OS_PREFER_IPV6`, or in the client section
+of the clouds.yaml.
+
+::
+ client:
+ prefer_ipv6: true
+ clouds:
+ mordred:
+ profile: hp
+ auth:
+ username: mordred@inaugust.com
+ password: XXXXXXXXX
+ project_name: mordred@inaugust.com
+ region_name: region-b.geo-1
+ monty:
+ profile: rax
+ auth:
+ username: mordred@inaugust.com
+ password: XXXXXXXXX
+ project_name: mordred@inaugust.com
+ region_name: DFW
+
+The above snippet will tell client programs to prefer returning an IPv6
+address. This will result in calls to, for instance, `shade`'s `get_public_ip`
+to return an IPv4 address on HP, and an IPv6 address on Rackspace.
+
Usage
-----