diff options
Diffstat (limited to 'products/onap-dublin/features/so/src')
17 files changed, 2468 insertions, 0 deletions
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-create-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-create-schema-dublin.yaml new file mode 100644 index 00000000..17dee449 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-create-schema-dublin.yaml @@ -0,0 +1,250 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: service-create
+description: Create a service instance using SO
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: true
+ - name: tenant-id
+ description: tenant id
+ type: string
+ short_option: t
+ long_option: tenant-id
+ is_optional: true
+ - name: model-invariant-id
+ description: model invariant id generated by ASDC.
+ type: string
+ short_option: e
+ long_option: model-invariant-id
+ is_optional: false
+ - name: model-uuid
+ description: model uuid generated by ASDC.
+ type: string
+ short_option: g
+ long_option: model-uuid
+ is_optional: false
+ - name: model-name
+ description: model name as provided in ASDC design time.
+ type: string
+ short_option: i
+ long_option: model-name
+ is_optional: false
+ - name: model-version
+ description: model-version
+ type: string
+ short_option: j
+ long_option: model-version
+ is_optional: false
+ - name: model-version-id
+ description: model-version-id
+ type: string
+ short_option: n
+ long_option: model-version-id
+ is_optional: false
+ - name: customer
+ description: unique id for customer
+ type: string
+ short_option: c
+ long_option: customer
+ is_optional: false
+ - name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: q
+ long_option: requestor-id
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: k
+ long_option: instance-name
+ is_optional: false
+ - name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+ - name: service-type
+ description: subscription service type
+ type: string
+ short_option: w
+ long_option: service-type
+ is_optional: false
+ - name: ala-carte
+ description: ala carte flag, defaults to true
+ type: string
+ short_option: a
+ long_option: ala-carte
+ is_optional: true
+ default_value: true
+ - name: customer-latitude
+ description: customer latitude, part of customer location
+ type: string
+ short_option: f
+ long_option: customer-latitude
+ is_optional: true
+ - name: customer-longitude
+ description: customer longitude, part of customer location
+ type: string
+ short_option: d
+ long_option: customer-longitude
+ is_optional: true
+ - name: customer-name
+ description: customer name, part of customer location
+ type: string
+ short_option: y
+ long_option: customer-name
+ is_optional: true
+ - name: homing-solution
+ description: homing solution to use [oof|sniro]
+ type: string
+ short_option: h
+ long_option: homing-solution
+ is_optional: true
+ - name: orchestrator
+ description: orchestrator to use [multicloud|openstack(default)]
+ type: string
+ short_option: o
+ long_option: orchestrator
+ is_optional: true
+ - name: api
+ description: api to use [GR_API|VNF_API]
+ type: string
+ short_option: p
+ long_option: api
+ is_optional: true
+ default_value: GR_API
+ - name: subscriber-name
+ description: subscriber name
+ type: string
+ short_option: s
+ long_option: subscriber-name
+ is_optional: true
+ - name: project-name
+ description: project name
+ type: string
+ short_option: x
+ long_option: project-name
+ is_optional: true
+ - name: owning-entity-id
+ description: owning entity id
+ type: string
+ short_option: z
+ long_option: owning-entity-id
+ is_optional: true
+ - name: owning-entity-name
+ description: owning entity name
+ type: string
+ short_option: m
+ long_option: owning-entity-name
+ is_optional: true
+
+results:
+ direction: portrait
+ attributes:
+ - name: service-id
+ description: instance id for the created service.
+ type: string
+ scope: short
+
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6
+ method: POST
+ body: '{
+ "requestDetails":{
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${model-invariant-id}",
+ "modelNameVersionId":"${model-uuid}",
+ "modelName":"${model-name}",
+ "modelVersion":"${model-version}",
+ "modelVersionId":"${model-version-id}"
+ },
+ "subscriberInfo":{
+ "globalSubscriberId":"${customer}",
+ "subscriberName":"${subscriber-name}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "instanceName":"${instance-name}",
+ "source":"CLI",
+ "suppressRollback":"${supress-rollback}"
+ },
+ "requestParameters":{
+ "subscriptionServiceType":"${service-type}",
+ "aLaCarte":"${ala-carte}",
+ "testApi":"${api}",
+ "userParams":[
+ {
+ "name":"Customer_Location",
+ "value":{
+ "customerLatitude":"${customer-latitude}",
+ "customerLongitude":"${customer-longitude}",
+ "customerName":"${customer-name}"
+ }
+ },
+ {
+ "name":"Homing_Solution",
+ "value":"${homing-solution}"
+ },
+ {
+ "name":"orchestrator",
+ "value":"${orchestrator}"
+ }
+ ]
+ },
+ "project":{
+ "projectName":"${project-name}"
+ },
+ "owningEntity":{
+ "owningEntityId":"${owning-entity-id}",
+ "owningEntityName":"${owning-entity-name}"
+ }
+ }
+ }'
+ success_codes:
+ - 202
+ result_map:
+ service-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"${instance-id}",
+ "requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-create-vcpe-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-create-vcpe-schema-dublin.yaml new file mode 100644 index 00000000..1294e7c2 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-create-vcpe-schema-dublin.yaml @@ -0,0 +1,247 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: service-create-vcpe
+description: Create a vcpe service instance using SO
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+- name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: true
+- name: tenant-id
+ description: tenant id
+ type: string
+ short_option: t
+ long_option: tenant-id
+ is_optional: true
+- name: model-invariant-id
+ description: model invariant id generated by ASDC.
+ type: string
+ short_option: e
+ long_option: model-invariant-id
+ is_optional: false
+- name: model-uuid
+ description: model uuid generated by ASDC.
+ type: string
+ short_option: g
+ long_option: model-uuid
+ is_optional: false
+- name: model-name
+ description: model name as provided in ASDC design time.
+ type: string
+ short_option: i
+ long_option: model-name
+ is_optional: false
+- name: model-version
+ description: model-version
+ type: string
+ short_option: j
+ long_option: model-version
+ is_optional: false
+- name: model-version-id
+ description: model-version-id
+ type: string
+ short_option: n
+ long_option: model-version-id
+ is_optional: false
+- name: customer
+ description: unique id for customer
+ type: string
+ short_option: c
+ long_option: customer
+ is_optional: false
+- name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: q
+ long_option: requestor-id
+ is_optional: false
+- name: instance-name
+ description: service instance name
+ type: string
+ short_option: k
+ long_option: instance-name
+ is_optional: false
+- name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+- name: brg-wan-mac-address
+ description: BRG_WAN_MAC_Address
+ type: string
+ short_option: b
+ long_option: brg-wan-mac-address
+ is_optional: false
+- name: customer-latitude
+ description: customer latitude, part of customer location
+ type: string
+ short_option: f
+ long_option: customer-latitude
+ is_optional: true
+- name: customer-longitude
+ description: customer longitude, part of customer location
+ type: string
+ short_option: d
+ long_option: customer-longitude
+ is_optional: true
+- name: customer-name
+ description: customer name, part of customer location
+ type: string
+ short_option: y
+ long_option: customer-name
+ is_optional: true
+- name: homing-solution
+ description: homing solution to use [oof|sniro]
+ type: string
+ short_option: h
+ long_option: homing-solution
+ is_optional: true
+- name: orchestrator
+ description: orchestrator to use [multicloud|openstack(default)]
+ type: string
+ short_option: o
+ long_option: orchestrator
+ is_optional: true
+- name: api
+ description: api to use [GR_API|VNF_API]
+ type: string
+ short_option: p
+ long_option: api
+ is_optional: true
+ default_value: VNF_API
+- name: subscriber-name
+ description: subscriber name
+ type: string
+ short_option: s
+ long_option: subscriber-name
+ is_optional: true
+- name: project-name
+ description: project name
+ type: string
+ short_option: x
+ long_option: project-name
+ is_optional: true
+- name: owning-entity-id
+ description: owning entity id
+ type: string
+ short_option: z
+ long_option: owning-entity-id
+ is_optional: true
+- name: owning-entity-name
+ description: owning entity name
+ type: string
+ short_option: m
+ long_option: owning-entity-name
+ is_optional: true
+
+results:
+ direction: portrait
+ attributes:
+ - name: service-id
+ description: instance id for the created service.
+ type: string
+ scope: short
+
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6
+ method: POST
+ body: '{
+ "requestDetails":{
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${model-invariant-id}",
+ "modelNameVersionId":"${model-uuid}",
+ "modelName":"${model-name}",
+ "modelVersion":"${model-version}",
+ "modelVersionId":"${model-version-id}"
+ },
+ "subscriberInfo":{
+ "globalSubscriberId":"${customer}",
+ "subscriberName":"${subscriber-name}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "instanceName":"${instance-name}",
+ "source":"CLI",
+ "suppressRollback":"${supress-rollback}"
+ },
+ "requestParameters":{
+ "subscriptionServiceType":"vCPE",
+ "aLaCarte":"false",
+ "testApi":"${api}",
+ "userParams":[
+ {
+ "name":"BRG_WAN_MAC_Address",
+ "value":"${brg-wan-mac-address}"
+ },
+ {
+ "name":"Customer_Location",
+ "value":{
+ "customerLatitude":"${customer-latitude}",
+ "customerLongitude":"${customer-longitude}",
+ "customerName":"${customer-name}"
+ }
+ },
+ {
+ "name":"Homing_Solution",
+ "value":"${homing-solution}"
+ },
+ {
+ "name":"orchestrator",
+ "value":"${orchestrator}"
+ }
+ ]
+ },
+ "project":{
+ "projectName":"${project-name}"
+ },
+ "owningEntity":{
+ "owningEntityId":"${owning-entity-id}",
+ "owningEntityName":"${owning-entity-name}"
+ }
+ }
+ }'
+ success_codes:
+ - 202
+ result_map:
+ service-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"${instance-id}",
+ "requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-delete-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-delete-schema-dublin.yaml new file mode 100644 index 00000000..5bade839 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-delete-schema-dublin.yaml @@ -0,0 +1,113 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: service-delete
+
+description: Delete a service instance using SO
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: service-id
+ description: unique id for service instance
+ type: string
+ short_option: x
+ long_option: service-instace-id
+ is_optional: false
+ - name: model-invariant-id
+ description: model invariant id for service in SDC catalog
+ type: string
+ short_option: b
+ long_option: model-invariant-id
+ is_optional: false
+ - name: model-uuid
+ description: model uuid for service in SDC catalog
+ type: string
+ short_option: i
+ long_option: model-uuid
+ is_optional: false
+ - name: model-name
+ description: model name available in SDC catalog
+ type: string
+ short_option: e
+ long_option: model-name
+ is_optional: false
+ - name: model-version
+ description: model version of service (eg. 1.0)
+ type: string
+ short_option: g
+ long_option: model-version
+ is_optional: false
+ - name: customer-name
+ description: unique id for customer
+ type: string
+ short_option: c
+ long_option: customer-name
+ is_optional: false
+ - name: cloud-region
+ description: cloud region id
+ type: string
+ short_option: j
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: tenant id
+ type: string
+ short_option: k
+ long_option: tenant-id
+ is_optional: false
+ - name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: r
+ long_option: requestor-id
+ is_optional: false
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-id}
+ method: DELETE
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${model-invariant-id}",
+ "modelVersionId":"${model-uuid}",
+ "modelName":"${model-name}",
+ "modelVersion":"${model-version}"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "subscriberInfo":{
+ "globalSubscriberId":"${customer-name}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "source":"CLI"
+ }
+ }
+ }'
+ success_codes:
+ - 202
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-list-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-list-schema-dublin.yaml new file mode 100644 index 00000000..912016f7 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-list-schema-dublin.yaml @@ -0,0 +1,83 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: service-list
+description: List all service instances from SO
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+results:
+ direction: landscape
+ attributes:
+ - name: name
+ description: Onap service name
+ scope: short
+ type: string
+ - name: version
+ description: Onap service version
+ scope: short
+ type: string
+ - name: url
+ description: Onap service base url
+ scope: short
+ type: url
+ - name: status
+ description: Onap service status
+ scope: short
+ type: digit
+ - name: nodes
+ description: Onap service running nodes
+ scope: long
+ type: json
+ - name: enable-ssl
+ description: Onap service is enabled with https or not
+ scope: long
+ type: string
+ - name: path
+ description: Onap service path
+ scope: long
+ type: string
+
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6
+ method: GET
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ name: $b{$.[*].serviceName}
+ version: $b{$.[*].version}
+ url: $b{$.[*].url}
+ status: $b{$.[*].status}
+ enable-ssl: $b{$.[*].enable_ssl}
+ path: $b{$.[*].path}
+ nodes: $b{$.[*].nodes[*].ip}:$b{$.[*].nodes[*].port}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"${instance-id}",
+ "requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-show-resource-module-name-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-show-resource-module-name-schema-dublin.yaml new file mode 100644 index 00000000..f190f064 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-show-resource-module-name-schema-dublin.yaml @@ -0,0 +1,61 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: service-show-resource-module-name
+description: Show a resource module name from SO
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+- name: service-id
+ description: unique id for service instance
+ type: string
+ short_option: s
+ long_option: service-instace-id
+ is_optional: false
+
+results:
+ direction: landscape
+ attributes:
+ - name: name
+ description: Onap resource module name
+ scope: short
+ type: string
+
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-id}
+ method: GET
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ name: $b{$.[*].serviceName}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"${instance-id}",
+ "requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-show-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-show-schema-dublin.yaml new file mode 100644 index 00000000..184707e8 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-show-schema-dublin.yaml @@ -0,0 +1,91 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: service-show
+description: Show a service instances from SO
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+- name: service-id
+ description: unique id for service instance
+ type: string
+ short_option: s
+ long_option: service-instace-id
+ is_optional: false
+
+results:
+ direction: landscape
+ attributes:
+ - name: name
+ description: Onap service name
+ scope: short
+ type: string
+ - name: version
+ description: Onap service version
+ scope: short
+ type: string
+ - name: url
+ description: Onap service base url
+ scope: short
+ type: url
+ - name: status
+ description: Onap service status
+ scope: short
+ type: digit
+ - name: nodes
+ description: Onap service running nodes
+ scope: long
+ type: json
+ - name: enable-ssl
+ description: Onap service is enabled with https or not
+ scope: long
+ type: string
+ - name: path
+ description: Onap service path
+ scope: long
+ type: string
+
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-id}
+ method: GET
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ name: $b{$.[*].serviceName}
+ version: $b{$.[*].version}
+ url: $b{$.[*].url}
+ status: $b{$.[*].status}
+ enable-ssl: $b{$.[*].enable_ssl}
+ path: $b{$.[*].path}
+ nodes: $b{$.[*].nodes[*].ip}:$b{$.[*].nodes[*].port}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"${instance-id}",
+ "requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-update-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-update-schema-dublin.yaml new file mode 100644 index 00000000..ab4ad008 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/service-update-schema-dublin.yaml @@ -0,0 +1,162 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: service-update
+description: Update a service instance using SO
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: service-id
+ description: unique id for service instance
+ type: string
+ short_option: x
+ long_option: service-instace-id
+ is_optional: false
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: tenant id
+ type: string
+ short_option: b
+ long_option: tenant-id
+ is_optional: false
+ - name: model-invariant-id
+ description: model invariant id generated by ASDC.
+ type: string
+ short_option: e
+ long_option: model-invariant-id
+ is_optional: false
+ - name: model-uuid
+ description: model uuid generated by ASDC.
+ type: string
+ short_option: g
+ long_option: model-uuid
+ is_optional: false
+ - name: model-name
+ description: model name as provided in ASDC design time.
+ type: string
+ short_option: i
+ long_option: model-name
+ is_optional: false
+ - name: model-version
+ description: model-version
+ type: string
+ short_option: j
+ long_option: model-version
+ is_optional: false
+ - name: model-version-id
+ description: model-version-id
+ type: string
+ short_option: n
+ long_option: model-version-id
+ is_optional: false
+ - name: customer
+ description: unique id for customer
+ type: string
+ short_option: c
+ long_option: customer
+ is_optional: false
+ - name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: q
+ long_option: requestor-id
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: k
+ long_option: instance-name
+ is_optional: false
+ - name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+ - name: service-type
+ description: subscription service type
+ type: string
+ short_option: w
+ long_option: service-type
+ is_optional: false
+
+results:
+ direction: portrait
+ attributes:
+ - name: service-id
+ description: instance id for the created service.
+ type: string
+ scope: short
+
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-id}
+ method: PUT
+ body: '{
+ "requestDetails":{
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${model-invariant-id}",
+ "modelNameVersionId":"${model-uuid}",
+ "modelName":"${model-name}",
+ "modelVersion":"${model-version}",
+ "modelVersionId":"${model-version-id}"
+ },
+ "subscriberInfo":{
+ "globalSubscriberId":"${customer}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "suppressRollback":"${supress-rollback}"
+ },
+ "requestParameters":{
+ "subscriptionServiceType":"${service-type}",
+ "aLaCarte":true
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_map:
+ service-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"${instance-id}",
+ "requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-create-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-create-schema-dublin.yaml new file mode 100644 index 00000000..7dc5c372 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-create-schema-dublin.yaml @@ -0,0 +1,143 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vf-module-create
+description: Create a VF Module
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: lcp-cloudregion-id
+ description: AIC LCP node location identifier
+ type: string
+ short_option: l
+ long_option: lcp-cloudregion-id
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id (uuid)
+ type: string
+ short_option: w
+ long_option: tenant-id
+ is_optional: false
+ - name: vnf-instance-id
+ description: vnf instance id
+ type: string
+ short_option: y
+ long_option: vnf-instace-id
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: x
+ long_option: service-instace-id
+ is_optional: false
+ - name: parenet-service-model
+ description: parent service model name
+ type: string
+ short_option: z
+ long_option: parenet-service-model
+ is_optional: false
+ - name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: i
+ long_option: instance-name
+ is_optional: false
+
+results:
+ direction: portrait
+ attribute:
+ - name: vf-instance-id
+ description: id for the created vf
+ type: string
+ scope: short
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules
+ method: POST
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vfModule",
+ "modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"vSAMP12..base..module-0",
+ "modelVersion":"1"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${lcp-cloudregion-id}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "suppressRollback":"${supress-rollback}"
+ },
+ "relatedInstanceList":[
+ {
+ "relatedInstance":{
+ "instanceId":"${service-instance-id}",
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"${parenet-service-model}",
+ "modelVersion":"1.0"
+ }
+ }
+ },
+ {
+ "relatedInstance":{
+ "instanceId":"${vnf-instance-id}",
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"vSAMP12",
+ "modelVersion":"1.0",
+ "modelCustomizationName":"vSAMP12 1"
+ }
+ }
+ }
+ ],
+ "requestParameters":{
+ "userParams":[
+
+ ]
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_mpa:
+ vf-instance-id: $b{$.vfInstanceId}
+ sample_response:
+ body: '{ "vfInstanceId" : "234567AB" }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-delete-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-delete-schema-dublin.yaml new file mode 100644 index 00000000..81b7fada --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-delete-schema-dublin.yaml @@ -0,0 +1,103 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vfmodule-delete
+
+description: delete a VF module (experimental)
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: vfmodule-id
+ description: VF module Id
+ type: string
+ short_option: x
+ long_option: vfmodule-id
+ is_optional: false
+ - name: service-id
+ description: unique id for service
+ type: string
+ short_option: j
+ long_option: service-id
+ is_optional: false
+ - name: vf-id
+ description: unique id for related VF
+ type: string
+ short_option: y
+ long_option: vf-id
+ is_optional: false
+ - name: vf-model-invariant-id
+ description: vf model invariant id
+ type: string
+ short_option: k
+ long_option: vf-model-invariant-id
+ is_optional: false
+ - name: vfmodule-name
+ description: vfmodule model name
+ type: string
+ short_option: e
+ long_option: vfmodule-name
+ is_optional: false
+ - name: vfmodule-version
+ description: vf module version
+ type: string
+ short_option: g
+ long_option: vfmodule-version
+ is_optional: false
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id
+ type: string
+ long_option: tenant-id
+ short_option: z
+ is_optional: false
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-id}/vnfs/${vf-id}/vfModules/${vfmodule-id}
+ method: DELETE
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vfModule",
+ "modelInvariantId":"${vf-model-invariant-id}",
+ "modelName":"${vfmodule-name}",
+ "modelVersion":"${vfmodule-version}"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "source":"VID"
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
\ No newline at end of file diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-list-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-list-schema-dublin.yaml new file mode 100644 index 00000000..e9d1ca73 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-list-schema-dublin.yaml @@ -0,0 +1,143 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vf-module-list
+description: List all VF Modules
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: lcp-cloudregion-id
+ description: AIC LCP node location identifier
+ type: string
+ short_option: l
+ long_option: lcp-cloudregion-id
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id (uuid)
+ type: string
+ short_option: w
+ long_option: tenant-id
+ is_optional: false
+ - name: vnf-instance-id
+ description: vnf instance id
+ type: string
+ short_option: y
+ long_option: vnf-instace-id
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: x
+ long_option: service-instace-id
+ is_optional: false
+ - name: parenet-service-model
+ description: parent service model name
+ type: string
+ short_option: z
+ long_option: parenet-service-model
+ is_optional: false
+ - name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: i
+ long_option: instance-name
+ is_optional: false
+
+results:
+ direction: portrait
+ attribute:
+ - name: vf-instance-id
+ description: id for the created vf
+ type: string
+ scope: short
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules
+ method: PUT
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vfModule",
+ "modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"vSAMP12..base..module-0",
+ "modelVersion":"1"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${lcp-cloudregion-id}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "suppressRollback":"${supress-rollback}"
+ },
+ "relatedInstanceList":[
+ {
+ "relatedInstance":{
+ "instanceId":"${service-instance-id}",
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"${parenet-service-model}",
+ "modelVersion":"1.0"
+ }
+ }
+ },
+ {
+ "relatedInstance":{
+ "instanceId":"${vnf-instance-id}",
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"vSAMP12",
+ "modelVersion":"1.0",
+ "modelCustomizationName":"vSAMP12 1"
+ }
+ }
+ }
+ ],
+ "requestParameters":{
+ "userParams":[
+
+ ]
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_mpa:
+ vf-instance-id: $b{$.vfInstanceId}
+ sample_response:
+ body: '{ "vfInstanceId" : "234567AB" }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-show-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-show-schema-dublin.yaml new file mode 100644 index 00000000..93a986ba --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-show-schema-dublin.yaml @@ -0,0 +1,83 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vf-module-show
+description: Show a VF Module
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+results:
+ direction: landscape
+ attributes:
+ - name: name
+ description: Onap service name
+ scope: short
+ type: string
+ - name: version
+ description: Onap service version
+ scope: short
+ type: string
+ - name: url
+ description: Onap service base url
+ scope: short
+ type: url
+ - name: status
+ description: Onap service status
+ scope: short
+ type: digit
+ - name: nodes
+ description: Onap service running nodes
+ scope: long
+ type: json
+ - name: enable-ssl
+ description: Onap service is enabled with https or not
+ scope: long
+ type: string
+ - name: path
+ description: Onap service path
+ scope: long
+ type: string
+
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6
+ method: GET
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ name: $b{$.[*].serviceName}
+ version: $b{$.[*].version}
+ url: $b{$.[*].url}
+ status: $b{$.[*].status}
+ enable-ssl: $b{$.[*].enable_ssl}
+ path: $b{$.[*].path}
+ nodes: $b{$.[*].nodes[*].ip}:$b{$.[*].nodes[*].port}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"${instance-id}",
+ "requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-update-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-update-schema-dublin.yaml new file mode 100644 index 00000000..02c1adce --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vf-module-update-schema-dublin.yaml @@ -0,0 +1,143 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vf-module-update
+description: Update a VF Module
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+ - name: lcp-cloudregion-id
+ description: AIC LCP node location identifier
+ type: string
+ short_option: l
+ long_option: lcp-cloudregion-id
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id (uuid)
+ type: string
+ short_option: w
+ long_option: tenant-id
+ is_optional: false
+ - name: vnf-instance-id
+ description: vnf instance id
+ type: string
+ short_option: y
+ long_option: vnf-instace-id
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: x
+ long_option: service-instace-id
+ is_optional: false
+ - name: parenet-service-model
+ description: parent service model name
+ type: string
+ short_option: z
+ long_option: parenet-service-model
+ is_optional: false
+ - name: supress-rollback
+ description: rollback changes if instantiation fails.
+ type: bool
+ short_option: r
+ long_option: supress-rollback
+ is_optional: true
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: i
+ long_option: instance-name
+ is_optional: false
+
+results:
+ direction: portrait
+ attribute:
+ - name: vf-instance-id
+ description: id for the created vf
+ type: string
+ scope: short
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules
+ method: PUT
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vfModule",
+ "modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"vSAMP12..base..module-0",
+ "modelVersion":"1"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${lcp-cloudregion-id}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "suppressRollback":"${supress-rollback}"
+ },
+ "relatedInstanceList":[
+ {
+ "relatedInstance":{
+ "instanceId":"${service-instance-id}",
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"${parenet-service-model}",
+ "modelVersion":"1.0"
+ }
+ }
+ },
+ {
+ "relatedInstance":{
+ "instanceId":"${vnf-instance-id}",
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff",
+ "modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe",
+ "modelName":"vSAMP12",
+ "modelVersion":"1.0",
+ "modelCustomizationName":"vSAMP12 1"
+ }
+ }
+ }
+ ],
+ "requestParameters":{
+ "userParams":[
+
+ ]
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_mpa:
+ vf-instance-id: $b{$.vfInstanceId}
+ sample_response:
+ body: '{"vfInstanceId":"234567AB"}'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-create-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-create-schema-dublin.yaml new file mode 100644 index 00000000..072f19ca --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-create-schema-dublin.yaml @@ -0,0 +1,185 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vfn-create
+description: Create a VNF
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+
+parameters:
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+ - name: product-family
+ description: service type for serivce (e.g. vLB)
+ type: string
+ short_option: w
+ long_option: product-family
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: o
+ long_option: instance-name
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instance-id
+ is_optional: false
+ - name: vf-model-invariant-id
+ description: vf model invariant id
+ type: string
+ short_option: b
+ long_option: vf-model-invariant-id
+ is_optional: false
+ - name: vf-model-uuid
+ description: model uuid for vf
+ type: string
+ short_option: c
+ long_option: vf-model-uuid
+ is_optional: false
+ - name: vf-model-name
+ description: vf model name
+ type: string
+ short_option: e
+ long_option: vf-model-name
+ is_optional: false
+ - name: vf-model-version
+ description: vf model version
+ type: string
+ short_option: g
+ long_option: vf-model-version
+ is_optional: false
+ - name: vf-model-customization-id
+ description: vf model customization id
+ type: string
+ short_option: i
+ long_option: vf-model-customization-id
+ is_optional: false
+ - name: service-model-invariant-id
+ description: model invariant id
+ type: string
+ short_option: j
+ long_option: service-model-invariant-id
+ is_optional: false
+ - name: service-model-uuid
+ description: model name version id
+ type: string
+ short_option: k
+ long_option: service-model-uuid
+ is_optional: false
+ - name: service-model-name
+ description: service model name
+ type: string
+ short_option: q
+ long_option: service-model-name
+ is_optional: false
+ - name: service-model-version
+ description: service model version
+ type: string
+ short_option: n
+ long_option: service-model-version
+ is_optional: false
+ - name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: r
+ long_option: requestor-id
+ is_optional: false
+
+
+results:
+ direction: portrait
+ attributes:
+ - name: vf-id
+ description: id for the created vnf
+ type: string
+ scope: short
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs
+ method: POST
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"${vf-model-invariant-id}",
+ "modelVersionId":"${vf-model-uuid}",
+ "modelName":"${vf-model-name}",
+ "modelVersion":"${vf-model-version}",
+ "modelCustomizationId":"${vf-model-customization-id}"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "productFamilyId":"${product-family}"
+ },
+ "relatedInstanceList":[
+ {
+ "relatedInstance":{
+ "instanceId":"${service-instance-id}",
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${service-model-invariant-id}",
+ "modelVersionId":"${service-model-uuid}",
+ "modelName":"${service-model-name}",
+ "modelVersion":"${service-model-version}"
+ }
+ }
+ }
+ ],
+ "requestParameters":{
+
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_map:
+ vf-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"2a152730-f6eb-4dc6-9b81-7a6f6f263d71",
+ "requestId":"6402628f-7f67-4605-9e60-0d8632616d02"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-delete-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-delete-schema-dublin.yaml new file mode 100644 index 00000000..439dfd57 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-delete-schema-dublin.yaml @@ -0,0 +1,106 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vnf-delete
+description: Delete a VNF
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+- name: vf-id
+ description: id for vnf
+ type: string
+ short_option: x
+ long_option: vf-id
+ is_optional: false
+- name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instance-id
+ is_optional: false
+- name: cloud-region
+ description: Cloud region ID
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+- name: tenant-id
+ description: openstack tenant id (uuid)
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+- name: model-invariant-id
+ description: model invariant id for service in SDC catalog
+ type: string
+ short_option: b
+ long_option: model-invariant-id
+ is_optional: false
+- name: model-uuid
+ description: model uuid for service in SDC catalog
+ type: string
+ short_option: c
+ long_option: model-uuid
+ is_optional: false
+- name: model-name
+ description: model name available in SDC catalog
+ type: string
+ short_option: e
+ long_option: model-name
+ is_optional: false
+- name: model-version
+ description: model version of service (eg. 1.0)
+ type: string
+ short_option: g
+ long_option: model-version
+ is_optional: false
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs/${vf-id}
+ method: DELETE
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"${model-invariant-id}",
+ "modelVersionId":"${model-uuid}",
+ "modelName":"${model-name}",
+ "modelVersion":"${model-version}"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "source":"VID"
+ },
+ "requestParameters":{
+ "userParams":[
+
+ ]
+ }
+ }
+ }'
+ success_codes:
+ - 202
\ No newline at end of file diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-list-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-list-schema-dublin.yaml new file mode 100644 index 00000000..51b00312 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-list-schema-dublin.yaml @@ -0,0 +1,185 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vnf-list
+description: List all VNFs
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+
+parameters:
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+ - name: product-family
+ description: service type for serivce (e.g. vLB)
+ type: string
+ short_option: w
+ long_option: product-family
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: o
+ long_option: instance-name
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instance-id
+ is_optional: false
+ - name: vf-model-invariant-id
+ description: vf model invariant id
+ type: string
+ short_option: b
+ long_option: vf-model-invariant-id
+ is_optional: false
+ - name: vf-model-uuid
+ description: model uuid for vf
+ type: string
+ short_option: c
+ long_option: vf-model-uuid
+ is_optional: false
+ - name: vf-model-name
+ description: vf model name
+ type: string
+ short_option: e
+ long_option: vf-model-name
+ is_optional: false
+ - name: vf-model-version
+ description: vf model version
+ type: string
+ short_option: g
+ long_option: vf-model-version
+ is_optional: false
+ - name: vf-model-customization-id
+ description: vf model customization id
+ type: string
+ short_option: i
+ long_option: vf-model-customization-id
+ is_optional: false
+ - name: service-model-invariant-id
+ description: model invariant id
+ type: string
+ short_option: j
+ long_option: service-model-invariant-id
+ is_optional: false
+ - name: service-model-uuid
+ description: model name version id
+ type: string
+ short_option: k
+ long_option: service-model-uuid
+ is_optional: false
+ - name: service-model-name
+ description: service model name
+ type: string
+ short_option: q
+ long_option: service-model-name
+ is_optional: false
+ - name: service-model-version
+ description: service model version
+ type: string
+ short_option: n
+ long_option: service-model-version
+ is_optional: false
+ - name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: r
+ long_option: requestor-id
+ is_optional: false
+
+
+results:
+ direction: portrait
+ attributes:
+ - name: vf-id
+ description: id for the created vnf
+ type: string
+ scope: short
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs
+ method: POST
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"${vf-model-invariant-id}",
+ "modelVersionId":"${vf-model-uuid}",
+ "modelName":"${vf-model-name}",
+ "modelVersion":"${vf-model-version}",
+ "modelCustomizationId":"${vf-model-customization-id}"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "productFamilyId":"${product-family}"
+ },
+ "relatedInstanceList":[
+ {
+ "relatedInstance":{
+ "instanceId":"${service-instance-id}",
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${service-model-invariant-id}",
+ "modelVersionId":"${service-model-uuid}",
+ "modelName":"${service-model-name}",
+ "modelVersion":"${service-model-version}"
+ }
+ }
+ }
+ ],
+ "requestParameters":{
+
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_map:
+ vf-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"2a152730-f6eb-4dc6-9b81-7a6f6f263d71",
+ "requestId":"6402628f-7f67-4605-9e60-0d8632616d02"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-show-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-show-schema-dublin.yaml new file mode 100644 index 00000000..9eab64f9 --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-show-schema-dublin.yaml @@ -0,0 +1,185 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vnf-show
+description: Show a VNF
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+
+parameters:
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+ - name: product-family
+ description: service type for serivce (e.g. vLB)
+ type: string
+ short_option: w
+ long_option: product-family
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: o
+ long_option: instance-name
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instance-id
+ is_optional: false
+ - name: vf-model-invariant-id
+ description: vf model invariant id
+ type: string
+ short_option: b
+ long_option: vf-model-invariant-id
+ is_optional: false
+ - name: vf-model-uuid
+ description: model uuid for vf
+ type: string
+ short_option: c
+ long_option: vf-model-uuid
+ is_optional: false
+ - name: vf-model-name
+ description: vf model name
+ type: string
+ short_option: e
+ long_option: vf-model-name
+ is_optional: false
+ - name: vf-model-version
+ description: vf model version
+ type: string
+ short_option: g
+ long_option: vf-model-version
+ is_optional: false
+ - name: vf-model-customization-id
+ description: vf model customization id
+ type: string
+ short_option: i
+ long_option: vf-model-customization-id
+ is_optional: false
+ - name: service-model-invariant-id
+ description: model invariant id
+ type: string
+ short_option: j
+ long_option: service-model-invariant-id
+ is_optional: false
+ - name: service-model-uuid
+ description: model name version id
+ type: string
+ short_option: k
+ long_option: service-model-uuid
+ is_optional: false
+ - name: service-model-name
+ description: service model name
+ type: string
+ short_option: q
+ long_option: service-model-name
+ is_optional: false
+ - name: service-model-version
+ description: service model version
+ type: string
+ short_option: n
+ long_option: service-model-version
+ is_optional: false
+ - name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: r
+ long_option: requestor-id
+ is_optional: false
+
+
+results:
+ direction: portrait
+ attributes:
+ - name: vf-id
+ description: id for the created vnf
+ type: string
+ scope: short
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs
+ method: POST
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"${vf-model-invariant-id}",
+ "modelVersionId":"${vf-model-uuid}",
+ "modelName":"${vf-model-name}",
+ "modelVersion":"${vf-model-version}",
+ "modelCustomizationId":"${vf-model-customization-id}"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "productFamilyId":"${product-family}"
+ },
+ "relatedInstanceList":[
+ {
+ "relatedInstance":{
+ "instanceId":"${service-instance-id}",
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${service-model-invariant-id}",
+ "modelVersionId":"${service-model-uuid}",
+ "modelName":"${service-model-name}",
+ "modelVersion":"${service-model-version}"
+ }
+ }
+ }
+ ],
+ "requestParameters":{
+
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_map:
+ vf-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"2a152730-f6eb-4dc6-9b81-7a6f6f263d71",
+ "requestId":"6402628f-7f67-4605-9e60-0d8632616d02"
+ }
+ }'
diff --git a/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-update-schema-dublin.yaml b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-update-schema-dublin.yaml new file mode 100644 index 00000000..937d069c --- /dev/null +++ b/products/onap-dublin/features/so/src/main/resources/open-cli-schema/vnf-update-schema-dublin.yaml @@ -0,0 +1,185 @@ +# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+name: vnf-update
+description: Update a VNF
+
+info:
+ product: onap-dublin
+ service: so
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+
+
+parameters:
+ - name: cloud-region
+ description: cloud region identifier
+ type: string
+ short_option: l
+ long_option: cloud-region
+ is_optional: false
+ - name: tenant-id
+ description: openstack tenant id
+ type: string
+ short_option: z
+ long_option: tenant-id
+ is_optional: false
+ - name: product-family
+ description: service type for serivce (e.g. vLB)
+ type: string
+ short_option: w
+ long_option: product-family
+ is_optional: false
+ - name: instance-name
+ description: service instance name
+ type: string
+ short_option: o
+ long_option: instance-name
+ is_optional: false
+ - name: service-instance-id
+ description: unique id for service instance
+ type: string
+ short_option: y
+ long_option: service-instance-id
+ is_optional: false
+ - name: vf-model-invariant-id
+ description: vf model invariant id
+ type: string
+ short_option: b
+ long_option: vf-model-invariant-id
+ is_optional: false
+ - name: vf-model-uuid
+ description: model uuid for vf
+ type: string
+ short_option: c
+ long_option: vf-model-uuid
+ is_optional: false
+ - name: vf-model-name
+ description: vf model name
+ type: string
+ short_option: e
+ long_option: vf-model-name
+ is_optional: false
+ - name: vf-model-version
+ description: vf model version
+ type: string
+ short_option: g
+ long_option: vf-model-version
+ is_optional: false
+ - name: vf-model-customization-id
+ description: vf model customization id
+ type: string
+ short_option: i
+ long_option: vf-model-customization-id
+ is_optional: false
+ - name: service-model-invariant-id
+ description: model invariant id
+ type: string
+ short_option: j
+ long_option: service-model-invariant-id
+ is_optional: false
+ - name: service-model-uuid
+ description: model name version id
+ type: string
+ short_option: k
+ long_option: service-model-uuid
+ is_optional: false
+ - name: service-model-name
+ description: service model name
+ type: string
+ short_option: q
+ long_option: service-model-name
+ is_optional: false
+ - name: service-model-version
+ description: service model version
+ type: string
+ short_option: n
+ long_option: service-model-version
+ is_optional: false
+ - name: requestor-id
+ description: requestor ID
+ type: string
+ short_option: r
+ long_option: requestor-id
+ is_optional: false
+
+
+results:
+ direction: portrait
+ attributes:
+ - name: vf-id
+ description: id for the created vnf
+ type: string
+ scope: short
+
+http:
+ service:
+ name: so
+ version: v6
+ auth: basic
+ mode: direct
+ request:
+ uri: /onap/so/infra/serviceInstances/v6/${service-instance-id}/vnfs
+ method: PUT
+ body: '{
+ "requestDetails":{
+ "modelInfo":{
+ "modelType":"vnf",
+ "modelInvariantId":"${vf-model-invariant-id}",
+ "modelVersionId":"${vf-model-uuid}",
+ "modelName":"${vf-model-name}",
+ "modelVersion":"${vf-model-version}",
+ "modelCustomizationId":"${vf-model-customization-id}"
+ },
+ "cloudConfiguration":{
+ "lcpCloudRegionId":"${cloud-region}",
+ "tenantId":"${tenant-id}"
+ },
+ "requestInfo":{
+ "requestorId":"${requestor-id}",
+ "instanceName":"${instance-name}",
+ "source":"VID",
+ "productFamilyId":"${product-family}"
+ },
+ "relatedInstanceList":[
+ {
+ "relatedInstance":{
+ "instanceId":"${service-instance-id}",
+ "modelInfo":{
+ "modelType":"service",
+ "modelInvariantId":"${service-model-invariant-id}",
+ "modelVersionId":"${service-model-uuid}",
+ "modelName":"${service-model-name}",
+ "modelVersion":"${service-model-version}"
+ }
+ }
+ }
+ ],
+ "requestParameters":{
+
+ }
+ }
+ }'
+
+ success_codes:
+ - 202
+ result_map:
+ vf-id: $b{$.requestReferences.instanceId}
+ sample_response:
+ body: '{
+ "requestReferences":{
+ "instanceId":"2a152730-f6eb-4dc6-9b81-7a6f6f263d71",
+ "requestId":"6402628f-7f67-4605-9e60-0d8632616d02"
+ }
+ }'
|