+NOTES.txt
.pytest_cache/
xunit-results.xml
.DS_Store
--- /dev/null
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
--- /dev/null
+apiVersion: v1
+description: A1 Helm chart for Kubernetes
+name: a1mediator
+version: 0.8.2
--- /dev/null
+{
+ "controls":[
+ {
+ "name":"control_admission_time",
+ "description":"time period to allow dual connection",
+ "message_receives_rmr_type":"DC_ADMISSION_INTERVAL_CONTROL",
+ "message_receives_payload_schema":{
+ "$schema":"http://json-schema.org/draft-07/schema#",
+ "type":"object",
+ "properties":{
+ "dc_admission_start_time":{
+ "type":"string",
+ "pattern":"^[0-9]{2}:[0-9]{2}:[0-9]{2}$"
+ },
+ "dc_admission_end_time":{
+ "type":"string",
+ "pattern":"^[0-9]{2}:[0-9]{2}:[0-9]{2}$"
+ }
+ },
+ "required":[
+ "dc_admission_start_time",
+ "dc_admission_end_time"
+ ]
+ },
+ "message_sends_rmr_type":"DC_ADMISSION_INTERVAL_CONTROL_ACK",
+ "message_sends_payload_schema":{
+ "$schema":"http://json-schema.org/draft-07/schema#",
+ "type":"object",
+ "properties":{
+ "status":{
+ "type":"string",
+ "enum":[
+ "SUCCESS",
+ "FAIL"
+ ]
+ },
+ "message":{
+ "type":"string"
+ }
+ }
+ }
+ },
+ {
+ "name":"test_policy",
+ "description":"for the purposes of testing",
+ "message_receives_rmr_type":"TEST_REQ",
+ "message_sends_rmr_type":"TEST_ACK",
+ "message_sends_payload_schema":{
+ "$schema":"http://json-schema.org/draft-07/schema#",
+ "type":"object",
+ "properties":{
+ "status":{
+ "type":"string",
+ "enum":[
+ "SUCCESS",
+ "FAIL"
+ ]
+ }
+ }
+ }
+ }
+ ]
+}
--- /dev/null
+DC_ADMISSION_INTERVAL_CONTROL:20000
+DC_ADMISSION_INTERVAL_CONTROL_ACK:20001
+TEST_REQ:10000
+TEST_ACK:10001
--- /dev/null
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "a1mediator.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "a1mediator.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "a1mediator.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "a1mediator.labels" -}}
+app.kubernetes.io/name: {{ include "a1mediator.name" . }}
+helm.sh/chart: {{ include "a1mediator.chart" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end -}}
--- /dev/null
+apiVersion: v1
+kind: ConfigMap
+metadata:
+ name: a1conf
+data:
+ local.rt: |
+ newrt|start
+ rte|10000|rmr_delay_receiver:4563
+ rte|20000|rmr_receiver:4560
+ rte|10001|{{ .Values.rmrservice.name }}:{{ .Values.rmrservice.port }}
+ rte|20001|{{ .Values.rmrservice.name }}:{{ .Values.rmrservice.port }}
+ newrt|end
+ rmr_string_int_mapping.txt: {{ tpl (.Files.Get "files/rmr_string_int_mapping.txt") . | quote }}
+ ricmanifest.json: {{ tpl (.Files.Get "files/ricmanifest.json") . | quote }}
--- /dev/null
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ include "a1mediator.fullname" . }}
+ labels:
+{{ include "a1mediator.labels" . | indent 4 }}
+spec:
+ replicas: {{ .Values.replicaCount }}
+ selector:
+ matchLabels:
+ app.kubernetes.io/name: {{ include "a1mediator.name" . }}
+ app.kubernetes.io/instance: {{ .Release.Name }}
+ template:
+ metadata:
+ labels:
+ app.kubernetes.io/name: {{ include "a1mediator.name" . }}
+ app.kubernetes.io/instance: {{ .Release.Name }}
+ spec:
+ imagePullSecrets:
+ - name: "{{ .Values.lf_docker_reg_secret }}"
+ containers:
+ - name: {{ .Chart.Name }}
+ volumeMounts:
+ - name: a1conf
+ mountPath: /opt/ricmanifest.json
+ subPath: ricmanifest.json
+ - name: a1conf
+ mountPath: /opt/rmr_string_int_mapping.txt
+ subPath: rmr_string_int_mapping.txt
+ - name: a1conf
+ mountPath: /opt/route/local.rt
+ subPath: local.rt
+ env:
+ - name: PYTHONUNBUFFERED
+ value: "0"
+ - name: RMR_RCV_RETRY_INTERVAL
+ value: "{{ .Values.rmr_timeout_config.rcv_retry_interval_ms }}"
+ - name: RMR_RETRY_TIMES
+ value: "{{ .Values.rmr_timeout_config.rcv_retry_times }}"
+ image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+ imagePullPolicy: {{ .Values.image.pullPolicy }}
+ ports:
+ - name: http
+ containerPort: {{ .Values.httpservice.port }}
+ protocol: TCP
+
+ livenessProbe:
+ httpGet:
+ path: /ui
+ port: http
+ readinessProbe:
+ httpGet:
+ path: /ui
+ port: http
+ resources:
+ {{- toYaml .Values.resources | nindent 12 }}
+ volumes:
+ - name: "a1conf"
+ configMap:
+ name: "a1conf"
+
+ {{- with .Values.nodeSelector }}
+ nodeSelector:
+ {{- toYaml . | nindent 8 }}
+ {{- end }}
+ {{- with .Values.affinity }}
+ affinity:
+ {{- toYaml . | nindent 8 }}
+ {{- end }}
+ {{- with .Values.tolerations }}
+ tolerations:
+ {{- toYaml . | nindent 8 }}
+ {{- end }}
--- /dev/null
+{{- define "imagePullSecret" }}
+{{- printf "{\"auths\": {\"%s\": {\"auth\": \"%s\"}}}" .Values.imageCredentials.registry (printf "%s:%s" .Values.imageCredentials.username .Values.imageCredentials.password | b64enc) | b64enc }}
+{{- end }}
--- /dev/null
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "a1mediator.fullname" . -}}
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+ name: {{ $fullName }}
+ labels:
+{{ include "a1mediator.labels" . | indent 4 }}
+ {{- with .Values.ingress.annotations }}
+ annotations:
+ {{- toYaml . | nindent 4 }}
+ {{- end }}
+spec:
+{{- if .Values.ingress.tls }}
+ tls:
+ {{- range .Values.ingress.tls }}
+ - hosts:
+ {{- range .hosts }}
+ - {{ . | quote }}
+ {{- end }}
+ secretName: {{ .secretName }}
+ {{- end }}
+{{- end }}
+ rules:
+ {{- range .Values.ingress.hosts }}
+ - host: {{ .host | quote }}
+ http:
+ paths:
+ {{- range .paths }}
+ - path: {{ . }}
+ backend:
+ serviceName: {{ $fullName }}
+ servicePort: http
+ {{- end }}
+ {{- end }}
+{{- end }}
--- /dev/null
+apiVersion: v1
+kind: Secret
+metadata:
+ name: lfhelper
+type: kubernetes.io/dockerconfigjson
+data:
+ .dockerconfigjson: {{ template "imagePullSecret" . }}
--- /dev/null
+apiVersion: v1
+kind: Service
+metadata:
+ name: {{ include "a1mediator.fullname" . }}
+ labels:
+{{ include "a1mediator.labels" . | indent 4 }}
+
+spec:
+ type: {{ .Values.httpservice.type }}
+ ports:
+ - port: {{ .Values.httpservice.port }}
+ targetPort: http
+ protocol: TCP
+ name: http
+ selector:
+ app.kubernetes.io/name: {{ include "a1mediator.name" . }}
+ app.kubernetes.io/instance: {{ .Release.Name }}
+
+---
+
+apiVersion: v1
+kind: Service
+metadata:
+ name: {{ .Values.rmrservice.name }}
+ labels:
+{{ include "a1mediator.labels" . | indent 4 }}
+
+spec:
+ type: {{ .Values.rmrservice.type }}
+ ports:
+ - port: {{ .Values.rmrservice.port }}
+ targetPort: {{ .Values.rmrservice.port }}
+ protocol: TCP
+ selector:
+ app.kubernetes.io/name: {{ include "a1mediator.name" . }}
+ app.kubernetes.io/instance: {{ .Release.Name }}
--- /dev/null
+apiVersion: v1
+kind: Pod
+metadata:
+ name: "{{ include "a1mediator.fullname" . }}-test-connection"
+ labels:
+{{ include "a1mediator.labels" . | indent 4 }}
+ annotations:
+ "helm.sh/hook": test-success
+spec:
+ containers:
+ - name: wget
+ image: busybox
+ command: ['wget']
+ args: ['{{ include "a1mediator.fullname" . }}:{{ .Values.httpservice.port }}']
+ restartPolicy: Never
--- /dev/null
+replicaCount: 1
+
+image:
+ repository: nexus3.o-ran-sc.org:10004/ric-plt-a1
+ tag: 0.8.2
+ pullPolicy: IfNotPresent
+
+# name of the secret that allows for privagte registry docker pulls.
+# if the value is "lfhelper", there is a helper function included in this chart, and it uses imageCredentials .
+# imageCredentials is referenced in secrets.yaml, and uses a helper function to formulate the docker reg username and password into a valid dockerconfig.json.
+# Note, if the value of lf_docker_reg_secret is changed, these image credentials are ignored and not used.
+lf_docker_reg_secret: lfhelper
+imageCredentials:
+ registry: nexus3.o-ran-sc.org:10004/ric-plt-a1
+ username:
+ password:
+
+httpservice:
+ port: 10000 ## dont change this!!
+ type: ClusterIP
+
+rmrservice:
+ name: rmrservice
+ port: 4562 ## dont change this!!
+ type: ClusterIP
+
+rmr_timeout_config:
+ rcv_retry_interval_ms: 500
+ rcv_retry_times: 20
+
+ingress:
+ enabled: false
+ annotations: {}
+ # kubernetes.io/ingress.class: nginx
+ # kubernetes.io/tls-acme: "true"
+ hosts:
+ - host: chart-example.local
+ paths: []
+
+ tls: []
+ # - secretName: chart-example-tls
+ # hosts:
+ # - chart-example.local
3) ``container-tag.yaml``
-4) ``a1/openapi.yml``
+4) ``a1mediator/values.yaml``
+
+5) ``a1mediator/Chart.yaml``
+
+6) ``a1/openapi.yml``
Running locally
===============
timeouts and send failures should be retried before A1 gives up and
returns a 503. The default is ``4``.
+K8S
+---
+The helm chart is in the folder `a1mediator`.
+
+There are two files in `a1mediator/files` that should be replaced with the "real" files for deployment. The ones included there, and referenced in the configmap, are only samples. To deploy A1 correctly, make sure these files are correct.
+
+::
+
+ helm install --devel a1mediator/ --name a1 --set imageCredentials.username=xxx --set imageCredentials.password=xxx
+
+The username and password here are the credentials to the registry defined in `a1mediator/values.yaml`. Currently this is the LF docker registry.
+
Docker
------
--- /dev/null
+# ==================================================================================
+# Copyright (c) 2019 Nokia
+# Copyright (c) 2018-2019 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.
+# ==================================================================================
+version: '3'
+services:
+
+ rmr_receiver:
+ build: .
+ hostname: "rmr_receiver"
+ volumes:
+ - ./test_docker.rt:/opt/route/local.rt
+
+ rmr_delay_receiver:
+ build: .
+ hostname: "rmr_delay_receiver"
+ volumes:
+ - ./test_docker.rt:/opt/route/local.rt
+ environment:
+ # https://github.com/docker/compose/issues/3878
+ RMR_RCV_RETRY_INTERVAL: 500
+ RMR_RETRY_TIMES: 10
+ TEST_RCV_PORT: 4563
+ TEST_RCV_RETURN_MINT: 10001
+ TEST_RCV_SEC_DELAY: 5
+ TEST_RCV_RETURN_PAYLOAD: '{"ACK_FROM": "DELAYED_TEST", "status": "SUCCESS"}'
docker-compose up --build -d
sleep 2
commands=
+# helm lint a1mediator/
pytest -n 2
ab -n 100 -c 10 -u putdata -T application/json http://localhost:10000/ric/policies/control_admission_time
commands_post=
Code Review / ric-plt / a1.git / commitdiff