Main a1 controller
"""
# ==================================================================================
-# Copyright (c) 2019 Nokia
-# Copyright (c) 2018-2019 AT&T Intellectual Property.
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
from jsonschema.exceptions import ValidationError
import connexion
from mdclogpy import Logger
+from ricsdl.exceptions import RejectedByBackend, NotConnected, BackendError
from a1 import a1rmr, exceptions, data
return "", 400
except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound):
return "", 404
- except BaseException as exc:
+ except (RejectedByBackend, NotConnected, BackendError):
+ """
+ These are SDL errors. At the time of development here, we do not have a good understanding which of these errors are "try again later it may work"
+ and which are "never going to work". There is some discussion that RejectedByBackend is in the latter category, suggesting it should map to 400,
+ but until we understand the root cause of these errors, it's confusing to clients to give them a 400 (a "your fault" code) because they won't know how to fix
+ For now, we log, and 503, and investigate the logs later to improve the handling/reporting.
+ """
+ # mdc_logger.exception(exc) # waiting for https://jira.o-ran-sc.org/browse/RIC-39
+ return "", 503
+ except BaseException:
# catch all, should never happen...
- mdc_logger.exception(exc)
+ # mdc_logger.exception(exc) # waiting for https://jira.o-ran-sc.org/browse/RIC-39
return Response(status=500)
We use dict data structures (KV) with the expectation of having to move this into Redis
"""
# ==================================================================================
-# Copyright (c) 2019 Nokia
-# Copyright (c) 2018-2019 AT&T Intellectual Property.
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
from threading import Thread
import msgpack
from mdclogpy import Logger
+
+from ricsdl.syncstorage import SyncStorage
+
from a1.exceptions import PolicyTypeNotFound, PolicyInstanceNotFound, PolicyTypeAlreadyExists, CantDeleteNonEmptyType
mdc_logger = Logger(name=__name__)
INSTANCE_DELETE_NO_RESP_TTL = int(os.environ.get("INSTANCE_DELETE_NO_RESP_TTL", 5))
INSTANCE_DELETE_RESP_TTL = int(os.environ.get("INSTANCE_DELETE_RESP_TTL", 5))
+A1NS = "A1m_ns"
+
class SDLWrapper:
"""
"""
def __init__(self):
- self.POLICY_DATA = {}
+ self.sdl = SyncStorage()
def set(self, key, value):
"""set a key"""
- self.POLICY_DATA[key] = msgpack.packb(value, use_bin_type=True)
+ self.sdl.set(A1NS, {key: msgpack.packb(value, use_bin_type=True)})
def get(self, key):
"""get a key"""
- if key in self.POLICY_DATA:
- return msgpack.unpackb(self.POLICY_DATA[key], raw=False)
+ ret_dict = self.sdl.get(A1NS, {key})
+ if key in ret_dict:
+ return msgpack.unpackb(ret_dict[key], raw=False)
+
return None
def find_and_get(self, prefix):
"""get all k v pairs that start with prefix"""
- return {k: msgpack.unpackb(v, raw=False) for k, v in self.POLICY_DATA.items() if k.startswith(prefix)}
+ ret_dict = self.sdl.find_and_get(A1NS, "{0}".format(prefix), atomic=True)
+ found = {k: msgpack.unpackb(v, raw=False) for k, v in ret_dict.items()}
+ # TODO: upgrade to sdl 2.0.0 which does the sorting for us
+ return {k: found[k] for k in sorted(found)}
def delete(self, key):
""" delete a key"""
- del self.POLICY_DATA[key]
+ self.sdl.remove(A1NS, {key})
SDL = SDLWrapper()
# ==================================================================================
-# Copyright (c) 2019 Nokia
-# Copyright (c) 2018-2019 AT&T Intellectual Property.
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# ==================================================================================
openapi: 3.0.0
info:
- version: 2.0.0
+ version: 2.1.0
title: RIC A1
paths:
'/a1-p/healthcheck':
items:
"$ref": "#/components/schemas/policy_type_id"
example: [20000, 20020]
+ 503:
+ description: "Potentially transient backend database error. Client should attempt to retry later."
'/a1-p/policytypes/{policy_type_id}':
parameters:
'404':
description: >
policy type not found
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
delete:
description: >
Delete this policy type. Can only be performed if there are no instances of this type
'404':
description: >
policy type not found
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
put:
description: >
Create a new policy type .
description: "policy type successfully created"
'400':
description: "illegal ID, or object already existed"
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
'/a1-p/policytypes/{policy_type_id}/policies':
parameters:
items:
"$ref": "#/components/schemas/policy_instance_id"
example: ["3d2157af-6a8f-4a7c-810f-38c2f824bf12", "06911bfc-c127-444a-8eb1-1bffad27cc3d"]
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
'/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}':
'404':
description: >
there is no policy instance with this policy_instance_id or there is no policy type with this policy_type_id
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
delete:
description: >
policy instance deletion initiated
'404':
description: >
- there is no policy instance with this policy_instance_id
- or there is no policy type with this policy_type_id
+ there is no policy instance with this policy_instance_id or there is no policy type with this policy_type_id
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
put:
description: >
'404':
description: >
There is no policy type with this policy_type_id
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
'/a1-p/policytypes/{policy_type_id}/policies/{policy_instance_id}/status':
parameters:
'404':
description: >
there is no policy instance with this policy_instance_id or there is no policy type with this policy_type_id
+ '503':
+ description: "Potentially transient backend database error. Client should attempt to retry later."
components:
schemas:
# The Jenkins job uses this string for the tag in the image name
# for example nexus3.o-ran-sc.org:10004/my-image-name:my-tag
---
-tag: 2.0.0
+tag: 2.1.0
:depth: 3
:local:
-[x.x.x] - TBD
--------------
+[2.1.0] - 1/8/2020
+------------------
::
- * Represents a resillent version of x.x.x that uses Redis for persistence
+ * Represents a resillent version of 2.0.0 that uses Redis for persistence
+ * Now relies on SDL and dbaas; SDL is the python interface library to dbaas
+ * Adds a 503 http code to nearly all http methods, as A1 now depends on an upstream system
+ * Integration tests have a copy of a dbaas helm chart, however the goal is to simplify that deployment per https://jira.o-ran-sc.org/browse/RIC-45
+ * Unit tests have a mockup of SDL, however again the goal is to simplify as SDL grows per https://jira.o-ran-sc.org/browse/RIC-44
+
[2.0.0] - 12/9/2019
apiVersion: v1
description: A1 Helm chart for Kubernetes
name: a1mediator
-version: 2.0.0
+version: 2.1.0
value: "5"
- name: INSTANCE_DELETE_RESP_TTL
value: "10"
+ - name: DBAAS_SERVICE_HOST
+ value: "dbaas"
+ - name: DBAAS_SERVICE_PORT
+ value: "6379"
+
image: "a1:latest"
imagePullPolicy: {{ .Values.image.pullPolicy }}
ports:
--- /dev/null
+# Copyright (c) 2019 AT&T Intellectual Property.
+# Copyright (c) 2019 Nokia.
+#
+# 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.
+
+#
+# This source code is part of the near-RT RIC (RAN Intelligent Controller)
+# platform project (RICP).
+#
+
+apiVersion: v1
+appVersion: "1.0"
+description: DBaaS realized with standalone, non-persistent, non-redundant Redis
+name: dbaas
+version: 0.1.0
--- /dev/null
+This was stolen from https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt/dbaas.git
--- /dev/null
+# Copyright (c) 2019 AT&T Intellectual Property.
+# Copyright (c) 2019 Nokia.
+#
+# 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.
+
+#
+# This source code is part of the near-RT RIC (RAN Intelligent Controller)
+# platform project (RICP).
+#
+
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+ name: {{ .Values.backend.name }}
+spec:
+ replicas: {{ .Values.backend.replicas }}
+ template:
+ metadata:
+ labels:
+ app: {{ .Values.backend.name }}
+ spec:
+ terminationGracePeriodSeconds: {{ .Values.backend.terminationGracePeriodSeconds }}
+ containers:
+ - image: {{ .Values.backend.image.name }}:{{ .Values.backend.image.tag }}
+ imagePullPolicy: {{ .Values.backend.image.imagePullPolicy }}
+ ports:
+ - containerPort: {{ .Values.backend.targetPort }}
+ name: {{ .Values.backend.name }}
+ restartPolicy: Always
--- /dev/null
+# Copyright (c) 2019 AT&T Intellectual Property.
+# Copyright (c) 2019 Nokia.
+#
+# 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.
+
+#
+# This source code is part of the near-RT RIC (RAN Intelligent Controller)
+# platform project (RICP).
+#
+
+apiVersion: v1
+kind: Service
+metadata:
+ name: {{ .Chart.Name }}
+spec:
+ selector:
+ app: {{ .Values.backend.name }}
+ ports:
+ - port: {{ .Values.backend.port }}
+ targetPort: {{ .Values.backend.targetPort }}
--- /dev/null
+# Copyright (c) 2019 AT&T Intellectual Property.
+# Copyright (c) 2019 Nokia.
+#
+# 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.
+
+#
+# This source code is part of the near-RT RIC (RAN Intelligent Controller)
+# platform project (RICP).
+#
+
+backend:
+ terminationGracePeriodSeconds: 0
+ replicas: 1
+ name: "redis-standalone"
+ port: 6379
+ targetPort: 6379
+ image:
+ name: nexus3.o-ran-sc.org:10002/o-ran-sc/ric-plt-dbaas
+ tag: 0.2.2
+ imagePullPolicy: IfNotPresent
#!/bin/sh
-echo "\n\n a1" >> log.txt
-kubectl get pods --namespace=default | awk '{ print $1 }' | egrep '^a1-a1mediator-' | xargs kubectl logs > log.txt 2>&1
+echo "\n\n a1" > log.txt
+kubectl get pods --namespace=default | awk '{ print $1 }' | egrep '^a1-a1mediator-' | xargs kubectl logs >> log.txt 2>&1
echo "\n\n test receiver" >> log.txt
kubectl get pods --namespace=default | awk '{ print $1 }' | egrep '^testreceiver-' | xargs -I X kubectl logs X testreceiver >> log.txt 2>&1
echo "\n\n query" >> log.txt
kubectl get pods --namespace=default | awk '{ print $1 }' | egrep '^testreceiver-' | xargs -I X kubectl logs X queryreceiver >> log.txt 2>&1
+
+echo "\n\n sdl-redis" >> log.txt
+kubectl get pods --namespace=default | awk '{ print $1 }' | egrep '^redis-standalone' | xargs kubectl logs >> log.txt 2>&1
# ==================================================================================
-# Copyright (c) 2019 Nokia
-# Copyright (c) 2018-2019 AT&T Intellectual Property.
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
setup(
name="a1",
- version="2.0.0",
+ version="2.1.0",
packages=find_packages(exclude=["tests.*", "tests"]),
author="Tommy Carpenter",
description="RIC A1 Mediator for policy/intent changes",
url="https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/a1",
entry_points={"console_scripts": ["run.py=a1.run:main"]},
# we require jsonschema, should be in that list, but connexion already requires a specific version of it
- install_requires=["requests", "Flask", "connexion[swagger-ui]", "gevent", "msgpack", "rmr>=2.2.0", "mdclogpy"],
+ install_requires=[
+ "requests",
+ "Flask",
+ "connexion[swagger-ui]",
+ "gevent",
+ "msgpack",
+ "rmr>=2.2.0",
+ "mdclogpy",
+ "ricsdl>=1.0.2,<2.0.0",
+ ],
package_data={"a1": ["openapi.yaml"]},
)
--- /dev/null
+# ==================================================================================
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
+#
+# 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.
+# ==================================================================================
+import msgpack
+from ricsdl.exceptions import RejectedByBackend, NotConnected, BackendError
+
+
+class MockSDLWrapper:
+ """
+ Mock wrapper for SDL that uses a dict so we do not rely on Redis for unit tests.
+ Would be really nice if SDL itself came with a "standalone: dictionary" mode for this purpose...
+ """
+
+ def __init__(self):
+ self.POLICY_DATA = {}
+
+ def set(self, key, value):
+ """set a key"""
+
+ # these are for unit testing that the handler works on various SDL errors
+ if key == "a1.policy_type.111":
+ raise RejectedByBackend()
+ if key == "a1.policy_type.112":
+ raise NotConnected()
+ if key == "a1.policy_type.113":
+ raise BackendError()
+
+ self.POLICY_DATA[key] = msgpack.packb(value, use_bin_type=True)
+
+ def get(self, key):
+ """get a key"""
+ if key in self.POLICY_DATA:
+ return msgpack.unpackb(self.POLICY_DATA[key], raw=False)
+ return None
+
+ def find_and_get(self, prefix):
+ """get all k v pairs that start with prefix"""
+ return {k: msgpack.unpackb(v, raw=False) for k, v in self.POLICY_DATA.items() if k.startswith(prefix)}
+
+ def delete(self, key):
+ """ delete a key"""
+ del self.POLICY_DATA[key]
tests for controller
"""
# ==================================================================================
-# Copyright (c) 2019 Nokia
-# Copyright (c) 2018-2019 AT&T Intellectual Property.
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==================================================================================
-
import time
import json
from rmr.rmr_mocks import rmr_mocks
-from a1 import a1rmr
+from a1 import a1rmr, data
+from .a1test_helpers import MockSDLWrapper
RCV_ID = "test_receiver"
ADM_CRTL_TID = 6660666
def setup_module():
"""module level setup"""
+ data.SDL = MockSDLWrapper() # patch SDL
+
def noop():
pass
"""
test a full A1 workflow
"""
+
+ # put type and instance
_put_ac_type(client, adm_type_good)
_put_ac_instance(client, monkeypatch, adm_instance_good)
res = client.delete(ADM_CTRL_TYPE)
assert res.status_code == 204
+ # test 503 handlers
+ res = client.put("/a1-p/policytypes/111", json=adm_type_good)
+ assert res.status_code == 503
+ res = client.put("/a1-p/policytypes/112", json=adm_type_good)
+ assert res.status_code == 503
+ res = client.put("/a1-p/policytypes/113", json=adm_type_good)
+ assert res.status_code == 503
+
def test_illegal_types(client, adm_type_good):
"""
# ==================================================================================
-# Copyright (c) 2019 Nokia
-# Copyright (c) 2018-2019 AT&T Intellectual Property.
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# limitations under the License.
# ==================================================================================
from a1 import data
+from .a1test_helpers import MockSDLWrapper
+
+
+def setup_module():
+ """module level setup"""
+ data.SDL = MockSDLWrapper() # patch SDL
def test_sdl_raw():
"""
test raw sdl functions
"""
- data.SDL = data.SDLWrapper()
data.SDL.set("as.df1", "data")
data.SDL.set("as.df2", "data2")
assert data.SDL.get("as.df1") == "data"
# ==================================================================================
-# Copyright (c) 2019 Nokia
-# Copyright (c) 2018-2019 AT&T Intellectual Property.
+# Copyright (c) 2019-2020 Nokia
+# Copyright (c) 2018-2020 AT&T Intellectual Property.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
sleep 5
helm install --devel testreceiver -n testreceiver
helm install --devel a1mediator -n a1
+ helm install --devel dbaas-service -n dbaas
# wait for helm charts
sleep 30
./portforward.sh
helm del --purge testreceiver
helm delete a1
helm del --purge a1
+ helm del dbaas
+ helm del --purge dbaas
pkill -9 kubectl
sleep 10
Code Review / ric-plt / a1.git / commitdiff