Synergy

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with synergy
   • What synergy affects
   • Setup requirements
   • Beginning with synergy
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

Set up and manage Synergy on an existing OpenStack instance.

Module Description

Users that already have an OpenStack instance can use this module to install and configure the two main Synergy components:

• synergy-service
• synergy-scheduler-manager

This module will download the latest version of Synergy and install it. One can manage Synergy configuration directly through this module.

Setup

What synergy affects

• Synergy configuration file at /etc/synergy/synergy.conf
• packages synergy-service (rpm or deb depending on the platform) and synergy-scheduler-manager (via pip)

Setup Requirements

An OpenStack instance (with the version specified in Limitations).

The Puppet module puppetlabs/apt if you plan to install on Ubuntu.

An OpenStack package repository for fetching python-oslo* libraries:

• on Ubuntu, use the OpenStack/CloudArchive repository.
• on CentOS, the CentOS Cloud SIG repository will be installed during the Puppet run through the centos-openstack-release-{openstackversion} package.

Beginning with synergy

Make sure this module is discoverable by your Puppet instance.

Declare the synergy class (see Usage).

Usage

class { 'synergy':
  synergy_db_url          => 'mysql://test:test@localhost',
  dynamic_quotas          => {'project_A' => 1,  'project_B' => 2},
  project_shares          => {'project_A' => 70, 'project_B' => 30 },
  user_shares             => {'project_A' => {'user1' => 60, 'user2' => 40 },
                              'project_B' => {'user3' => 80, 'user4' => 20}},
  keystone_url            => 'https://example.com',
  keystone_admin_user     => 'admin',
  keystone_admin_password => 'the admin password',
}

Reference

Class: synergy

Parameters

• synergy_db_url (required): the Synergy database, must be compliant to the SQLAlchemy database URL schema.
• synergy_log_file (default: /var/log/synergy/synergy.log): a file to log to.
• synergy_log_level (default: INFO): log all information including and above this level, choices: INFO, WARNING, ERROR.
• synergy_service_host (default: localhost): synergy host.
• synergy_service_port (default: 8051): synergy port.
• synergy_project_shares (required): a puppet hash describing the project shares (see Usage for an example).
• keystone_url (required): Keystone URL.
• keystone_admin_user (required): Keystone admin user.
• keystone_admin_password (required): Keystone admin password.
• nova_url (required): Nova URL
• nova_db_url (required): Nova database URL, in SQLAlchemy format.
• amqp_backend (default: rabbit): AMQP backend.
• amqp_host (required): AMQP host.
• amqp_port (default: 5672): AMQP port.
• amqp_user (default: openstack): AMQP user.
• amqp_password (required): AMQP password.
• amqp_virtual_host (default: /): AMQP virtual host.

Limitations

Operating System

• CentOS 7
• Ubuntu 14.04

OpenStack version

• Liberty

Development

Feel free to submit pull requests on the project github page.

Release Notes

0.4.0 (2016-09-13)

• add tabulate package.
• document Synergy class parameters.

0.3.1 (2016-09-06)

• CentOS Synergy packages are now retrieved using the INDIGO-DC repository.

0.3.0 (2016-09-05)

• Ubuntu Synergy packages are now retrieved using the INDIGO-DC repository.