oslo.config/doc/source
Dharini Chandrasekar babff882c0 Fixing HostName and adding support for HostAddress
When config options in different projects use IPOpt as the opt's
type, it restricts operators to only IP addresses.
When the opt is set to HostnameOpt type, currently even an
incomplete or invalid IP passes as a valid hostname. Also, currently
HostnameOpt does not make sure that there is a presense of at least one
non-numeric character in the provided host name.

According to RFC 1123, (https://tools.ietf.org/html/rfc1123),
a valid host name can never have the dotted-decimal form #.#.#.#,
since at least the highest-level component label will be alphabetic.

This patch fixes the existing Hostname Opt to abide by the stated RFC
and also adds a new opt type that would enable operators to provide
either a hostname or an IP and at the same time perform checks on
both IPOpt type and HostnameOpt type, by setting opt type to
"HostAddressOpt" type. This would ensure that an invalid IP does
not pass as a valid hostname and at the same time retains the rules
required to be followed for the validation of an acceptable hostname.

Change-Id: I77bdb64b7e6e56ce761d76696bc4448a9bd325eb
Closes-Bug: #1619044
Closes-Bug: #1615028
2016-12-07 03:27:45 +00:00
..
builtins.rst add built-in options to auto-generated documentation 2016-01-15 20:45:11 +00:00
cfg.rst Move files out of the namespace package 2014-12-12 16:13:29 -05:00
cfgfilter.rst Move files out of the namespace package 2014-12-12 16:13:29 -05:00
conf.py decode subprocess output so doc build works on python3 2016-06-25 17:16:21 -04:00
config-generator.conf Add sphinx extension to build sample config 2015-08-11 10:18:40 -04:00
configopts.rst Move files out of the namespace package 2014-12-12 16:13:29 -05:00
contributing.rst Update contributing instructions 2014-09-04 15:30:07 -04:00
exceptions.rst Add missing exceptions to the documentation 2016-08-28 16:42:48 -07:00
faq.rst Add FAQ entry for why we do not treat config options as API 2015-06-30 22:39:35 +00:00
fixture.rst Move files out of the namespace package 2014-12-12 16:13:29 -05:00
generator.rst improve documentation about registering entry points for config generator 2016-03-11 15:40:10 -05:00
helpers.rst Move files out of the namespace package 2014-12-12 16:13:29 -05:00
history.rst Include changelog/history in docs 2015-09-24 15:13:45 -07:00
index.rst Enabling your project for mutable-config 2016-07-07 11:37:30 +01:00
mutable.rst Enabling your project for mutable-config 2016-07-07 11:37:30 +01:00
namespaces.rst Add some guidance for group names 2014-10-09 16:14:04 -04:00
opts.rst Fixing HostName and adding support for HostAddress 2016-12-07 03:27:45 +00:00
parser.rst Move files out of the namespace package 2014-12-12 16:13:29 -05:00
sphinxconfiggen.rst update docs for sphinxconfiggen 2016-07-13 16:16:28 -04:00
sphinxext.rst have show-options load the generator config file 2016-02-08 13:00:57 -05:00
styleguide.rst update doc to use new type PortOpt 2015-10-22 01:44:34 -06:00
types.rst Move files out of the namespace package 2014-12-12 16:13:29 -05:00