aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorseshukm <seshu.kumar.m@huawei.com>2018-10-03 20:35:52 +0800
committerMichael Lando <michael.lando@intl.att.com>2018-10-08 06:42:43 +0000
commit86b2f6d9686b15c8a3ec77184ec9545f6aecdc62 (patch)
tree18e30c91a7d58e5279baea3426f4ca8657eda4eb
parentc31b73a86a38ab45fa833016a18637f6431918db (diff)
Correct the incorrect
Change-Id: I6b436d9babbe8ebff17fefc5126d7948fedc20a7 Issue-ID: SDC-1770 Signed-off-by: seshukm <seshu.kumar.m@huawei.com>
Diffstat
-rw-r--r--docs/configuration.rst4
-rw-r--r--docs/consumedapis.rst2
-rw-r--r--docs/delivery.rst2
-rw-r--r--docs/logging.rst40
-rw-r--r--docs/release-notes.rst28
-rw-r--r--docs/sdcsdks.rst6
6 files changed, 41 insertions, 41 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst
index f1d3eb6d7d..691922e178 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -283,7 +283,7 @@ BE-configuration.yaml
# Mapping of index prefix to time-based frame. For example, if below is configured:
#
- # - indexPrefix: auditingevents
+ # - indexPrefix: auditing events
# creationPeriod: minute
#
# then ES object of type which is mapped to "auditingevents-*" template, and created on 2015-12-23 13:24:54, will enter "auditingevents-2015-12-23-13-24" index.
@@ -882,7 +882,7 @@ BE-configuration.yaml
waitOnShutDownInMinutes: 10
numberOfCacheWorkers: 4
- # Validators for tosca properties
+ # Validators for Tosca properties
toscaValidators:
stringMaxLength: 2500
diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst
index 5da13fbf3c..4fe7852e95 100644
--- a/docs/consumedapis.rst
+++ b/docs/consumedapis.rst
@@ -17,6 +17,6 @@ SDC allows the user to choose packages from VNF-SDK and start the onboarding fro
* - URL
- Description
* - /onapapi/vnfsdk-marketplace/v1/PackageResource/csars
- - get all avilable csar pckage data
+ - get all available csar package data
* - /onapapi/vnfsdk-marketplace/v1/PackageResource/csars/{id}/files
- Download CSAR by id \ No newline at end of file
diff --git a/docs/delivery.rst b/docs/delivery.rst
index bdeda93966..23f951bc8e 100644
--- a/docs/delivery.rst
+++ b/docs/delivery.rst
@@ -40,7 +40,7 @@ Below is a diagram of the SDC project docker containers and the connections betw
sdc-ui-sanity -> sdc-frontend;
group deploy_group {
color = green;
- label = "Aplication Layer"
+ label = "Application Layer"
sdc-backend; sdc-onboarding-backend; sdc-kibana; sdc-frontend;sdc-elasticsearch; sdc-cassandra; sdc-cassandra-Config; sdc-elasticsearch-config; sdc-backend-config; sdc-onboarding-init;
}
group testing_group {
diff --git a/docs/logging.rst b/docs/logging.rst
index 1eb68c2c69..a1e3a659c0 100644
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -8,8 +8,8 @@ Logging
Where to Access Information
---------------------------
the logs for the application are available in the docker it self at /var/lib/jetty/logs/
-in Heat deployment the dockers are maped into /data/logs on the vm where the application is running.
-In OOM you can use the logging project to accses the logging collected from the applications.
+in Heat deployment the dockers are mapped into /data/logs on the vm where the application is running.
+In OOM you can use the logging project to access the logging collected from the applications.
+-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
@@ -17,29 +17,29 @@ In OOM you can use the logging project to accses the logging collected from the
+===============================+==========================================+=====================+===========================================================================================================================================================================================+=====================+
| BE catalog and onboarding | /data/logs/BE/2017_03_10.stderrout.log | Jetty server log | The log describes info regarding Jetty startup and execution | the log rolls daily |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/audit.log | application audit | An audit record is created for each operation in SDC | rolls at 20 mb |
+| | /data/logs/BE/SDC/SDC-BE/audit.log | application audit | An audit record is created for each operation in SDC | rolls at 20 MB |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb |
+| | /data/logs/BE/SDC/SDC-BE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 MB |
| | | | The file is located under:,config/catalog-be/logback.xml. | |
| | | | This log holds the debug and trace level output of the application. | |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/error.log | application logging | This log holds the info and error level output of the application. | rolls at 20 mb |
+| | /data/logs/BE/SDC/SDC-BE/error.log | application logging | This log holds the info and error level output of the application. | rolls at 20 MB |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use. will be used in future relases. | rolls at 20 mb |
+| | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use. will be used in future releases. | rolls at 20 MB |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/all.log | application logging | On demand, we can enable log aggregation into one file for easier debugging. This is done by editing the logback.xml inside the server docker. | rolls at 20 mb |
+| | /data/logs/BE/SDC/SDC-BE/all.log | application logging | On demand, we can enable log aggregation into one file for easier debugging. This is done by editing the logback.xml inside the server docker. | rolls at 20 MB |
| | | | The file is located under:,config/catalog-be/logback.xml. | |
| | | | To allow this logger, set the value for this property to true This log holds all logging output of the application. | |
+-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
| FE | /data/logs/FE/2017_03_10.stderrout.log | Jetty server log | The log describes info regarding the Jetty startup and execution | the log rolls daily |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/FE/SDC/SDC-FE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb |
+| | /data/logs/FE/SDC/SDC-FE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 MB |
| | | | The file is located,under: config/catalog-fe/logback.xml. | |
| | | | This log holds the debug and trace level output of the application. | |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/FE/SDC/SDC-FE/error.log | application logging | This log holds the Info and Error level output of the application. | rolls at 20 mb |
+| | /data/logs/FE/SDC/SDC-FE/error.log | application logging | This log holds the Info and Error level output of the application. | rolls at 20 MB |
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/FE/SDC/SDC-FE/all.log | application logging | On demand we can enable log aggregation into one file for easier debuging, by editing the logback.xml inside the server docker.The file is located under: config/catalog-fe/logback.xml. | rolls |
+| | /data/logs/FE/SDC/SDC-FE/all.log | application logging | On demand we can enable log aggregation into one file for easier debugging, by editing the logback.xml inside the server docker.The file is located under: config/catalog-fe/logback.xml. | rolls |
| | | | To allow this logger set this property to true | |
| | | | This log holds all the logging output of the application. | |
+-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
@@ -48,7 +48,7 @@ In OOM you can use the logging project to accses the logging collected from the
Error / Warning Messages
------------------------
-Respone Types
+Response Types
=============
::
@@ -159,7 +159,7 @@ Respone Types
---------SVC4003------------------------------
==============================================
-- %1 - Users's ID
+- %1 - User's ID
::
@@ -172,7 +172,7 @@ Respone Types
---------SVC4004-----------------------------
=============================================
-- %1 - Users's email address
+- %1 - User's email address
::
@@ -198,7 +198,7 @@ Respone Types
---------SVC4006------------------------------
==============================================
-- %1 - Users's USER_ID
+- %1 - User's USER_ID
::
@@ -222,7 +222,7 @@ Respone Types
---------SVC4008-----------------------------
=============================================
-- %1 - Users's USER_ID
+- %1 - User's USER_ID
::
@@ -958,7 +958,7 @@ Respone Types
- %1-resource/service
- %2-artifact/artifacts
-- %3-semicolomn separated list of artifact
+- %3-semicolon separated list of artifact
::
@@ -1403,7 +1403,7 @@ Respone Types
ADDITIONAL_INFORMATION_VALUE_NOT_ALLOWED_CHARACTERS: {
code: 400,
- message: 'Error: Invalid Content. Additional information contains non-english characters.',
+ message: 'Error: Invalid Content. Additional information contains non-English characters.',
messageId: "SVC4525"
}
@@ -2093,7 +2093,7 @@ Respone Types
==============================================
- %1 - Product
-- %2 - Aabbreviated/Full"
+- %2 - Abbreviated/Full"
::
@@ -2624,7 +2624,7 @@ Respone Types
FAILED_RETRIVE_ARTIFACTS_TYPES: {
code: 400,
- message: "Error: Failed to retrieve list of suported artifact types.",
+ message: "Error: Failed to retrieve list of supported artifact types.",
messageId: "SVC4620"
}
@@ -3252,7 +3252,7 @@ Respone Types
INVALID_SERVICE_TYPE: {
code: 400,
- message: 'Error: Invalid Content. Serivce type is not allowed to contain characters like <>:"\/|?* and space characters other than regular space.',
+ message: 'Error: Invalid Content. Service type is not allowed to contain characters like <>:"\/|?* and space characters other than regular space.',
messageId: "SVC4666"
}
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index fe24f76463..08adeedff2 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -111,7 +111,7 @@ Workflow information is available in readthedocs
- [`SDC-686 <https://jira.onap.org/browse/SDC-686>`__\ ] - code sync
- [`SDC-687 <https://jira.onap.org/browse/SDC-687>`__\ ] - sdc designer integration part 1
- [`SDC-712 <https://jira.onap.org/browse/SDC-712>`__\ ] - import normative superation
-- [`SDC-713 <https://jira.onap.org/browse/SDC-713>`__\ ] - Amsterdam branch
+- [`SDC-713 <https://jira.onap.org/browse/SDC-713>`__\ ] - amsterdam branch
- [`SDC-728 <https://jira.onap.org/browse/SDC-728>`__\ ] - sdc designer integration part 2
- [`SDC-732 <https://jira.onap.org/browse/SDC-732>`__\ ] - sdc designer integration part 3
- [`SDC-740 <https://jira.onap.org/browse/SDC-740>`__\ ] - converter support IntermediateCatchEvent
@@ -166,7 +166,7 @@ Workflow information is available in readthedocs
- [`SDC-952 <https://jira.onap.org/browse/SDC-952>`__\ ] - update SDC-DISTRIBUTION-CLIENT packages
- [`SDC-953 <https://jira.onap.org/browse/SDC-953>`__\ ] - update SDC-DOCKER-BASE packages
- [`SDC-954 <https://jira.onap.org/browse/SDC-954>`__\ ] - update SDC-TITAN-CASSANDRA packages
-- [`SDC-955 <https://jira.onap.org/browse/SDC-955>`__\ ] - configuration overriding capabilities.
+- [`SDC-955 <https://jira.onap.org/browse/SDC-955>`__\ ] - configuration ovriding capabilities.
- [`SDC-957 <https://jira.onap.org/browse/SDC-957>`__\ ] - add ignore conformance level option
- [`SDC-969 <https://jira.onap.org/browse/SDC-969>`__\ ] - sync1802E to ONAP part 1
- [`SDC-972 <https://jira.onap.org/browse/SDC-972>`__\ ] - sdc designer integration part 4 design alignment
@@ -201,9 +201,9 @@ Workflow information is available in readthedocs
- [`SDC-1131 <https://jira.onap.org/browse/SDC-1131>`__\ ] - Use Extend Activities to Design Workflow and Save
- [`SDC-1164 <https://jira.onap.org/browse/SDC-1164>`__\ ] - SDC designer Integration part 8 - Add promise logic to the SDC pub-sub notify
- [`SDC-1165 <https://jira.onap.org/browse/SDC-1165>`__\ ] - SDC designer Integration part 9 - Create component that disables selected layouts
-- [`SDC-1169 <https://jira.onap.org/browse/SDC-1169>`__\ ] - CII passing bage
+- [`SDC-1169 <https://jira.onap.org/browse/SDC-1169>`__\ ] - CII passing badge
- [`SDC-1172 <https://jira.onap.org/browse/SDC-1172>`__\ ] - reach 50% unit test coverage sdc workflow
-- [`SDC-1174 <https://jira.onap.org/browse/SDC-1174>`__\ ] - Support unified Tosca pattern 1C2 for vlan sub-interface
+- [`SDC-1174 <https://jira.onap.org/browse/SDC-1174>`__\ ] - Support unified Tosca pattern 1C2 for vlan subinterface
- [`SDC-1197 <https://jira.onap.org/browse/SDC-1197>`__\ ] - Enhance SDC Parser to support Interface and Operations
- [`SDC-1221 <https://jira.onap.org/browse/SDC-1221>`__\ ] - Fix library CVEs in sdc-cassandra
- [`SDC-1310 <https://jira.onap.org/browse/SDC-1310>`__\ ] - Fix additional library CVEs in sdc-docker-base
@@ -232,7 +232,7 @@ Workflow information is available in readthedocs
- [`SDC-434 <https://jira.onap.org/browse/SDC-434>`__\ ] - Healing should be added to the resubmitAll utility REST
- [`SDC-438 <https://jira.onap.org/browse/SDC-438>`__\ ] - Unable to Access SDC from Portal
- [`SDC-440 <https://jira.onap.org/browse/SDC-440>`__\ ] - When creating a new VSP "HSS_FE_test_100617", HEAT validation failed with 2 errors
-- [`SDC-458 <https://jira.onap.org/browse/SDC-458>`__\ ] - Onboard questionnaire-component missing enum AIC
+- [`SDC-458 <https://jira.onap.org/browse/SDC-458>`__\ ] - Onboard questionaire-component missing enum AIC
- [`SDC-459 <https://jira.onap.org/browse/SDC-459>`__\ ] - Month navigation does not work in firefox
- [`SDC-466 <https://jira.onap.org/browse/SDC-466>`__\ ] - Submit failed for existing VSP "Nimbus 3.1 PCRF 0717"
- [`SDC-468 <https://jira.onap.org/browse/SDC-468>`__\ ] - add check for flat node type, in case of port mirroring
@@ -305,7 +305,7 @@ Workflow information is available in readthedocs
- [`SDC-773 <https://jira.onap.org/browse/SDC-773>`__\ ] - SDC Import Export Executors should be supported.
- [`SDC-774 <https://jira.onap.org/browse/SDC-774>`__\ ] - fix parameter value check in vm grouping
- [`SDC-776 <https://jira.onap.org/browse/SDC-776>`__\ ] - Sonar coverage drop onboarding
-- [`SDC-777 <https://jira.onap.org/browse/SDC-777>`__\ ] - sonar scan alignment
+- [`SDC-777 <https://jira.onap.org/browse/SDC-777>`__\ ] - sonar scan alignement
- [`SDC-792 <https://jira.onap.org/browse/SDC-792>`__\ ] - Add a private constructor to hide the implicit public one to ConfigurationUtils
- [`SDC-811 <https://jira.onap.org/browse/SDC-811>`__\ ] - Assign Mib to Component
- [`SDC-830 <https://jira.onap.org/browse/SDC-830>`__\ ] - Broken mapping of ChoiceOrOther because of missing default constructor
@@ -393,7 +393,7 @@ Workflow information is available in readthedocs
- [`SDC-1239 <https://jira.onap.org/browse/SDC-1239>`__\ ] - ui-attachments-page-bug-fix
- [`SDC-1241 <https://jira.onap.org/browse/SDC-1241>`__\ ] - SDC-BE pod started but it's responding with 503 HTTP code
- [`SDC-1244 <https://jira.onap.org/browse/SDC-1244>`__\ ] - Issue in healing zusammen MainTool
-- [`SDC-1245 <https://jira.onap.org/browse/SDC-1245>`__\ ] - jenkins relase jobs are failing
+- [`SDC-1245 <https://jira.onap.org/browse/SDC-1245>`__\ ] - jenkins release jobs are failing
- [`SDC-1247 <https://jira.onap.org/browse/SDC-1247>`__\ ] - SDC tester page hangs when clicking on Accept button
- [`SDC-1248 <https://jira.onap.org/browse/SDC-1248>`__\ ] - support 5 digit port number
- [`SDC-1249 <https://jira.onap.org/browse/SDC-1259>`__\ ] - not able to get the value fromProperty node
@@ -426,13 +426,13 @@ Workflow information is available in readthedocs
- [`SDC-1309 <https://jira.onap.org/browse/SDC-1309>`__\ ] - SDC fails health check on HEAT deployment
- [`SDC-1315 <https://jira.onap.org/browse/SDC-1315>`__\ ] - Nested Dependency Issue
- [`SDC-1321 <https://jira.onap.org/browse/SDC-1321>`__\ ] - Catalog Docker swagger not loading
-- [`SDC-1328 <https://jira.onap.org/browse/SDC-1328>`__\ ] - plugin Iframe changes size on WINDOW_OUT event to composition page
+- [`SDC-1328 <https://jira.onap.org/browse/SDC-1328>`__\ ] - plug-in Iframe changes size on WINDOW_OUT event to composition page
- [`SDC-1329 <https://jira.onap.org/browse/SDC-1329>`__\ ] - Warning in generated CSAR
- [`SDC-1332 <https://jira.onap.org/browse/SDC-1332>`__\ ] - Enable VNF market place in sdc deployment
- [`SDC-1336 <https://jira.onap.org/browse/SDC-1336>`__\ ] - SDC service category missing Network Service and E2E Service types
- [`SDC-1337 <https://jira.onap.org/browse/SDC-1337>`__\ ] - Unexpected entry for interfaces + interface_types when no operation is defined
- [`SDC-1341 <https://jira.onap.org/browse/SDC-1341>`__\ ] - SDC-DMAAP connection fails in multi-node cluster
-- [`SDC-1347 <https://jira.onap.org/browse/SDC-1347>`__\ ] - Wrap plugins API call in a promise to prevent loading issues of SDC UI
+- [`SDC-1347 <https://jira.onap.org/browse/SDC-1347>`__\ ] - Wrap plug-ins API call in a promise to prevent loading issues of SDC UI
- [`SDC-1349 <https://jira.onap.org/browse/SDC-1349>`__\ ] - Filter By vendor view - list of vsp is not closed
- [`SDC-1351 <https://jira.onap.org/browse/SDC-1351>`__\ ] - Viewer can archive and restore
- [`SDC-1352 <https://jira.onap.org/browse/SDC-1352>`__\ ] - SDC service design Properties Assignment page doesn't function properly
@@ -627,7 +627,7 @@ New Features
- [`SDC-232 <https://jira.onap.org/browse/SDC-232>`__\ ] - Import TOSCA
YAML CSAR - BE
- [`SDC-240 <https://jira.onap.org/browse/SDC-240>`__\ ] - WorkFlow
- Designer seed code
+ Deisigner seed code
- [`SDC-248 <https://jira.onap.org/browse/SDC-248>`__\ ] - add verify
job for workflow-designer in ci-manager
- [`SDC-255 <https://jira.onap.org/browse/SDC-255>`__\ ] - support add
@@ -647,7 +647,7 @@ New Features
- [`SDC-295 <https://jira.onap.org/browse/SDC-295>`__\ ] - delete node
or connection by keyboard
- [`SDC-299 <https://jira.onap.org/browse/SDC-299>`__\ ] - Port
- mirorring
+ mirroring
- [`SDC-306 <https://jira.onap.org/browse/SDC-306>`__\ ] - Replace
Dockefiles with new baselines
- [`SDC-318 <https://jira.onap.org/browse/SDC-318>`__\ ] - Provide
@@ -673,7 +673,7 @@ New Features
- [`SDC-476 <https://jira.onap.org/browse/SDC-476>`__\ ] - add sonar
branch to sdc project pom
- [`SDC-481 <https://jira.onap.org/browse/SDC-481>`__\ ] - update
- swager
+ swagger
- [`SDC-498 <https://jira.onap.org/browse/SDC-498>`__\ ] - Support and
align CSAR's for VOLTE
- [`SDC-506 <https://jira.onap.org/browse/SDC-506>`__\ ] - Fill SDC
@@ -682,7 +682,7 @@ New Features
- [`SDC-521 <https://jira.onap.org/browse/SDC-521>`__\ ] - CSIT and
sanity stabilization
- [`SDC-522 <https://jira.onap.org/browse/SDC-522>`__\ ] - sync 1710
- defacts into ONAP
+ defects into ONAP
- [`SDC-586 <https://jira.onap.org/browse/SDC-586>`__\ ] - Support and
align CSAR's for VOLTE
- [`SDC-594 <https://jira.onap.org/browse/SDC-594>`__\ ] - Fill SDC
@@ -756,7 +756,7 @@ Bug Fixes
SDC distributions failing in ORD - Add Software Product - Status 500
- [`SDC-363 <https://jira.onap.org/browse/SDC-363>`__\ ] - data convert
error for tree node
-- [`SDC-369 <https://jira.onap.org/browse/SDC-369>`__\ ] - invalide tag
+- [`SDC-369 <https://jira.onap.org/browse/SDC-369>`__\ ] - invalid tag
defined for docker
- [`SDC-375 <https://jira.onap.org/browse/SDC-375>`__\ ] - Onboarding
build time
diff --git a/docs/sdcsdks.rst b/docs/sdcsdks.rst
index f428c3531f..d35ce4d5e8 100644
--- a/docs/sdcsdks.rst
+++ b/docs/sdcsdks.rst
@@ -31,11 +31,11 @@ SDC-TITAN-CASSANDRA
| This is a link to the github page of titan project for extra reading regarding Titan DB: `<https://github.com/thinkaurelius/titan>`_
|
-| SDC forked part of the project to overide the default Titan configuration for Cassandra.
-| The change allows the use of Titan as an active pasive deployment for geo redudndency.
+| SDC forked part of the project to override the default Titan configuration for Cassandra.
+| The change allows the use of Titan as an active passive deployment for geo-redundancy.
|
| Titan by default uses QUORUM in Cassandra on write and read operations.
-| Using our change allows the use of local QUORUM to read and write only to a spacific data center.
+| Using our change allows the use of local QUORUM to read and write only to a specific data center.
| Since the project is in end of life state the change cannot be merged back to the project.