From: Chen, Jackie Date: Tue, 16 Jun 2020 19:47:46 +0000 (-0400) Subject: Updating release notes in preparation of bronze release X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?p=it%2Fotf.git;a=commitdiff_plain;h=243dc50c98dbe64b8801145462b2f18bab7e7786 Updating release notes in preparation of bronze release - made some changes to developer-guide.rst - made changes to helm files - added new values.yaml for db Change-Id: I8a05db4be5a28f85d2c07212b256116505eb5d01 Signed-off-by: Chen, Jackie --- diff --git a/a1-policy-manager-vth/helm/a1-policy-manager-vth/values.yaml b/a1-policy-manager-vth/helm/a1-policy-manager-vth/values.yaml index 5c3e5a0..e0424e7 100644 --- a/a1-policy-manager-vth/helm/a1-policy-manager-vth/values.yaml +++ b/a1-policy-manager-vth/helm/a1-policy-manager-vth/values.yaml @@ -1,8 +1,8 @@ appName: a1-policy-manager-vth env: dev version: 0.0.1-SNAPSHOT -image: dockercentral.it.att.com:5100/com.att.ecomp.otf.dev/a1-policy-manager-vth:0.0.1-SNAPSHOT -namespace: com-att-ecomp-otf-dev #org-oran-otf +image: a1-policy-manager-vth:0.0.1-SNAPSHOT +namespace: org-oran-otf nodePort: 32330 replicas: 1 health : /otf/vth/oran/a1/v1/health @@ -12,8 +12,8 @@ pvc: prod: org-oran-otf-prod-logs-pv auth: enabled: true - user: user - pw: pw + user: "!" + pw: "!" proxy: enabled: false http: diff --git a/a1-sdnc-vth/helm/a1-sdnc-vth/values.yaml b/a1-sdnc-vth/helm/a1-sdnc-vth/values.yaml index fac619d..4cfff81 100644 --- a/a1-sdnc-vth/helm/a1-sdnc-vth/values.yaml +++ b/a1-sdnc-vth/helm/a1-sdnc-vth/values.yaml @@ -1,8 +1,8 @@ appName: a1-sdnc-vth env: dev version: 0.0.1-SNAPSHOT -image: dockercentral.it.att.com:5100/com.att.ecomp.otf.dev/a1-sdnc-vth:0.0.1-SNAPSHOT -namespace: com-att-ecomp-otf-dev #org-oran-otf +image: a1-sdnc-vth:0.0.1-SNAPSHOT +namespace: org-oran-otf nodePort: 32331 replicas: 1 health : /otf/vth/oran/a1/v1/health diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 021a954..1fd4499 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -26,11 +26,12 @@ Developer-Guide Deployment ---------- +The following are typical steps used to deploy and run different components of OTF. OTF Frontend ^^^^^^^^^^^^ 1) docker build -t otf-frontend:0.0.1-SNAPSHOT . -2) docker run -d --network="host" otf-frontend:0.0.1-SNAPSHOT +2) docker run -e OTF_URL='http://localhost:8082/ -d --network="host" otf-frontend:0.0.1-SNAPSHOT OTF SERVICE API ^^^^^^^^^^^^^^^^ @@ -78,7 +79,7 @@ Unable to log in to OTF UI as the first user on the platform ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ When registering as a new user, you will eventually need an admin to "enable" you. If you are the first User, there will be no admin and you will be unable to log in even after you register. In order to fix this, you will have to -manually go into the mongo database and alter certain attributes for this new user. +manually go into the mongo database and alter certain enabled and permission attribute for this new user. .. image:: images/mongo-user.PNG diff --git a/docs/release-notes.rst b/docs/release-notes.rst index b151888..1b1ea24 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -25,7 +25,7 @@ Version history | 2019-11-12 | 0.1.0 | Rohan Patel (AT&T) | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | +| 2020-06-16 | 0.1.2 | Jackie Chen (AT&T) | new VTH development| | | | | | +--------------------+--------------------+--------------------+--------------------+ | | 1.0 | | | @@ -36,8 +36,15 @@ Version history Summary ------- -This release will include the initial commit of the OTF platform code. Applications include otf-frontend, otf-service-api, otf-camunda, and several virtual test head microservices (ping, ssh, robot, ric). In addition setup documentation and installation guides are included to build docker containers and helm charts for deployment. +This release(0.1.2) will include new VTHs that were developed for oran community.The following are VTHs were developed: + - dmaap + - A1-mediator + - smo-o1 + - SDNC + - A1-policy-manager + +Most of the vth were built according to health-check use cases(Workflow #2,#3,#4) via: https://wiki.o-ran-sc.org/display/RSAC/Health-Check+Use+Case @@ -52,13 +59,13 @@ Release Data | **Repo/commit-ID** | it/otf | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | E.g. Arno RC2 | +| **Release designation** | Bronze | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | E.g. 2015-04-16 | +| **Release date** | 2020-06-16 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | +| **Purpose of the delivery** | update repo with VTHs | | | | +--------------------------------------+--------------------------------------+ @@ -75,25 +82,7 @@ Feature Additions | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| INT-34 | Contribute OTF seed code to Linux | -| | Foundation | -+--------------------------------------+--------------------------------------+ -| INT-35 | Deploy one operational OTF instance | -| | in O-RAN SC lab | -+--------------------------------------+--------------------------------------+ -| INT-36 | Develop one VTH | -| | | -+--------------------------------------+--------------------------------------+ -| INT-37 | Create one test strategy for | -| | End-to-End Integration/Demo | -+--------------------------------------+--------------------------------------+ -| INT-38 | Create one test instance | | | | -+--------------------------------------+--------------------------------------+ -| INT-39 | Demonstrate OTF test execution | -| | | -+--------------------------------------+--------------------------------------+ -| INT-40 | Documentation OTF and education | | | | +--------------------------------------+--------------------------------------+ @@ -156,8 +145,33 @@ otf-service-api: otf-sst-test-head: - VTH that enables ssh capability to remote server - +dmaap-vth: + - VTH used to subscribe and publish topics/message via dmaap api + +a1-mediator-vth: + - VTH used to communicate with A1-mediator + - Built according to: https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt/a1.git;a=blob;f=a1/openapi.yaml + - Functionality includes: + - health-check on A1 + - list registered policy types + - GET,DELETE,PUT policy types + - list policy instance + - GET,DELETE,PUT policy instance + - Retrieve policy instance status + +smo-o1-vth: + - Performs health checks to verify that O1 interface is alive by getting alarm list + +a1-policy-manager-vth: + - Used to communicate with A1 policy management service api + - Built according to: https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/policy-agent-api.html#policy-agent-api + - Has all functionality that is available in the above link. The vth will require the action and method necessary information e.g. query values and json data and forward the request to the service + +a1-sdnc-vth: + - Used to communicate with SDNC A1 Controller api + - built according to: https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/sdnc-a1-controller-api.html + - Has all functionality that is available in the above link. The vth will require the action and method necessary information e.g. query values and json data and forward the request to the service Instructions on how to build and run these applications can be found in the otf-installation.txt file located in the it/otf repository. diff --git a/otf-helm/otf/Chart.yaml b/otf-helm/otf/Chart.yaml index d1eda9c..4a2cd62 100644 --- a/otf-helm/otf/Chart.yaml +++ b/otf-helm/otf/Chart.yaml @@ -18,4 +18,4 @@ version: 1.0 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. -appVersion: Camille.2.1 +appVersion: 0.0.1 diff --git a/otf-helm/otf/values/values.yaml b/otf-helm/otf/values/values.yaml new file mode 100644 index 0000000..fa8e91e --- /dev/null +++ b/otf-helm/otf/values/values.yaml @@ -0,0 +1,65 @@ +# Default values for otf. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +shared: &shared + httpProxy: "!" + httpsProxy: "!" + namespace: dev + proxyUrl: "!" + proxyPort: "!" + nodeApi: + url: "!" + host: "!" + +global: + + mongodb: &mongodb + <<: *shared + appName: mongodb + version: 0.0.1 + replicas : 1 + mongodbRootPassword: "!" + mongodbUsername: "!" + mongodbPassword: "!" + mongodbDatabase: otf + port: "!" + targetPort: "!" + image: + registry: docker.io + repository: bitnami/mongodb + tag: 4.2.6-debian-10-r18 + pullPolicy: IfNotPresent + debug: false + resources: + limits: + memory: "500Mi" + cpu: "1" + requests: + memory: "256Mi" + cpu: "1" + + mysqldb: &mysqldb + <<: *shared + appName: mysqldb + version: 0.0.1 + replicas : 1 + mysqlRootPassword: "!" + mysqlUser: "!" + mysqlPassword: "!" + mysqlDatabase: otf_camunda + port: 3306 + targetPort: 8306 + image: + registry: docker.io + image: mysql + tag: 5.7.26 + pullPolicy: IfNotPresent + debug: false + resources: + limits: + memory: "500Mi" + cpu: "1" + requests: + memory: "256Mi" + cpu: "1" diff --git a/smo-o1-vth/helm/o1-vth/values.yaml b/smo-o1-vth/helm/o1-vth/values.yaml index 012a940..44d602e 100644 --- a/smo-o1-vth/helm/o1-vth/values.yaml +++ b/smo-o1-vth/helm/o1-vth/values.yaml @@ -12,7 +12,7 @@ pvc: prod: org-oran-otf-prod-logs-pv HTTP: "[Your HTTP PROXY HERE]" HTTPS: "[Your HTTPS PROXY HERE]" -BASE_URL: http://sdn-r-dev.open5g-test.com +BASE_URL: "base url for health check" credentials: username: "!" password: "!"