openstack/tacker
Code Issues Proposed changes

doc change default vim registration via CLI

Browse Source 
Update doc to include new way of default vim registration
via CLI.

Change-Id: If8c126257d56ca94e64ee533901540bd4bf39ce6
Partial-Bug: 1592957
This commit is contained in:
Saju Madhavan 2016-07-16 03:20:58 +05:30
parent ae288ca5ec
commit 5f6303ca63
2 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/devref/multisite_vim_usage_guide.rst
View File

@ -68,10 +68,9 @@ remote OpenStack site.
Default VIM configuration
~~~~~~~~~~~~~~~~~~~~~~~~~
The default vim needs to be registered and added to tacker.conf under
'nfvo_vim' section. This is required when the optional argument -vim-id
is not provided during vnf-create. Refer to steps described in
`manual installation`_ to add it into tacker.conf.
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.
.. _manual installation: http://docs.openstack.org/developer/tacker/install/manual_installation.html#registering-default-vim
@ -98,8 +97,9 @@ Deploying a new VNF on registered VIM
+----------------+--------------------------------------+
The --vim-id/--vim-name argument is optional during vnf-create. If
--vim-id/--vim-name is not specified, the 'default_vim' key in tacker.conf will
be used to deploy VNF on the default site.
--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
VNF in a specify region within that VIM.

22
doc/source/install/manual_installation.rst
View File

@ -305,34 +305,32 @@ required because the console will be locked by a running process.
Registering default VIM
=======================
1). Register the VIM that will be used as a default VIM for VNF deployments.
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.
.. code-block:: console
tacker vim-register --config-file config.yaml --name <Default VIM name>
--description <Default VIM description>
tacker vim-register --is-default --config-file config.yaml \
--name <Default VIM name> --description <Default VIM description>
..
config.yaml will contain VIM specific parameters as below:
.. code-block:: ini
auth_url: http://<keystone ip>:5000
auth_url: http://<keystone_public_endpoint_url>:5000
username: <username>
password: <password>
project_name: <project_name>
.. note::
Here username must point to the user having 'admin' and 'advsvc' role on the
project that will be used for deploying VNFs.
2). Add the VIM name registered in step 1 in /etc/tacker/tacker.conf under
[nfvo_vim] section:
Add following parameters to config.yaml if VIM is using keystone v3:
.. code-block:: ini
default_vim = <Default VIM Name>
project_domain_name: <domain>
user_domain_name: <domain>
3). Restart tacker server
.. note::
Here username must point to the user having 'admin' and 'advsvc' role on the
project that will be used for deploying VNFs.