openstack/masakari
Code Issues Proposed changes

Fix release notes formatting

Browse Source 
Formatted previously added release notes to avoid 'ScannerError'.
Also modified conf.py under releasenotes to generate releasenotes
as per standards and to remove occurrences of Glance snippet.

Closes-Bug: #1662445
Change-Id: Ie928d173c1ab4b512f303f6643da045d85a339c5
This commit is contained in:
bhagyashris
2017-02-10 16:10:45 +05:30
parent c2bf0d8b57
commit 77f51c51a9
7 changed files with 82 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
releasenotes/notes/add_ha_enabled_config_options-54a9270a5993d20a.yaml
View File

@@ -1,23 +1,32 @@
--- ---
features: features:
- Added two new config options: - |
Operators can decide whether all instances or only those instances which
contain metadata key 'HA_Enabled=True' should be allowed for evacuation
from a failed source compute node. When set to True, it will evacuate all
instances from a failed source compute node. First preference will be
given to those instances which contain 'HA_Enabled=True' metadata key,
and then it will evacuate the remaining ones. When set to False, it will
evacuate only those instances which contain 'HA_Enabled=True' metadata
key.
evacuate_all_instances: To use this feature, following config option need to be set under
Operators can decide whether all instances or only those instances ``host_failure`` section in 'masakari.conf' file::
which contain metadata key 'HA_Enabled=True' should be allowed for
evacuation from a failed source compute node. When set to True, it will
evacuate all instances from a failed source compute node. First
preference will be given to those instances which contain
'HA_Enabled=True' metadata key, and then it will evacuate the remaining
ones. When set to False, it will evacuate only those instances which
contain 'HA_Enabled=True' metadata key.
process_all_instances: [host_failure]
Operators can decide whether all instances or only those instances evacuate_all_instances = True
which contain metadata key 'HA_Enabled=True' should be taken into
account to recover from instance failure events. When set to True, - |
it will execute instance failure recovery actions for an instance Operators can decide whether all instances or only those instances which
irrespective of whether that particular instance contains metadata key contain metadata key 'HA_Enabled=True' should be taken into account to
'HA_Enabled=True' or not. When set to False, it will only execute recover from instance failure events. When set to True, it will execute
instance failure recovery actions for an instance which contain instance failure recovery actions for an instance irrespective of whether
metadata key 'HA_Enabled=True'. that particular instance contains metadata key 'HA_Enabled=True' or not.
When set to False, it will only execute instance failure recovery action
for an instance which contain metadata key 'HA_Enabled=True'.
To use this feature, following config option need to be set under
``instance_failure`` section in 'masakari.conf' file::
[instance_failure]
process_all_instances = True

1
releasenotes/notes/adopt-oslo-config-generator-cf2fdb17cf7f13db.yaml
View File

@@ -1,5 +1,6 @@
--- ---
other: other:
- |
Adopt oslo-config-generator to generate sample config files. Adopt oslo-config-generator to generate sample config files.
New config options from masakari code should register with New config options from masakari code should register with
masakari/conf/opts.py. A deprecated option should add a masakari/conf/opts.py. A deprecated option should add a

31
releasenotes/notes/correct_response_code-df8b43a201efa1b4.yaml
View File

@@ -1,23 +1,16 @@
--- ---
fixes: fixes:
- Following apis will return correct response codes now: - |
POST: notification create: Fixes `bug 1645699`_ which will return correct response codes for below
old_response: 200, new_response: 202 apis:
DELETE: notification delete: - POST /v1/notification - old_response: 200, new_response: 202
old_response: 404, new_response: 405 - DELETE /v1/notification - old_response: 404, new_response: 405
- PUT /v1/notification/<notification_uuid> - old_response: 404,
new_response: 405
- POST /v1/host - old_response: 200, new_response: 201
- DELETE /v1/host/<host_uuid> - old_response: 200, new_response: 204
- POST /v1/segment - old_response: 200, new_response: 201
- DELETE /v1/segment/<segment_uuid> - old_response: 200, new_response: 204
PUT: notification update: .. _bug 1645699: https://bugs.launchpad.net/masakari/+bug/1645699
old_response: 404, new_response: 405
POST: Host create:
old_response: 200, new_response: 201
DELETE: Host delete:
old_response: 200, new_response: 204
POST: Failover-segment create:
old_response: 200, new_response: 201
DELETE: Failover-segment delete:
old_response: 200, new_response: 204

24
releasenotes/notes/failover_segment_apis-f5bea1cd6d103048.yaml
View File

@@ -1,19 +1,11 @@
--- ---
features: features:
- Added following new REST API's for masakari operators - - |
Added following new REST API's for masakari operators:
1. GET /v1/segments
Returns list of all failover segments.
2. GET /v1/segments/<segment_uuid>
Returns specific failover segment with uuid.
3. POST /v1/segments
Creates a new failover segment
4. PUT /v1/segments/<segment_uuid>
Updates a failover segment by uuid
5. DELETE /v1/segments/<segment_uuid>
Delete a failover segment by uuid
- GET /v1/segments - Returns list of all failover segments.
- GET /v1/segments/<segment_uuid> - Returns specific failover segment
with uuid.
- POST /v1/segments - Creates a new failover segment
- PUT /v1/segments/<segment_uuid> - Updates a failover segment by uuid
- DELETE /v1/segments/<segment_uuid> - Delete a failover segment by uuid

27
releasenotes/notes/host-apis-46a87fcd56d8ed30.yaml
View File

@@ -1,18 +1,15 @@
--- ---
features: features:
- Added following new REST API's for masakari operators - - |
Added following new REST API's for masakari operators:
1. GET /v1/segments/<segment_uuid>/hosts - GET /v1/segments/<segment_uuid>/hosts - Returns list of all hosts
Returns list of all hosts associated with failover segment. associated with failover segment.
- GET /v1/segments/<segment_uuid>/hosts/<host_uuid> - Returns specific host
2. GET /v1/segments/<segment_uuid>/hosts/<host_uuid> from the failover segment with uuid.
Returns specific host from the failover segment with uuid. - POST /v1/segments/<segment_uuid>/hosts - Creates a new host in failover
segment
3. POST /v1/segments/<segment_uuid>/hosts - PUT /v1/segments/<segment_uuid>/hosts/<host_uuid> - Updates a host in
Creates a new host in failover segment failover segment by uuid
- DELETE /v1/segments/<segment_uuid>/hosts/<host_uuid> - Delete a host from
4. PUT /v1/segments/<segment_uuid>/hosts/<host_uuid> failover segment by uuid
Updates a host in failover segment by uuid
5. DELETE /v1/segments/<segment_uuid>/hosts/<host_uuid>
Delete a host from failover segment by uuid

15
releasenotes/notes/notifications_apis-3c3d5055ae9c6649.yaml
View File

@@ -1,12 +1,9 @@
--- ---
features: features:
- Added following new REST API's related to notifications - - |
Added following new REST API's related to notifications:
1. GET /v1/notifications - GET /v1/notifications - Returns list of all notifications.
Returns list of all notifications. - GET /v1/notifications/<notification_uuid> - Returns specific notification
with uuid.
2. GET /v1/notifications/<notification_uuid> - POST /v1/notifications - Creates a new notification.
Returns specific notification with uuid.
3. POST /v1/notifications
Creates a new notification.

28
releasenotes/source/conf.py
View File

@@ -12,8 +12,8 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# Glance Release Notes documentation build configuration file, created by # Masakari Release Notes documentation build configuration file, created by
# sphinx-quickstart on Tue Nov 3 17:40:50 2015. # sphinx-quickstart on Tue Jun 28 9:58 AM 2016.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
# containing dir. # containing dir.
@@ -55,18 +55,19 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'masakari Release Notes' project = u'Masakari Release Notes'
copyright = u'2016, OpenStack Foundation' copyright = u'2016, OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
from masakari.version import version_info as masakari_version
# The short X.Y version. # The short X.Y version.
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '' release = masakari_version.version_string_with_vcs()
# The short X.Y version. # The short X.Y version.
version = '' version = masakari_version.canonical_version_string()
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@@ -166,7 +167,7 @@ html_static_path = ['_static']
# html_domain_indices = True # html_domain_indices = True
# If false, no index is generated. # If false, no index is generated.
# html_use_index = True html_use_index = False
# If true, the index is split into individual pages for each letter. # If true, the index is split into individual pages for each letter.
# html_split_index = False # html_split_index = False
@@ -189,7 +190,7 @@ html_static_path = ['_static']
# html_file_suffix = None # html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'GlanceReleaseNotesdoc' htmlhelp_basename = 'MasakariReleaseNotesdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
@@ -209,8 +210,9 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation', ('index', 'MasakariReleaseNotes.tex',
u'Glance Developers', 'manual'), u'Masakari Release Notes Documentation', u'Masakari Developers',
'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@@ -239,8 +241,8 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'glancereleasenotes', u'Glance Release Notes Documentation', ('index', 'masakarireleasenotes', u'Masakari Release Notes Documentation',
[u'Glance Developers'], 1) [u'Masakari Developers'], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
@@ -253,8 +255,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'GlanceReleaseNotes', u'Glance Release Notes Documentation', ('index', 'MasakariReleaseNotes', u'Masakari Release Notes Documentation',
u'Glance Developers', 'GlanceReleaseNotes', u'Masakari Developers', 'MasakariReleaseNotes',
'One line description of project.', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]