diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.rst | 90 | ||||
| -rw-r--r-- | docs/exprimantle.rst | 18 | ||||
| -rw-r--r-- | docs/genericdesignerintegration.rst | 14 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/installation.rst | 3 | ||||
| -rw-r--r-- | docs/logging.rst | 30 | ||||
| -rw-r--r-- | docs/release-notes.rst | 79 | ||||
| -rw-r--r-- | docs/workflow.rst | 15 |
8 files changed, 209 insertions, 42 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index 4c011631e2..7f4c635969 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -23,14 +23,9 @@ environment.json # Environment description "description": "OpenSource-xxx", - - # Chef properties - "cookbook_versions": { - "Deploy-SDandC": "= 1.0.0" - }, "json_class": "Chef::Environment", "chef_type": "environment", - + "default_attributes": { "disableHttp": false, # IPs used for docker configuration @@ -50,13 +45,10 @@ environment.json # Configuration parameters used in portal properties "ECompP": { "ecomp_rest_url": "http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/auxapi", - "ueb_url_list": "10.0.11.1,10.0.11.1", - "app_secret": "XftIATw9Jr3VzAcPqt3NnJOu", - "app_key": "x9UfO7JsDn8BESVX", - "inbox_name": "ECOMP-PORTAL-INBOX", "ecomp_redirect_url": "http://portal.api.simpledemo.openecomp.org:8989/ECOMPPORTAL/login.htm", - "app_topic_name": "ECOMP-PORTAL-OUTBOX-SDC1", - "decryption_key": "AGLDdG4D04BKm2IxIWEr8o==" + "cipher_key": "AGLDdG4D04BKm2IxIWEr8o==", + "portal_user": "Ipwxi2oLvDxctMA1royaRw1W0jhucLx+grHzci3ePIA=", + "portal_pass": "j85yNhyIs7zKYbR1VlwEfNhS6b7Om4l0Gx5O8931sCI=" }, # Configuration parameters used by SDC to work with Dmaap @@ -125,6 +117,7 @@ environment.json "cassandra_password": "Aa1234%^!", "concurrent_writes": "32", "cluster_name": "SDC-CS-", + "datacenter_name": "SDC-CS-", "multithreaded_compaction": "false", "cache_dir": "/var/lib/cassandra/saved_caches", "log_file": "/var/lib/cassandra/log/system.log", @@ -231,6 +224,8 @@ BE-configuration.yaml file: groups.yml - policies: file: policies.yml + - annotations: + file: annotations.yml # Users # Deprecated. Will be removed in future releases @@ -338,6 +333,7 @@ BE-configuration.yaml - CP - VL - VF + - CR - VFCMT - Abstract - CVFC @@ -391,7 +387,7 @@ BE-configuration.yaml # Resource type to exclude excludeResourceType: - PNF - + - CR # Informational resource artifacts placeHolder # For each artifact the following properties exists: # @@ -528,6 +524,9 @@ BE-configuration.yaml MODEL_QUERY_SPEC: acceptedTypes: - xml + UCPE_LAYER_2_CONFIGURATION: + acceptedTypes: + - xml #AAI Artifacts AAI_SERVICE_MODEL: @@ -539,6 +538,9 @@ BE-configuration.yaml AAI_VF_INSTANCE_MODEL: acceptedTypes: - xml + UCPE_LAYER_2_CONFIGURATION: + acceptedTypes: + - xml OTHER: acceptedTypes: @@ -546,7 +548,8 @@ BE-configuration.yaml PLAN: acceptedTypes: - xml - + WORKFLOW: + acceptedTypes: # Resource deployment artifacts placeHolder # For each artifact the following properties exists: # @@ -677,6 +680,8 @@ BE-configuration.yaml validForResourceTypes: - VF - VFC + WORKFLOW: + acceptedTypes: # Resource instance deployment artifacts placeHolder # For each artifact the following properties exists: @@ -768,6 +773,7 @@ BE-configuration.yaml - CP - VL - VF + - CR - VFCMT - Abstract - PNF @@ -831,7 +837,7 @@ BE-configuration.yaml # Url for onboarding health check healthCheckUri: "/onboarding-api/v1.0/healthcheck" - + dcae: # The ip of the onboarding docker host: <%= @dcae_be_vip %> @@ -976,6 +982,10 @@ BE-configuration.yaml - org.openecomp.groups.VfModule - org.openecomp.groups.heat.HeatStack - tosca.groups.Root + PNF: + - org.openecomp.groups.VfModule + - org.openecomp.groups.heat.HeatStack + - tosca.groups.Root VF: - org.openecomp.groups.VfModule - org.openecomp.groups.heat.HeatStack @@ -987,7 +997,7 @@ BE-configuration.yaml healthStatusExclude: - DE - - DMAPP + - DMAAP - DCAE @@ -1350,6 +1360,54 @@ FE-configuration.yaml # Kibana usage protocol kibanaProtocol: http +FE-plugins-configuration.yaml +***************************** +:: + + # defnition of the plugins that exist in sdc + # we have a pre defined list of plugins that are conected to the system. + # the plugins define where they are shown to who and on what elements + pluginsList: + # the DCAE-DS is the SDC monitoring design studio this entry defines there use as part of the service level context + - pluginId: DCAED + # this defines from which url to chek that they are available + pluginDiscoveryUrl: <%= @dcae_discovery_url %> + # this defines from wht URL will ther you be served. + pluginSourceUrl: <%= @dcae_source_url %> + #thsi defines the plugin state name used by the UI for sending messages. + pluginStateUrl: "dcaed" + # the display options for the plugin + pluginDisplayOptions: + # the plugin will be displayed in the context of a catalog item + context: + # what will the option tag in the ui will be called + displayName: "Monitoring" + # under what catalog item to display it + displayContext: ["SERVICE"] + # what user roles will have the option to access the plugin + displayRoles: ["DESIGNER"] + # DCAE-DS as a tab + - pluginId: DCAE-DS + pluginDiscoveryUrl: <%= @dcae_dt_discovery_url %> + pluginSourceUrl: <%= @dcae_dt_source_url %> + pluginStateUrl: "dcae-ds" + pluginDisplayOptions: + tab: + displayName: "DCAE-DS" + displayRoles: ["DESIGNER"] + #work flow plugin + - pluginId: WORKFLOW + pluginDiscoveryUrl: <%= @workflow_discovery_url %> + pluginSourceUrl: <%= @workflow_source_url %> + pluginStateUrl: "workflowDesigner" + pluginDisplayOptions: + tab: + displayName: "WORKFLOW" + displayRoles: ["DESIGNER", "TESTER"] + + # how long we will wai for the plugin to respond before cuting it. + connectionTimeout: 1000 + Onboarding configuration ------------------------ diff --git a/docs/exprimantle.rst b/docs/exprimantle.rst deleted file mode 100644 index 3976661843..0000000000 --- a/docs/exprimantle.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -========================= -SDC Experimental features -========================= - - -DCAE-D -============= - - - -WORKFLOW -===================== - - - diff --git a/docs/genericdesignerintegration.rst b/docs/genericdesignerintegration.rst new file mode 100644 index 0000000000..5a717f4d32 --- /dev/null +++ b/docs/genericdesignerintegration.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======== +Generic Designer Integration +======== + +plugable Architecture +================================ + +SDC has been working on opening the application to allow an easy integration for any designer explanations. +the current definitions and explanations are located here. + +`Generic Designer Support <https://wiki.onap.org/display/DW/Generic+Designer+Support/>`_ diff --git a/docs/index.rst b/docs/index.rst index ede5533d3e..5caea8acf5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,8 +13,10 @@ SDC Documentation offeredapis.rst delivery.rst humaninterfaces.rst + genericdesignerintegration.rst installation.rst logging.rst release-notes.rst sdcsdks.rst dcaedesigner.rst + workflow.rst diff --git a/docs/installation.rst b/docs/installation.rst index 612a97453e..960ae05adf 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -15,6 +15,9 @@ For local deployment SDC offers two options: - `Deploying SDC on a Linux VM for Development <https://wiki.onap.org/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development>`_ - `Using Vagrant-Onap for local deployment of SDC project <https://wiki.onap.org/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development>`_ +Colection of commends used in deploying and monitoring sdc in OOM +- `SDC on OOM <https://wiki.onap.org/display/DW/SDC+on+OOM>`_ + SDC troubleshooting: diff --git a/docs/logging.rst b/docs/logging.rst index 8c1bd11847..5fa0532697 100644 --- a/docs/logging.rst +++ b/docs/logging.rst @@ -11,6 +11,8 @@ the logs for the application are available in the docker itself at /var/lib/jett 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. +In the OOM deployment the log location in the docker is /var/log/onap + +-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | Server | Location | Type | Description | Rolling | @@ -44,6 +46,34 @@ In OOM you can use the logging project to access the logging collected from the | | | | This log holds all the logging output of the application. | | +-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +Changing log level +--------------------------- +SDC uses logback for logging. +in order to change the level you will need to acses the docker. +in it update the logback.xml according to your need, the change does not requir a restart to the docker. + +to change the level for all logs, change the following value: + +:: + + <root level="INFO"> + + +to change the level for logs of some specific packages, change the following value: + +:: + + <logger level="INFO" name="org.openecomp.sdc" /> + + +to agregate all the logs level into a single log file called all.log change the foloing property to true: + +:: + + <property name="enable-all-log" scope="context" value="false" /> + + + Error / Warning Messages ------------------------ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 08adeedff2..20e4892269 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -4,6 +4,69 @@ Release Notes ============= +Version: 1.3.5 +============== + +:Release Date: 2018-11-30 + +`Link to README <https://github.com/onap/sdc>`__ + +SDC SDKs Versions +----------------- + +- sdc-distribution-client + :Version: 1.3.0 +- sdc-tosca + :Version: 1.4.7 + + `Link to README <https://github.com/onap/sdc-sdc-tosca>`__ + +Release Purpose +---------------- +The Casablanca release was focused on improving platform stability and resiliency and introducing now platform capabilities. + +**New Features** + +The Casablanca release is the third release of the Service Design and Creation (SDC). + +The main goal of the Casablanca release was to: + - Improve code coverage of the SDC code. + - Complete E2E workflow design and distribution. + - Finalize DCAE-DS and integrate it with OOM + - Support HPA + - Security enchantments + + +Security Notes +-------------- + +SDC code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SDC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307823>`_. + +Quick Links: + +- `SDC project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592847>`_ +- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1629>`_ +- `Project Vulnerability Review Table for SDC <https://wiki.onap.org/pages/viewpage.action?pageId=45307823>`_ + +**Known Issues** + +- [`SDC-1958 <https://jira.onap.org/browse/SDC-1958>`__\ ] - SDC Parser can not be used for CCVPN Templates. +- [`SDC-1955 <https://jira.onap.org/browse/SDC-1955>`__\ ] - SDC distribution failed + +**Upgrade Notes** + + N/A + +**Deprecation Notes** + + N/A + +**Other** + + N/A + + + Version: 1.2.0 ============== @@ -16,9 +79,9 @@ SDC SDKs Versions :Version: 1.3.0 -- sdc-tosca + - sdc-tosca - :Version: 1.3.5 + :Version: 1.3.5 Release Purpose ---------------- @@ -446,13 +509,13 @@ Workflow information is available in readthedocs Security Notes -------------- -SDC code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SDC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377537>`_. +SDC code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SDC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377537>`__. Quick Links: -- `SDC project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592847>`_ -- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1629>`_ -- `Project Vulnerability Review Table for SDC <https://wiki.onap.org/pages/viewpage.action?pageId=28377537>`_ +- `SDC project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592847>`__ +- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1629>`__ +- `Project Vulnerability Review Table for SDC <https://wiki.onap.org/pages/viewpage.action?pageId=28377537>`__ **Known Issues** @@ -483,9 +546,9 @@ SDC SDKs Versions :Version: 1.1.32 -- sdc-tosca + - sdc-tosca - :Version: 1.1.32 + :Version: 1.1.32 Release Purpose diff --git a/docs/workflow.rst b/docs/workflow.rst new file mode 100644 index 0000000000..a0d598dda1 --- /dev/null +++ b/docs/workflow.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +===================== +SDC Workflow Designer +===================== + +README +------- + +the readme file for the workflow is available `here <https://github.com/onap/sdc-sdc-workflow-designer>`__ + +Documentation +------------- +architecture and User guides are available `here <https://wiki.onap.org/display/DW/SDC-WORKFLOW>`__
\ No newline at end of file |