tacker/doc/source/install/manual_installation.rst

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 http://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: http://docs.openstack.org/liberty/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

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

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;

2). Create users, roles and endpoints.

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

source 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 --password <PASSWORD> tacker
openstack role add --project services --user tacker admin

c). Create tacker service.

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

d). Provide an endpoint to tacker service.

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.

git clone https://github.com/openstack/tacker

4). Install all requirements.

cd tacker
sudo  pip install -r requirements.txt

Note

If OpenStack components mentioned in pre-requisites section have been installed, the below command would be sufficient.

cd tacker
sudo  pip install tosca-parser

5). Install tacker.

sudo python setup.py install

6). Create 'tacker' directory in '/var/log'.

Note

The above referenced path '/var/log' is for Ubuntu and may be different for other Operating Systems.

sudo mkdir /var/log/tacker

7). Generate the tacker.conf.sample using tools/generate_config_file_sample.sh

or 'tox -e config-gen' command and rename it to tacker.conf. Then edit it to ensure the below entries:

Note

In Ubuntu 14.04, the tacker.conf is located at /usr/local/etc/tacker/ and below ini sample is for Ubuntu and directory paths referred in ini may be different for other Operating Systems.

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
state_path = /var/lib/tacker
...
[keystone_authtoken]
project_name = service
password = <TACKER_SERVICE_USER_PASSWORD>
auth_url = http://<KEYSTONE_IP>:35357
#identity_uri = http://<KEYSTONE_IP>:5000
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_nova]
password = <NOVA_SERVICE_USER_PASSWORD>
auth_url = http://<NOVA_IP>:35357
...
[tacker_heat]
heat_uri = http://<HEAT_IP>:8004/v1

8). Populate Tacker database:

Note

The below command is for Ubuntu Operating System.

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

Install Tacker client

1). Clone tacker-client repository.

cd ~/
git clone https://github.com/openstack/python-tackerclient

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

2). Install horizon module.

cd tacker-horizon
sudo python setup.py install

3). Enable tacker horizon in dashboard.

Note

The below destination path referred is for Ubuntu 14.04 and may change for other Operating Systems.

sudo cp openstack_dashboard_extensions/* \
    /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.

Note

Ensure that ml2_conf.ini as per Step 4 from the pre-requisites section has been configured.

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

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>

config.yaml will contain VIM specific parameters as below:

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

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

project_domain_name: <domain>
user_domain_name: <domain>

Note

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

3). Restart tacker server.