diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index cd013044a..b6fd55fac 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -28,6 +28,64 @@ and `tacker CLI `. Deprecated: 'tacker' command line is deprecated, will be deleted after Rocky is released. Please use 'openstack' client command line instead. + +OpenStackClient CLI +------------------- + +The following list covers the extended commands for Tacker services +available in **openstack** command. + +These commands can be referenced by doing **openstack help** and the detail +of individual command can be referred by **openstack help **. + +.. code-block:: console + + openstack vnf create Create a VNF. + openstack vnf delete Delete given VNF(s). + openstack vnf list List VNF(s) that belong to a given tenant. + openstack vnf resource list List resources of a VNF like VDU, CP, etc. + openstack vnf scale Scale a VNF. + openstack vnf show Show information of a given VNF. + openstack vnf set Update a given VNF. + openstack vnf descriptor create Create a VNFD. + openstack vnf descriptor delete Delete given VNFD(s). + openstack vnf descriptor list List VNFD(s) that belong to a given tenant. + openstack vnf descriptor show Show information of a given VNFD. + openstack vnf descriptor template show Show template of a given VNFD. + openstack vim list List VIM(s) that belong to a given tenant. + openstack vim register Create a VIM. + openstack vim show Show information of a given VIM. + openstack vim set Update a given VIM. + openstack vim delete Delete given VIM(s). + openstack ns create Create a NS. + openstack ns delete Delete given NS(s). + openstack ns list List NS that belong to a given tenant. + openstack ns show Show information of a given NS. + openstack ns descriptor create Create a NSD. + openstack ns descriptor delete Delete a given NSD. + openstack ns descriptor list List NSD(s) that belong to a given tenant. + openstack ns descriptor show Show information of a given NSD. + openstack ns descriptor template show Show template of a given NSD. + openstack vnf graph create Create a VNFFG. + openstack vnf graph delete Delete a given VNFFG. + openstack vnf graph list List VNFFG(s) that belong to a given tenant. + openstack vnf graph show Show information of a given VNFFG. + openstack vnf graph set Update a given VNFFG. + openstack vnf graph descriptor create Create a VNFFGD. + openstack vnf graph descriptor delete Delete a given VNFFGD. + openstack vnf graph descriptor list List VNFFGD(s) that belong to a given tenant. + openstack vnf graph descriptor show Show information of a given VNFFGD. + openstack vnf graph descriptor template show Show template of a given VNFFGD. + openstack vnf chain list List SFC(s) that belong to a given tenant. + openstack vnf chain show Show information of a given SFC. + openstack vnf classifier list List FC(s) that belong to a given tenant. + openstack vnf classifier show Show information of a given FC. + openstack vnf network forwarding path list List NFP(s) that belong to a given tenant. + openstack vnf network forwarding path show Show information of a given NFP. + openstack nfv event show Show event given the event id. + openstack nfv event list List events of resources. + + Tacker CLI ---------- @@ -191,61 +249,3 @@ Tacker CLI vnffgd-list List VNFFGDs that belong to a given tenant. vnffgd-show Show information of a given VNFFGD. vnffgd-template-show Show template of a given VNFFGD. - - -OpenStackClient CLI -------------------- - -The following list covers the extended commands for Tacker services -available in **openstack** command. - -These commands can be referenced by doing **openstack help** and the detail -of individual command can be referred by **openstack help **. - -.. code-block:: console - - openstack vnf create Create a VNF. - openstack vnf delete Delete given VNF(s). - openstack vnf list List VNF(s) that belong to a given tenant. - openstack vnf resource list List resources of a VNF like VDU, CP, etc. - openstack vnf scale Scale a VNF. - openstack vnf show Show information of a given VNF. - openstack vnf set Update a given VNF. - openstack vnf descriptor create Create a VNFD. - openstack vnf descriptor delete Delete given VNFD(s). - openstack vnf descriptor list List VNFD(s) that belong to a given tenant. - openstack vnf descriptor show Show information of a given VNFD. - openstack vnf descriptor template show Show template of a given VNFD. - openstack vim list List VIM(s) that belong to a given tenant. - openstack vim register Create a VIM. - openstack vim show Show information of a given VIM. - openstack vim set Update a given VIM. - openstack vim delete Delete given VIM(s). - openstack ns create Create a NS. - openstack ns delete Delete given NS(s). - openstack ns list List NS that belong to a given tenant. - openstack ns show Show information of a given NS. - openstack ns descriptor create Create a NSD. - openstack ns descriptor delete Delete a given NSD. - openstack ns descriptor list List NSD(s) that belong to a given tenant. - openstack ns descriptor show Show information of a given NSD. - openstack ns descriptor template show Show template of a given NSD. - openstack vnf graph create Create a VNFFG. - openstack vnf graph delete Delete a given VNFFG. - openstack vnf graph list List VNFFG(s) that belong to a given tenant. - openstack vnf graph show Show information of a given VNFFG. - openstack vnf graph set Update a given VNFFG. - openstack vnf graph descriptor create Create a VNFFGD. - openstack vnf graph descriptor delete Delete a given VNFFGD. - openstack vnf graph descriptor list List VNFFGD(s) that belong to a given tenant. - openstack vnf graph descriptor show Show information of a given VNFFGD. - openstack vnf graph descriptor template show Show template of a given VNFFGD. - openstack vnf chain list List SFC(s) that belong to a given tenant. - openstack vnf chain show Show information of a given SFC. - openstack vnf classifier list List FC(s) that belong to a given tenant. - openstack vnf classifier show Show information of a given FC. - openstack vnf network forwarding path list List NFP(s) that belong to a given tenant. - openstack vnf network forwarding path show Show information of a given NFP. - openstack nfv event show Show event given the event id. - openstack nfv event list List events of resources. - diff --git a/doc/source/contributor/development.environment.rst b/doc/source/contributor/development.environment.rst index 37d262faa..453b6d86d 100644 --- a/doc/source/contributor/development.environment.rst +++ b/doc/source/contributor/development.environment.rst @@ -34,7 +34,7 @@ you can use the excellent `DevStack`_ project to do so. There is a wiki page that describes `setting up Tacker using DevStack`_. .. _DevStack: https://git.openstack.org/cgit/openstack-dev/devstack -.. _setting up Tacker using Devstack: https://wiki.openstack.org/wiki/Tacker/Installation +.. _setting up Tacker using Devstack: https://docs.openstack.org/tacker/latest/install/devstack.html Getting the code ---------------- diff --git a/doc/source/contributor/encrypt_vim_auth_with_barbican.rst b/doc/source/contributor/encrypt_vim_auth_with_barbican.rst index b9056b94a..48dfb552e 100644 --- a/doc/source/contributor/encrypt_vim_auth_with_barbican.rst +++ b/doc/source/contributor/encrypt_vim_auth_with_barbican.rst @@ -71,7 +71,7 @@ Create a vim and verify it works: $ source openrc-test.sh $ openstack secret list - $ tacker vim-register --config-file vim-test.yaml vim-test + $ openstack vim register --config-file vim-test.yaml vim-test Created a new vim: +----------------+---------------------------------------------------------+ | Field | Value | @@ -111,7 +111,7 @@ Now we create a vnf to verify it works: .. code-block:: bash - $ tacker vnf-create --vnfd-template vnfd-sample.yaml \ + $ openstack vnf create --vnfd-template vnfd-sample.yaml \ --vim-name vim-test --vim-region-name RegionOne vnf-test Created a new vnf: +----------------+-------------------------------------------------------+ @@ -132,7 +132,7 @@ Now we create a vnf to verify it works: | vnfd_id | dc68ccfd-fd7c-4ef6-8fed-f097d036c722 | +----------------+-------------------------------------------------------+ - $ tacker vnf-delete vnf-test + $ openstack vnf delete vnf-test We can found that vnf create successfully. @@ -140,7 +140,7 @@ Now we delete the vim to verify the secret can be deleted. .. code-block:: bash - $ tacker vim-delete vim-test + $ openstack vim delete vim-test All vim(s) deleted successfully $ openstack secret list diff --git a/doc/source/contributor/event_logging.rst b/doc/source/contributor/event_logging.rst index a1dd04998..74e3891c3 100644 --- a/doc/source/contributor/event_logging.rst +++ b/doc/source/contributor/event_logging.rst @@ -47,30 +47,27 @@ Tacker supports display of events to an end user via - Horizon UI - a separate events tab per resource displays associated events. -- Tacker Client - supports below commands: - - event-show: Show detailed info for a given event ID. - - events-list: Lists all events for all resources. - - vim-events-list: List events that belong to a given VIM. - - vnf-events-list: List events that belong to a given VNF. - - vnfd-events-list: List events that belong to a given VNFD. +- OpenStackClient CLI - supports below commands: + - openstack nfv event show: Show detailed info for a given event ID. + - openstack nfv event list: Lists all events for all resources. NOTE: For more details on the syntax of these CLIs, refer to -`Tacker CLI reference guide `_ +`OpenStackClient CLI reference guide `_ -Tacker Client command usage examples to access resource lifecycle events ------------------------------------------------------------------------- +OpenStackClient CLI usage examples to access resource lifecycle events +---------------------------------------------------------------------- 1. The following command displays all the state transitions that occurred on -a long running VNF. The sample output illustrates a VNF that has -successfully gone through a scale out operation. Note, the here -is VNF's uuid. +a long running VNF. The sample output illustrates a VNF that has +successfully gone through a scale out operation. Note, the +here is VNF's uuid. .. code-block:: console - tacker vnf-events-list --resource_id + openstack nfv event list --resource-id +----+---------------+-------------------+-------------------+------------+-------------------+---------------------+ - | id | resource_type | resource_id | resource_state | event_type | timestamp | event_details | + | ID | Resource Type | Resource ID | Resource State | Event Type | Timestamp | Event Details | +----+---------------+-------------------+-------------------+------------+-------------------+---------------------+ | 13 | vnf | 9dd7b2f1-e91e-418 | PENDING_CREATE | CREATE | 2016-09-21 | VNF UUID assigned. | | | | 3-bcbe- | | | 20:12:37 | | @@ -98,14 +95,14 @@ is VNF's uuid. 2. The following command displays any reachability issues related to a VIM site. The sample output illustrates a VIM that is reachable. Note, the - here is a VIM uuid. + here is a VIM uuid. .. code-block:: console - tacker vim-events-list --resource_id + openstack nfv event list --resource-id +----+---------------+---------------------+----------------+------------+---------------------+---------------+ - | id | resource_type | resource_id | resource_state | event_type | timestamp | event_details | + | ID | Resource Type | Resource ID | Resource State | Event Type | Timestamp | Event Details | +----+---------------+---------------------+----------------+------------+---------------------+---------------+ | 1 | vim | d8c11a53-876c-454a- | PENDING | CREATE | 2016-09-20 23:07:42 | | | | | bad1-cb13ad057595 | | | | | @@ -121,10 +118,10 @@ Miscellaneous events command examples: .. code-block:: console - tacker events-list + openstack nfv event list +----+---------------+-----------------+----------------+------------+-----------------+-----------------+ - | id | resource_type | resource_id | resource_state | event_type | timestamp | event_details | + | ID | Resource Type | Resource ID | Resource State | Event Type | Timestamp | Event Details | +----+---------------+-----------------+----------------+------------+-----------------+-----------------+ | 1 | vim | c89e5d9d-6d55-4 | PENDING | CREATE | 2016-09-10 | | | | | db1-bd67-30982f | | | 20:32:46 | | @@ -155,10 +152,10 @@ Miscellaneous events command examples: .. code-block:: console - tacker events-list --event_type CREATE + openstack nfv event list --event-type CREATE +----+---------------+-----------------+----------------+------------+-----------------+-----------------+ - | id | resource_type | resource_id | resource_state | event_type | timestamp | event_details | + | ID | Resource Type | Resource ID | Resource State | Event Type | Timestamp | Event Details | +----+---------------+-----------------+----------------+------------+-----------------+-----------------+ | 1 | vim | c89e5d9d-6d55-4 | PENDING | CREATE | 2016-09-10 | | | | | db1-bd67-30982f | | | 20:32:46 | | @@ -187,7 +184,7 @@ Miscellaneous events command examples: .. code-block:: console - tacker event-show 5 + openstack nfv event show 5 +----------------+------------------------------------------------------------------------------------------+ | Field | Value | diff --git a/doc/source/contributor/tacker_vim_monitoring.rst b/doc/source/contributor/tacker_vim_monitoring.rst index 36ea164f5..9e4812e0f 100644 --- a/doc/source/contributor/tacker_vim_monitoring.rst +++ b/doc/source/contributor/tacker_vim_monitoring.rst @@ -38,7 +38,7 @@ Firstly register a VIM: .. code-block:: console - $ tacker vim-register --config-file ~/testvim_config.yaml testvim2 -c id -c name -c status + $ openstack vim register --config-file ~/testvim_config.yaml testvim2 -c id -c name -c status Created a new vim: +--------+--------------------------------------+ | Field | Value | @@ -56,7 +56,7 @@ there is a mistral workflow named as .. code-block:: console - $ mistral workflow-list --filter name=vim_id_4406cf8f-f2af-46cc-bfb9-e00add5805b7 -c ID -c Name + $ openstack workflow list --filter name=vim_id_4406cf8f-f2af-46cc-bfb9-e00add5805b7 -c ID -c Name +--------------------------------------+---------------------------------------------+ | ID | Name | +--------------------------------------+---------------------------------------------+ @@ -69,7 +69,7 @@ and it is executed: .. code-block:: console - $ mistral execution-list --filter workflow_name=vim_id_4406cf8f-f2af-46cc-bfb9-e00add5805b7 -c ID -c 'Workflow name' -c State + $ openstack workflow execution list --filter workflow_name=vim_id_4406cf8f-f2af-46cc-bfb9-e00add5805b7 -c ID -c 'Workflow name' -c State +--------------------------------------+---------------------------------------------+---------+ | ID | Workflow name | State | +--------------------------------------+---------------------------------------------+---------+ @@ -82,7 +82,7 @@ The monitoring task is running too: .. code-block:: console - $ mistral task-list --filter workflow_name=vim_id_4406cf8f-f2af-46cc-bfb9-e00add5805b7 -c ID -c 'Workflow name' -c Name -c State + $ openstack task execution list --filter workflow_name=vim_id_4406cf8f-f2af-46cc-bfb9-e00add5805b7 -c ID -c 'Workflow name' -c Name -c State +--------------------------------------+-----------------------------+---------------------------------------------+---------+ | ID | Name | Workflow name | State | +--------------------------------------+-----------------------------+---------------------------------------------+---------+ @@ -95,7 +95,7 @@ Of course, the VIM's state is in 'REACHABLE' status: .. code-block:: console - $ tacker vim-list --name testvim2 -c id -c name -c status + $ openstack vim list --name testvim2 -c id -c name -c status +--------------------------------------+----------+-----------+ | id | name | status | +--------------------------------------+----------+-----------+ diff --git a/doc/source/contributor/vnfd_template_parameterization.rst b/doc/source/contributor/vnfd_template_parameterization.rst index 134d44a9d..28b25e530 100644 --- a/doc/source/contributor/vnfd_template_parameterization.rst +++ b/doc/source/contributor/vnfd_template_parameterization.rst @@ -264,12 +264,12 @@ Key Summary in the parameters value file. #. Supply a parameters value file in yaml format each time during VNF deployment with different values for the parameters. -#. An example of a vnf-create python-tackerclient command specifying a +#. An example of a OpenStackClient vnf creation command specifying a parameterized template and parameter values file would like below: .. code-block:: console - tacker vnf-create --vnfd-name --param-file + openstack vnf create --vnfd-name --param-file #. Specifying a parameter values file during VNF creation is also supported in Horizon UI. diff --git a/doc/source/install/deploy_openwrt.rst b/doc/source/install/deploy_openwrt.rst index 71e11afb1..5c86fcb32 100644 --- a/doc/source/install/deploy_openwrt.rst +++ b/doc/source/install/deploy_openwrt.rst @@ -244,14 +244,14 @@ rules if inject succeed. .. code-block:: console - tacker vnfd-create --vnfd-file tosca-vnfd-openwrt.yaml + openstack vnf descriptor create --vnfd-file tosca-vnfd-openwrt.yaml .. 4.Create a VNF: .. code-block:: console - tacker vnf-create --vnfd-name \ + openstack vnf create --vnfd-name \ --config-file tosca-config-openwrt-firewall.yaml .. @@ -259,8 +259,8 @@ rules if inject succeed. .. code-block:: console - tacker vnf-list - tacker vnf-show + openstack vnf list + openstack vnf show .. We can replace the firewall rules configuration file with diff --git a/doc/source/install/getting_started.rst b/doc/source/install/getting_started.rst index efc30fc9d..b7eedd1a9 100644 --- a/doc/source/install/getting_started.rst +++ b/doc/source/install/getting_started.rst @@ -44,12 +44,12 @@ user can set cert_verify parameter to 'False'. 2.) Register the VIM that will be used as a default VIM for VNF deployments. This will be required when the optional argument --vim-id is not provided by -the user during vnf-create. +the user during vnf creation. .. code-block:: console - tacker vim-register --is-default --config-file vim-config.yaml \ - --description 'my first vim' hellovim + openstack vim register --config-file vim-config.yaml \ + --description 'my first vim' --is-default hellovim .. @@ -116,22 +116,22 @@ Onboarding sample VNF .. code-block:: console - tacker vnfd-create --vnfd-file sample-vnfd.yaml samplevnfd + openstack vnf descriptor create --vnfd-file sample-vnfd.yaml samplevnfd .. 3). Create a VNF. .. code-block:: console - tacker vnf-create --vnfd-name samplevnfd samplevnf + openstack vnf create --vnfd-name samplevnfd samplevnf .. 5). Check the status. .. code-block:: console - tacker vim-list - tacker vnfd-list - tacker vnf-list - tacker vnf-show samplevnf + openstack vim list + openstack vnf descriptor list + openstack vnf list + openstack vnf show samplevnf .. diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 3565c7dd4..5f09003b7 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -25,7 +25,7 @@ For Tacker to work, the system consists of two parts, one is tacker system and another is VIM systems. Tacker system can be installed (here just some ways are listed): -* via devstack, which is usually used by developers +* via DevStack, which is usually used by developers * via Tacker source code manually * via Kolla installation diff --git a/doc/source/install/kolla.rst b/doc/source/install/kolla.rst index 05cc9a171..982b0a5e4 100644 --- a/doc/source/install/kolla.rst +++ b/doc/source/install/kolla.rst @@ -192,6 +192,6 @@ components. .. code-block:: console $ . /etc/kolla/admin-openrc.sh - $ tacker vim-list + $ openstack vim list .. diff --git a/doc/source/install/kubernetes_vim_installation.rst b/doc/source/install/kubernetes_vim_installation.rst index b80b1c704..d7682519d 100644 --- a/doc/source/install/kubernetes_vim_installation.rst +++ b/doc/source/install/kubernetes_vim_installation.rst @@ -221,21 +221,22 @@ User can change the authentication like username, password, etc. Please see Kubernetes document [#fourth]_ to read more information about Kubernetes authentication. -* Run Tacker command for register vim: +* Run OpenStackClient command for register vim: .. code-block:: console - $ tacker vim-register --config-file vim_config.yaml vim-kubernetes + $ openstack vim register --config-file vim_config.yaml vim-kubernetes - $ tacker vim-list + $ openstack vim list +--------------------------------------+----------------------------------+----------------+------------+------------+------------------------------------------------------------+-----------+ - | id | tenant_id | name | type | is_default | placement_attr | status | + | ID | Tenant ID | Name | Type | Is Default | Placement attribution | Status | +--------------------------------------+----------------------------------+----------------+------------+------------+------------------------------------------------------------+-----------+ | 45456bde-6179-409c-86a1-d8cd93bd0c6d | a6f9b4bc9a4d439faa91518416ec0999 | vim-kubernetes | kubernetes | False | {u'regions': [u'default', u'kube-public', u'kube-system']} | REACHABLE | +--------------------------------------+----------------------------------+----------------+------------+------------+------------------------------------------------------------+-----------+ -In ``placement_attr``, there are three regions: 'default', 'kube-public', -'kube-system', that map to ``namespace`` in Kubernetes environment. +In ``Placement attribution``, there are three regions: 'default', +'kube-public', 'kube-system', that map to ``namespace`` in Kubernetes +environment. * Other related commands to Kubernetes VIM @@ -249,9 +250,9 @@ In ``placement_attr``, there are three regions: 'default', 'kube-public', type: "kubernetes" - $ tacker vim-update vim-kubernetes --config-file kubernetes-VIM-update.yaml - $ tacker vim-show vim-kubernetes - $ tacker vim-delete vim-kubernetes + $ openstack vim set vim-kubernetes --config-file kubernetes-VIM-update.yaml + $ openstack vim show vim-kubernetes + $ openstack vim delete vim-kubernetes When update Kubernetes VIM, user can update VIM information (such as username, password, bearer_token and ssl_ca_cert) except auth_url and type of VIM. diff --git a/doc/source/reference/mistral_workflows_usage_guide.rst b/doc/source/reference/mistral_workflows_usage_guide.rst index cc6d3f304..a37d9c5b3 100644 --- a/doc/source/reference/mistral_workflows_usage_guide.rst +++ b/doc/source/reference/mistral_workflows_usage_guide.rst @@ -19,8 +19,8 @@ Mistral workflows for Tacker OpenStack Mistral already integrated with Tacker. The Tenant User or Operator can make use of tacker actions to create custom Mistral Workflows. This -document describes the usage of Mistral CLI to validate, create and executing -Tacker workflows. +document describes the usage of OpenStackClient CLI to validate, create +and executing Tacker workflows. References @@ -35,11 +35,11 @@ Validate workflow definition files before registering with Mistral. :: - usage: mistral workflow-validate + usage: openstack workflow validate :: - $ mistral workflow-validate create_vnf.yaml + $ openstack workflow validate create_vnf.yaml +-------+-------+ | Field | Value | @@ -48,7 +48,7 @@ Validate workflow definition files before registering with Mistral. | Error | None | +-------+-------+ - $ mistral workflow-validate create_vnfd.yaml + $ openstack workflow validate create_vnfd.yaml +-------+-------+ | Field | Value | @@ -57,7 +57,7 @@ Validate workflow definition files before registering with Mistral. | Error | None | +-------+-------+ - $ mistral workflow-validate delete_vnf.yaml + $ openstack workflow validate delete_vnf.yaml +-------+-------+ | Field | Value | @@ -66,7 +66,7 @@ Validate workflow definition files before registering with Mistral. | Error | None | +-------+-------+ - $ mistral workflow-validate delete_vnfd.yaml + $ openstack workflow validate delete_vnfd.yaml +-------+-------+ | Field | Value | @@ -83,11 +83,11 @@ std.delete_vnf workflows in Mistral. :: - usage: mistral workflow-create --public + usage: openstack workflow create --public :: - $ mistral workflow-create create_vnf.yaml --public + $ openstack workflow create create_vnf.yaml --public +--------------------------------------+----------------+----------------------------------+--------+-------+----------------------------+------------+ | ID | Name | Project ID | Tags | Input | Created at | Updated at | @@ -95,7 +95,7 @@ std.delete_vnf workflows in Mistral. | 445e165a-3654-4996-aad4-c6fea65e95d5 | std.create_vnf | bde60e557de840a8a837733aaa96e42e | | body | 2016-07-29 15:08:45.585192 | None | +--------------------------------------+----------------+----------------------------------+--------+-------+----------------------------+------------+ - $ mistral workflow-create create_vnfd.yaml --public + $ openstack workflow create create_vnfd.yaml --public +--------------------------------------+-----------------+----------------------------------+--------+-------+----------------------------+------------+ | ID | Name | Project ID | Tags | Input | Created at | Updated at | @@ -103,7 +103,7 @@ std.delete_vnf workflows in Mistral. | 926caa3e-ee59-4ca0-ac1b-cae03538e389 | std.create_vnfd | bde60e557de840a8a837733aaa96e42e | | body | 2016-07-29 15:08:54.933874 | None | +--------------------------------------+-----------------+----------------------------------+--------+-------+----------------------------+------------+ - $ mistral workflow-create delete_vnfd.yaml --public + $ openstack workflow create delete_vnfd.yaml --public +--------------------------------------+-----------------+----------------------------------+--------+---------+----------------------------+------------+ | ID | Name | Project ID | Tags | Input | Created at | Updated at | @@ -111,7 +111,7 @@ std.delete_vnf workflows in Mistral. | f15b7402-ce31-4369-98d4-818125191564 | std.delete_vnfd | bde60e557de840a8a837733aaa96e42e | | vnfd_id | 2016-08-14 20:01:00.135104 | None | +--------------------------------------+-----------------+----------------------------------+--------+---------+----------------------------+------------+ - $ mistral workflow-create delete_vnf.yaml --public + $ openstack workflow create delete_vnf.yaml --public +--------------------------------------+----------------+----------------------------------+--------+--------+----------------------------+------------+ | ID | Name | Project ID | Tags | Input | Created at | Updated at | +--------------------------------------+----------------+----------------------------------+--------+--------+----------------------------+------------+ @@ -128,11 +128,11 @@ Create new execution for VNFD creation. :: - usage: mistral execution-create [] [] + usage: openstack workflow execution create [] [] :: - $ mistral execution-create std.create_vnfd create_vnfd.json + $ openstack workflow execution create std.create_vnfd create_vnfd.json +-------------------+--------------------------------------+ | Field | Value | @@ -152,11 +152,11 @@ Gather execution details based on execution id. :: - usage: mistral execution-get + usage: openstack workflow execution show :: - $mistral execution-get 31f086aa-a3c9-4f44-b8b2-bec560e32653 + $ openstack workflow execution show 31f086aa-a3c9-4f44-b8b2-bec560e32653 +-------------------+--------------------------------------+ | Field | Value | @@ -178,11 +178,11 @@ Gather VNFD ID from execution output data. :: - usage: mistral execution-get-output + usage: openstack workflow execution output show :: - $ mistral execution-get-output 31f086aa-a3c9-4f44-b8b2-bec560e32653 + $ openstack workflow execution output show 31f086aa-a3c9-4f44-b8b2-bec560e32653 Response: @@ -190,12 +190,12 @@ Gather VNFD ID from execution output data. "vnfd_id": "fb164b77-5e24-402d-b5f4-c6596352cabe" } -Verify VNFD details using tacker CLI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Verify VNFD details using OpenStackClient CLI +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: - $ tacker vnfd-show "fb164b77-5e24-402d-b5f4-c6596352cabe" + $ openstack vnf descriptor show "fb164b77-5e24-402d-b5f4-c6596352cabe" +---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Field | Value | @@ -227,7 +227,7 @@ Create new execution for VNF creation. :: - $ mistral execution-create std.create_vnf create_vnf.json + $ openstack workflow execution create std.create_vnf create_vnf.json +-------------------+--------------------------------------+ | Field | Value | @@ -247,7 +247,7 @@ Gather execution details based on execution id. :: - $ mistral execution-get 3bf2051b-ac2e-433b-8f18-23f57f32f184 + $ openstack workflow execution show 3bf2051b-ac2e-433b-8f18-23f57f32f184 +-------------------+--------------------------------------+ | Field | Value | @@ -267,7 +267,7 @@ Gather VNF ID from execution output data. :: - $ mistral execution-get-output 3bf2051b-ac2e-433b-8f18-23f57f32f184 + $ openstack workflow execution output show 3bf2051b-ac2e-433b-8f18-23f57f32f184 Response: @@ -278,11 +278,11 @@ Gather VNF ID from execution output data. "vnf_id": "1c349534-a539-4d5a-b854-033f98036cd5" } -Verify VNF details using tacker CLI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Verify VNF details using OpenStackClient CLI +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: - $ tacker vnf-show "1c349534-a539-4d5a-b854-033f98036cd5" + $ openstack vnf show "1c349534-a539-4d5a-b854-033f98036cd5" +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Field | Value | @@ -313,7 +313,7 @@ Create new execution for VNF deletion. :: - $ mistral execution-create std.delete_vnf delete_vnf.json + $ openstack workflow execution create std.delete_vnf delete_vnf.json +-------------------+--------------------------------------+ | Field | Value | @@ -333,7 +333,7 @@ Gather execution details based on execution id. :: - $ mistral execution-get 677c7bab-18ee-4a34-b1e6-a305e98ba887 + $ openstack workflow execution show 677c7bab-18ee-4a34-b1e6-a305e98ba887 +-------------------+--------------------------------------+ | Field | Value | @@ -354,7 +354,7 @@ Gather execution output data from execution id. :: - $ mistral execution-get-output 677c7bab-18ee-4a34-b1e6-a305e98ba887 + $ openstack workflow execution output show 677c7bab-18ee-4a34-b1e6-a305e98ba887 Response: @@ -412,7 +412,7 @@ Create new execution for VNF deletion. :: - $ mistral execution-create std.delete_vnfd delete_vnfd.json + $ openstack workflow execution create std.delete_vnfd delete_vnfd.json +-------------------+--------------------------------------+ | Field | Value | @@ -432,7 +432,7 @@ Gather execution details based on execution id. :: - $ mistral execution-get 1e0340c0-bee8-4ca4-8150-ac6e5eb58c99 + $ openstack workflow execution show 1e0340c0-bee8-4ca4-8150-ac6e5eb58c99 +-------------------+--------------------------------------+ | Field | Value | @@ -454,7 +454,7 @@ Gather execution output data from execution id. :: - $ mistral execution-get-output 1e0340c0-bee8-4ca4-8150-ac6e5eb58c99 + $ openstack workflow execution output show 1e0340c0-bee8-4ca4-8150-ac6e5eb58c99 Response: diff --git a/doc/source/user/alarm_monitoring_usage_guide.rst b/doc/source/user/alarm_monitoring_usage_guide.rst index bd3ad4fd6..0504a30bc 100644 --- a/doc/source/user/alarm_monitoring_usage_guide.rst +++ b/doc/source/user/alarm_monitoring_usage_guide.rst @@ -195,7 +195,7 @@ Tacker users could use CLI: .. code-block:: console - $aodh alarm list + $ aodh alarm list +--------------------------------------+-----------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------+----------+---------+ | alarm_id | type | name | state | severity | enabled | diff --git a/doc/source/user/containerized_vnf_usage_guide.rst b/doc/source/user/containerized_vnf_usage_guide.rst index a768ffbfb..7771f2ac2 100644 --- a/doc/source/user/containerized_vnf_usage_guide.rst +++ b/doc/source/user/containerized_vnf_usage_guide.rst @@ -213,7 +213,7 @@ Create sample containerized VNF .. code-block:: console - $ tacker vnfd-create --vnfd-file tosca-vnfd-containerized.yaml VNFD1 + $ openstack vnf descriptor create --vnfd-file tosca-vnfd-containerized.yaml VNFD1 Created a new vnfd: +-----------------+-------------------------------------------------------------------------------------------------------+ | Field | Value | @@ -228,7 +228,7 @@ Create sample containerized VNF | updated_at | | +-----------------+-------------------------------------------------------------------------------------------------------+ - $ tacker vnf-create --vnfd-name VNFD1 --vim-name vim-kubernetes VNF1 + $ openstack vnf create --vnfd-name VNFD1 --vim-name vim-kubernetes VNF1 Created a new vnf: +----------------+-------------------------------------------------------------------------------------------------------+ | Field | Value | @@ -248,7 +248,7 @@ Create sample containerized VNF | vnfd_id | fb4a0aa8-e410-4e73-abdc-d2808de155ef | +----------------+-------------------------------------------------------------------------------------------------------+ - $ tacker vnf-list + $ openstack vnf list +--------------------------------------+------+----------------------------+--------+--------------------------------------+--------------------------------------+ | id | name | mgmt_url | status | vim_id | vnfd_id | +--------------------------------------+------+----------------------------+--------+--------------------------------------+--------------------------------------+ @@ -285,7 +285,7 @@ User also can scale VNF manually, by running the following commands: .. code-block:: console - $ tacker vnf-scale --vnf-name VNF1 --scaling-policy-name SP1 --scaling-type out + $ openstack vnf scale --vnf-name VNF1 --scaling-policy-name SP1 --scaling-type out $ kubectl get deployment NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE diff --git a/doc/source/user/multisite_vim_usage_guide.rst b/doc/source/user/multisite_vim_usage_guide.rst index ab397bfd0..a62417738 100644 --- a/doc/source/user/multisite_vim_usage_guide.rst +++ b/doc/source/user/multisite_vim_usage_guide.rst @@ -37,7 +37,7 @@ To register a new OpenStack VIM inside Tacker. :: - $ tacker vim-register --description 'OpenStack Liberty' --config-file vim_config.yaml Site1 + $ openstack vim register --description 'OpenStack Liberty' --config-file vim_config.yaml Site1 Created a new vim: +----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | Field | Value | @@ -70,8 +70,8 @@ Default VIM configuration ~~~~~~~~~~~~~~~~~~~~~~~~~ The default vim needs to be registered. This is required when the optional -argument -vim-id is not provided during vnf-create. Refer to steps described in -`manual installation`_ to register default vim. +argument -vim-id is not provided during vnf creation. Refer to steps described +in `manual installation`_ to register default vim. .. _manual installation: https://docs.openstack.org/tacker/latest/install/manual_installation.html#registering-default-vim @@ -81,7 +81,7 @@ Onboard a VNFD :: - $ tacker vnfd-create --description "Openwrt VNFD" --vnfd-file vnfd1.yaml openwrt-vnfd1 + $ openstack vnf descriptor create --description "Openwrt VNFD" --vnfd-file vnfd1.yaml openwrt-vnfd1 Created a new vnfd: +-----------------+--------------------------------------+ | Field | Value | @@ -101,7 +101,7 @@ Deploying a new VNF on registered VIM :: - $ tacker vnf-create --description 'Openwrt VNF on Site1' --vnfd-id c3cbf0c0-a492-49e3-9541-945e49e7ed7e --vim-name Site1 openwrt_VNF + $ openstack vnf create --description 'Openwrt VNF on Site1' --vnfd-id c3cbf0c0-a492-49e3-9541-945e49e7ed7e --vim-name Site1 openwrt_VNF Created a new vnf: +----------------+--------------------------------------+ | Field | Value | @@ -118,12 +118,12 @@ Deploying a new VNF on registered VIM | vnfd_id | c3cbf0c0-a492-49e3-9541-945e49e7ed7e | +----------------+--------------------------------------+ -The --vim-id/--vim-name argument is optional during vnf-create. If +The --vim-id/--vim-name argument is optional during vnf creation. If --vim-id/--vim-name is not specified, the default vim will 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-create to deploy the +User can optionally provide --vim-region-name during vnf creation to deploy the VNF in a specify region within that VIM. Updating a VIM @@ -135,7 +135,7 @@ Tacker allows for updating VIM authorization parameters such as 'username', :: - $tacker vim-update VIM0 --config-file update.yaml + $ openstack vim set VIM0 --config-file update.yaml update.yaml in above command will contain: @@ -154,7 +154,7 @@ To delete a VIM : :: - $ tacker vim-delete VIM1 + $ openstack vim delete VIM1 Deleted vim: VIM1 Features diff --git a/doc/source/user/scale_usage_guide.rst b/doc/source/user/scale_usage_guide.rst index 3d131a3ba..1e09f1c1d 100644 --- a/doc/source/user/scale_usage_guide.rst +++ b/doc/source/user/scale_usage_guide.rst @@ -115,7 +115,7 @@ Tacker provides following CLI for scaling. .. code-block::console -**tacker vnf-scale --vnf-id ** +**openstack vnf scale --vnf-id ** **--vnf-name ** **--scaling-policy-name ** **--scaling-type ** @@ -132,7 +132,7 @@ as below: .. code-block::console -**tacker vnf-scale --vnf-name sample-vnf** +**openstack vnf scale --vnf-name sample-vnf** **--scaling-policy-name sp1** **--scaling-type out** diff --git a/doc/source/user/vnffg_usage_guide.rst b/doc/source/user/vnffg_usage_guide.rst index 8a15389f6..0afef58cd 100644 --- a/doc/source/user/vnffg_usage_guide.rst +++ b/doc/source/user/vnffg_usage_guide.rst @@ -141,11 +141,11 @@ flow through the path. This creates an extra classifier to ensure return traffic flows through the chain in a reverse path, otherwise this traffic routed normally and does not enter the VNFFG. -Tacker provides the following CLI to create a VNFFGD: +Tacker provides the following OpenStackClient CLI to create a VNFFGD: .. code-block:: console - tacker vnffgd-create --vnffgd-file + openstack vnf graph descriptor create --vnffgd-file Creating the VNFFG @@ -158,36 +158,36 @@ same Connection Point definitions as the ones you declared in your VNFFGD. .. code-block:: console - tacker vnfd-create --vnfd-file tosca-vnffg-vnfd1.yaml VNFD1 - tacker vnf-create --vnfd-name VNFD1 VNF1 + openstack vnf descriptor create --vnfd-file tosca-vnffg-vnfd1.yaml VNFD1 + openstack vnf create --vnfd-name VNFD1 VNF1 - tacker vnfd-create --vnfd-file tosca-vnffg-vnfd2.yaml VNFD2 - tacker vnf-create --vnfd-name VNFD2 VNF2 + openstack vnf descriptor create --vnfd-file tosca-vnffg-vnfd2.yaml VNFD2 + openstack vnf create --vnfd-name VNFD2 VNF2 Refer the 'Getting Started' link below on how to create a VNFD and deploy 2 VNFs: `VNF1`_ and `VNF2`_. https://docs.openstack.org/tacker/latest/install/getting_started.html -Tacker provides the following CLI to create VNFFG from VNFFGD: +Tacker provides the following OpenStackClient CLI to create VNFFG from VNFFGD: .. code-block:: console - tacker vnffg-create --vnffgd-name --vnf-mapping --symmetrical + openstack vnf graph create --vnffgd-name --vnf-mapping --symmetrical or you can create directly VNFFG from vnffgd template without initiating VNFFGD. .. code-block:: console - tacker vnffg-create --vnffgd-template --vnf-mapping \ + openstack vnf graph create --vnffgd-template --vnf-mapping \ --symmetrical If you use a parameterized vnffg template: .. code-block:: console - tacker vnffg-create --vnffgd-name --param-file --vnf-mapping \ + openstack vnf graph create --vnffgd-name --param-file --vnf-mapping \ --symmetrical Here, @@ -205,7 +205,7 @@ to the desired VNF instance: .. code-block:: console - tacker vnf-list + openstack vnf list +--------------------------------------+------+---------------------------+--------+--------------------------------------+--------------------------------------+ | id | name | mgmt_url | status | vim_id | vnfd_id | @@ -214,7 +214,7 @@ to the desired VNF instance: | 91e32c20-6d1f-47a4-9ba7-08f5e5effe07 | VNF1 | {"VDU1": "192.168.1.7"} | ACTIVE | 0e70ec23-6f32-420a-a039-2cdb2c20c329 | 27795330-62a7-406d-9443-2daad76e674b | +--------------------------------------+------+---------------------------+--------+--------------------------------------+--------------------------------------+ - tacker vnffg-create --vnffgd-name myvnffgd --vnf-mapping \ + openstack vnf graph create --vnffgd-name myvnffgd --vnf-mapping \ VNFD1:'91e32c20-6d1f-47a4-9ba7-08f5e5effe07',VNFD2:'7168062e-9fa1-4203-8cb7-f5c99ff3ee1b' --symmetrical myvnffg Alternatively, if no vnf-mapping is provided then Tacker VNFFG will attempt @@ -243,7 +243,7 @@ VNFFG command with parameter file: .. code-block:: console - tacker vnffg-create --vnffgd-name vnffgd-param --vnf-mapping VNFD1:'91e32c20-6d1f-47a4-9ba7-08f5e5effe07',\ + openstack vnf graph create --vnffgd-name vnffgd-param --vnf-mapping VNFD1:'91e32c20-6d1f-47a4-9ba7-08f5e5effe07',\ VNFD2:'7168062e-9fa1-4203-8cb7-f5c99ff3ee1b' --param-file vnffg-param-file.yaml myvnffg @@ -256,18 +256,18 @@ Viewing a VNFFG A VNFFG once created is instantiated as multiple sub-components. These components include the VNFFG itself, which relies on a Network Forwarding Path (NFP). The NFP is then composed of a Service Function Chain (SFC) and -a Classifier. The main command to view a VNFFG is 'tacker vnffg-show, +a Classifier. The main command to view a VNFFG is 'openstack vnf graph show', however there are several commands available in order to view the sub-components for a rendered VNFFG: .. code-block:: console - tacker nfp-list - tacker nfp-show - tacker chain-list - tacker chain-show - tacker classifier-list - tacker classifier-show + openstack vnf network forwarding path list + openstack vnf network forwarding path show + openstack vnf chain list + openstack vnf chain show + openstack vnf classifier list + openstack vnf classifier show Updating the VNFFG ~~~~~~~~~~~~~~~~~~ @@ -279,10 +279,10 @@ Using the below command query the list of existing VNFFG templates. .. code-block:: console - tacker vnffg-list + openstack vnf graph list - +--------------------+---------+-------+-------------------------------------+ - | id | name | status | vnffgd_id | + +--------------------+--------+------- +-------------------------------------+ + | ID | Name | Status | VNFFGD ID | +--------------------+-----------------+-------------------------------------+ | f4438511-e33d-43df-| | | | | 95d9-0199253db72e | myvnffg| ACTIVE | bd7829bf-85de-4f3b-960a-8482028bfb34| @@ -303,7 +303,7 @@ of VNFFG creation. .. code-block:: console - tacker vnffg-show myvnffg + openstack vnf graph show myvnffg After user determined which VNF is used and which VNF is going to be used in the update procedure he can execute: @@ -312,7 +312,7 @@ To update the VNF mappings to VNFFG, execute the below command .. code-block:: console - tacker vnffg-update --vnf-mapping VNFD1:vnf1,VNFD2:vnf2 myvnffg + openstack vnf graph set --vnf-mapping VNFD1:vnf1,VNFD2:vnf2 myvnffg Updated vnffg: myvnffg @@ -422,7 +422,7 @@ below command: .. code-block:: console - tacker vnffg-update --vnffgd-template myvnffgd.yaml myvnffg + openstack vnf graph set --vnffgd-template myvnffgd.yaml myvnffg Updated vnffg: myvnffg @@ -430,7 +430,7 @@ Of course the above update VNFFG's choices can be combined in a single command. .. code-block:: console - tacker vnffg-update --vnf-mapping VNFD1:vnf1,VNFD2:vnf2 --vnffgd-template myvnffgd.yaml myvnffg + openstack vnf graph set --vnf-mapping VNFD1:vnf1,VNFD2:vnf2 --vnffgd-template myvnffgd.yaml myvnffg Updated vnffg: myvnffg diff --git a/doc/source/user/vnfm_usage_guide.rst b/doc/source/user/vnfm_usage_guide.rst index 5268b3094..3835367a5 100644 --- a/doc/source/user/vnfm_usage_guide.rst +++ b/doc/source/user/vnfm_usage_guide.rst @@ -31,7 +31,7 @@ command: .. code-block:: console - tacker vnfd-create --vnfd-file + openstack vnf descriptor create --vnfd-file .. note:: @@ -56,14 +56,14 @@ creating VNFs in Tacker. .. code-block:: console - tacker vnfd-create --vnfd-file + openstack vnf descriptor create --vnfd-file .. ii). Create a VNF. .. code-block:: console - tacker vnf-create --vnfd-name + openstack vnf create --vnfd-name Example @@ -71,8 +71,8 @@ Example .. code-block:: console - tacker vnfd-create --vnfd-file sample-vnfd-hello-world.yaml hello-world-vnfd - tacker vnf-create --vnfd-name hello-world-vnfd hw-vnf + openstack vnf descriptor create --vnfd-file sample-vnfd-hello-world.yaml hello-world-vnfd + openstack vnf create --vnfd-name hello-world-vnfd hw-vnf Direct VNF Instantiation ------------------------ @@ -82,7 +82,7 @@ onboarding the template into Tacker VNFD Catalog. .. code-block:: console - tacker vnf-create --vnfd-template + openstack vnf create --vnfd-template This method is recommended when NFV Catalog is maintained outside Tacker and Tacker is primarily used as a NFV workflow engine. @@ -92,7 +92,7 @@ Example .. code-block:: console - tacker vnf-create --vnfd-template sample-vnfd-hello-world.yaml hw-vnf + openstack vnf create --vnfd-template sample-vnfd-hello-world.yaml hw-vnf .. note :: @@ -104,8 +104,8 @@ Example .. code-block:: console - tacker vnfd-list --template-source inline - tacker vnfd-list --template-source all + openstack vnf descriptor list --template-source inline + openstack vnf descriptor list --template-source all Finding VNFM Status =================== @@ -114,11 +114,11 @@ Status of various VNFM resources can be checked by following commands. .. code-block:: console - tacker vim-list - tacker vnfd-list - tacker vnf-list - tacker vnf-show - tacker vnfd-show + openstack vim list + openstack vnf descriptor list + openstack vnf list + openstack vnf show + openstack vnf descriptor show .. @@ -129,6 +129,6 @@ VNFs and VNFDs can be deleted as shown below. .. code-block:: console - tacker vnf-delete - tacker vnfd-delete + openstack vnf delete + openstack vnf descriptor delete ..