summaryrefslogtreecommitdiffstats
path: root/heat/vCPE/vgw/base_vcpe_vgw.yaml
blob: 0847b69d27232be1530b080c68f594e006bfa58c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
##########################################################################
#
#==================LICENSE_START==========================================
#
#
# Copyright 2017 AT&T Intellectual Property. All rights reserved.
#
# 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.
#
#==================LICENSE_END============================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
#
##########################################################################

heat_template_version: 2013-05-23

description: Heat template to deploy vCPE vGateway (vG)

##############
#            #
# PARAMETERS #
#            #
##############

parameters:
  vcpe_image_name:
    type: string
    label: Image name or ID
    description: Image to be used for compute instance
  vcpe_flavor_name:
    type: string
    label: Flavor
    description: Type of instance (flavor) to be used
  public_net_id:
    type: string
    label: Public network name or ID
    description: Public network that enables remote connection to VNF
  mux_gw_private_net_id:
    type: string
    label: vGMUX private network name or ID
    description: Private network that connects vGMUX to vGWs
  mux_gw_private_subnet_id:
    type: string
    label: vGMUX private sub-network name or ID
    description: vGMUX private sub-network name or ID
  mux_gw_private_net_cidr:
    type: string
    label: vGMUX private network CIDR
    description: The CIDR of the vGMUX private network
  onap_private_net_id:
    type: string
    label: ONAP management network name or ID
    description: Private network that connects ONAP components and the VNF
  onap_private_subnet_id:
    type: string
    label: ONAP management sub-network name or ID
    description: Private sub-network that connects ONAP components and the VNF
  onap_private_net_cidr:
    type: string
    label: ONAP private network CIDR
    description: The CIDR of the protected private network
  cpe_public_net_id:
    type: string
    label: vCPE network that emulates internetmanagement name or ID
    description: Private network that connects vGW to emulated internet
  cpe_public_subnet_id:
    type: string
    label: vCPE Public subnet
    description: vCPE Public subnet
  cpe_public_net_cidr:
    type: string
    label: vCPE public network CIDR
    description: The CIDR of the vCPE public
  vgw_private_ip_0:
    type: string
    label: vGW private IP address towards the vGMUX
    description: Private IP address that is assigned to the vGW to communicate with vGMUX
  vgw_private_ip_1:
    type: string
    label: vGW private IP address towards the ONAP management network
    description: Private IP address that is assigned to the vGW to communicate with ONAP components
  ## VPP will use DHCP to get the vgw_private_ip_2 on the CPE_PUBLIC  subnet
  #vgw_private_ip_2:
  #  type: string
  #  label: vGW private IP address towards the vCPE public network
  #  description: Private IP address that is assigned to the vGW to communicate with vCPE public network
  vgw_name_0:
    type: string
    label: vGW  name
    description: Name of the vGW
  vnf_id:
    type: string
    label: VNF ID
    description: The VNF ID is provided by ONAP
  vf_module_id:
    type: string
    label: vCPE module ID
    description: The vCPE Module ID is provided by ONAP
  dcae_collector_ip:
    type: string
    label: DCAE collector IP address
    description: IP address of the DCAE collector
  dcae_collector_port:
    type: string
    label: DCAE collector port
    description: Port of the DCAE collector
  key_name:
    type: string
    label: Key pair name
    description: Public/Private key pair name
  pub_key:
    type: string
    label: Public key
    description: Public key to be installed on the compute instance
  repo_url_artifacts:
    type: string
    label: Repository URL
    description: URL of the repository that hosts the demo packages
  install_script_version:
    type: string
    label: Installation script version number
    description: Version number of the scripts that install the vFW demo app
  demo_artifacts_version:
    type: string
    label: Artifacts version used in demo vnfs
    description: Artifacts (jar, tar.gz) version used in demo vnfs
  nexus_artifact_repo:
    type: string
    description: Root URL for the Nexus repository for Maven artifacts.
    default: "https://nexus.onap.org"
  cloud_env:
    type: string
    label: Cloud environment
    description: Cloud environment (e.g., openstack, rackspace)
  vpp_source_repo_url:
    type: string
    label: VPP Source Git Repo
    description: URL for VPP source codes
  vpp_source_repo_release_tag:
    type: string
    label: VPP Source Git Release tag
    description: Git release tag for the VPP source codes
  hc2vpp_source_repo_url:
    type: string
    label: Honeycomb Source Git Repo
    description: URL for Honeycomb source codes
  hc2vpp_source_repo_release_tag:
    type: string
    label: Honeycomb Source Git release tag
    description: Git release tag for the Honeycomb source codes
  mux_ip_addr:
    type: string
    label: vGMUX IP address
    description: IP address of vGMUX
  vg_vgmux_tunnel_vni:
    type: number
    label: vG-vGMUX tunnel vni
    description: vni value of vG-vGMUX vxlan tunnel

#############
#           #
# RESOURCES #
#           #
#############

resources:

  random-str:
    type: OS::Heat::RandomString
    properties:
      length: 4

  my_keypair:
    type: OS::Nova::KeyPair
    properties:
      name:
        str_replace:
          template: base_rand
          params:
            base: { get_param: key_name }
            rand: { get_resource: random-str }
      public_key: { get_param: pub_key }
      save_private_key: false

  # Virtual GW Instantiation
  vgw_private_0_port:
    type: OS::Neutron::Port
    properties:
      network: { get_param: mux_gw_private_net_id }
      fixed_ips: [{"subnet": { get_param: mux_gw_private_subnet_id }, "ip_address": { get_param: vgw_private_ip_0 }}]

  vgw_private_1_port:
    type: OS::Neutron::Port
    properties:
      network: { get_param: onap_private_net_id }
      fixed_ips: [{"subnet": { get_param: onap_private_subnet_id }, "ip_address": { get_param: vgw_private_ip_1 }}]

  vgw_private_2_port:
    type: OS::Neutron::Port
    properties:
      network: { get_param: cpe_public_net_id}
      fixed_ips: [{"subnet": { get_param: cpe_public_subnet_id }}]
      ##fixed_ips: [{"subnet": { get_param: cpe_public_subnet_id }, "ip_address": { get_param: vgw_private_ip_2 }}]

  vgw_0:
    type: OS::Nova::Server
    properties:
      image: { get_param: vcpe_image_name }
      flavor: { get_param: vcpe_flavor_name }
      name: { get_param: vgw_name_0 }
      key_name: { get_resource: my_keypair }
      networks:
        - network: { get_param: public_net_id }
        - port: { get_resource: vgw_private_0_port }
        - port: { get_resource: vgw_private_1_port }
        - port: { get_resource: vgw_private_2_port }
      metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }}
      user_data_format: RAW
      user_data:
        str_replace:
          params:
            __mux_gw_private_net_ipaddr__ : { get_param: vgw_private_ip_0 }
            __oam_ipaddr__ : { get_param: vgw_private_ip_1 }
            __oam_cidr__ : { get_param: onap_private_net_cidr }
            __cpe_public_net_cidr__ : { get_param: cpe_public_net_cidr }
            __mux_gw_private_net_cidr__ : { get_param: mux_gw_private_net_cidr }
            __repo_url_artifacts__ : { get_param: repo_url_artifacts }
            __demo_artifacts_version__ : { get_param: demo_artifacts_version }
            __install_script_version__ : { get_param: install_script_version }
            __cloud_env__ : { get_param: cloud_env }
            __vpp_source_repo_url__ : { get_param: vpp_source_repo_url }
            __vpp_source_repo_release_tag__ : { get_param: vpp_source_repo_release_tag }
            __hc2vpp_source_repo_url__ : { get_param: hc2vpp_source_repo_url }
            __hc2vpp_source_repo_release_tag__ : { get_param: hc2vpp_source_repo_release_tag }
            __mux_ip_addr__: { get_param: mux_ip_addr }
            __vg_vgmux_tunnel_vni__: { get_param: vg_vgmux_tunnel_vni }
            __nexus_artifact_repo__: { get_param: nexus_artifact_repo }
          template: |
            #!/bin/bash

            # Create configuration files
            mkdir /opt/config
            echo "__oam_ipaddr__" > /opt/config/oam_ipaddr.txt
            echo "__oam_cidr__" > /opt/config/oam_cidr.txt
            echo "__cpe_public_net_cidr__" > /opt/config/cpe_public_net_cidr.txt
            echo "__mux_gw_private_net_ipaddr__" > /opt/config/mux_gw_private_net_ipaddr.txt
            echo "__mux_gw_private_net_cidr__" > /opt/config/mux_gw_private_net_cidr.txt
            echo "__repo_url_artifacts__" > /opt/config/repo_url_artifacts.txt
            echo "__demo_artifacts_version__" > /opt/config/demo_artifacts_version.txt
            echo "__install_script_version__" > /opt/config/install_script_version.txt
            echo "__cloud_env__" > /opt/config/cloud_env.txt
            echo "__vpp_source_repo_url__" > /opt/config/vpp_source_repo_url.txt
            echo "__vpp_source_repo_release_tag__" > /opt/config/vpp_source_repo_release_tag.txt
            echo "__hc2vpp_source_repo_url__" > /opt/config/hc2vpp_source_repo_url.txt
            echo "__hc2vpp_source_repo_release_tag__" > /opt/config/hc2vpp_source_repo_release_tag.txt
            echo "__mux_ip_addr__" > /opt/config/mux_ip_addr.txt
            echo "__vg_vgmux_tunnel_vni__" > /opt/config/vg_vgmux_tunnel_vni.txt
            echo "__nexus_artifact_repo__" > /opt/config/nexus_artifact_repo.txt

            # Download and run install script
            apt-get -y install unzip
            if [[ "__install_script_version__" =~ "SNAPSHOT" ]]; then REPO=snapshots; else REPO=releases; fi
            curl -k -L "__nexus_artifact_repo__/service/local/artifact/maven/redirect?r=${REPO}&g=org.onap.demo.vnf.vcpe&a=vcpe-scripts&e=zip&v=__install_script_version__" -o /opt/vcpe-scripts-__install_script_version__.zip
            unzip -j /opt/vcpe-scripts-__install_script_version__.zip -d /opt v_gw_install.sh
            cd /opt
            chmod +x v_gw_install.sh
            ./v_gw_install.sh