diff --git a/source/_static/images/vnf-add-detail.png b/source/_static/images/vnf-add-detail.png new file mode 100644 index 0000000000..9554e83c84 Binary files /dev/null and b/source/_static/images/vnf-add-detail.png differ diff --git a/source/_static/images/vnf-add-nic.png b/source/_static/images/vnf-add-nic.png new file mode 100644 index 0000000000..1dd96cfe56 Binary files /dev/null and b/source/_static/images/vnf-add-nic.png differ diff --git a/source/_static/images/vnf-appliance-networks-selection.png b/source/_static/images/vnf-appliance-networks-selection.png new file mode 100644 index 0000000000..828a89a8ef Binary files /dev/null and b/source/_static/images/vnf-appliance-networks-selection.png differ diff --git a/source/_static/images/vnf-appliance-vnf-nics.png b/source/_static/images/vnf-appliance-vnf-nics.png new file mode 100644 index 0000000000..fd327c8953 Binary files /dev/null and b/source/_static/images/vnf-appliance-vnf-nics.png differ diff --git a/source/_static/images/vnf-details-list.png b/source/_static/images/vnf-details-list.png new file mode 100644 index 0000000000..1f069fd83e Binary files /dev/null and b/source/_static/images/vnf-details-list.png differ diff --git a/source/_static/images/vnf-nics-list.png b/source/_static/images/vnf-nics-list.png new file mode 100644 index 0000000000..4e0dda3172 Binary files /dev/null and b/source/_static/images/vnf-nics-list.png differ diff --git a/source/_static/images/vnf-template-vnf-settings.png b/source/_static/images/vnf-template-vnf-settings.png new file mode 100644 index 0000000000..2a03d1317d Binary files /dev/null and b/source/_static/images/vnf-template-vnf-settings.png differ diff --git a/source/adminguide/index.rst b/source/adminguide/index.rst index 311ba14c1b..0809f86af4 100644 --- a/source/adminguide/index.rst +++ b/source/adminguide/index.rst @@ -134,6 +134,7 @@ Managing Networks and Traffic networking_and_traffic networking/using_remote_access + networking/vnf_templates_appliances Managing the Cloud diff --git a/source/adminguide/networking/vnf_templates_appliances.rst b/source/adminguide/networking/vnf_templates_appliances.rst new file mode 100644 index 0000000000..fcc57bbac9 --- /dev/null +++ b/source/adminguide/networking/vnf_templates_appliances.rst @@ -0,0 +1,181 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information# + regarding copyright ownership. The ASF licenses this file + to you 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. + + +VNF Templates and Appliances +======================= + +Virtualized Network Functions (VNFs) refers to virtualized software applications +which offers network services, for example routers, firewalls, load balancers. + + +Adding a VNF template from an URL +------- + +To create a VNF appliance, user needs to register a VNF template and add VNF settings. + +#. Log in to the CloudStack UI as an administrator or end user. + +#. In the left navigation, choose Images -> Templates + +#. Click on the "Register template from URL" button. + +#. Specify the "Template type" to "VNF" + +#. Click on the OK button. + +When the VNF template is registered successfully, you will see the template on +the same page or under Network -> VNF templates. + + For more information, see `“Uploading Templates from a remote HTTP server” + <../templates.html#uploading-templates-from-a-remote-http-server>`_. + + +Updating a VM template to VNF template +------- + +Users are able to update an existing VM template, which is uploaded from +HTTP server or local, or created from volume, to be a VNF template. + +#. Log in to the CloudStack UI as an administrator or end user. + +#. In the left navigation, choose Images -> Templates + +#. Select the VM template you want to work with. + +#. Go into System Preferences -> Network + +#. Change the "Template type" to "VNF" + +#. Click on the OK button. + + +Updating the VNF settings of a VNF template +------------------- + +Users need to add the VNF nics and VNF details of the VNF templates. + +#. Log in to the CloudStack UI as an administrator or end user. + +#. In the left navigation, choose Images -> Templates + +#. Select the VNF template you want to work with. + +#. Click on the "VNF settings" tab of the VNF template + + |vnf-template-vnf-settings.png| + +#. To add VNF nics, click on the "Add VNF nic" button + + |vnf-add-nic.png| + + The following parameters are supported. + + - deviceid: The device ID of the VNF nic. The device id must be consecutive and start from 0. + + - name: The name of the VNF nic. + + - required: True if the VNF nic is required. Otherwise it is optional. It cannot be true if a preceding nic is optional. + + - management: True if the VNF nic is a management interface. False otherwise + + - description: The description of the VNF nic. + + When VNF nics are added, users will see the list of VNF nics. + + |vnf-nics-list.png| + +#. To add VNF details, click on the "Add VNF detail" button + + |vnf-add-detail.png| + + The following parameters are supported. + + - name: The name of the VNF detail. The valid values are: ACCESS_METHODS, + USERNAME, PASSWORD, SSH_USER, SSH_PASSWORD, SSH_PORT, WEB_USER, WEB_PASSWORD, + HTTP_PATH, HTTP_PORT, HTTPS_PATH, HTTPS_PORT, ICON, VERSION, VENDOR and MAINTAINER + + - value: The value of the VNF detail. If the name is access_methods, the valid values are: console, http, https, ssh-key, ssh-password + +#. To edit or remove VNF details, click on the corresponding icon of each VNF detail. + + |vnf-details-list.png| + + +Deploying VNF appliances +------------------- + +#. Log in to the CloudStack UI as an administrator or end user. + +#. In the left navigation, choose Network -> VNF appliances + +#. Click on the "Add VNF Appliance" button. + + For more information, see `“Creating VMs” + <../virtual_machines.html#creating-vms>`_. + +#. Choose the networks you want to add to the VNF appliance + + |vnf-appliance-networks-selection.png| + +#. In the "VNF nics" step, choose the network each VNF nic will use + + |vnf-appliance-vnf-nics.png| + + The following parameters are supported, if the management network is an Isolated + network or Shared network with security groups. + + - Configure rules for VNF management interfaces. False by default. + + - Source cidr list of rules. It is The CIDR list to forward traffic from to the + VNF management interface. Multiple entries must be separated by a single comma + character (,). The default value is 0.0.0.0/0. + + .. note:: + The following network rules will be applied. + + - If management network is an isolated network, CloudStack will acquire a public + IP, enable static nat on the VNF appliance, and create firewall rules to allow + traffic to ssh/http/https ports based on access_methods in VNF template details. + + - If management network is a shared network with security groups, CloudStack will + create a new security group with rules to allow traffic to ssh/http/https ports + based on access_methods in VNF template details, and assign to the VNF appliance. + + - If management network is a L2 network, VPC tier or Shared network without security + groups, no network rules will be configured. + + +#. Click on the "Launch VNF appliance" button + +When the VNF appliance is deployed successfully, you will see the VNF appliance on +the "VNF appliances" page. + + +.. |vnf-template-vnf-settings.png| image:: /_static/images/vnf-template-vnf-settings.png + :alt: VNF settings of VM template +.. |vnf-add-nic.png| image:: /_static/images/vnf-add-nic.png + :alt: Add VNF nic +.. |vnf-nics-list.png| image:: /_static/images/vnf-nics-list.png + :alt: List of VNF nics +.. |vnf-add-detail.png| image:: /_static/images/vnf-add-detail.png + :alt: Add VNF detail +.. |vnf-details-list.png| image:: /_static/images/vnf-details-list.png + :alt: List of VNF details +.. |vnf-appliance-networks-selection.png| image:: /_static/images/vnf-appliance-networks-selection.png + :alt: Select networks for VNF appliance +.. |vnf-appliance-vnf-nics.png| image:: /_static/images/vnf-appliance-vnf-nics.png + :alt: Specify VNF nics of VNF appliance +