1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# ================================================================================
# Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
# Copyright (C) 2021 Nokia. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
import json
import os
import requests
from onap_dcae_cbs_docker_client import get_module_logger
from onap_dcae_cbs_docker_client.exceptions import ENVsMissing, CantGetConfig, CBSUnreachable
logger = get_module_logger(__name__)
#########
# HELPERS
def _recurse(config):
"""
Recurse through a configuration, or recursively a sub element of it.
If it's a dict: recurse over all the values
If it's a list: recurse over all the values
If it's a string: return the replacement
If none of the above, just return the item.
"""
if isinstance(config, list):
return [_recurse(item) for item in config]
if isinstance(config, dict):
for key in config:
config[key] = _recurse(config[key])
return config
if isinstance(config, str):
return change_envs(config)
# not a dict, not a list, not a string, nothing to do.
return config
def _get_path(path):
"""
Try to get the config, and return appropriate exceptions otherwise
"""
try:
hostname = os.environ["HOSTNAME"] # this is the name of the component itself
# in most cases, this is the K8s service name which is a resolvable DNS name
# if running outside k8s, this name needs to be resolvable by DNS via other means.
cbs_name = os.environ["CONFIG_BINDING_SERVICE"]
except KeyError as e:
raise ENVsMissing("Required ENV Variable {0} missing".format(e))
# See if we are using https
https_cacert = os.environ.get("DCAE_CA_CERTPATH", None)
# Get the CBS URL.
cbs_url = "https://{0}:10443".format(cbs_name) if https_cacert else "http://{0}:10000".format(cbs_name)
# get my config
try:
my_config_endpoint = "{0}/{1}/{2}".format(cbs_url, path, hostname)
res = requests.get(my_config_endpoint, verify=https_cacert) if https_cacert else requests.get(my_config_endpoint)
res.raise_for_status()
config = res.json()
logger.debug(
"get_config returned the following configuration: %s using the config url %s",
json.dumps(config),
my_config_endpoint,
)
return config
except requests.exceptions.HTTPError: # this is thrown by raise_for_status
logger.error(
"The config binding service endpoint %s returned a bad status. code: %d, text: %s",
my_config_endpoint,
res.status_code,
res.text,
)
raise CantGetConfig(res.status_code, res.text)
except requests.exceptions.ConnectionError as e: # this is thrown if requests.get cant even connect to the endpoint
raise CBSUnreachable(e)
def change_envs(value):
"""
Replace env reference by actual value and return it
"""
if value.startswith('$'):
try:
value = os.environ[value.replace('${', '').replace('}', '')]
except KeyError as e:
raise ENVsMissing("Required ENV Variable {0} missing".format(e))
return value
#########
# Public
def get_all():
"""
Hit the CBS service_component_all endpoint
"""
config = _get_path("service_component_all")
return _recurse(config)
def get_config():
"""
Hit the CBS service_component endpoint
TODO: should we take in a "retry" boolean, and retry on behalf of the caller?
Currently, we return an exception and let the application decide how it wants to proceed (Crash, try again, etc).
"""
config = _get_path("service_component")
return _recurse(config)
|
