CCVPN Use Case IM Proposal (Deprecated in R4)
0.Background
Please refer CCVPN Use Case Proposal
For CCVPN current proposal, we define it based on the codes of ONAP Beijing release. There is no change for the ONAP service and resource model.
1.Diagram
1.1CCVPN Current Solution
1.2 CCVPN Stretch Goal
2. Service
2.1 CCVPN Service(Stretch Goal)
Derived from ServiceComposite
Attributes | Required | Cardinality | Content | Description |
sotnVpnInfraSrv | M | 1 | SOTN VPN Infra Service | References the SOTN VPN Infra service |
sdwanVpnInfraSrv | M | 1..N | SDWAN VPN Infra Service | References the SD-WAN VPN Infra service |
siteSrv | M | 0..N | Site Service | References the descriptor of a Site service. Refer Note1. |
Note1: At least 1 site is suggested.
2.2 SOTN VPN Infra Service
Derived from Service
Attributes | Required | Cardinality | Content | Description |
sotnConnectivity | M | 1 | SOTN Connectivity | References the descriptor of the SOTN connectivity |
spPartner | O | 1 | SPPartner | The service provider partner reference |
2.3 SDWAN VPN Infra Service
Derived from Service
Attributes | Required | Cardinality | Content | Description |
sdwanConnectivity | M | 1 | SDWAN Connectivity | References the descriptor of the SDWAN Connectivity. |
internetCloudAccess | M | 1 | Internet Cloud Access | References the descriptor of the internet cloud access. |
spPartner | O | 1 | SPPartner | The service provider partner reference |
2.4 Site Service
Derived from Service
Attributes | Required | Cardinality | Content | Description |
device | M | 0..2 | Device | References the descriptor of the Device |
siteWanPort | M | 0..N | Site WAN Port | Reference the Site Wan Port. |
siteLanPort | M | 0..N | Site LAN Port | Reference the Site Lan Port. |
sotnVpnInfraAttachment | M | 1 | SOTN VPN Attachment | References the descriptor of the SOTN VPN attachment. |
sdwanVpnInfraAttachment | M | 1 | SDWAN VPN Attachment | References the descriptor of the SDWAN VPN attachment. |
spPartner | O | 1 | SPPartner | The service provider partner reference |
3. Resource
3.1 SOTN Connectivity
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the SOTN connectivity information element. |
name | M | 1 | String | The name of the SOTN connectivity. |
description | O | 1 | String | The description of the SOTN connectivity. |
type | M | 1 | String | The type should be: client/ethernet. |
startTime | M | 1 | String | The start time of the SOTN connectivity |
endTime | M | 1 | String | The end time of the SOTN connectivity |
COS | O | 1 | String | It can be premium/standard |
reroute | O | 1 | boolean | Reroute enable |
SLS | O | 1 | String | Service Level Specification |
dualLink | O | 1 | boolean | Is dual link for this connectivity |
CIR | O | 1 | String | The CIR for the SOTN connectivity. Only for Ethernet type |
EIR | O | 1 | String | The EIR for the SOTN connectivity. Only for Ethernet type |
CBS | O | 1 | String | The CBS for the SOTN connectivity. Only for Ethernet type |
EBS | O | 1 | String | The EBS for the SOTN connectivity. Only for Ethernet type |
colorAware | O | 1 | Boolean | The color aware for the SOTN connectivity. Only for Ethernet type. |
couplingFlag | O | 1 | Boolean | The coupling flag for the SOTN connectivity. Only for Ethernet type. |
3.2 SDWAN Connectivity
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the SDWAN connectivity information element. |
name | M | 1 | String | The name of the SDWAN connectivity. |
vni | O | 1 | String | The VXLAN ID of the SDWAN connectivity. |
topology | M | 1 | String |
|
3.3 SOTN VPN Infra Attachment
Attributes | Required | Cardinality | Content | Description |
sotnVpnName | M | 1 | String | References the SOTN VPN Infra service. |
clientSignal | O | 1 | String | The client signal for the site. It is used for only client type connectivity. |
cVLAN | O | 1 | String | The cVLAN for the site. It is used for only ethernet type connectivity. |
3.4 SDWAN VPN Infra Attachment
Attributes | Required | Cardinality | Content | Description |
sdwanVpnName | M | 1 | String | References the SDWAN VPN Infra service. |
role | O | 1 | Boolean | The role for site attach to the VPN. It can be hub/spoke. Only for hub-spoke VPN. |
3.5 Device
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the device |
esn | O | 1 | String | Device Series number, Refer to Note2 |
name | O | 1 | String | The name of the device |
description | O | 1 | String | The description of the device |
vendor | O | 1 | String | The vendor of the device |
class | M | 1 | String | The class of the device, it can be VNF/PNF |
type | O | 1 | String | The type of the device, Refer to Note2 |
version | O | 1 | String | The version of the device. |
systemIp | O | 1 | String | The system IP of the device. |
Note2: Esn and type must have one.
3.6 Internet Cloud Access
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the Internet cloud access |
internetCloudAccessType | O | 1 | String | Centralized(default) or Direct internet access |
internetGatewaySiteId | O | 1 | String | Refer to the site id of the Gateway |
isPermit | M | 1 | String | Is the site permit to access internet. Default: true |
3.7 Site WAN Port
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the WAN port |
name | O | 1 | String | The name of the WAN port |
description | O | 1 | String | The description of the WAN port |
deviceId | M | 1 | String | The deviceId of the site |
portType | M | 1 | String | The port type of the device for WAN port. 1 GE, 2 FE, 3 XGE, 4 LTE, 5 xDSL(ATM), 6 xSDL(PTM) |
portNumber | M | 1 | String | Port number |
ipAddress | M | 1 | String | The ip and mask of the WAN port |
providerIpAddress | M | 1 | String | The ip address of the provider PE |
vlanId | O | 1 | String | The vlan id of the WAN port |
transportNetworkName | M | 1 | String | The transport network name that WAN port connect to. |
inputBandwidth | M | 1 | int | The input bandwidth of the WAN port. (Mbps) |
outputBandwidth | M | 1 | int | The output bandwidth of the WAN port. (Mbps) |
3.8 Site LAN Port
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the LAN port |
name | M | 1 | String | The name of the LAN port |
description | M | 1 | String | The description of the LAN port |
deviceId | M | 1 | String | The device id of in the site |
portId | M | 1 | String | The portId of the device |
ipAddress | M | 1 | String | The ip address of the LAN port |
vlanTag | M | 1 | String | The vlan tag of the LAN port |
dhcpService | O | 1 | DHCP Service Object | DHCP service of the LAN port |
inputBandwidth | O | 1 | String | The input bandwidth of the LAN port |
outputBandwidth | O | 1 | String | The output bandwidth of the LAN port |
DHCP Service
Attributes | Required | Cardinality | Content | Description |
serviceEnable | M | 1 | boolean | DHCP enable flag. Default: false |
dhcpServiceType | M | 1 | enum | Relay / Server |
leaseTime | C | 1 | uint16 | When dhcpServiceType is Server |
domainName | C | 1 | String | When dhcpServiceType is Server |
dns | C | N | string | When dhcpServiceType is Server |
ntpPrimary | C | 1 | string | When dhcpServiceType is Server |
ntpSecondary | C | 1 | string | When dhcpServiceType is Server |
nbns | C | N | string | When dhcpServiceType is Server |
domainName | C | 1 | string | When dhcpServiceType is Server |
serverIpAddress | C | 1 | string | When dhcpServiceType is Relay |
3.9 SPPartner
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the SPPartner |
url | M | 1 | String | The url of the ONAP from SPPartner |
providingServiceInvarianteUuid | M | 1 | String | The providing service invariant uuid from SPPartner |
providingServiceUuid | M | 1 | String | The providing service uuid from SPPartner |
handoverMode | M | 1 | String | The handover mode for the cross ONAP. It can be SOTN/SD-WAN |
3.10 Site
Actually, This Site resource is used for Site DC Service and Site Enterprise service because SDC does not support service level parameters definition (All the parameters can be find in Site Service IM), so we make it as a resource for site service here.
Attributes | Required | Cardinality | Content | Description |
id | M | 1 | String | Identifier of the enterprise site. |
name | M | 1 | String | The name of the site |
description | O | 1 | String | The description of the site |
location | M | 1 | Location Object | The location of the site. |
type | M | 1 | String | 1: single gateway 2: dual gateway default: 1 This item is used for SDWAN only. |
role | M | 1 | String | 1: dsvpn-hub 2: sd-wan-edge This item is used for SDWAN only. |
controlPoint | O | 1 | String | The control site for the site. It is needed for sd-wan-edge role site. |
Location Object
Attributes | Required | Cardinality | Content | Description |
emails | O | 1..N | String | Email list |
postcode | M | 1 | String | postcode |
address | M | 1 | String | Address |
latitude | O | 1 | String | Latitude |
longitude | O | 1 | String | Longitude |