Manual Installation

Manual Installation

This document describes how to install and run Tacker manually on the controller node.

Pre-requisites

1). Ensure that OpenStack components Keystone, Glance, Nova, Neutron, Heat and Horizon are installed. Refer https://docs.openstack.org/ for installation of OpenStack on different Operating Systems.

2). Create client environment scripts “admin-openrc.sh” and “demo-openrc.sh” for the admin and demo projects. Sample instructions for Ubuntu can be found at link below:

https://docs.openstack.org/newton/install-guide-ubuntu/keystone-openrc.html#creating-the-scripts

3). Ensure that the below required packages are installed on the system.

sudo apt-get install python-pip git tox

4). Ensure entry for extensions drivers in ml2_conf.ini. Restart neutron services after the below entry has been added.

[ml2]
extension_drivers = port_security

5). Modify heat’s policy.json file under /etc/heat/policy.json file to allow users in non-admin projects with ‘admin’ roles to create flavors.

"resource_types:OS::Nova::Flavor": "role:admin"

Installing Tacker server

Note

The paths we are using for configuration files in these steps are with reference to Ubuntu Operating System. The paths may vary for other Operating Systems.

The branch_name which is used in commands, specify the branch_name as “stable/<branch>” for any stable branch installation. For eg: stable/ocata, stable/newton. If unspecified the default will be “master” branch.

1). Create MySQL database and user.

mysql -uroot -p
CREATE DATABASE tacker;
GRANT ALL PRIVILEGES ON tacker.* TO 'tacker'@'localhost' \
    IDENTIFIED BY '<TACKERDB_PASSWORD>';
GRANT ALL PRIVILEGES ON tacker.* TO 'tacker'@'%' \
    IDENTIFIED BY '<TACKERDB_PASSWORD>';
exit;

Note

Replace TACKERDB_PASSWORD with your password.

2). Create users, roles and endpoints:

a). Source the admin credentials to gain access to admin-only CLI commands:

. admin-openrc.sh

b). Create tacker user with admin privileges.

Note

Project_name can be “service” or “services” depending on your OpenStack distribution.

openstack user create --domain default --password <PASSWORD> tacker
openstack role add --project service --user tacker admin

c). Create tacker service.

openstack service create --name tacker \
    --description "Tacker Project" nfv-orchestration

d). Provide an endpoint to tacker service.

If you are using keystone v3 then,

openstack endpoint create --region RegionOne nfv-orchestration \
           public http://<TACKER_NODE_IP>:9890/
openstack endpoint create --region RegionOne nfv-orchestration \
           internal http://<TACKER_NODE_IP>:9890/
openstack endpoint create --region RegionOne nfv-orchestration \
           admin http://<TACKER_NODE_IP>:9890/

If you are using keystone v2 then,

openstack endpoint create --region RegionOne \
     --publicurl 'http://<TACKER_NODE_IP>:9890/' \
     --adminurl 'http://<TACKER_NODE_IP>:9890/' \
     --internalurl 'http://<TACKER_NODE_IP>:9890/' <SERVICE-ID>

3). Clone tacker repository.

cd ~/
git clone https://github.com/openstack/tacker -b <branch_name>

4). Install all requirements.

cd tacker
sudo pip install -r requirements.txt

5). Install tacker.

sudo python setup.py install

6). Create ‘tacker’ directory in ‘/var/log’.

sudo mkdir /var/log/tacker
7). Generate the tacker.conf.sample using tools/generate_config_file_sample.sh
or ‘tox -e config-gen’ command. Rename the “tacker.conf.sample” file at “etc/tacker/” to tacker.conf. Then edit it to ensure the below entries:

Note

Ignore any warnings generated while using the “generate_config_file_sample.sh”.

Note

project_name can be “service” or “services” depending on your OpenStack distribution in the keystone_authtoken section.

[DEFAULT]
auth_strategy = keystone
policy_file = /usr/local/etc/tacker/policy.json
debug = True
use_syslog = False
bind_host = <TACKER_NODE_IP>
bind_port = 9890
service_plugins = nfvo,vnfm

state_path = /var/lib/tacker
...

[nfvo]
vim_drivers = openstack

[keystone_authtoken]
memcached_servers = 11211
region_name = RegionOne
auth_type = password
project_domain_name = <DOMAIN_NAME>
user_domain_name = <DOMAIN_NAME>
username = <TACKER_USER_NAME>
project_name = service
password = <TACKER_SERVICE_USER_PASSWORD>
auth_url = http://<KEYSTONE_IP>:35357
auth_uri = http://<KEYSTONE_IP>:5000
...

[agent]
root_helper = sudo /usr/local/bin/tacker-rootwrap /usr/local/etc/tacker/rootwrap.conf
...

[database]
connection = mysql://tacker:<TACKERDB_PASSWORD>@<MYSQL_IP>:3306/tacker?charset=utf8
...

[tacker]
monitor_driver = ping,http_ping

8). Copy the tacker.conf file to “/usr/local/etc/tacker/” directory

sudo su
cp etc/tacker/tacker.conf /usr/local/etc/tacker/

9). Populate Tacker database:

/usr/local/bin/tacker-db-manage --config-file /usr/local/etc/tacker/tacker.conf upgrade head

Install Tacker client

1). Clone tacker-client repository.

cd ~/
git clone https://github.com/openstack/python-tackerclient -b <branch_name>

2). Install tacker-client.

cd python-tackerclient
sudo python setup.py install

Install Tacker horizon

1). Clone tacker-horizon repository.

cd ~/
git clone https://github.com/openstack/tacker-horizon -b <branch_name>

2). Install horizon module.

cd tacker-horizon
sudo python setup.py install

3). Enable tacker horizon in dashboard.

sudo cp tacker_horizon/enabled/* \
    /usr/share/openstack-dashboard/openstack_dashboard/enabled/

4). Restart Apache server.

sudo service apache2 restart

Starting Tacker server

1).Open a new console and launch tacker-server. A separate terminal is required because the console will be locked by a running process.

sudo python /usr/local/bin/tacker-server \
    --config-file /usr/local/etc/tacker/tacker.conf \
    --log-file /var/log/tacker/tacker.log

Registering default VIM

1.) 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.

tacker vim-register --is-default --config-file config.yaml \
       --description <Default VIM description> <Default VIM Name>

2.) The config.yaml will contain VIM specific parameters as below:

auth_url: http://<keystone_public_endpoint_url>:5000
username: <Tacker service username>
password: <Tacker service password>
project_name: <project_name>

Add following parameters to config.yaml if VIM is using keystone v3:

project_domain_name: <domain_name>
user_domain_name: <domain_name>

Note

Here username must point to the user having ‘admin’ and ‘advsvc’ role on the project that will be used for deploying VNFs.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.