Installation and configuration¶

Installation¶

sudo -i

1. Save the list of previously installed packages before starting the installation, this will allow to painlessly restore the system in case of damage. Run the following commands to do this:

   mkdir -p /tmp/rollback/rs_server
   pip3 freeze > /tmp/rollback/rs_server/pip_before.txt
   

   After that, the directory /tmp/rollback/rs_server will contain the file pip_before.txt with a list of installed applications.

2. Also save migration versions:

   openstack aos db list -n rs_sever > /tmp/rollback/rs_server/migrations.txt
   

   Where:

   • /tmp/rollback/rs_server/ is a file directory;
   • migrations.txt is a name of the file with migration versions.

3. Install RSserver package:

   • from Python package repository:

     pip3 install rs-server
     

4. Save the list of installed packages after installation to be able to roll back changes:

   pip3 freeze > /tmp/rollback/rs_server/pip_after.txt
   

5. Add user aos:

   useradd -m aos
   passwd password
   

Configuration¶

1. Perform the initial configuration of the module:

   openstack aos configure -n rs_server
   

   When running the command openstack aos configure -n rs_server:

   examples of configuration files to the directory /etc/aos/ are copying; configuration files for the Apache web server are generating; statics for RSserver are assembling.

2. Create directory for logs with the required permissions:

   mkdir -p /var/log/aos/rs-server
   chown -R aos:aos /var/log/aos/rs-server
   

1. Copy the sample configuration file, if using non-standard parameters, edit them:

   cp /etc/aos/aos.conf.example /etc/aos/aos.conf
   cp /etc/aos/rs_server.conf.example /etc/aos/rs_server.conf
   

2. Create database using MySQL as an example, configure rights, database type and other parameters:

   # Login to the database using the root password
   mysql -uroot -p
   # Create rs_server database
   CREATE DATABASE rs_server;
   # Give permission to read, edit, perform any actions on all tables in rs_server database
   GRANT ALL PRIVILEGES ON rs_server.* TO 'aos'@'localhost' IDENTIFIED BY 'password';
   GRANT ALL PRIVILEGES ON rs_server.* TO 'aos'@'%' IDENTIFIED BY 'password';
   # Exit the database
   

3. Edit section [database] of the configuration file etc/aos/rs_server.conf, for example:

   [database]
   url = mysql+pymysql://aos:password@tst.stand.loc:3306/rs_server?charset=utf8
   

4. Migrate database:

   openstack aos db migrate -n rs_server
   

5. Configure RabbitMQ Server message broker:

   rabbitmqctl add_user aos password
   rabbitmqctl add_vhost aos
   rabbitmqctl set_permissions -p aos aos ".*" ".*" ".*"
   rabbitmqctl set_permissions aos ".*" ".*" ".*"
   

6. Create RSserver API service:

   openstack service create --name rs-server --description "RSserver Service" rs-server
   

7. Create endpoints:

   openstack endpoint create --region RegionOne rs-server internal http://controller:9364
   openstack endpoint create --region RegionOne rs-server admin http://controller:9364
   openstack endpoint create --region RegionOne rs-server public http://controller:9364
   

8. Create user in OpenStack for API services:

   openstack user create --domain default --project service --project-domain default --password password --or-show aos
   

9. Assign user service role:

   openstack role add --user aos --user-domain default --project service --project-domain default service
   

10. Enable and start systemd services:

    systemctl daemon-reload
    systemctl enable aos-rs-server-api.service
    systemctl start aos-rs-server-api.service
    systemctl enable aos-rs-broker-api.service
    systemctl start aos-rs-broker-api.service
    systemctl enable aos-rs-listener.service
    systemctl start aos-rs-listener.service
    systemctl enable aos-rs-beat.service
    systemctl start aos-rs-beat.service
    systemctl enable aos-rs-worker.service
    systemctl start aos-rs-worker.service
    

11. Configure Nova services on all controllers and compute nodes for synchronization instances (in the configuration file /etc/nova/nova.conf):

    [oslo_messaging_notifications]
    driver = messagingv2
    

12. Configure Keystone services on all controllers and compute nodes for synchronization instances (in the configuration file /etc/keystone/keystone.conf):

    [oslo_messaging_notifications]
    driver = messagingv2
    

13. Configure Neutron services on all controllers and compute nodes for synchronization instances (in the configuration file /etc/neutron/neutron.conf):

    [DEFAULT]
    notification_driver = messagingv2
    

14. Configure Cinder services on all controllers and compute nodes for synchronization instances (in the configuration file /etc/cinder/cinder.conf):

    [DEFAULT]
    notification_driver = messagingv2
    

15. Create symlink to the supplied Apache config file and restart web servers:

    # Debian:
    ln -s /etc/apache2/conf-available/aos-rs-web.conf /etc/apache2/conf-enabled/aos-rs-web.conf
    service apache2 restart
    

    Note

    It is need to make sure that the configuration file is correct, namely, check paths to the installed modules, paths to logs, compliance of directives of the installed version of Apache.

16. Restart Nova and Neutron service, this action is necessary to enable notifications:

    # Debian:
    systemctl restart nova-api.service
    systemctl restart neutron-server.service
    

RS broker API service configuration¶

WSGI server gunicorn is used to start the service by default. Use following options to configure alternate server:

• WSGI application path is rs_server.api.broker_api.wsgi:application;

• WSGI file:

  # Ubuntu, Debian:
  ``/usr/local/bin/aos-rs-broker-wsgi``.
  

Configuration file¶

Configuration file is presented in ini format and consists of the following sections and parameters:

Recovery plan¶

Roll back if the RSserver plug-in installation or update fails:

1. Compare versions of migrations in file /tmp/rollback/rs_server/migrations.txt with current. If there are any differences, migrate to the previous version for each of the applications. Migration example:

   openstack aos db list -n rs_server
   openstack aos db migrate -n rs_server --migration 14
   

2. Revert to the previous state of the packages:

   cd /tmp/rollback/rs_server
   diff --changed-group-format='%>' --unchanged-group-format='' pip_before.txt pip_after.txt > pip_uninstall.txt
   diff --changed-group-format='%<' --unchanged-group-format='' pip_before.txt pip_after.txt > pip_install.txt
   pip3 uninstall -r pip_uninstall.txt
   pip3 install -r pip_install.txt