openstack/openstack-manuals
Code Issues Proposed changes
openstack-manuals/doc/config-reference/source/message/api.rst
Rui Chen d14dc6a7ea Yaml format policy Update in Configuration Reference 
For Newton, the content of the page needs to be updated to reflect the
change from .JSON to YAML format. A note also needs to be added that
specifies environments with .JSON format policy files will still work
through a backport.

Change-Id: I11c5f2b8e5964e37ae9fb04e2bd2260cd6a5b6d2
Co-Authored-By: Kevin_Zheng <zhengzhenyu@huawei.com>
Closes-Bug: #1575926
2017-02-15 14:18:49 +08:00

1.3 KiB
Raw Blame History

Message API configuration

The Message service has two APIs: the HTTP REST API for WSGI transport driver, and the Websocket API for Websocket transport driver. The Message service can use only one transport driver at the same time. See zaqar-drivers for driver options.

The functionality and behavior of the APIs are defined by API versions. For example, the Websocket API v2 acts the same as the HTTP REST API v2. For now there are v1, v1.1 and v2 versions of HTTP REST API and only v2 version of Websocket API.

Permission control options in each API version:

  • The v1 does not have any permission options.
  • The v1.1 has only admin_mode option which controls the global permission to access the pools and flavors functionality.
  • The v2 has only:
    • RBAC policy options: policy_default_rule, policy_dirs, policy_file which controls the permissions to access each type of functionality for different types of users. See ../policy-yaml-file.
    • secret_key option which defines a secret key to use for signing special URLs. These are called pre-signed URLs and give temporary permissions to outsiders of the system.

Configuration options

The Message service can be configured by changing the following options: