diff options
-rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 47 | ||||
-rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmp.yml | 29 | ||||
-rwxr-xr-x | cps-ncmp-rest/docs/openapi/openapi.yml | 5 | ||||
-rwxr-xr-x | cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java | 7 | ||||
-rw-r--r-- | csit/plans/cps/sdnc/sdnc_setup.sh | 2 | ||||
-rwxr-xr-x | csit/plans/cps/setup.sh | 161 | ||||
-rwxr-xr-x | csit/plans/cps/teardown.sh | 1 | ||||
-rw-r--r-- | csit/plans/cps/test.properties | 26 | ||||
-rw-r--r-- | csit/tests/actuator/actuator.robot | 2 | ||||
-rw-r--r-- | csit/tests/cps-admin/cps-admin.robot | 2 | ||||
-rw-r--r-- | csit/tests/cps-data/cps-data.robot | 2 | ||||
-rw-r--r-- | csit/tests/ncmp-passthrough/ncmp-passthrough.robot | 2 | ||||
-rwxr-xr-x | docker-compose/docker-compose.yml | 34 | ||||
-rw-r--r-- | docs/admin-guide.rst | 8 | ||||
-rwxr-xr-x | docs/conf.py | 5 | ||||
-rw-r--r-- | docs/deployment.rst | 3 | ||||
-rwxr-xr-x | docs/index.rst | 2 | ||||
-rw-r--r-- | docs/modeling.rst | 5 |
18 files changed, 229 insertions, 114 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index d35919da4b..1f55ce1998 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -19,6 +19,7 @@ components: schemas: + # Common Schemas ErrorMessage: type: object title: Error @@ -30,6 +31,7 @@ components: details: type: string + # Request Schemas RestDmiPluginRegistration: type: object properties: @@ -65,6 +67,51 @@ components: type: string example: system-001 + Conditions: + type: object + properties: + conditions: + $ref: '#/components/schemas/ConditionsData' + ConditionsData: + type: array + items: + type: object + $ref: '#/components/schemas/ConditionProperties' + ConditionProperties: + properties: + name: + type: string + example: hasAllModules + conditionParameters: + $ref: '#/components/schemas/ConditionParameters' + ConditionParameters: + type: array + items: + type: object + $ref: '#/components/schemas/ConditionParameter' + ConditionParameter: + properties: + moduleName: + type: string + example: someModuleName + + #Response Schemas + CmHandles: + type: object + properties: + cmHandles: + $ref: '#/components/schemas/CmHandleProperties' + CmHandleProperties: + type: array + items: + type: object + $ref: '#/components/schemas/CmHandleProperty' + CmHandleProperty: + properties: + cmHandleId: + type: string + example: someCmHandleId + parameters: cmHandleInPath: name: cm-handle diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml index 52245c3cc0..9e3560a2fa 100755 --- a/cps-ncmp-rest/docs/openapi/ncmp.yml +++ b/cps-ncmp-rest/docs/openapi/ncmp.yml @@ -283,4 +283,31 @@ fetchModuleReferencesByCmHandle: 403: $ref: 'components.yaml#/components/responses/Forbidden' 404: - $ref: 'components.yaml#/components/responses/NotFound'
\ No newline at end of file + $ref: 'components.yaml#/components/responses/NotFound' + +executeCmHandleSearch: + post: + description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names + tags: + - network-cm-proxy + summary: Execute cm handle search using the available conditions + operationId: executeCmHandleSearch + requestBody: + required: true + content: + application/json: + schema: + $ref: 'components.yaml#/components/schemas/Conditions' + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: 'components.yaml#/components/schemas/CmHandles' + 400: + $ref: 'components.yaml#/components/responses/BadRequest' + 401: + $ref: 'components.yaml#/components/responses/Unauthorized' + 403: + $ref: 'components.yaml#/components/responses/Forbidden'
\ No newline at end of file diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml index 69c2a117d6..64a74c5933 100755 --- a/cps-ncmp-rest/docs/openapi/openapi.yml +++ b/cps-ncmp-rest/docs/openapi/openapi.yml @@ -45,4 +45,7 @@ paths: $ref: 'ncmp.yml#/resourceDataForPassthroughRunning' /v1/ch/{cm-handle}/modules: - $ref: 'ncmp.yml#/fetchModuleReferencesByCmHandle'
\ No newline at end of file + $ref: 'ncmp.yml#/fetchModuleReferencesByCmHandle' + + /v1/ch/searches: + $ref: 'ncmp.yml#/executeCmHandleSearch'
\ No newline at end of file diff --git a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java index 9b15a7890d..14f33d1e24 100755 --- a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java +++ b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/NetworkCmProxyController.java @@ -29,6 +29,8 @@ import javax.validation.Valid; import javax.validation.constraints.NotNull; import org.onap.cps.ncmp.api.NetworkCmProxyDataService; import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi; +import org.onap.cps.ncmp.rest.model.CmHandles; +import org.onap.cps.ncmp.rest.model.Conditions; import org.onap.cps.spi.FetchDescendantsOption; import org.onap.cps.spi.model.DataNode; import org.onap.cps.spi.model.ModuleReference; @@ -194,6 +196,11 @@ public class NetworkCmProxyController implements NetworkCmProxyApi { } @Override + public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) { + return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); + } + + @Override public ResponseEntity<Object> getModuleReferencesByCmHandle(final String cmHandle) { final Collection<ModuleReference> moduleReferences = networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle); diff --git a/csit/plans/cps/sdnc/sdnc_setup.sh b/csit/plans/cps/sdnc/sdnc_setup.sh index 18d21b3889..c2b7a84f15 100644 --- a/csit/plans/cps/sdnc/sdnc_setup.sh +++ b/csit/plans/cps/sdnc/sdnc_setup.sh @@ -31,7 +31,7 @@ TIME_OUT=600 INTERVAL=30 TIME=0 while [ "$TIME" -lt "$TIME_OUT" ]; do - response=$(curl --write-out '%{http_code}' --silent --output /dev/null -H "Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==" -X POST -H "X-FromAppId: csit-sdnc" -H "X-TransactionId: csit-sdnc" -H "Accept: application/json" -H "Content-Type: application/json" http://localhost:8282/restconf/operations/SLI-API:healthcheck ); + response=$(curl --write-out '%{http_code}' --silent --output /dev/null -H "Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==" -X POST -H "X-FromAppId: csit-sdnc" -H "X-TransactionId: csit-sdnc" -H "Accept: application/json" -H "Content-Type: application/json" http://$SDNC_HOST:$SDNC_PORT/restconf/operations/SLI-API:healthcheck ); echo $response if [ "$response" == "200" ]; then diff --git a/csit/plans/cps/setup.sh b/csit/plans/cps/setup.sh index 2fc0ec4877..e4bdd47a9e 100755 --- a/csit/plans/cps/setup.sh +++ b/csit/plans/cps/setup.sh @@ -23,107 +23,124 @@ # Branched from ccsdk/distribution to this repository Feb 23, 2021 # -# Copy docker-compose.yml and application.yml to archives -mkdir -p $WORKSPACE/archives/docker-compose -cp $WORKSPACE/../docker-compose/*.yml $WORKSPACE/archives/docker-compose -cd $WORKSPACE/archives/docker-compose +check_health() +{ +TIME_OUT=120 +INTERVAL=5 +TICKER=0 + +while [ "$TICKER" -le "$TIME_OUT" ]; do + + RESPONSE=$(curl --location --request GET 'http://'$1'/manage/health/readiness') + + if [[ "$RESPONSE" == *"UP"* ]]; then + echo "$2 started in $TICKER" + break; + fi + + sleep $INTERVAL + TICKER=$((TICKER + INTERVAL)) +done + +if [ "$TICKER" -ge "$TIME_OUT" ]; then + echo TIME OUT: $2 session not started in $TIME_OUT seconds... Could cause problems for testing activities... +fi + +} + +###################### setup env ############################ # Set env variables for docker compose export LOCAL_IP=$(ip -4 addr show docker0 | grep -Po 'inet \K[\d.]+') -export DMI_SERVICE_URL=http://$LOCAL_IP:8783 -export DB_HOST=$LOCAL_IP -export SDNC_HOST=$LOCAL_IP -export CPS_CORE_HOST=$LOCAL_IP -export DB_USERNAME=cps -export DB_PASSWORD=cps -# Use latest image version -export VERSION=latest + +source $WORKSPACE/plans/cps/test.properties +export $(cut -d= -f1 $WORKSPACE/plans/cps/test.properties) + +###################### setup cps-ncmp ############################ +mkdir -p $WORKSPACE/archives/dc-cps +cp $WORKSPACE/../docker-compose/*.yml $WORKSPACE/archives/dc-cps +cd $WORKSPACE/archives/dc-cps # download docker-compose of a required version (1.25.0 supports configuration of version 3.7) curl -L https://github.com/docker/compose/releases/download/1.25.0/docker-compose-`uname -s`-`uname -m` > docker-compose chmod +x docker-compose # start CPS and PostgreSQL containers with docker compose -docker network create test_network ./docker-compose up -d -###################### setup sdnc ############################ +###################### setup onap-dmi-plugin ############################ + +cd $WORKSPACE/archives +git clone "https://gerrit.onap.org/r/cps/ncmp-dmi-plugin" +mkdir -p $WORKSPACE/archives/dc-dmi +cp $WORKSPACE/archives/ncmp-dmi-plugin/docker-compose/*.yml $WORKSPACE/archives/dc-dmi +cd $WORKSPACE/archives/dc-dmi +# download docker-compose of a required version (1.25.0 supports configuration of version 3.7) +curl -L https://github.com/docker/compose/releases/download/1.25.0/docker-compose-`uname -s`-`uname -m` > docker-compose +chmod +x docker-compose +./docker-compose up -d + +###################### setup sdnc ####################################### source $WORKSPACE/plans/cps/sdnc/sdnc_setup.sh -###################### setup pnfsim ########################## +###################### setup pnfsim ##################################### docker-compose -f $WORKSPACE/plans/cps/pnfsim/docker-compose.yml up -d # Allow time for netconf-pnp-simulator & SDNC to come up fully sleep 30s +###################### mount pnf-sim as PNFDemo ########################## SDNC_TIME_OUT=250 SDNC_INTERVAL=10 SDNC_TIME=0 while [ "$SDNC_TIME" -le "$SDNC_TIME_OUT" ]; do - # Mount netconf node - - curl --location --request PUT 'http://'"$LOCAL_IP"':8282/restconf/config/network-topology:network-topology/topology/topology-netconf/node/PNFDemo' \ - --header 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "node": [ - { - "node-id": "PNFDemo", - "netconf-node-topology:protocol": { - "name": "TLS" - }, - "netconf-node-topology:host": '"$LOCAL_IP"', - "netconf-node-topology:key-based": { - "username": "netconf", - "key-id": "ODL_private_key_0" - }, - "netconf-node-topology:port": 6512, - "netconf-node-topology:tcp-only": false, - "netconf-node-topology:max-connection-attempts": 5 - } - ] - }' - - # Verify node has been mounted - - RESPONSE=$( curl --location --request GET 'http://'"$LOCAL_IP"':8282/restconf/config/network-topology:network-topology/topology/topology-netconf' --header 'Authorization: basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==') - - if [[ "$RESPONSE" == *"PNFDemo"* ]]; then - echo "Node mounted in $SDNC_TIME" - break; - fi - - sleep $SDNC_INTERVAL - SDNC_TIME=$((SDNC_TIME + SDNC_INTERVAL)) - -done + # Mount netconf node + curl --location --request PUT 'http://'$SDNC_HOST:$SDNC_PORT'/restconf/config/network-topology:network-topology/topology/topology-netconf/node/PNFDemo' \ + --header 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "node": [ + { + "node-id": "PNFDemo", + "netconf-node-topology:protocol": { + "name": "TLS" + }, + "netconf-node-topology:host": "'$LOCAL_IP'", + "netconf-node-topology:key-based": { + "username": "netconf", + "key-id": "ODL_private_key_0" + }, + "netconf-node-topology:port": 6512, + "netconf-node-topology:tcp-only": false, + "netconf-node-topology:max-connection-attempts": 5 + } + ] + }' + + # Verify node has been mounted + + RESPONSE=$( curl --location --request GET 'http://'$SDNC_HOST:$SDNC_PORT'/restconf/config/network-topology:network-topology/topology/topology-netconf' --header 'Authorization: basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==') + + if [[ "$RESPONSE" == *"PNFDemo"* ]]; then + echo "Node mounted in $SDNC_TIME" + break; + fi -# Validate CPS service initialization completed via periodic log checking for line like below: -# org.onap.cps.Application ... Started Application in X.XXX seconds + sleep $SDNC_INTERVAL + SDNC_TIME=$((SDNC_TIME + SDNC_INTERVAL)) -TIME_OUT=300 -INTERVAL=5 -TIME=0 +done -while [ "$TIME" -le "$TIME_OUT" ]; do - LOG_FOUND=$( ./docker-compose logs --tail="all" | grep "org.onap.cps.Application" | egrep -c "Started Application in" ) +###################### verify ncmp-cps health ########################## - if [ "$LOG_FOUND" -gt 0 ]; then - echo "CPS Service started" - break; - fi +check_health $CPS_CORE_HOST:$CPS_CORE_MANAGEMENT_PORT 'cps-ncmp' - echo "Sleep $INTERVAL seconds before next check for CPS initialization (waiting $TIME seconds; timeout is $TIME_OUT seconds)" - sleep $INTERVAL - TIME=$((TIME + INTERVAL)) -done +###################### verify dmi health ########################## -if [ "$TIME" -gt "$TIME_OUT" ]; then - echo "TIME OUT: CPS Service wasn't able to start in $TIME_OUT seconds, setup failed." - exit 1; -fi +check_health $DMI_HOST:$DMI_MANAGEMENT_PORT 'dmi-plugin' +###################### ROBOT Configurations ########################## # Pass variables required for Robot test suites in ROBOT_VARIABLES -ROBOT_VARIABLES="-v CPS_HOST:$LOCAL_IP -v CPS_PORT:8883 -v DMI_HOST:$LOCAL_IP -v DMI_PORT:8783 -v MANAGEMENT_PORT:8887 -v DATADIR:$WORKSPACE/data"
\ No newline at end of file +ROBOT_VARIABLES="-v CPS_CORE_HOST:$CPS_CORE_HOST -v CPS_CORE_PORT:$CPS_CORE_PORT -v DMI_HOST:$LOCAL_IP -v DMI_PORT:$DMI_PORT -v CPS_CORE_MANAGEMENT_PORT:$CPS_CORE_MANAGEMENT_PORT -v DATADIR:$WORKSPACE/data"
\ No newline at end of file diff --git a/csit/plans/cps/teardown.sh b/csit/plans/cps/teardown.sh index 3ef50d4146..75f0af41fc 100755 --- a/csit/plans/cps/teardown.sh +++ b/csit/plans/cps/teardown.sh @@ -29,4 +29,3 @@ echo y | docker volume prune echo 'Removing Networks...' echo y | docker network prune - diff --git a/csit/plans/cps/test.properties b/csit/plans/cps/test.properties new file mode 100644 index 0000000000..3e546fbec1 --- /dev/null +++ b/csit/plans/cps/test.properties @@ -0,0 +1,26 @@ +DB_HOST=$LOCAL_IP +DB_USERNAME=cps +DB_PASSWORD=cps + +SDNC_HOST=$LOCAL_IP +SDNC_PORT=8282 +SDNC_USERNAME=admin +SDNC_PASSWORD=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U + +CPS_CORE_HOST=$LOCAL_IP +CPS_CORE_PORT=8883 +CPS_CORE_MANAGEMENT_PORT=8887 +CPS_CORE_USERNAME=cpsuser +CPS_CORE_PASSWORD=cpsr0cks! + +DMI_HOST=$LOCAL_IP +DMI_PORT=8783 +DMI_USERNAME=cpsuser +DMI_PASSWORD=cpsr0cks! +DMI_MANAGEMENT_PORT=8787 +DMI_SERVICE_URL=http://$LOCAL_IP:$DMI_PORT + +DOCKER_REPO=nexus3.onap.org:10003 + +CPS_VERSION=latest +DMI_VERSION=latest
\ No newline at end of file diff --git a/csit/tests/actuator/actuator.robot b/csit/tests/actuator/actuator.robot index 55ff40e076..2ee575e406 100644 --- a/csit/tests/actuator/actuator.robot +++ b/csit/tests/actuator/actuator.robot @@ -23,7 +23,7 @@ Documentation CPS - Actuator endpoints Library Collections Library RequestsLibrary -Suite Setup Create Session MANAGEMENT_URL http://${CPS_HOST}:${MANAGEMENT_PORT}/manage +Suite Setup Create Session MANAGEMENT_URL http://${CPS_CORE_HOST}:${CPS_CORE_MANAGEMENT_PORT}/manage *** Variables *** diff --git a/csit/tests/cps-admin/cps-admin.robot b/csit/tests/cps-admin/cps-admin.robot index 43a46d3274..a075788ff4 100644 --- a/csit/tests/cps-admin/cps-admin.robot +++ b/csit/tests/cps-admin/cps-admin.robot @@ -23,7 +23,7 @@ Library Collections Library OperatingSystem Library RequestsLibrary -Suite Setup Create Session CPS_URL http://${CPS_HOST}:${CPS_PORT} +Suite Setup Create Session CPS_URL http://${CPS_CORE_HOST}:${CPS_CORE_PORT} *** Variables *** diff --git a/csit/tests/cps-data/cps-data.robot b/csit/tests/cps-data/cps-data.robot index e7334ae11e..1c48e00691 100644 --- a/csit/tests/cps-data/cps-data.robot +++ b/csit/tests/cps-data/cps-data.robot @@ -23,7 +23,7 @@ Library Collections Library OperatingSystem Library RequestsLibrary -Suite Setup Create Session CPS_URL http://${CPS_HOST}:${CPS_PORT} +Suite Setup Create Session CPS_URL http://${CPS_CORE_HOST}:${CPS_CORE_PORT} *** Variables *** diff --git a/csit/tests/ncmp-passthrough/ncmp-passthrough.robot b/csit/tests/ncmp-passthrough/ncmp-passthrough.robot index 3b68c335f5..c23fa085b8 100644 --- a/csit/tests/ncmp-passthrough/ncmp-passthrough.robot +++ b/csit/tests/ncmp-passthrough/ncmp-passthrough.robot @@ -26,7 +26,7 @@ Library OperatingSystem Library RequestsLibrary Library BuiltIn -Suite Setup Create Session CPS_URL http://${CPS_HOST}:${CPS_PORT} +Suite Setup Create Session CPS_URL http://${CPS_CORE_HOST}:${CPS_CORE_PORT} *** Variables *** diff --git a/docker-compose/docker-compose.yml b/docker-compose/docker-compose.yml index c928ee88b0..5bdff9d79a 100755 --- a/docker-compose/docker-compose.yml +++ b/docker-compose/docker-compose.yml @@ -97,13 +97,13 @@ services: cps-and-ncmp: container_name: cps-and-ncmp - image: ${DOCKER_REPO:-nexus3.onap.org:10003}/onap/cps-and-ncmp:${VERSION:-latest} + image: ${DOCKER_REPO:-nexus3.onap.org:10003}/onap/cps-and-ncmp:${CPS_VERSION:-latest} ports: - - "8883:8080" - - "8887:8081" + - ${CPS_CORE_PORT:-8883}:8080 + - ${CPS_CORE_MANAGEMENT_PORT:-8887}:8081 environment: - CPS_USERNAME: ${CPS_USERNAME:-cpsuser} - CPS_PASSWORD: ${CPS_PASSWORD:-cpsr0cks!} + CPS_USERNAME: ${CPS_CORE_USERNAME:-cpsuser} + CPS_PASSWORD: ${CPS_CORE_PASSWORD:-cpsr0cks!} DB_HOST: ${DB_HOST} DB_USERNAME: ${DB_USERNAME:-cps} DB_PASSWORD: ${DB_PASSWORD:-cps} @@ -114,26 +114,4 @@ services: #NOTIFICATION_DATASPACE_FILTER_PATTERNS: '.*' restart: unless-stopped depends_on: - - dbpostgresql - - ncmp-dmi-plugin: - container_name: ncmp-dmi-plugin - image: ${DOCKER_REPO:-nexus3.onap.org:10003}/onap/ncmp-dmi-plugin:${VERSION:-latest} - ports: - - "8783:8080" - - "8787:8081" - environment: - DMI_USERNAME: ${DMI_USERNAME:-cpsuser} - DMI_PASSWORD: ${DMI_PASSWORD:-cpsr0cks!} - CPS_CORE_HOST: ${CPS_CORE_HOST} - CPS_CORE_PORT: ${CPS_CORE_PORT:-8883} - CPS_CORE_USERNAME: ${CPS_CORE_USERNAME:-cpsuser} - CPS_CORE_PASSWORD: ${CPS_CORE_PASSWORD:-cpsr0cks!} - SDNC_HOST: ${SDNC_HOST} - SDNC_PORT: ${SDNC_PORT:-8282} - SDNC_USERNAME: ${SDNC_USERNAME:-admin} - SDNC_PASSWORD: ${SDNC_PASSWORD:-Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U} - DMI_SERVICE_URL: ${DMI_SERVICE_URL} - restart: unless-stopped - depends_on: - - cps-and-ncmp #it depends on cps_and_ncmp for registration but as a container it can run independently.
\ No newline at end of file + - dbpostgresql
\ No newline at end of file diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 3a6f8e2559..7689ee5b6d 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -12,6 +12,9 @@ CPS Admin Guide .. toctree:: :maxdepth: 1 +.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning +.. _cps_common_logging: + Logging & Diagnostics ===================== @@ -44,6 +47,9 @@ Logger configuration is provided as a chart resource : | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning +.. _cps_common_monitoring: + Monitoring ========== Once CPS-Core is deployed, information related to the running instance of the application is available @@ -69,4 +75,4 @@ Prometheus Metrics can be checked at the following endpoint .. code:: - http://<cps-component-service-name>:8081/manage/prometheus
\ No newline at end of file + http://<cps-component-service-name>:8081/manage/prometheus diff --git a/docs/conf.py b/docs/conf.py index 3aaddd194f..84dac1ea21 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,14 +20,15 @@ from docutils.parsers.rst import directives from docs_conf.conf import * +#change 'latest' to relevant branch-name once branch has been created branch = 'latest' doc_url = 'https://docs.onap.org/projects' master_doc = 'index' intersphinx_mapping = {} -# Latest (change to branch) -intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None) linkcheck_ignore = [ 'http://localhost', diff --git a/docs/deployment.rst b/docs/deployment.rst index 61f9ad2943..b1839cbb88 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -98,7 +98,8 @@ Each cps component can be restarted independently by issuing the following comma kubectl delete pod <cps-component-pod-name> -n <namespace> -.. _credentials_retrieval: +.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning +.. _cps_common_credentials_retrieval: Credentials Retrieval --------------------- diff --git a/docs/index.rst b/docs/index.rst index b749604eeb..62ba5e8b17 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,7 +23,7 @@ CPS Documentation release-notes.rst DMI-Plugin Documentation ------------------------------ +------------------------ * :ref:`DMI-Plugin<onap-cps-ncmp-dmi-plugin:master_index>` diff --git a/docs/modeling.rst b/docs/modeling.rst index a91eb0178a..5504bf322e 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -56,6 +56,9 @@ Querying - **CPS Path** is used to query data nodes. The CPS Path is described in detail in :doc:`cps-path`. +.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning +.. _cps_ncmp_modelling: + NCMP Modeling ============= @@ -83,4 +86,4 @@ Basic Concepts | Passthrough-operational | config-true, config-false | read-only | +--------------------------------+-------------------------------------+-------------------------+ | Passthrough-running | config-true | read-write | - +--------------------------------+-------------------------------------+-------------------------+
\ No newline at end of file + +--------------------------------+-------------------------------------+-------------------------+ |