diff options
27 files changed, 311 insertions, 33 deletions
diff --git a/catalog-be/src/main/resources/config/configuration.yaml b/catalog-be/src/main/resources/config/configuration.yaml index 5242652188..2ae2cccb77 100644 --- a/catalog-be/src/main/resources/config/configuration.yaml +++ b/catalog-be/src/main/resources/config/configuration.yaml @@ -133,6 +133,7 @@ artifactTypes: - SNMP_POLL - SNMP_TRAP - GUIDE + - PLAN licenseTypes: - User @@ -322,6 +323,14 @@ serviceDeploymentArtifacts: - xml OTHER: acceptedTypes: + +#PLAN + PLAN: + acceptedTypes: + - xml + validForResourceTypes: + - VF + - VFC resourceDeploymentArtifacts: HEAT: @@ -439,6 +448,11 @@ resourceDeploymentArtifacts: SNMP_TRAP: acceptedTypes: validForResourceTypes: *allResourceTypes + +#PLAN + PLAN: + acceptedTypes: + - xml resourceInstanceDeploymentArtifacts: HEAT_ENV: @@ -476,6 +490,11 @@ resourceInstanceDeploymentArtifacts: SNMP_TRAP: acceptedTypes: validForResourceTypes: *allResourceTypes + +#PLAN + PLAN: + acceptedTypes: + - xml resourceInformationalArtifacts: CHEF: diff --git a/common-app-api/src/main/java/org/openecomp/sdc/common/api/ArtifactTypeEnum.java b/common-app-api/src/main/java/org/openecomp/sdc/common/api/ArtifactTypeEnum.java index f13984bc67..6beec9de54 100644 --- a/common-app-api/src/main/java/org/openecomp/sdc/common/api/ArtifactTypeEnum.java +++ b/common-app-api/src/main/java/org/openecomp/sdc/common/api/ArtifactTypeEnum.java @@ -37,8 +37,10 @@ public enum ArtifactTypeEnum { DCAE_INVENTORY_POLICY("DCAE_INVENTORY_POLICY"), DCAE_INVENTORY_DOC("DCAE_INVENTORY_DOC"), DCAE_INVENTORY_BLUEPRINT("DCAE_INVENTORY_BLUEPRINT"), DCAE_INVENTORY_EVENT("DCAE_INVENTORY_EVENT"), // AAI Artifacts AAI_SERVICE_MODEL("AAI_SERVICE_MODEL"), AAI_VF_MODEL("AAI_VF_MODEL"), AAI_VF_MODULE_MODEL("AAI_VF_MODULE_MODEL"), AAI_VF_INSTANCE_MODEL("AAI_VF_INSTANCE_MODEL"), - // MIB artifacts - SNMP_POLL ("SNMP_POLL"), SNMP_TRAP("SNMP_TRAP"), GUIDE("GUIDE"); + // MIB Artifacts + SNMP_POLL ("SNMP_POLL"), SNMP_TRAP("SNMP_TRAP"), GUIDE("GUIDE"), + // PLAN Artifacts + PLAN("PLAN"); ArtifactTypeEnum(String type) { this.type = type; diff --git a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Model.java b/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Model.java index 6668836518..c55abb36c2 100644 --- a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Model.java +++ b/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Model.java @@ -80,9 +80,6 @@ public abstract class Model { case "org.openecomp.resource.vfc.nodes.heat.cinder": modelToBeReturned = new VolumeWidget(); break; - case "org.openecomp.resource.pnf": - modelToBeReturned = new PnfResource(); - break; default: modelToBeReturned = null; break; diff --git a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/PnfResource.java b/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/PnfResource.java deleted file mode 100644 index 67e19392ba..0000000000 --- a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/PnfResource.java +++ /dev/null @@ -1,9 +0,0 @@ -package org.openecomp.sdc.generator.aai.model; - -import org.openecomp.sdc.generator.aai.types.Cardinality; - -@org.openecomp.sdc.generator.aai.types.Model(widget = Widget.Type.PNF, cardinality = Cardinality - .UNBOUNDED, - dataDeleteFlag = true) -public class PnfResource extends Resource { -} diff --git a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/PnfWidget.java b/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/PnfWidget.java deleted file mode 100644 index 2aa03b38bd..0000000000 --- a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/PnfWidget.java +++ /dev/null @@ -1,11 +0,0 @@ -package org.openecomp.sdc.generator.aai.model; - -import org.openecomp.sdc.generator.aai.types.Cardinality; -import org.openecomp.sdc.generator.aai.types.ModelType; -import org.openecomp.sdc.generator.aai.types.ModelWidget; - -@org.openecomp.sdc.generator.aai.types.Model(widget = Widget.Type.PNF, cardinality - = Cardinality.UNBOUNDED, dataDeleteFlag = true) -@ModelWidget(type = ModelType.WIDGET, name = "pnf") -public class PnfWidget extends ResourceWidget { -} diff --git a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Widget.java b/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Widget.java index ce1ef703d9..6220519a3f 100644 --- a/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Widget.java +++ b/common/openecomp-sdc-artifact-generator-lib/openecomp-sdc-artifact-generator-api/src/main/java/org/openecomp/sdc/generator/aai/model/Widget.java @@ -78,8 +78,6 @@ public abstract class Widget extends Model { return new AllotedResourceWidget(); case TUNNEL_XCONNECT: return new TunnelXconnectWidget(); - case PNF: - return new PnfWidget(); default: return null; } @@ -193,6 +191,6 @@ public abstract class Widget extends Model { public enum Type { SERVICE, VF, VFC, VSERVER, VOLUME, FLAVOR, TENANT, VOLUME_GROUP, LINT, L3_NET, VFMODULE, IMAGE, - OAM_NETWORK,ALLOTTED_RESOURCE,TUNNEL_XCONNECT, PNF + OAM_NETWORK,ALLOTTED_RESOURCE,TUNNEL_XCONNECT } } diff --git a/docs/index.rst b/docs/index.rst index 833e1aa969..b4ceb80ea6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,10 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -TODO Add files to toctree and delete this header ------------------------------------------------- -.. toctree:: - :maxdepth: 1 +SDC Documentation +================= +.. toctree:: + :maxdepth: 2 + releases/index + onap-developer/index diff --git a/docs/onap-developer/docs-templates-platform-component-administration.rst b/docs/onap-developer/docs-templates-platform-component-administration.rst new file mode 100644 index 0000000000..1d512cf020 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-administration.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Administration +-------------- +Describe expected changes and the processes and actions taken for each. + + +Processes ++++++++++ +* Process 1 +* Process 2 + +Actions ++++++++ +* Action X +* Action Y + diff --git a/docs/onap-developer/docs-templates-platform-component-architecture.rst b/docs/onap-developer/docs-templates-platform-component-architecture.rst new file mode 100644 index 0000000000..fd46637fd1 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-architecture.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Architecture +------------ +Describe the architecture and design of the platform component. diff --git a/docs/onap-developer/docs-templates-platform-component-configuration.rst b/docs/onap-developer/docs-templates-platform-component-configuration.rst new file mode 100644 index 0000000000..c0c969f854 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-configuration.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +------------- +Describe configurations how to provide parameters and value + +Basic Setup ++++++++++++ + +You can provide the following in ``basic.conf`` + +``host=ADDRESS`` + The address of the host + +``port=PORT`` + The port used for signaling + + Optional. Default: ``8080`` diff --git a/docs/onap-developer/docs-templates-platform-component-consumedapis.rst b/docs/onap-developer/docs-templates-platform-component-consumedapis.rst new file mode 100644 index 0000000000..c4309cdb12 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-consumedapis.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Consumed APIs +============= +References to APIs offered by other components + + diff --git a/docs/onap-developer/docs-templates-platform-component-delivery.rst b/docs/onap-developer/docs-templates-platform-component-delivery.rst new file mode 100644 index 0000000000..cfcab0449b --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-delivery.rst @@ -0,0 +1,31 @@ +Delivery +-------- +Describe how functions are packaged into run-time components. +For some components a block diagram may be useful. + +.. blockdiag:: + + + blockdiag layers { + orientation = portrait + a -> m; + b -> n; + c -> x; + m -> y; + m -> z; + group l1 { + color = blue; + x; y; z; + } + group l2 { + color = yellow; + m; n; + } + group l3 { + color = orange; + a; b; c; + } + + } + + diff --git a/docs/onap-developer/docs-templates-platform-component-humaninterfaces.rst b/docs/onap-developer/docs-templates-platform-component-humaninterfaces.rst new file mode 100644 index 0000000000..03cc875edf --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-humaninterfaces.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Human Interfaces +---------------- +Provide info on the targeted user, interface types, ports/protocols to access, etc. + +Target Users +++++++++++++ + +Interface Type +++++++++++++++ + +Access +++++++ + + + + diff --git a/docs/onap-developer/docs-templates-platform-component-index.rst b/docs/onap-developer/docs-templates-platform-component-index.rst new file mode 100644 index 0000000000..d5db511f1e --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-index.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Platform Component +================== +Provide an overview of the ONAP Platform component capabilities here. +Add or remove sections below as appropriate for the platform component. + +.. toctree:: + :maxdepth: 1 + + architecture.rst + offeredapis.rst + consumedapis.rst + delivery.rst + logging.rst + installation.rst + configuration.rst + administration.rst + humaninterfaces.rst diff --git a/docs/onap-developer/docs-templates-platform-component-installation.rst b/docs/onap-developer/docs-templates-platform-component-installation.rst new file mode 100644 index 0000000000..3238236c43 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-installation.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 + +Installation +------------ +Describe the environment and steps to install. + + +Environment ++++++++++++ + + +Steps ++++++ diff --git a/docs/onap-developer/docs-templates-platform-component-logging.rst b/docs/onap-developer/docs-templates-platform-component-logging.rst new file mode 100644 index 0000000000..8d480e2832 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-logging.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 + +Logging & Diagnostic Information +-------------------------------- +Description of how to interact with and diagnose problems with the components +as delivered. + +Where to Access Information ++++++++++++++++++++++++++++ + + +Error / Warning Messages +++++++++++++++++++++++++ diff --git a/docs/onap-developer/docs-templates-platform-component-offeredapis.rst b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst new file mode 100644 index 0000000000..55e58bd9b3 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst @@ -0,0 +1,29 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Offered APIs +============ +List APIs offered. One or more of the following examples may be appropriate. + +Example Swagger Displayed with swaggerv2doc directive +----------------------------------------------------- + +.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json + + +Example documenting a REST interface with Sphinx httpdomain directive +--------------------------------------------------------------------- + +.. http:get:: path + + For more information see `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_ + + +Word Document Converted to RST using Pandocs +-------------------------------------------- + +.. toctree:: + :maxdepth: 1 + + ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide diff --git a/docs/releases/docs-templates-release-notes-bug-fixes.rst b/docs/releases/docs-templates-release-notes-bug-fixes.rst new file mode 100644 index 0000000000..ee4ff9faf2 --- /dev/null +++ b/docs/releases/docs-templates-release-notes-bug-fixes.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Bug Fixes +--------- + diff --git a/docs/releases/docs-templates-release-notes-deprecation-notes.rst b/docs/releases/docs-templates-release-notes-deprecation-notes.rst new file mode 100644 index 0000000000..e954e8764c --- /dev/null +++ b/docs/releases/docs-templates-release-notes-deprecation-notes.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Deprecation Notes +----------------- + diff --git a/docs/releases/docs-templates-release-notes-index.rst b/docs/releases/docs-templates-release-notes-index.rst new file mode 100644 index 0000000000..adc76f935c --- /dev/null +++ b/docs/releases/docs-templates-release-notes-index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Release Notes +============= + +.. toctree:: + :maxdepth: 2 + + new-features.rst + bug-fixes.rst + known-issues.rst + security-issues.rst + upgrade-notes.rst + deprecation-notes.rst + other.rst diff --git a/docs/releases/docs-templates-release-notes-known-issues.rst b/docs/releases/docs-templates-release-notes-known-issues.rst new file mode 100644 index 0000000000..01c93d124a --- /dev/null +++ b/docs/releases/docs-templates-release-notes-known-issues.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Known Issues +------------ + diff --git a/docs/releases/docs-templates-release-notes-new-features.rst b/docs/releases/docs-templates-release-notes-new-features.rst new file mode 100644 index 0000000000..ab86bb9497 --- /dev/null +++ b/docs/releases/docs-templates-release-notes-new-features.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +New Features +------------ + diff --git a/docs/releases/docs-templates-release-notes-other.rst b/docs/releases/docs-templates-release-notes-other.rst new file mode 100644 index 0000000000..2ce683b5bf --- /dev/null +++ b/docs/releases/docs-templates-release-notes-other.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Other +----- + diff --git a/docs/releases/docs-templates-release-notes-security-issues.rst b/docs/releases/docs-templates-release-notes-security-issues.rst new file mode 100644 index 0000000000..96e1fe95e0 --- /dev/null +++ b/docs/releases/docs-templates-release-notes-security-issues.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Security Issues +--------------- + diff --git a/docs/releases/docs-templates-release-notes-upgrade-notes.rst b/docs/releases/docs-templates-release-notes-upgrade-notes.rst new file mode 100644 index 0000000000..f31c74a696 --- /dev/null +++ b/docs/releases/docs-templates-release-notes-upgrade-notes.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Upgrade Notes +------------- + diff --git a/docs/releases/index.rst b/docs/releases/index.rst new file mode 100644 index 0000000000..eabde3a24e --- /dev/null +++ b/docs/releases/index.rst @@ -0,0 +1,32 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Releases +======== +ONAP is developed and released around 6 month cycles. After an initial major release, additional +stable point releases may be created. + +Major Releases +-------------- + +.. csv-table:: + :align: left + :header-rows: 0 + :header: "Release", "Status", "Initial Release Date", "Next Phase", "EOL Date" + :widths: 15, 10, 10, 15, 10 + + "Amsterdam", "Under Development", "TBD", "", "" + "R1.0.0 Seed Code", "EOL", "2017-04-XX", "", "" + + +.. include:: repolist.rst + + +Cryptographic Signatures +------------------------ + + +References +---------- + + diff --git a/sdc-os-chef/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb b/sdc-os-chef/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb index df9e74ad51..a4be8b10d0 100644 --- a/sdc-os-chef/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb +++ b/sdc-os-chef/sdc-backend/chef-repo/cookbooks/sdc-catalog-be/templates/default/BE-configuration.yaml.erb @@ -126,7 +126,7 @@ artifactTypes: - SNMP_POLL - SNMP_TRAP - GUIDE - + - PLAN licenseTypes: - User @@ -305,6 +305,11 @@ serviceDeploymentArtifacts: OTHER: acceptedTypes: +#PLAN + PLAN: + acceptedTypes: + - xml + resourceDeploymentArtifacts: HEAT: acceptedTypes: @@ -422,6 +427,14 @@ resourceDeploymentArtifacts: acceptedTypes: validForResourceTypes: *allResourceTypes +#PLAN + PLAN: + acceptedTypes: + - xml + validForResourceTypes: + - VF + - VFC + resourceInstanceDeploymentArtifacts: HEAT_ENV: acceptedTypes: @@ -459,6 +472,11 @@ resourceInstanceDeploymentArtifacts: acceptedTypes: validForResourceTypes: *allResourceTypes +#PLAN + PLAN: + acceptedTypes: + - xml + resourceInformationalArtifacts: CHEF: acceptedTypes: |