osmclient/templates/nsd.yaml.j2

   1 # Copyright 2019 ETSI OSM
   2 #
   3 # All Rights Reserved.
   4 #
   5 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   6 #    not use this file except in compliance with the License. You may obtain
   7 #    a copy of the License at
   8 #
   9 #         http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #    Unless required by applicable law or agreed to in writing, software
  12 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14 #    License for the specific language governing permissions and limitations
  15 #    under the License.
  16
  17 nsd-catalog:
  18     schema-version: "v3.0"
  19     nsd:
  20     -   id: {{ name }}_nsd
  21         name: {{ name }}_nsd
  22         short-name: {{ name }}_nsd
  23         vendor: {{ vendor }}
  24         description: Generated by OSM package generator
  25         version: '1.0'
  26         {%- if detailed is sameas true %}
  27
  28         # Place the logo as png in icons directory and provide the name here
  29         # logo: <update, optional> Example: icons/logo.png
  30         {%- endif %}
  31
  32         # Specify the VNFDs that are part of this NSD
  33         constituent-vnfd:
  34         # The member-vnf-index needs to be unique, starting from 1
  35         # vnfd-id-ref is the id of the VNFD
  36         # Multiple constituent VNFDs can be specified
  37         -   member-vnf-index: "1"
  38             vnfd-id-ref: {{ name }}_vnfd
  39             {%- if detailed is sameas true %}
  40             # start-by-default: True
  41             {%- endif %}
  42
  43         # Networks for the VNFs
  44         vld:
  45         -   id: {{ name }}_nsd_vld0
  46             name: mgmt
  47             short-name: mgmt
  48             type: ELAN
  49             mgmt-network: true
  50             {%- if detailed is sameas true %}
  51             # description: <update>
  52             # vim-network-name: <update> Name of network in VIM account
  53             # ip-profile-ref: <update> Name of reference of IP profile object
  54             # provider-network:
  55             #     physical-network: <update> Name of the physical network on which provider network is built
  56             #     segmentation_id: <update> ID of segregated virtual network
  57             {%- endif %}
  58
  59             # Specify the constituent VNFs
  60             # member-vnf-index-ref - entry from constituent vnf
  61             # vnfd-id-ref - VNFD id
  62             # vnfd-connection-point-ref - connection point name in the VNFD
  63             vnfd-connection-point-ref:
  64             -   member-vnf-index-ref: "1"
  65                 vnfd-id-ref: {{ name }}_vnfd
  66                 # NOTE: Validate the entry below
  67                 vnfd-connection-point-ref: vnf-cp0
  68                 {%- if detailed is sameas true %}
  69                 # ip-address: <update> IP address of the connection point
  70                 {%- endif %}
  71
  72             {%- for x in range(1, interfaces + 1 ) %}
  73             -   member-vnf-index-ref: "1"
  74                 vnfd-id-ref: {{ name }}_vnfd
  75                 # NOTE: Validate the entry below
  76                 vnfd-connection-point-ref: vnf-cp{{ x }}
  77                 {%- if detailed is sameas true %}
  78                 # ip-address: <update> IP address of the connection point
  79                 {%- endif %}
  80             {%- endfor %}
  81
  82             {%- if detailed is sameas true %}
  83             # List of IP Profiles.
  84             # IP Profile describes the IP characteristics for the Virtual-Link
  85             #ip-profiles
  86             #-   name: <update>
  87             #    description: <update>
  88             #    ip-profile-params:
  89             #    -   ip-version:
  90             #        subnet-address: <update>
  91             #        gateway-address: <update>
  92             #        security-group: <update>
  93             #        subnet-prefix-pool: <update>
  94             #        dns-server:
  95             #        -   address: <update>
  96             #        dhcp-params:
  97             #        -   enabled: <update>
  98             #            start-address: <update>
  99             #            count: <update>
 100
 101             # Information about NS configuration
 102             #ns-configuration:
 103             #    juju:
 104             #        charm: <update>
 105             #        proxy: <update>
 106             #        vca-relationships:
 107             #            relation:
 108             #            -   requires: <update>
 109             #                provides: <update>
 110
 111             #    # List of config primitives supported by the
 112             #    # configuration agent for this NS.
 113             #    config-primitive:
 114             #    -   name: <update>
 115             #        parameter:
 116             #        -   name: <update>
 117             #            data-type: <update>
 118             #            mandatory: <update>
 119             #            default-value: <update>
 120             #            parameter-pool: <update>
 121             #            read-only: <update>
 122             #            hidden: <update>
 123
 124             #    # Initial set of configuration primitives.
 125             #    initial-config-primitive:
 126             #    -   seq: <update>
 127             #        name: <update>
 128             #        parameter:
 129             #        -   name: <update>
 130             #            data-type: <update>
 131             #            value: <update>
 132
 133             #    # Terminate set of configuration primitives.
 134             #    terminate-config-primitive:
 135             #    -   seq: <update>
 136             #        name: <update>
 137             #        parameter:
 138             #        -   name: <update>
 139             #            data-type: <update>
 140             #            value: <update>
 141
 142             #    # List of VCA related metric
 143             #    metrics:
 144             #    -   name: <update>
 145
 146             # Used to configure the list of public keys to be injected as part
 147             # of ns instantiation
 148             #key-pair:
 149             #-   name: <update>
 150             #    key: <update>
 151
 152             # List of users to be added through cloud-config
 153             #user:
 154             #-   name: <update>
 155             #    user-info: <update>
 156             #    key-pair:
 157             #    -   name: <update>
 158             #        key: <update>
 159
 160             # List of VNF Forwarding Graph Descriptors (VNFFGD)
 161             #vnffgd:
 162             #-   id: <update>
 163             #    name: <update>
 164             #    short-name: <update>
 165             #    vendor: <update>
 166             #    description: <update>
 167             #    version: <update>
 168             #    # List of Rendered Service Paths
 169             #    rsp:
 170             #    -   id: <update>
 171             #        name: <update>
 172             #        vnfd-connection-point-ref:
 173             #        -   member-vnf-index-ref: <update>
 174             #            order: <update>
 175             #            vnfd-id-ref: <update>
 176             #            vnfd-ingress-connection-point-ref: <update>
 177             #            vnfd-egress-connection-point-ref: <update>
 178             #    # List of classifier rules
 179             #    classifier:
 180             #    -   id: <update>
 181             #        name: <update>
 182             #        rsp-id-ref: <update>
 183             #        member-vnf-index-ref: <update>
 184             #        vnfd-id-ref: <update>
 185             #        vnfd-connection-point-ref: <update>
 186             #        match-attributes:
 187             #        -   id: <update>
 188             #            ip-proto: <update>
 189             #            source-ip-address: <update>
 190             #            destination-ip-address: <update>
 191             #            source-port: <update>
 192             #            destination-port: <update>
 193             {%- endif %}