e3e3fc5163
This patch deprecates the Legacy APIs excluding VIM feature. * Emit a warning log when a Deprecated API is executed. * Add warning block to api-refs and docs related with deprecated Legacy feature. Implements: blueprint deprecate-legacy-apis Change-Id: Ie378d1000089401e3a0854b209654182da09e272
64 lines
2.1 KiB
ReStructuredText
64 lines
2.1 KiB
ReStructuredText
========================
|
|
VNF Component in Tacker
|
|
========================
|
|
|
|
.. warning::
|
|
Legacy Tacker features excluding VIM feature are deprecated
|
|
and will be removed in the first major release after the Tacker server
|
|
version 9.0.0 (2023.1 Antelope release).
|
|
|
|
This section will cover how to deploy `vnf component` in Tacker with the
|
|
examples of how to write VNF descriptors.
|
|
|
|
|
|
Sample TOSCA with VNFC
|
|
=======================
|
|
|
|
The following example shows vnfc resource using TOSCA template.
|
|
The target (VDU1) of the 'firewall_vnfc' in this example need to be
|
|
described firstly like other TOSCA templates in Tacker.
|
|
|
|
.. code-block:: yaml
|
|
|
|
topology_template:
|
|
node_templates:
|
|
firewall_vnfc:
|
|
type: tosca.nodes.nfv.VNFC.Tacker
|
|
requirements:
|
|
- host: VDU1
|
|
interfaces:
|
|
Standard:
|
|
create: install_vnfc.sh
|
|
|
|
Every vnfc node must be of type 'tosca.nodes.nfv.VNFC.Tacker'. It takes
|
|
two parameters:
|
|
|
|
1) requirements: This node will accept list of hosts on which VNFC has to be
|
|
installed.
|
|
2) interfaces: This node will accept the absolute path of shell script to be run
|
|
on the VDUs. This shell script should reside in the machine where tacker
|
|
server is running.
|
|
|
|
|
|
How to Setup Environment
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
To make use of VNFC in Tacker, we have to upload the image to the glance in
|
|
which heat-config and heat-config agents are installed. The installation steps
|
|
can be referred `here <https://docs.openstack.org/heat-agents/latest/
|
|
install/building_image.html>`_. The tool
|
|
'tools/vnfc/build_image.sh' can be used to generate such a kind of image.
|
|
|
|
Currently VNFC feature works by using `heat software config <https://docs.openstack.org/heat/latest/
|
|
template_guide/software_deployment.html#software-config-resources>`_ which
|
|
makes use of heat API.
|
|
|
|
So the glance images which has heat-config agents installed are only to be
|
|
passed to VDU.
|
|
|
|
Known Limitations
|
|
~~~~~~~~~~~~~~~~~
|
|
1) Only one VNFC is supported for one VDU. Multiple VNFC per VDU will
|
|
be introduced in future.
|
|
2) The shell script for vnfc has to be placed in the machine where tacker
|
|
server is running.
|