You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
OpenDev Sysadmins 829e7998b3 OpenDev Migration Patch 3 years ago
tools Workflow documentation is now in infra-manual 8 years ago
v2.0 Change all used passwords and secrets to 'secretsecret' 8 years ago
v3 Merge "Correct response status for HEAD requests" 8 years ago
.gitignore doc-tools: Ignore build-*.log.gz 9 years ago
.gitreview OpenDev Migration Patch 3 years ago
README.rst Include a link to keystone-specs in the README 8 years ago
doc-test.conf Set up for publishing via openstack-doc-tools 9 years ago
pom.xml Update to clouddocs-maven-plugin 2.1.3 8 years ago
test-requirements.txt Updated from global requirements 8 years ago
tox.ini Add new checklinks tox environment 8 years ago

README.rst

Identity Service API

This repository is now frozen-in-time and will not accept new patches.

It was the original holder for API information for the OpenStack Identity Service, also known as the Keystone project. The Keystone project provides authentication for OpenStack services, with plans to also provide authorization.

The Identity Service APIs are now included in the Keystone Specifications project. Available to view online at

Building v2.0 Docs

Build these docs using the same procedure as documented for the openstack-manuals project: https://github.com/openstack/openstack-manuals

In short, with Maven 3:

cd openstack-identity-api/v2.0
mvn clean generate-sources

Building v3 Docs

The v3 docs require an extra proprocessing to convert the Markdown source into the DocBook format required by the Maven build process. A few extra tools are required for this preprocessing step.

Installing conversion tools on Ubuntu:

apt-get install pandoc xsltproc docbook5-xml

To build the docs:

cd openstack-identity-api/v3 ./preprocess.sh mvn clean generate-sources

Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

  • tox -e checkniceness - to run the niceness tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.

Contributing

Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing

Refer to http://keystone.openstack.org to learn more about installing an OpenStack Identity Service server that can respond to these API commands.