diff options
Diffstat (limited to 'keystone-moon/releasenotes')
10 files changed, 366 insertions, 0 deletions
diff --git a/keystone-moon/releasenotes/notes/.placeholder b/keystone-moon/releasenotes/notes/.placeholder new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/keystone-moon/releasenotes/notes/.placeholder diff --git a/keystone-moon/releasenotes/notes/deprecations-c4afc19dc5324b9c.yaml b/keystone-moon/releasenotes/notes/deprecations-c4afc19dc5324b9c.yaml new file mode 100644 index 00000000..0c1c4f11 --- /dev/null +++ b/keystone-moon/releasenotes/notes/deprecations-c4afc19dc5324b9c.yaml @@ -0,0 +1,19 @@ +--- +other: + - Running keystone in eventlet remains deprecated and will be removed in the + Mitaka release. + - Using LDAP as the resource backend, i.e for projects and domains, is now + deprecated and will be removed in the Mitaka release. + - Using the full path to the driver class is deprecated in favor of using + the entrypoint. In the Mitaka release, the entrypoint must be used. + - In the [resource] and [role] sections of the ``keystone.conf`` file, not + specifying the driver and using the assignment driver is deprecated. In + the Mitaka release, the resource and role drivers will default to the SQL + driver. + - In ``keystone-paste.ini``, using ``paste.filter_factory`` is deprecated in + favor of the "use" directive, specifying an entrypoint. + - Not specifying a domain during a create user, group or project call, which + relied on falling back to the default domain, is now deprecated and will + be removed in the N release. + - Certain deprecated methods from the assignment manager were removed in + favor of the same methods in the [resource] and [role] manager. diff --git a/keystone-moon/releasenotes/notes/new_features-e33d793d8a5ca76a.yaml b/keystone-moon/releasenotes/notes/new_features-e33d793d8a5ca76a.yaml new file mode 100644 index 00000000..06e1db2c --- /dev/null +++ b/keystone-moon/releasenotes/notes/new_features-e33d793d8a5ca76a.yaml @@ -0,0 +1,21 @@ +--- +features: + - > + **Experimental** - Domain specific configuration options can be stored in + SQL instead of configuration files, using the new REST APIs. + - > + **Experimental** - Keystone now supports tokenless authorization with + X.509 SSL client certificate. + - Configuring per-Identity Provider WebSSO is now supported. + - > + ``openstack_user_domain`` and ``openstack_project_domain`` attributes were + added to SAML assertion in order to map user and project domains, + respectively. + - The credentials list call can now have its results filtered by credential + type. + - Support was improved for out-of-tree drivers by defining stable driver + interfaces. + - Several features were hardened, including Fernet tokens, federation, + domain specific configurations from database and role assignments. + - Certain variables in ``keystone.conf`` now have options, which determine + if the user's setting is valid. diff --git a/keystone-moon/releasenotes/notes/upgrade_notes-ca81f5d531ab3522.yaml b/keystone-moon/releasenotes/notes/upgrade_notes-ca81f5d531ab3522.yaml new file mode 100644 index 00000000..be8282ce --- /dev/null +++ b/keystone-moon/releasenotes/notes/upgrade_notes-ca81f5d531ab3522.yaml @@ -0,0 +1,31 @@ +--- +upgrade: + - The EC2 token middleware, deprecated in Juno, is no longer available in + keystone. It has been moved to the keystonemiddleware package. + - The ``compute_port`` configuration option, deprecated in Juno, is no longer + available. + - The XML middleware stub has been removed, so references to it must be + removed from the ``keystone-paste.ini`` configuration file. + - stats_monitoring and stats_reporting paste filters have been removed, so + references to it must be removed from the ``keystone-paste.ini`` + configuration file. + - The external authentication plugins ExternalDefault, ExternalDomain, + LegacyDefaultDomain, and LegacyDomain, deprecated in Icehouse, are no + longer available. + - The ``keystone.conf`` file now references entrypoint names for drivers. + For example, the drivers are now specified as "sql", "ldap", "uuid", + rather than the full module path. See the sample configuration file for + other examples. + - We now expose entrypoints for the ``keystone-manage`` command instead of a + file. + - Schema downgrades via ``keystone-manage db_sync`` are no longer supported. + Only upgrades are supported. + - Features that were "extensions" in previous releases (OAuth delegation, + Federated Identity support, Endpoint Policy, etc) are now enabled by + default. + - A new ``secure_proxy_ssl_header`` configuration option is available when + running keystone behind a proxy. + - Several configuration options have been deprecated, renamed, or moved to + new sections in the ``keystone.conf`` file. + - Domain name information can now be used in policy rules with the attribute + ``domain_name``. diff --git a/keystone-moon/releasenotes/source/_static/.placeholder b/keystone-moon/releasenotes/source/_static/.placeholder new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/keystone-moon/releasenotes/source/_static/.placeholder diff --git a/keystone-moon/releasenotes/source/_templates/.placeholder b/keystone-moon/releasenotes/source/_templates/.placeholder new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/keystone-moon/releasenotes/source/_templates/.placeholder diff --git a/keystone-moon/releasenotes/source/conf.py b/keystone-moon/releasenotes/source/conf.py new file mode 100644 index 00000000..6df2e041 --- /dev/null +++ b/keystone-moon/releasenotes/source/conf.py @@ -0,0 +1,275 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Keystone Release Notes documentation build configuration file, created by +# sphinx-quickstart on Tue Nov 3 17:40:50 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'oslosphinx', + 'reno.sphinxext', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Keystone Release Notes' +copyright = u'2015, Keystone Developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +import pbr.version +keystone_version = pbr.version.VersionInfo('keystone') +# The full version, including alpha/beta/rc tags. +release = keystone_version.version_string_with_vcs() +# The short X.Y version. +version = keystone_version.canonical_version_string() + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'KeystoneReleaseNotesdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'KeystoneReleaseNotes.tex', + u'Keystone Release Notes Documentation', + u'Keystone Developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'keystonereleasenotes', u'Keystone Release Notes Documentation', + [u'Keystone Developers'], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'KeystoneReleaseNotes', u'Keystone Release Notes Documentation', + u'Keystone Developers', 'KeystoneReleaseNotes', + 'Identity, Authentication and Access Management for OpenStack.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False diff --git a/keystone-moon/releasenotes/source/index.rst b/keystone-moon/releasenotes/source/index.rst new file mode 100644 index 00000000..9139d688 --- /dev/null +++ b/keystone-moon/releasenotes/source/index.rst @@ -0,0 +1,9 @@ +======================== + Keystone Release Notes +======================== + +.. toctree:: + :maxdepth: 1 + + liberty + unreleased diff --git a/keystone-moon/releasenotes/source/liberty.rst b/keystone-moon/releasenotes/source/liberty.rst new file mode 100644 index 00000000..36217be8 --- /dev/null +++ b/keystone-moon/releasenotes/source/liberty.rst @@ -0,0 +1,6 @@ +============================== + Liberty Series Release Notes +============================== + +.. release-notes:: + :branch: origin/stable/liberty diff --git a/keystone-moon/releasenotes/source/unreleased.rst b/keystone-moon/releasenotes/source/unreleased.rst new file mode 100644 index 00000000..cd22aabc --- /dev/null +++ b/keystone-moon/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================== + Current Series Release Notes +============================== + +.. release-notes:: |