4.4 KiB
Installation
Install freezer-api
# git clone https://git.openstack.org/openstack/freezer-api.git
# cd freezer-api
# pip install ./
edit config file
# sudo cp etc/freezer/freezer-api.conf /etc/freezer/freezer-api.conf
# sudo cp etc/freezer/freezer-paste.ini /etc/freezer/freezer-paste.ini
# sudo vi /etc/freezer/freezer-api.conf
# sudo vi /etc/freezer/freezer-paste.ini
setup/configure the db
The currently supported db is Elasticsearch. In case you are using a dedicated instance of the server, you'll need to start it. Depending on the OS flavor it might be a:
# service elasticsearch start
or, on systemd
# systemctl start elasticsearch
Elasticsearch needs to know what type of data each document's field contains. This information is contained in the mapping, or schema definition. Elasticsearch will use dynamic mapping to try to guess the field type from the basic datatypes available in JSON, but some field's properties have to be explicitly declared to tune the indexing engine. To do that, use the freezer-manage command: :
# freezer-manage db sync
You should have updated your configuration files before doing this step. freezer-manage has the following options:
To create the db mappings use the following command:
# freezer-manage db sync
To update the db mappings using the following command. Update means that you might have some mappings and you want to update it with a more recent ones :
# freezer-manage db update
To remove the db mappings using the following command :
# freezer-manage db remove
To print the db mappings using the following command :
# freezer-manage db show
To update your settings (number of replicas) all what you need to do is to change its value in the configuration file and then run the following command :
# freezer-manage db update-settings
If you provided an invalid number of replicas that will cause problems later on, so it's highly recommended to make sure that you are using the correct number of replicas. For more info click here Elasticsearch_Replicas_instructions
To get information about optional additional parameters:
# freezer-manage -h
If you want to add any additional parameter like --yes or --erase, they should be before the db option. Check the following examples:
Wrong Example:
# freezer-manage db sync -y -e
Correct Example:
# freezer-manage -y -e db sync
run simple instance
# freezer-api
examples running using uwsgi
# uwsgi --http :9090 --need-app --master --module freezer_api.cmd.wsgi:application
# uwsgi --https :9090,foobar.crt,foobar.key --need-app --master --module freezer_api.cmd.wsgi:application
example running freezer-api with apache2
# sudo vi /etc/apache2/sites-enabled/freezer-api.conf
<VirtualHost ...>
=freezer display-name=%{GROUP}
WSGIDaemonProcess freezer-api processes=2 threads=2 user
WSGIProcessGroup freezer-api
WSGIApplicationGroup freezer-api
WSGIScriptAlias / /opt/stack/freezer_api/cmd/wsgi.py
/var/log/freezer-api/freezer-api.log
ErrorLog /var/log/freezer-api/freezer-api_access.log combined
CustomLogLogLevel info
<Directory /opt/stack/freezer_api>
Options Indexes FollowSymLinks MultiViews
all granted
RequireAllowOverride None
Order allow,deny
from all
allowLimitRequestBody 102400
</Directory>
</VirtualHost>
API registration
# openstack user create --domain default --password-prompt freezer
# openstack role add --project service --user freezer admin
# openstack service create --name freezer --description "Freezer Backup Service" backup
# openstack endpoint create --region RegionOne backup public http://freezer_api_publicurl:port
# openstack endpoint create --region RegionOne backup internal http://freezer_api_internalurl:port
# openstack endpoint create --region RegionOne backup admin http://freezer_api_adminurl:port
devstack_plugin.rst