Browse Source

Merge "Tacker documents trivial fix"

changes/48/743748/2
Zuul 5 days ago
committed by Gerrit Code Review
parent
commit
a499efb827
16 changed files with 39 additions and 39 deletions
  1. +1
    -1
      doc/source/contributor/development.environment.rst
  2. +1
    -1
      doc/source/contributor/event_logging.rst
  3. +2
    -2
      doc/source/contributor/tacker_functional_test.rst
  4. +2
    -2
      doc/source/contributor/vnfd_template_description.rst
  5. +2
    -2
      doc/source/contributor/vnffgd_template_description.rst
  6. +2
    -2
      doc/source/contributor/zabbix-plugin.rst
  7. +2
    -2
      doc/source/install/kubernetes_vim_installation.rst
  8. +1
    -1
      doc/source/reference/block_storage_usage_guide.rst
  9. +1
    -1
      doc/source/reference/reservation_policy_usage_guide.rst
  10. +2
    -2
      doc/source/user/containerized_vnf_usage_guide.rst
  11. +3
    -3
      doc/source/user/dynamic_vnffg_usage_guide.rst
  12. +4
    -4
      doc/source/user/multisite_vim_usage_guide.rst
  13. +3
    -3
      doc/source/user/nsd_usage_guide.rst
  14. +2
    -2
      doc/source/user/placement_policy_usage_guide.rst
  15. +6
    -6
      doc/source/user/vnffg_usage_guide.rst
  16. +5
    -5
      doc/source/user/vnffg_usage_guide_advanced.rst

+ 1
- 1
doc/source/contributor/development.environment.rst View File

@@ -24,7 +24,7 @@ Mac OS X. These instructions assume you're already familiar with
Git and Gerrit, which is a code repository mirror and code review toolset
, however if you aren't please see `this Git tutorial`_ for an introduction
to using Git and `this guide`_ for a tutorial on using Gerrit and Git for
code contribution to Openstack projects.
code contribution to OpenStack projects.

.. _this Git tutorial: http://git-scm.com/book/en/Getting-Started
.. _this guide: https://docs.openstack.org/infra/manual/developers.html#development-workflow


+ 1
- 1
doc/source/contributor/event_logging.rst View File

@@ -11,7 +11,7 @@ Overview
--------

OpenStack Tacker supports capturing resource event information when the
tacker resources undergo create, update, delete, scale and monitor
tacker resources undergo create, update, delete, scale and monitor
operations. This information becomes useful to an admin for audit purposes.

Tacker Resources supporting Events


+ 2
- 2
doc/source/contributor/tacker_functional_test.rst View File

@@ -76,7 +76,7 @@ Important guidelines to follow:
* Testcases in tox environment may be executed in parallel.
The order in which the testcases are executed may vary
between two environments.
* The code added should meet pep8 standards. This can be verified with
* The code added should meet pep8 standards. This can be verified with
following command and ensuring the code does not return any errors.

.. code-block:: console
@@ -123,4 +123,4 @@ Committing testcase and opening a review:
Sample testcase:
================
* Check sample tests under following directory:
https://github.com/openstack/tacker/blob/master/tacker/tests/functional/
https://opendev.org/openstack/tacker/src/branch/master/tacker/tests/functional/

+ 2
- 2
doc/source/contributor/vnfd_template_description.rst View File

@@ -65,7 +65,7 @@ network function.
flavor describing physical properties for the VDU to be spawned, monitoring
policies for the VDU, providing user data in form of custom commands to the
VDU. A complete list of VDU properties currently supported by Tacker are
listed `here <https://github.com/openstack/tacker/blob/master/tacker/tosca/
listed `here <https://opendev.org/openstack/tacker/src/branch/master/tacker/tosca/
lib/tacker_nfv_defs.yaml>`_ under **properties** section of
**tosca.nodes.nfv.VDU.Tacker** field

@@ -170,7 +170,7 @@ Configuring a VDU
"""""""""""""""""
A VDU can be configured as a specific Network Function under **config**
section in VNFD template. A sample template configuring a VDU as a firewall
can be viewed in a `sample file <https://github.com/openstack/tacker/blob/
can be viewed in a `sample file <https://opendev.org/openstack/tacker/src/branch/
master/samples/tosca-templates/vnfd/tosca-config-openwrt-firewall.yaml>`_.

Specifying external image


+ 2
- 2
doc/source/contributor/vnffgd_template_description.rst View File

@@ -273,7 +273,7 @@ composed of a Forwarding Path and a VNFFG. A full VNFFGD is shown below:

.. [#f1] http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/tosca-nfv-v1.0.html
.. [#f2] https://github.com/openstack/tacker/tree/master/samples/tosca-templates/vnffgd
.. [#f3] https://github.com/openstack/tacker/blob/master/tacker/tosca/lib/tacker_nfv_defs.yaml
.. [#f4] https://github.com/openstack/tacker/blob/master/tacker/tosca/lib/tacker_nfv_defs.yaml
.. [#f3] https://opendev.org/openstack/tacker/src/branch/master/tacker/tosca/lib/tacker_nfv_defs.yaml
.. [#f4] https://opendev.org/openstack/tacker/src/branch/master/tacker/tosca/lib/tacker_nfv_defs.yaml
.. [#f5] http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd03/tosca-nfv-v1.0-csd03.html#_Toc447714727
.. [#f6] https://docs.openstack.org/tacker/latest/user/vnffg_usage_guide.html

+ 2
- 2
doc/source/contributor/zabbix-plugin.rst View File

@@ -28,7 +28,7 @@ settings. You do not have to do a lot of work or complex settings.

Zabbix-Agent must be installed in the VNF. And you need to set it up. The
necessary settings must be made in /etc/zabbix/zabbix_agentd.conf in the
VNF. Installation and The setting method is as follows.
VNF. Installation and the setting method is as follows.

.. code-block:: console

@@ -139,7 +139,7 @@ recommended to use USER_DATA parameter.

If we enter Zabbix-related information in the template, you will
get a Token according to the internal workflow of Zabbix-plugin.
It it used to configure varitous monitoring functions.
It it used to configure various monitoring functions.

.. code-block:: console



+ 2
- 2
doc/source/install/kubernetes_vim_installation.rst View File

@@ -265,7 +265,7 @@ References
----------

.. [#first] https://github.com/openstack-dev/devstack/blob/master/doc/source/networking.rst#shared-guest-interface
.. [#second] https://github.com/openstack/tacker/blob/master/doc/source/install/devstack.rst
.. [#third] https://github.com/openstack/tacker/blob/master/devstack/local.conf.kubernetes
.. [#second] https://opendev.org/openstack/tacker/src/branch/master/doc/source/install/devstack.rst
.. [#third] https://opendev.org/openstack/tacker/src/branch/master/devstack/local.conf.kubernetes
.. [#fourth] https://github.com/openstack/kuryr-kubernetes/blob/master/doc/source/installation/testing_connectivity.rst
.. [#fifth] https://kubernetes.io/docs/admin/authentication

+ 1
- 1
doc/source/reference/block_storage_usage_guide.rst View File

@@ -19,7 +19,7 @@ Orchestrating VNFs with attached Volumes

To support persistent volumes to VNF, TOSCA NFV profile supports new type
of nodes. Tacker has now feature of parsing of those new nodes and creation
of cinder volumes which are attached to the VDUs.
of cinder volumes which are attached to the VDUs.


Prerequisites


+ 1
- 1
doc/source/reference/reservation_policy_usage_guide.rst View File

@@ -407,7 +407,7 @@ When reservation resource type is physical:host

..

2. Replace the flavor with reservation in tosca-tempate given for reservation
2. Replace the flavor with reservation in tosca-template given for reservation
policy as below:
Ref:
``samples/tosca-templates/vnfd/tosca-vnfd-host-reservation.yaml``


+ 2
- 2
doc/source/user/containerized_vnf_usage_guide.rst View File

@@ -319,7 +319,7 @@ After installation, user should check kuryr.conf configuration.

To use CustomResourceDefinition, user needs to add CRD.
User can make a additional network using yaml file like below.
Create yaml file like below and register it.
Create yaml file like below and register it.

.. code-block:: console

@@ -410,7 +410,7 @@ Known Issues and Limitations

References
==========
.. [#first] https://github.com/openstack/tacker/blob/master/doc/source/install/kubernetes_vim_installation.rst
.. [#first] https://opendev.org/openstack/tacker/src/branch/master/doc/source/install/kubernetes_vim_installation.rst
.. [#second] https://kubernetes.io/docs/concepts/workloads/pods/init-containers
.. [#third] https://kubernetes.io/docs/concepts/workloads/pods/pod-overview
.. [#fourth] https://kubernetes.io/docs/concepts/workloads/controllers/deployment


+ 3
- 3
doc/source/user/dynamic_vnffg_usage_guide.rst View File

@@ -292,9 +292,9 @@ mitigated.
.. [#f1] https://www.openstack.org/videos/vancouver-2018/dynamic-sfc-from-tacker-to-incept-specific-traffic-of-vm-1
.. [#f2] https://github.com/dangtrinhnt/DynamicSFCDemo/blob/master/DynamicSFC_OpenStackSummit2018Vancouver.pdf
.. [#f3] https://docs.openstack.org/devstack/latest/
.. [#f4] https://github.com/openstack/tacker/blob/master/devstack/local.conf.example
.. [#f4] https://opendev.org/openstack/tacker/src/branch/master/devstack/local.conf.example
.. [#f5] https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-zabbix-to-securely-monitor-remote-servers-on-ubuntu-16-04
.. [#f6] https://blog.rapid7.com/2017/02/14/how-to-install-suricata-nids-on-ubuntu-linux/
.. [#f7] https://docs.openstack.org/tacker/latest/install/deploy_openwrt.html
.. [#f8] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnfd/tosca-vnfd-openwrt.yaml
.. [#f9] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnfd/tosca-config-openwrt-firewall.yaml
.. [#f8] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnfd/tosca-vnfd-openwrt.yaml
.. [#f9] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnfd/tosca-config-openwrt-firewall.yaml

+ 4
- 4
doc/source/user/multisite_vim_usage_guide.rst View File

@@ -17,7 +17,7 @@
Multisite VIM Usage
===================

A single Tacker controller node can be used to manage multiple Openstack sites
A single Tacker controller node can be used to manage multiple OpenStack sites
without having the need to deploy Tacker server on each of these sites. Tacker
allows users to deploy VNFs in multiple OpenStack sites using the multisite VIM
feature. OpenStack versions starting from Kilo are supported with this feature.
@@ -69,7 +69,7 @@ remote OpenStack site.
.. note::

In Keystone, port `5000` is enabled for authentication service [1]_, so the
end users can use `auth_url: 'http://127.0.0.1:5000/v3` instead of
end users can use `auth_url: 'http://127.0.0.1:5000/v3` instead of
`auth_url: 'http://127.0.0.1/identity'` as above mention.

Default VIM configuration
@@ -130,7 +130,7 @@ be used to deploy VNF on the default site. We can create default vim
by specifying --is-default option with vim-register command.

User can optionally provide --vim-region-name during vnf creation to deploy the
VNF in a specify region within that VIM.
VNF in a specify region within that VIM.

Updating a VIM
~~~~~~~~~~~~~~
@@ -165,7 +165,7 @@ To delete a VIM :

Features
~~~~~~~~
* Tacker support multi-tenancy, that means a VIM regisetered by one tenant can
* Tacker support multi-tenancy, that means a VIM registered by one tenant can
not be shared with other.
* Pluggable driver module framework allowing Tacker to interact with multiple
VIM types.


+ 3
- 3
doc/source/user/nsd_usage_guide.rst View File

@@ -488,9 +488,9 @@ Reference

.. [#f1] https://www.etsi.org/deliver/etsi_gs/NFV-IFA/001_099/014/02.01.01_60/gs_NFV-IFA014v020101p.pdf
.. [#f2] https://wiki.onap.org/display/DW/ONAP+Release+1+modeling+specification?preview=%2F13599755%2F13599839%2FNSD+Specification.pdf
.. [#f3] https://github.com/openstack/tacker/blob/master/tacker/nfvo/drivers/workflow/workflow_generator.py
.. [#f3] https://opendev.org/openstack/tacker/src/branch/master/tacker/nfvo/drivers/workflow/workflow_generator.py
.. [#f4] https://docs.openstack.org/tacker/latest/install/deploy_openwrt.html
.. [#f5] https://docs.openstack.org/tacker/latest/user/vnffg_usage_guide.html
.. [#f6] https://docs.openstack.org/tacker/latest/user/vnffg_usage_guide_advanced.html
.. [#f7] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/nsd/sample-tosca-vnfd1.yaml
.. [#f8] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/nsd/sample-tosca-vnfd2.yaml
.. [#f7] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/nsd/sample-tosca-vnfd1.yaml
.. [#f8] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/nsd/sample-tosca-vnfd2.yaml

+ 2
- 2
doc/source/user/placement_policy_usage_guide.rst View File

@@ -17,7 +17,7 @@
VDU Placement policy
====================

Openstack nova server groups can be used to control the affinity and
OpenStack nova server groups can be used to control the affinity and
anti-affinity scheduling policy for a group of VDU's. Below placement
policies are supported::

@@ -144,7 +144,7 @@ Deploying placement TOSCA template using Tacker

Once OpenStack/Devstack along with Tacker has been successfully installed,
deploy a sample placement policy template from location given below:
https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnfd/tosca-placement-policy-anti-affinity.yaml
https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnfd/tosca-placement-policy-anti-affinity.yaml

Refer the 'Getting Started' link below on how to create a VNFD and deploy a
VNF:


+ 6
- 6
doc/source/user/vnffg_usage_guide.rst View File

@@ -25,7 +25,7 @@ decides which traffic should go through them.

Similar to how VNFs are described by VNFDs, VNFFGs are described by VNF
Forwarding Graph Descriptors (VNFFGD). Please see the `devref guide
<https://github.com/openstack/tacker/blob/master/doc/source/contributor
<https://opendev.org/openstack/tacker/src/branch/master/doc/source/contributor
/vnffgd_template_description.rst>`_ on VNFFGD to learn more about
how a VNFFGD is defined.

@@ -43,7 +43,7 @@ in order to use Tacker VNFFG. Networking-sfc also requires at least OVS 2.5
.0, so also ensure that is installed. See the full `Networking-sfc guide
<https://docs.openstack.org/networking-sfc/latest/>`_.

A simple example of a service chain would be one that forces all traffice
A simple example of a service chain would be one that forces all traffic
from HTTP client to HTTP server to go through VNFs that was created by
VNFFG.

@@ -111,7 +111,7 @@ applies to an OpenStack VIM.

Two "network_dst_port_id" and "ip_dst_prefix" parameters must be set when you
want to create VNFFG with "symmetrical" feature. If you want to create VNFFG
without "symmetrical", you can ommit "network_dst_port_id" and "ip_dst_prefix".
without "symmetrical", you can omit "network_dst_port_id" and "ip_dst_prefix".

.. code-block:: yaml

@@ -401,7 +401,7 @@ derived from the following VNFFGD template.
constituent_vnfs: [VNFD3]
members: [Forwarding_path1]

By using the below VNFFGD template we can update the exisitng VNFFG.
By using the below VNFFGD template we can update the existing VNFFG.

.. code-block:: yaml

@@ -484,7 +484,7 @@ Known Issues and Limitations
- NSH attributes not yet supported
- n-sfc Bug: https://bugs.launchpad.net/networking-sfc/+bug/1746686

.. _VNF1: https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd1.yaml
.. _VNF2: https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd2.yaml
.. _VNF1: https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd1.yaml
.. _VNF2: https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd2.yaml
.. _SFC_PROXY: https://tools.ietf.org/html/rfc8300
.. _SFC_ENCAPSULATION: https://docs.openstack.org/networking-sfc/latest/contributor/ietf_sfc_encapsulation.html

+ 5
- 5
doc/source/user/vnffg_usage_guide_advanced.rst View File

@@ -235,9 +235,9 @@ If user delete VNFFG1, the VNFFG2 is not affected because the port pair group
.. rubric:: Footnotes

.. [#f1] https://docs.openstack.org/tacker/latest/user/vnffg_usage_guide.html
.. [#f2] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnffgd/tosca-vnffgd-sample.yaml
.. [#f3] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnffgd/tosca-vnffgd-sample-VNF1.yaml
.. [#f2] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnffgd/tosca-vnffgd-sample.yaml
.. [#f3] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnffgd/tosca-vnffgd-sample-VNF1.yaml
.. [#f4] https://docs.openstack.org/tacker/latest/user/vnffg_usage_guide.html
.. [#f5] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd1.yaml
.. [#f6] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd2.yaml
.. [#f7] https://github.com/openstack/tacker/blob/master/samples/tosca-templates/vnffgd
.. [#f5] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd1.yaml
.. [#f6] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnffgd/tosca-vnffg-vnfd2.yaml
.. [#f7] https://opendev.org/openstack/tacker/src/branch/master/samples/tosca-templates/vnffgd

Loading…
Cancel
Save