Define and onboard model for subscription events

	- created new yang model for subscription events; added in
	  ncmp-service
	- created new container/service to run an init container
	- added script file to the container
	- added Dockerfile to be the base image of the init container
	- health check for CPS added as part of script
	- removed previous patch modification in setup
	- changed path of models and dockerfile to main project
	- latest patch: changed connection to external ports of CPS

Issue-ID: CPS-1393
Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech>
Change-Id: I2367020e57b34a669dda93050eeaeede5846304e

diff --git a/cps-ncmp-service/src/main/resources/model/subscription.yang b/cps-ncmp-service/src/main/resources/model/subscription.yang
new file mode 100644 (file)
index 0000000..c5dee43
--- /dev/null
+++ b/cps-ncmp-service/src/main/resources/model/subscription.yang
@@ -0,0 +1,33 @@
+module subscription {
+    yang-version 1.1;
+    namespace "org:onap:ncmp:subscription";
+
+    prefix subs;
+
+    revision "2022-10-12" {
+        description
+        "NCMP subscription model";
+    }
+
+    container subscription-registry {
+        list subscription {
+            key "clientID clientName";
+
+            leaf clientID {
+                type string;
+            }
+
+            leaf clientName {
+                type string;
+            }
+
+            leaf topic {
+                type string;
+            }
+
+            leaf isTagged {
+                type boolean;
+            }
+        }
+    }
+}
\ No newline at end of file

diff --git a/docker-compose/docker-compose.yml b/docker-compose/docker-compose.yml
index 28faf02..fe41fc4 100644 (file)
--- a/docker-compose/docker-compose.yml
+++ b/docker-compose/docker-compose.yml
@@ -1,7 +1,7 @@
 # ============LICENSE_START=======================================================
 # Copyright (c) 2020 Pantheon.tech.
 # Modifications Copyright (C) 2021 Bell Canada.
-# Modifications Copyright (C) 2022 Nordix Foundation.
+# Modifications Copyright (C) 2022-2023 Nordix Foundation.
 # ================================================================================
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -30,6 +30,11 @@ services:
       POSTGRES_DB: cpsdb
       POSTGRES_USER: ${DB_USERNAME:-cps}
       POSTGRES_PASSWORD: ${DB_PASSWORD:-cps}
+    healthcheck:
+      test: ["CMD", "pg_isready"]
+      interval: 30s
+      timeout: 5s
+      retries: 5
 
   cps-and-ncmp:
     container_name: cps-and-ncmp
@@ -103,3 +108,15 @@ services:
       notification.data-updated.enabled: 'true'
       NOTIFICATION_DATASPACE_FILTER_PATTERNS: '.*'
     restart: unless-stopped
+
+  init-db:
+    build: ../../../docker-compose/initfile
+    environment:
+      CPS_CORE_PORT: ${CPS_CORE_PORT:-8883}
+      CPS_CORE_MANAGEMENT_PORT: ${CPS_CORE_MANAGEMENT_PORT:-8887}
+    volumes:
+      - ./initfile:/initfile
+      - ../../../cps-ncmp-service/src/main/resources/model/:/model
+    depends_on:
+      cps-and-ncmp:
+        condition: service_started
\ No newline at end of file

diff --git a/docker-compose/initfile/Dockerfile b/docker-compose/initfile/Dockerfile
new file mode 100644 (file)
index 0000000..3c3231e
--- /dev/null
+++ b/docker-compose/initfile/Dockerfile
@@ -0,0 +1,6 @@
+# syntax=docker/dockerfile:1
+FROM alpine:latest
+RUN apk --no-cache add curl
+RUN apk --no-cache add bash
+COPY onboardSubscriptionModel.sh /onboardSubscriptionModel.sh
+CMD ["sh", "onboardSubscriptionModel.sh"]
\ No newline at end of file

diff --git a/docker-compose/initfile/onboardSubscriptionModel.sh b/docker-compose/initfile/onboardSubscriptionModel.sh
new file mode 100644 (file)
index 0000000..59fa471
--- /dev/null
+++ b/docker-compose/initfile/onboardSubscriptionModel.sh
@@ -0,0 +1,70 @@
+#!/bin/bash
+#
+# ============LICENSE_START=======================================================
+#   Copyright (C) 2023 Nordix Foundation.
+# ================================================================================
+#  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.
+#
+#  SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+
+echo "Getting ready to upload model for subscription events ..."
+
+createSchemaSetBasePath="/cps/api/v2/dataspaces/NCMP-Admin/schema-sets?schema-set-name=subscriptions"
+createAnchorBasePath="/cps/api/v2/dataspaces/NCMP-Admin/anchors?schema-set-name=subscriptions&anchor-name=AVC-subscriptions"
+
+ATTEMPT_COUNT=0
+while :
+do
+  status="UP"
+  hostIpAddress=$(ip -4 route show default | cut -d" " -f3)
+
+  if  curl -X 'GET' 'http://'"$hostIpAddress"':'"$CPS_CORE_MANAGEMENT_PORT"'/manage/health/readiness' | grep -q "$status"
+  then
+        echo "Checking that NCMP dataspace exists ..."
+        ncmpDataspaceExists=$(curl --write-out %{http_code} --silent --output /dev/null -X 'GET' 'http://'"$hostIpAddress"':'"$CPS_CORE_PORT"'/cps/api/v2/admin/dataspaces/NCMP-Admin' -H 'accept: */*' --header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=')
+
+        echo "NCMP dataspace exist:  $ncmpDataspaceExists"
+
+        if [ "$ncmpDataspaceExists" == 200 ]
+        then
+          echo "Uploading model ..."
+          create_schema_set_status_code=$(curl --write-out %{http_code} --silent --output /dev/null -X 'POST' 'http://'"$hostIpAddress"':'"$CPS_CORE_PORT"''"$createSchemaSetBasePath"'' -H 'accept: */*' --form "file=@"/model/subscription.yang"" --header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=')
+          create_anchor_status_code=$(curl --write-out %{http_code} --silent --output /dev/null -X 'POST' 'http://'"$hostIpAddress"':'"$CPS_CORE_PORT"''"$createAnchorBasePath"'' -H 'accept: */*' --header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=')
+
+          echo "create schema set status: $create_schema_set_status_code"
+          echo "create anchor status: $create_anchor_status_code"
+
+          if [ "$create_schema_set_status_code" == 201 ] && [ "$create_anchor_status_code" == 201 ]
+          then
+            echo "Model upload finish!"
+            echo "Exiting container ..."
+            echo "Bye Bye!"
+            break
+          fi
+        fi
+  fi
+
+  if [ $ATTEMPT_COUNT == 20 ]
+  then
+    echo -e "Creating schema set last status:\n $(curl -X 'POST' 'http://'"$hostIpAddress"':'"$CPS_CORE_PORT"''"$createSchemaSetBasePath"'' -H 'accept: */*' --form "file=@"/model/subscription.yang"" --header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=')\n"
+    echo -e "Creating anchor last status:\n $(curl -X 'POST' 'http://'"$hostIpAddress"':'"$CPS_CORE_PORT"''"$createAnchorBasePath"'' -H 'accept: */*' --header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=')\n"
+    echo -e "\nToo many attempts. Bye Bye!"
+    break
+  else
+    echo "RETRYING ...[ $ATTEMPT_COUNT attempt(s) ]"
+    ATTEMPT_COUNT=$(($ATTEMPT_COUNT +1))
+    sleep 10
+  fi
+done
\ No newline at end of file