Commit Graph

47 Commits (master)

Author SHA1 Message Date
Ghanshyam Mann 51789f3b4f Retire openstack-specs repo
As discussed in TC meeting[1], TC is retiring the
openstack-specs repo.


Change-Id: Ieb37227e6b80a64ead680ece315973e2f040da6e
2021-06-18 17:23:31 +00:00
Andreas Jaeger 70a7c6d7dd Several cleanups
Switch to openstackdocstheme, use python3 everywhere, remove
old cruft in setup.cfg.

Change-Id: Ib915d26d09a59122be15a4fa726370bde56dda90
2020-03-19 13:58:46 +01:00
OpenDev Sysadmins ae90bfdea2 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at with any
questions you may have.
2019-04-19 19:39:25 +00:00
Doug Hellmann 5434b04abd fix tox python3 overrides
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I51f1d5da9248b139a59bd9fe59b284b368b61021
Signed-off-by: Doug Hellmann <>
2018-09-26 18:49:16 -04:00
Doug Hellmann ab214c434f import zuul job settings from project-config
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are

See the python3-first goal document for details:

Change-Id: Ic29b2d2b249353609779e27b8601152d98803716
Story: #2002586
Task: #24757
2018-08-20 13:07:18 -04:00
Chris Dent 9f5da124f4 Note that openstack-specs are not currently used
To help direct people to the right resources add links to community
goals and SIGs instead of openstack-specs. Otherwise people may be
inclined to rely on them.

Related IRC discussion:

Change-Id: If16dfb6c336a96f9cda24988d1baa742a4251c67
2017-08-29 17:30:11 +01:00
Jenkins 47bc225734 Merge "Add clouds.yaml support specification" 2016-01-19 20:10:23 +00:00
Jenkins 16a0fe966c Merge "Deprecate individual CLIs in favour of OSC" 2016-01-19 20:08:50 +00:00
Jenkins 90c8ccdf80 Merge "Adds spec for Service Catalog standardization" 2016-01-12 21:24:26 +00:00
Monty Taylor b0c5e61c0f Add clouds.yaml support specification
Describe an effort to extend existing clouds.yaml support to all
existing command line clients as well as support to horizon for
providing a downloadable config file snippet.

Change-Id: Ibc3f2e63deb8dbb1b96aec4000f8bbfef16bc7b0
2016-01-12 13:15:44 -05:00
Anne Gentle 722e891e23 Adds spec for Service Catalog standardization
- Cross project session at the Vancouver Summit.
- Blueprint likely to live in keystone project.

Change-Id: I1d74149b1f9f7739a630e2b52392a786a414776e
Co-authored-by: Sean Dague <>
2016-01-07 15:32:09 +00:00
Jamie Lennox 6d0b5b68b5 Deprecate individual CLIs in favour of OSC
The OpenStack Client has been the suggested way forward for CLI
applications now for a few cycles however we remain in a limbo where in
some cases we suggest using OpenStack Client and in others we suggest
the project CLI.

Ratify that the OpenStack client is the recommended CLI for OpenStack
projects so that there is a clear direction on this.

Change-Id: Icf517986bfc318eb621210383f81366779da5840
2015-12-21 10:12:12 +11:00
Jenkins ece411aa6f Merge "Chronicles of a DLM" 2015-12-15 21:01:33 +00:00
Joshua Harlow 2bd1df191c Chronicles of a DLM
Distributed locks, the concept, the problem space, what
has been done, what could be done, what will be done,
what must be done, the journey begins now (weekdays at
7pm EST).

Updating due to summit session result, some more small
work and/or tweaks still needed.

Change-Id: Ibce47659c1108b94b4d538c63da69ce0371aed04
2015-11-09 17:34:07 -08:00
Jenkins b3fa6513ea Merge "Return request ID to caller" 2015-09-22 20:07:29 +00:00
abhishekkekane 55be021048 Return request ID to caller
In this spec we are proposing to return 'request_id' along with various return
types such as list, dict, resource object etc. from python-clients to return
request id to the user.

blueprint: expose-get-x-openstack-request-id
Change-Id: Ia2e6789f24d0a7024b40230eb6fc866937a61b1f
2015-08-17 12:50:32 -07:00
xiabing.yao 7e45be4792 Update setuptools setup_requires
Update setuptools setup_requires to have the same style as other project-spec.

Change-Id: I13f83e78bf7a9c1e94fb4fd2decfc74b227adca2
2015-08-05 09:54:39 +08:00
Jenkins a492cacfce Merge "Clean up formatting on literal blocks" 2015-07-30 08:37:20 +00:00
Jenkins 69a3e2889f Merge "Eventlet Best Practices" 2015-07-14 20:19:01 +00:00
James Polley fbe8022f32 Clean up formatting on literal blocks
These literal blocks show log snippets weren't being formatted
correctly due to a missing newline between the :: and the literal

This change just adds some whitespace to make the formatting come out
as intended; there's no change to the content of the guidelines.

Change-Id: Ic2f5fa9dcf281adbc95ce980b5409e993fead94e
2015-07-13 10:04:13 +10:00
Jenkins 0f845db4c0 Merge "Update to CORS specification." 2015-06-30 20:14:46 +00:00
Jenkins 87cfe23f2a Merge "Add requirements management specification." 2015-06-30 20:12:48 +00:00
Jenkins a932d5aeb4 Merge "Enabling Python 3 for Application Integration Tests" 2015-06-30 20:10:31 +00:00
Robert Collins b486418b62 Add requirements management specification.
Our current requirements management policy is causing signficant gate
downtime, developer issues and packaging headaches. We can do better.

Using pins rather than open ranges for testing avoids firedrills. Most
of the work involved is a consequence of that key change.

Change-Id: I1a53b418568b8304ad74a2b30bdf1bb86ccb5f7a
2015-06-24 09:10:08 +12:00
Michael Krotscheck b79dbecdf5 Update to CORS specification.
Changes requested in discussion on the original CORS specification, however
deferred in favor of landing that specification. Commentary here:

Change-Id: I9e8be30834e7020320a1cd37c8f18e59da4b360b
2015-06-09 13:34:35 -07:00
Jenkins 884324c5c6 Merge "CORS Support for OpenStack" 2015-06-09 20:32:47 +00:00
Doug Hellmann 9c45871249 Enabling Python 3 for Application Integration Tests
Change-Id: I41b39924230e2e2166609cc79d59e444855f6557
2015-06-09 18:23:28 +00:00
Michael Krotscheck c1db8b5414 CORS Support for OpenStack
This specification details implementing the W3C's Cross Origin
Resource Sharing specification in openstack's API's. It is intended
to provide additional options to user interface projects, by
permitting the API's to selectively break the single-origin policy
for configurable domains. It makes use of a single, common
middleware implementation already available in oslo_middleware.

Change-Id: I2135043f49f64b096b6bd295966d2e73697c7764
2015-05-26 13:07:07 -07:00
Clint Byrum fa30228a71 Supported messaging drivers policy
Change-Id: Ie62d2f49ca0cb073ec3e54aedd8567e78cd45b6e
2015-04-20 16:10:10 -07:00
Jenkins fbd64a5dd1 Merge "Add library stable release procedures/policy" 2015-03-31 20:08:19 +00:00
Doug Hellmann ffbed4cbf1 Add library stable release procedures/policy
Change-Id: I7bf8636a4fb0b16633558306fc624b7e3e3dfa36
2015-03-18 15:05:13 +00:00
Jenkins 524ee1c857 Merge "Cross-Project spec to eliminate SQL Schema Downgrades" 2015-03-17 20:05:27 +00:00
Jenkins e216fda214 Merge "Set the warnerrors pbr option in the setup.cfg file" 2015-03-13 15:56:58 +00:00
Christian Berendt 551ac5a94d Set the warnerrors pbr option in the setup.cfg file
To fail in case of any warnings or errors during the
doc build process the warnerrors pbr option has to be
set to true in the setup.cfg file.

Change-Id: I04c82cd4cc9a9ecced37da7acc0d4f602bc7d863
2015-03-04 13:02:01 +01:00
Jenkins a1c06496a0 Merge "Add TRACE definition to log guidelines" 2015-03-03 20:13:29 +00:00
Ben Nemec a4e96ea539 Eventlet Best Practices
Attempt to document best practices for using eventlet, so things
learned by one project can be more easily applied to others.

Change-Id: I1d03f5a86970b59705ff7160db3e51a92d8776e6
2015-02-25 15:47:43 -06:00
Jenkins 6fc666fc39 Merge "Remove docutils pin" 2015-02-24 21:04:34 +00:00
Jenkins 5c34fe8b6f Merge "CLI Sorting Argument Guidelines" 2015-02-24 20:15:48 +00:00
Andreas Jaeger aa62b5c0af Remove docutils pin
This was added to work around bug 1091333.  A new sphinx has been
released and so this is no longer necessary.

Change-Id: I6ea61a3cc441dd1ca2ced7e2fd837a55b917f76d
2015-02-17 20:23:19 +01:00
Morgan Fainberg 90b7e9302a Cross-Project spec to eliminate SQL Schema Downgrades
This proposes the cross-project spec to eliminate SQL Schema Downgrades
in OpenStack. This is based upon the conversations had on both the
dev and operator mailing lists. In short, SQL Schema Downgrades do not
have a clear use-case where a restore to known-good point would not both
be more appropriate and desired (due to data inconsistency, integrity,

Change-Id: I622f89fe63327d44f9b229d3bd9e76e15acbaa7a
2015-02-16 23:12:46 -08:00
Sean Dague db9ee1782c Add TRACE definition to log guidelines
We should consider actually using the TRACE keyword for logging as
something meaningful. Today TRACE is used as a prefix for stack traces
even though it has no logging level definition.

This would provide a deep debug level which many developers have
requested. TRACE is a standard level in other logging systems such as:
and means what we are proposing here.

This means that 3rd party tools are highly likely to understand this
meaning for TRACE (and actually be terribly confused by the current
OpenStack use of TRACE).

Co-Authored-By: Alexis Lee <>

Change-Id: Iba69bb07e4c6fd5232efa20b984042a30c85e58b
2015-02-05 16:30:36 -05:00
Steven Kaufer b99a20720f CLI Sorting Argument Guidelines
This goal of this specification is to define the syntax for client
sorting arguments so that there is consistency across projects.

Note that an API working group guideline for sorting is closely

Change-Id: Id99091cfcf0c8770babba5e6cbf9c9772b015960
2015-01-16 21:27:36 +00:00
Jenkins c3be753672 Merge "Log Guidelines" 2015-01-13 20:42:07 +00:00
Sean Dague f699e86238 Log Guidelines
Proposed final draft.

This attempts to integrate much of the existing feedback, including
clarity around the points that were confusing people regarding the
"unit of work" and when stacktraces are appropriate.

In addition the Security logging section was dropped, because
realistically it was a poor fit for this original document. The wiki
page on it remains. My expectation is that security for logging should
be proposed as a follow on patch by someone that wants to make that
info fit well with this document.

All the open questions are now removed. Hopefully this ends up very
close to an agreed point.

Note: This evolved originally in the nova-specs repo at:
I674966988ed501dee323a106b84b5b6602d846b1 but is now moved over to
cross project specs repo. Some deep history can be seen at the
original draft.

Part of bp:log-guidelines

Change-Id: I3a8d0ac570e05eb11ccc70ad4eb9da277aaac256
2015-01-06 09:26:42 -05:00
Jeremy Stanley 5191b37a08 Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I3458bc41aa1d4f2425e2a0603d00560173921402
2014-12-05 03:30:38 +00:00
Doug Hellmann ba3f0de32f Establish sphinx build structure
Set up sphinx to convert the specs to HTML and create an empty specs
directory to hold proposed specifications.

Change-Id: Ic49cfd646fd6782bc0e539de6390217767d3c4ff
2014-11-20 16:04:18 -05:00
OpenStack Project Creator 0037520075 Added .gitreview 2014-10-24 08:21:52 +00:00