Yoga Series Release Notes

Upgrade Notes

  • The default value of [oslo_policy] policy_file config option has been changed from policy.json to policy.yaml. Operators who are utilizing customized or previously generated static policy JSON files (which are not needed by default), should generate new policy files or convert them in YAML format. Use the oslopolicy-convert-json-to-yaml tool to convert a JSON to YAML formatted policy file in backward compatible way.

Deprecation Notes

  • Use of JSON policy files was deprecated by the oslo.policy library during the Victoria development cycle. As a result, this deprecation is being noted in the Wallaby cycle with an anticipated future removal of support by oslo.policy. As such operators will need to convert to YAML policy files. Please see the upgrade notes for details on migration of any custom policy files.


Upgrade Notes

  • The default value of kafka.legacy_kafka_client_enabled has changed from True to False. The use of new Confluent Kafka client is recommended.


New Features

  • Adds support for configuring periodic notifications for all notification types.

  • A new config option, queue_buffering_max_messages, has been added to support controlling the size of posts to Kafka from the Monasca API.

Upgrade Notes

  • Python 2.7 support has been dropped. Last release of monasca-api to support python 2.7 is OpenStack Train. The minimum version of Python now supported by monasca-api is Python 3.6.

Bug Fixes

  • An issue with migrating the DB schema in the Stein release which can cause an upgrade to fail. See story 2006984


New Features

  • support cassandra cluster configuration with loadbalancing policy DCAwareRoundRobinPolicy. ‘local_data_center’ defalut value is ‘’.

  • Allow metric_dimensions filter to filter on multiple dimension values, on alarms count endpoint (IE metric_dimension=hostname:host1|host2). This brings the query parameters into parity between the alarms list and alarms count endpoints. This also restores functionality that was available on the deprecated java api.

  • Support cassandra connection timeout option which set timeout when creating a new connection.

  • Configuration option db_per_tenant added for InfluxDB to allow data points to be written to dedicated tenant database where the database_name prefixes the tenant ID, e.g. monasca_tenantid.

  • Merge monasca-log-api source code into the monasca-api and enable logs endpoints.

  • Introduce configuration options that allow to enable/disable metrics and logs endpoints.

  • Dimensions names and values can be scoped by a timerange which can make dimension related queries to large databases much faster because only the relevant shards are searched. Users that upgrade their Monasca Grafana Datasource plugin to version 1.3.0 will benefit from this feature.

Upgrade Notes

  • Configuration option legacy_kafka_client_enabled added to allow working with both legacy kafka-python and new Confluent Kafka client. Please set message format version for the Kafka brokers to to avoid performance issues until all consumers are upgraded.

  • Upgrade Storm to 1.2.2 from 1.1.3.

  • Upgrade Apache Kafka from version 1.0.1 to 2.0.1. Please consult official upgrading notes for complete information on upgrading from previous versions.

Security Issues

  • InfluxDB 1.7.6 fixes a security issue in which monasca-api leaks dimensions across projects.

Other Notes

  • Unified response when content-type is incorect. Changed response for log part from 415 to 400 (Bad request, message - Bad content type. Must be application/json).


New Features

  • Added new tool monasca-status upgrade check. New framework for monasca-status upgrade check command is added. This framework allows adding various checks which can be run before a Monasca upgrade to ensure if the upgrade can be performed safely.

  • User can configure Cassandra cluster port via configuration option. Default value for port number is 9042.

Upgrade Notes

  • Operator can now use new CLI tool monasca-status upgrade check to check if the Monasca deployment can be safely upgraded from N-1 to N release.

  • agent_authorized_roles default value changed to monasca-agent to be consistent with rest of Monasca, was configured by default to agent so old policy configuration should be checked and adjusted accordingly.

  • Deprecated configuration option database.url has been removed. Please use database.connection instead.

  • The concept of built-in monasca-notification plugins has been removed and the built-in plugins are no longer pre-populated in the database. If you were using the PAGERDUTY, EMAIL or WEBHOOK notification plugin you should explicitly enable it in the monasca-notification config file.

Deprecation Notes

  • Configuration file path /etc/monasca/api-config.conf and /etc/monasca/api.conf are deprecated. Use the standard path /etc/monasca/monasca-api.conf or the configuration dir (supported via oslo.config) /etc/monasca/monasca-api.conf.d/any_config_name.conf


Upgrade Notes


New Features

  • Use of oslo mechanisms for defining and enforcing policy. A command line entry point that allow the user to generate a sample policy file.

Upgrade Notes

  • Apache Kafka has been upgraded to version 1.0.1 in devstack. It is the recommended version for Monasca. Because of existing old consumers, Kafka log message format option log.message.format.version should be set to 0.9.0.


Upgrade Notes

Other Notes

  • Removed maintaining the example of configuration file. The file was removed from the tree, however it can be generated using oslo.config generator feature. Devstack plugin has been also migrated to use it.


Upgrade Notes

  • Documentation handling of monasca-api has been migrated to match OpenStack process. Note that this is just initial migration and entire transition will be completed in future.