Ansible deployment of the Kolla containers
Go to file
Rafael Weingärtner 220943fad4 Cloudkitty InfluxDB Storage backend via Kolla-ansible
NOTE: Backported feature to Stein, as part of a fix for bug 1838641.

This proposal will add support to Kolla-Ansible for Cloudkitty
 InfluxDB storage system deployment. The feature of InfluxDB as the
 storage backend for Cloudkitty was created with the following commit
 https://github.com/openstack/cloudkitty/commit/
 c4758e78b49386145309a44623502f8095a2c7ee

Problem Description
===================

With the addition of support for InfluxDB in Cloudkitty, which is
achieving general availability via Stein release, we need a method to
easily configure/support this storage backend system via Kolla-ansible.

Kolla-ansible is already able to deploy and configure an InfluxDB
system. Therefore, this proposal will use the InfluxDB deployment
configured via Kolla-ansible to connect to CloudKitty and use it as a
storage backend.

If we do not provide a method for users (operators) to manage
Cloudkitty storage backend via Kolla-ansible, the user has to execute
these changes/configurations manually (or via some other set of
automated scripts), which creates distributed set of configuration
files, "configurations" scripts that have different versioning schemas
and life cycles.

Proposed Change
===============

Architecture
------------

We propose a flag that users can use to make Kolla-ansible configure
CloudKitty to use InfluxDB as the storage backend system. When
enabling this flag, Kolla-ansible will also enable the deployment of
the InfluxDB via Kolla-ansible automatically.

CloudKitty will be configured accordingly to [1] and [2]. We will also
externalize the "retention_policy", "use_ssl", and "insecure", to
allow fine granular configurations to operators. All of these
configurations will only be used when configured; therefore, when they
are not set, the default value/behavior defined in Cloudkitty will be
used. Moreover, when we configure "use_ssl" to "true", the user will
be able to set "cafile" to a custom trusted CA file. Again, if these
variables are not set, the default ones in Cloudkitty will be used.

Implementation
--------------
We need to introduce a new variable called
`cloudkitty_storage_backend`. Valid options are `sqlalchemy` or
`influxdb`. The default value in Kolla-ansible is `sqlalchemy` for
backward compatibility. Then, the first step is to change the
definition for the following variable:
`/ansible/group_vars/all.yml:enable_influxdb: "{{ enable_monasca |
bool }}"`

We also need to enable InfluxDB when CloudKitty is configured to use
it as the storage backend. Afterwards, we need to create tasks in
CloudKitty configurations to create the InfluxDB schema and configure
the configuration files accordingly.

Alternatives
------------
The alternative would be to execute the configurations manually or
handle it via a different set of scripts and configurations files,
which can become cumbersome with time.

Security Impact
---------------
None identified by the author of this spec

Notifications Impact
--------------------
Operators that are already deploying CloudKitty with InfluxDB as
storage backend would need to convert their configurations to
Kolla-ansible (if they wish to adopt Kolla-ansible to execute these
tasks).

Also, deployments (OpenStack environments) that were created with
Cloudkitty using storage v1 will need to migrate all of their data to
V2 before enabling InfluxDB as the storage system.

Other End User Impact
---------------------
None.

Performance Impact
------------------
None.

Other Deployer Impact
---------------------
New configuration options will be available for CloudKitty.
* cloudkitty_storage_backend
* cloudkitty_influxdb_retention_policy
* cloudkitty_influxdb_use_ssl
* cloudkitty_influxdb_cafile
* cloudkitty_influxdb_insecure_connections
* cloudkitty_influxdb_name

Developer Impact
----------------
None

Implementation
==============

Assignee
--------
* `Rafael Weingärtner <rafaelweingartne>`

Work Items
----------
 * Extend InfluxDB "enable/disable" variable
 * Add new tasks to configure Cloudkitty accordingly to these new
 variables that are presented above
 * Write documentation and release notes

Dependencies
============
None

Documentation Impact
====================
New documentation for the feature.

References
==========
[1] `https://docs.openstack.org/cloudkitty/latest/admin/configuration/storage.html#influxdb-v2`
[2] `https://docs.openstack.org/cloudkitty/latest/admin/configuration/collector.html#metric-collection`

Change-Id: I65670cb827f8ca5f8529e1786ece635fe44475b0
Signed-off-by: Rafael Weingärtner <rafael@apache.org>
Related-Bug: #1838641
(cherry picked from commit 97cb30cdd8)
2019-09-11 18:06:57 +01:00
ansible Cloudkitty InfluxDB Storage backend via Kolla-ansible 2019-09-11 18:06:57 +01:00
contrib Update tacker CLI to openstack CLI in cleanup-tacker 2019-01-16 21:12:48 +08:00
deploy-guide/source Fix the deploy guide build failed 2019-06-06 10:39:55 +00:00
doc Allow to configure docker for Zun 2019-08-17 13:01:04 +00:00
etc/kolla Merge "Allow to configure docker for Zun" into stable/stein 2019-08-22 12:01:38 +00:00
kolla_ansible cmd: Extract methods to allow import from external 2019-03-10 21:02:38 +01:00
releasenotes Cloudkitty InfluxDB Storage backend via Kolla-ansible 2019-09-11 18:06:57 +01:00
specs doc: Start using openstackdoctheme's extlink extension 2019-07-23 16:55:57 +02:00
tests Add ceph-mds/rgw/nfs to gate 2019-08-06 17:55:44 +00:00
tools CI: clean up requirements installation 2019-07-26 14:13:15 +02:00
zuul.d CI: Test ironic also when nova role is modified 2019-07-26 14:11:55 +02:00
.gitignore Switch to stestr 2018-07-24 14:18:20 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:29:09 +00:00
.stestr.conf Switch to stestr 2018-07-24 14:18:20 +07:00
.yamllint Verify YAML syntax in gates 2018-03-26 17:56:22 +02:00
bindep.txt Make Ubuntu gate work 2016-11-03 16:07:47 +00:00
LICENSE Add ASL license 2014-09-20 17:29:35 -07:00
lower-constraints.txt remove pep8 from lower-constraints.txt 2019-02-04 16:56:22 +05:30
README.rst Move to opendev 2019-07-23 16:48:40 +02:00
requirements.txt Add jmespath to requirements.txt 2018-11-20 14:22:37 +00:00
setup.cfg Update programming language mentioned in setup.cfg 2019-03-14 16:47:49 +05:30
setup.py Updated from global requirements 2017-03-02 17:44:00 +00:00
test-requirements.txt Update hacking version 2018-12-27 04:44:49 +00:00
tox.ini Update UPPER_CONSTRAINTS_FILE for stable/stein 2019-04-05 14:00:19 +00:00

Team and repository tags

image

Kolla-Ansible Overview

The Kolla-Ansible is a deliverable project separated from Kolla project.

Kolla-Ansible deploys OpenStack services and infrastructure components in Docker containers.

Kolla's mission statement is:

To provide production-ready containers and deployment tools for operating
OpenStack clouds.

Kolla is highly opinionated out of the box, but allows for complete customization. This permits operators with little experience to deploy OpenStack quickly and as experience grows modify the OpenStack configuration to suit the operator's exact requirements.

Getting Started

Learn about Kolla-Ansible by reading the documentation online Kolla-Ansible.

Get started by reading the Developer Quickstart.

OpenStack services

Kolla-Ansible deploys containers for the following OpenStack projects:

Infrastructure components

Kolla-Ansible deploys containers for the following infrastructure components:

Directories

  • ansible - Contains Ansible playbooks to deploy OpenStack services and infrastructure components in Docker containers.
  • contrib - Contains demos scenarios for Heat, Magnum and Tacker and a development environment for Vagrant
  • doc - Contains documentation.
  • etc - Contains a reference etc directory structure which requires configuration of a small number of configuration variables to achieve a working All-in-One (AIO) deployment.
  • kolla_ansible - Contains password generation script.
  • releasenotes - Contains releasenote of all features added in Kolla-Ansible.
  • specs - Contains the Kolla-Ansible communities key arguments about architectural shifts in the code base.
  • tests - Contains functional testing tools.
  • tools - Contains tools for interacting with Kolla-Ansible.
  • zuul.d - Contains project gate job definitions.

Getting Involved

Need a feature? Find a bug? Let us know! Contributions are much appreciated and should follow the standard Gerrit workflow.

  • We communicate using the #openstack-kolla irc channel.
  • File bugs, blueprints, track releases, etc on Launchpad.
  • Attend weekly meetings.
  • Contribute code.

Contributors

Check out who's contributing code and contributing reviews.

Notices

Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein.