Merge "Generate the endpoint map statically"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
5cc1491387
274
network/endpoints/build_endpoint_map.py
Executable file
274
network/endpoints/build_endpoint_map.py
Executable file
@ -0,0 +1,274 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
"""
|
||||
Generate the endpoint_map.yaml template from data in the endpoint_data.yaml
|
||||
file.
|
||||
|
||||
By default the files in the same directory as this script are operated on, but
|
||||
different files can be optionally specified on the command line.
|
||||
|
||||
The --check option verifies that the current output file is up-to-date with the
|
||||
latest data in the input file. The script exits with status code 2 if a
|
||||
mismatch is detected.
|
||||
"""
|
||||
|
||||
from __future__ import print_function
|
||||
|
||||
|
||||
__all__ = ['load_endpoint_data', 'generate_endpoint_map_template',
|
||||
'write_template', 'build_endpoint_map', 'check_up_to_date']
|
||||
|
||||
|
||||
import collections
|
||||
import copy
|
||||
import itertools
|
||||
import os
|
||||
import sys
|
||||
import yaml
|
||||
|
||||
|
||||
(IN_FILE, OUT_FILE) = ('endpoint_data.yaml', 'endpoint_map.yaml')
|
||||
|
||||
SUBST = (SUBST_IP_ADDRESS, SUBST_CLOUDNAME) = ('IP_ADDRESS', 'CLOUDNAME')
|
||||
PARAMS = (PARAM_CLOUDNAME, PARAM_ENDPOINTMAP) = ('CloudName', 'EndpointMap')
|
||||
FIELDS = (F_PORT, F_PROTOCOL, F_HOST) = ('port', 'protocol', 'host')
|
||||
|
||||
ENDPOINT_TYPES = frozenset(['Internal', 'Public', 'Admin'])
|
||||
|
||||
|
||||
def get_file(default_fn, override=None, writable=False):
|
||||
if override == '-':
|
||||
if writable:
|
||||
return sys.stdout
|
||||
else:
|
||||
return sys.stdin
|
||||
|
||||
if override is not None:
|
||||
filename = override
|
||||
else:
|
||||
filename = os.path.join(os.path.dirname(__file__), default_fn)
|
||||
|
||||
return open(filename, 'w' if writable else 'r')
|
||||
|
||||
|
||||
def load_endpoint_data(infile=None):
|
||||
with get_file(IN_FILE, infile) as f:
|
||||
return yaml.safe_load(f)
|
||||
|
||||
|
||||
def vip_param_name(endpoint_type_defn):
|
||||
return endpoint_type_defn['vip_param'] + 'VirtualIP'
|
||||
|
||||
|
||||
def vip_param_names(config):
|
||||
def ep_types(svc):
|
||||
return (v for k, v in svc.items() if k in ENDPOINT_TYPES or not k)
|
||||
|
||||
return set(vip_param_name(defn)
|
||||
for svc in config.values() for defn in ep_types(svc))
|
||||
|
||||
|
||||
def endpoint_map_default(config):
|
||||
def map_item(ep_name, ep_type, svc):
|
||||
values = collections.OrderedDict([
|
||||
(F_PROTOCOL, svc.get(F_PROTOCOL, 'http')),
|
||||
(F_PORT, str(svc[ep_type].get(F_PORT, svc[F_PORT]))),
|
||||
(F_HOST, SUBST_IP_ADDRESS),
|
||||
])
|
||||
return ep_name + ep_type, values
|
||||
|
||||
return collections.OrderedDict(map_item(ep_name, ep_type, svc)
|
||||
for ep_name, svc in sorted(config.items())
|
||||
for ep_type in sorted(set(svc) &
|
||||
ENDPOINT_TYPES))
|
||||
|
||||
|
||||
def make_parameter(ptype, default, description=None):
|
||||
param = collections.OrderedDict([('type', ptype), ('default', default)])
|
||||
if description is not None:
|
||||
param['description'] = description
|
||||
return param
|
||||
|
||||
|
||||
def template_parameters(config):
|
||||
params = collections.OrderedDict((n, make_parameter('string', ''))
|
||||
for n in sorted(vip_param_names(config)))
|
||||
|
||||
params[PARAM_ENDPOINTMAP] = make_parameter('json',
|
||||
endpoint_map_default(config),
|
||||
'Mapping of service endpoint '
|
||||
'-> protocol. Typically set '
|
||||
'via parameter_defaults in the '
|
||||
'resource registry.')
|
||||
|
||||
params[PARAM_CLOUDNAME] = make_parameter('string',
|
||||
'overcloud',
|
||||
'The DNS name of this cloud. '
|
||||
'e.g. ci-overcloud.tripleo.org')
|
||||
return params
|
||||
|
||||
|
||||
def template_output_definition(endpoint_name,
|
||||
endpoint_variant,
|
||||
endpoint_type,
|
||||
vip_param,
|
||||
uri_suffix=None,
|
||||
name_override=None):
|
||||
def extract_field(field):
|
||||
assert field in FIELDS
|
||||
return {'get_param': ['EndpointMap',
|
||||
endpoint_name + endpoint_type,
|
||||
copy.copy(field)]}
|
||||
|
||||
port = extract_field(F_PORT)
|
||||
protocol = extract_field(F_PROTOCOL)
|
||||
host = {
|
||||
'str_replace': collections.OrderedDict([
|
||||
('template', extract_field(F_HOST)),
|
||||
('params', {
|
||||
SUBST_IP_ADDRESS: {'get_param': vip_param},
|
||||
SUBST_CLOUDNAME: {'get_param': PARAM_CLOUDNAME},
|
||||
})
|
||||
])
|
||||
}
|
||||
uri_fields = [protocol, '://', copy.deepcopy(host), ':', port]
|
||||
uri_fields_suffix = (copy.deepcopy(uri_fields) +
|
||||
([uri_suffix] if uri_suffix is not None else []))
|
||||
|
||||
name = name_override if name_override is not None else (endpoint_name +
|
||||
endpoint_variant +
|
||||
endpoint_type)
|
||||
|
||||
return name, {
|
||||
'host': host,
|
||||
'port': extract_field('port'),
|
||||
'protocol': extract_field('protocol'),
|
||||
'uri': {
|
||||
'list_join': ['', uri_fields_suffix]
|
||||
},
|
||||
'uri_no_suffix': {
|
||||
'list_join': ['', uri_fields]
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def template_endpoint_items(config):
|
||||
def get_svc_endpoints(ep_name, svc):
|
||||
for ep_type in set(svc) & ENDPOINT_TYPES:
|
||||
defn = svc[ep_type]
|
||||
for variant, suffix in defn.get('uri_suffixes',
|
||||
{'': None}).items():
|
||||
name_override = defn.get('names', {}).get(variant)
|
||||
yield template_output_definition(ep_name, variant, ep_type,
|
||||
vip_param_name(defn),
|
||||
suffix,
|
||||
name_override)
|
||||
|
||||
return itertools.chain.from_iterable(sorted(get_svc_endpoints(ep_name,
|
||||
svc))
|
||||
for (ep_name,
|
||||
svc) in sorted(config.items()))
|
||||
|
||||
|
||||
def generate_endpoint_map_template(config):
|
||||
return collections.OrderedDict([
|
||||
('heat_template_version', '2015-04-30'),
|
||||
('description', 'A map of OpenStack endpoints.'),
|
||||
('parameters', template_parameters(config)),
|
||||
('outputs', {
|
||||
'endpoint_map': {
|
||||
'value':
|
||||
collections.OrderedDict(template_endpoint_items(config))
|
||||
}
|
||||
}),
|
||||
])
|
||||
|
||||
|
||||
autogen_warning = """### DO NOT MODIFY THIS FILE
|
||||
### This file is automatically generated from endpoint_data.yaml
|
||||
### by the script build_endpoint_map.py
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class TemplateDumper(yaml.SafeDumper):
|
||||
def represent_ordered_dict(self, data):
|
||||
return self.represent_dict(data.items())
|
||||
|
||||
|
||||
TemplateDumper.add_representer(collections.OrderedDict,
|
||||
TemplateDumper.represent_ordered_dict)
|
||||
|
||||
|
||||
def write_template(template, filename=None):
|
||||
with get_file(OUT_FILE, filename, writable=True) as f:
|
||||
f.write(autogen_warning)
|
||||
yaml.dump(template, f, TemplateDumper, width=68)
|
||||
|
||||
|
||||
def read_template(template, filename=None):
|
||||
with get_file(OUT_FILE, filename) as f:
|
||||
return yaml.safe_load(f)
|
||||
|
||||
|
||||
def build_endpoint_map(output_filename=None, input_filename=None):
|
||||
if output_filename is not None and output_filename == input_filename:
|
||||
raise Exception('Cannot read from and write to the same file')
|
||||
config = load_endpoint_data(input_filename)
|
||||
template = generate_endpoint_map_template(config)
|
||||
write_template(template, output_filename)
|
||||
|
||||
|
||||
def check_up_to_date(output_filename=None, input_filename=None):
|
||||
if output_filename is not None and output_filename == input_filename:
|
||||
raise Exception('Input and output filenames must be different')
|
||||
config = load_endpoint_data(input_filename)
|
||||
template = generate_endpoint_map_template(config)
|
||||
existing_template = read_template(output_filename)
|
||||
return existing_template == template
|
||||
|
||||
|
||||
def get_options():
|
||||
from optparse import OptionParser
|
||||
|
||||
parser = OptionParser('usage: %prog'
|
||||
' [-i INPUT_FILE] [-o OUTPUT_FILE] [--check]',
|
||||
description=__doc__)
|
||||
parser.add_option('-i', '--input', dest='input_file', action='store',
|
||||
default=None,
|
||||
help='Specify a different endpoint data file')
|
||||
parser.add_option('-o', '--output', dest='output_file', action='store',
|
||||
default=None,
|
||||
help='Specify a different endpoint map template file')
|
||||
parser.add_option('-c', '--check', dest='check', action='store_true',
|
||||
default=False, help='Check that the output file is '
|
||||
'up to date with the data')
|
||||
parser.add_option('-d', '--debug', dest='debug', action='store_true',
|
||||
default=False, help='Print stack traces on error')
|
||||
|
||||
return parser.parse_args()
|
||||
|
||||
|
||||
def main():
|
||||
options, args = get_options()
|
||||
if args:
|
||||
print('Warning: ignoring positional args: %s' % ' '.join(args),
|
||||
file=sys.stderr)
|
||||
|
||||
try:
|
||||
if options.check:
|
||||
if not check_up_to_date(options.output_file, options.input_file):
|
||||
print('EndpointMap template does not match input data',
|
||||
file=sys.stderr)
|
||||
sys.exit(2)
|
||||
else:
|
||||
build_endpoint_map(options.output_file, options.input_file)
|
||||
except Exception as exc:
|
||||
if options.debug:
|
||||
raise
|
||||
print('%s: %s' % (type(exc).__name__, str(exc)), file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -1,60 +0,0 @@
|
||||
heat_template_version: 2015-04-30
|
||||
|
||||
description: >
|
||||
OpenStack Endpoint
|
||||
|
||||
parameters:
|
||||
EndpointName:
|
||||
type: string
|
||||
description: The name of the Endpoint being evaluated
|
||||
EndpointMap:
|
||||
type: json
|
||||
default: {}
|
||||
description: Mapping of service endpoint -> protocol. Typically set
|
||||
via parameter_defaults in the resource registry.
|
||||
IP:
|
||||
type: string
|
||||
description: The IP address of the Neutron Port that the endpoint is attached to
|
||||
UriSuffix:
|
||||
type: string
|
||||
default: ''
|
||||
description: A suffix attached to the URL
|
||||
CloudName:
|
||||
type: string
|
||||
default: ''
|
||||
description: The DNS name of this cloud. E.g. ci-overcloud.tripleo.org
|
||||
|
||||
outputs:
|
||||
endpoint:
|
||||
description: >
|
||||
A Hash containing a mapping of service endpoints to ports, protocols, uris
|
||||
assigned IPs, and hostnames for a specific endpoint
|
||||
value:
|
||||
port: {get_param: [EndpointMap, {get_param: EndpointName }, port] }
|
||||
protocol: {get_param: [EndpointMap, {get_param: EndpointName }, protocol] }
|
||||
ip: {get_param: IP}
|
||||
host:
|
||||
str_replace:
|
||||
template: {get_param: [EndpointMap, {get_param: EndpointName }, host]}
|
||||
params: {IP_ADDRESS: {get_param: IP}, CLOUDNAME: {get_param: CloudName}}
|
||||
uri:
|
||||
list_join:
|
||||
- ''
|
||||
- - {get_param: [EndpointMap, {get_param: EndpointName }, protocol] }
|
||||
- '://'
|
||||
- str_replace:
|
||||
template: {get_param: [EndpointMap, {get_param: EndpointName }, host]}
|
||||
params: {IP_ADDRESS: {get_param: IP}, CLOUDNAME: {get_param: CloudName }}
|
||||
- ':'
|
||||
- {get_param: [EndpointMap, {get_param: EndpointName }, port] }
|
||||
- {get_param: UriSuffix }
|
||||
uri_no_suffix:
|
||||
list_join:
|
||||
- ''
|
||||
- - {get_param: [EndpointMap, {get_param: EndpointName }, protocol] }
|
||||
- '://'
|
||||
- str_replace:
|
||||
template: {get_param: [EndpointMap, {get_param: EndpointName }, host]}
|
||||
params: {IP_ADDRESS: {get_param: IP}, CLOUDNAME: {get_param: CloudName} }
|
||||
- ':'
|
||||
- {get_param: [EndpointMap, {get_param: EndpointName }, port] }
|
||||
185
network/endpoints/endpoint_data.yaml
Normal file
185
network/endpoints/endpoint_data.yaml
Normal file
@ -0,0 +1,185 @@
|
||||
# Data in this file is used to generate the endpoint_map.yaml template.
|
||||
# Run the script build_endpoint_map.py to regenerate the file.
|
||||
|
||||
Ceilometer:
|
||||
Internal:
|
||||
vip_param: CeilometerApi
|
||||
Public:
|
||||
vip_param: Public
|
||||
Admin:
|
||||
vip_param: CeilometerApi
|
||||
port: 8777
|
||||
|
||||
Cinder:
|
||||
Internal:
|
||||
vip_param: CinderApi
|
||||
uri_suffixes:
|
||||
'': /v1/%(tenant_id)s
|
||||
V2: /v2/%(tenant_id)s
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /v1/%(tenant_id)s
|
||||
V2: /v2/%(tenant_id)s
|
||||
Admin:
|
||||
vip_param: CinderApi
|
||||
uri_suffixes:
|
||||
'': /v1/%(tenant_id)s
|
||||
V2: /v2/%(tenant_id)s
|
||||
port: 8776
|
||||
|
||||
Glance:
|
||||
Internal:
|
||||
vip_param: GlanceApi
|
||||
Public:
|
||||
vip_param: Public
|
||||
Admin:
|
||||
vip_param: GlanceApi
|
||||
port: 9292
|
||||
|
||||
GlanceRegistry:
|
||||
Internal:
|
||||
vip_param: GlanceRegistry
|
||||
Public:
|
||||
vip_param: Public
|
||||
Admin:
|
||||
vip_param: GlanceRegistry
|
||||
port: 9191
|
||||
|
||||
Mysql:
|
||||
'':
|
||||
vip_param: Mysql
|
||||
|
||||
Heat:
|
||||
Internal:
|
||||
vip_param: HeatApi
|
||||
uri_suffixes:
|
||||
'': /v1/%(tenant_id)s
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /v1/%(tenant_id)s
|
||||
Admin:
|
||||
vip_param: HeatApi
|
||||
uri_suffixes:
|
||||
'': /v1/%(tenant_id)s
|
||||
port: 8004
|
||||
|
||||
Horizon:
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /dashboard
|
||||
port: 80
|
||||
|
||||
Keystone:
|
||||
Internal:
|
||||
vip_param: KeystonePublicApi
|
||||
uri_suffixes:
|
||||
'': /v2.0
|
||||
EC2: /v2.0/ec2tokens
|
||||
names:
|
||||
EC2: KeystoneEC2
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /v2.0
|
||||
Admin:
|
||||
vip_param: KeystoneAdminApi
|
||||
uri_suffixes:
|
||||
'': /v2.0
|
||||
port: 35357
|
||||
port: 5000
|
||||
|
||||
# TODO(ayoung): V3 is a temporary fix. Endpoints should be versionless.
|
||||
# Required for https://bugs.launchpad.net/puppet-nova/+bug/1542486
|
||||
KeystoneV3:
|
||||
Internal:
|
||||
vip_param: KeystonePublicApi
|
||||
uri_suffixes:
|
||||
'': /v3
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /v3
|
||||
Admin:
|
||||
vip_param: KeystoneAdminApi
|
||||
uri_suffixes:
|
||||
'': /v3
|
||||
port: 35357
|
||||
port: 5000
|
||||
|
||||
Neutron:
|
||||
Internal:
|
||||
vip_param: NeutronApi
|
||||
Public:
|
||||
vip_param: Public
|
||||
Admin:
|
||||
vip_param: NeutronApi
|
||||
port: 9696
|
||||
|
||||
Nova:
|
||||
Internal:
|
||||
vip_param: NovaApi
|
||||
uri_suffixes:
|
||||
'': /v2/%(tenant_id)s
|
||||
V3: /v3
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /v2/%(tenant_id)s
|
||||
V3: /v3
|
||||
Admin:
|
||||
vip_param: NovaApi
|
||||
uri_suffixes:
|
||||
'': /v2/%(tenant_id)s
|
||||
V3: /v3
|
||||
port: 8774
|
||||
|
||||
NovaEC2:
|
||||
Internal:
|
||||
vip_param: NovaApi
|
||||
uri_suffixes:
|
||||
'': /services/Cloud
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /services/Cloud
|
||||
Admin:
|
||||
vip_param: NovaApi
|
||||
uri_suffixes:
|
||||
'': /services/Admin
|
||||
port: 8773
|
||||
|
||||
Swift:
|
||||
Internal:
|
||||
vip_param: SwiftProxy
|
||||
uri_suffixes:
|
||||
'': /v1/AUTH_%(tenant_id)s
|
||||
S3:
|
||||
Public:
|
||||
vip_param: Public
|
||||
uri_suffixes:
|
||||
'': /v1/AUTH_%(tenant_id)s
|
||||
S3:
|
||||
Admin:
|
||||
vip_param: SwiftProxy
|
||||
uri_suffixes:
|
||||
'':
|
||||
S3:
|
||||
port: 8080
|
||||
|
||||
Sahara:
|
||||
Internal:
|
||||
vip_param: SaharaApi
|
||||
uri_suffixes:
|
||||
'': /v1.1/%(tenant_id)s
|
||||
Public:
|
||||
vip_param: SaharaApi
|
||||
uri_suffixes:
|
||||
'': /v1.1/%(tenant_id)s
|
||||
Admin:
|
||||
vip_param: SaharaApi
|
||||
uri_suffixes:
|
||||
'': /v1.1/%(tenant_id)s
|
||||
port: 8386
|
||||
File diff suppressed because it is too large
Load Diff
@ -116,7 +116,6 @@ resource_registry:
|
||||
OS::TripleO::BlockStorage::Ports::ManagementPort: network/ports/noop.yaml
|
||||
|
||||
# Service Endpoint Mappings
|
||||
OS::TripleO::Endpoint: network/endpoints/endpoint.yaml
|
||||
OS::TripleO::EndpointMap: network/endpoints/endpoint_map.yaml
|
||||
|
||||
# validation resources
|
||||
|
||||
Loading…
Reference in New Issue
Block a user