Documentation work from the OpenStack Security Group (OSSG)
Go to file
Andreas Jaeger 09fd21d286 Enhance AFS root-marker
Add some more information to the marker file for publishing.

Change-Id: Ia5aff2a0d4a8f84c7216033f9cd62f7c49235706
2016-10-31 20:20:59 +01:00
common Updated from openstack-manuals 2016-10-28 19:29:07 +00:00
security-guide Updated from openstack-manuals 2016-10-26 19:05:01 +09:00
security-notes [Trivial] Fix a typo in security-doc 2016-10-19 18:23:15 -07:00
security-threat-analysis Added section on security review 2016-10-18 18:44:26 +01:00
tools Enhance AFS root-marker 2016-10-31 20:20:59 +01:00
.gitignore Adding documentation for security threat analysis 2016-04-24 08:55:44 -05:00
.gitreview Added .gitreview 2014-05-22 00:51:40 +00:00
README.rst Build Security Threat Analysis 2016-05-03 10:02:01 +09:00
bindep.txt Move other-requirements.txt to bindep.txt 2016-08-12 21:17:57 +02:00
doc-tools-check-languages.conf Build Security Threat Analysis 2016-05-03 10:02:01 +09:00
test-requirements.txt Sync requirements with global requirements 2016-09-28 18:56:27 +02:00
tox.ini Adding OSSN-0068 2016-07-13 21:47:55 +09:00

README.rst

OpenStack Security Documentation

This repository contains the OpenStack Security documentation.

For more details, see the OpenStack Documentation Contributor Guide.

It includes these manuals:

  • Security Guide
  • Security Notes
  • Security Threat Analysis

The Security Notes are published by the OpenStack Security Project (OSSP) to advise users of security related issues. For more information refer https://wiki.openstack.org/wiki/Security_Notes and https://wiki.openstack.org/wiki/Security/Security_Note_Process.

Security Advisories are issued by the Vulnerability Management Team (VMT). For more information about OpenStack's Vulnerability Management Team (VMT) refer https://security.openstack.org/vmt-process.html.

Directory Structure

Security Guide is in the directory security-guide, which source files in RST format in the directory security-guide/source.

Security Threat Analysis is in the directory security-guide, which source files in RST format in the directory security-threat-analysis/source.

The security notes are in the directory security-notes.

Testing of changes and building of the guides

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.

tox

Contributing

Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.

The best way to get involved with the community is to talk with others online or at a meet up and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

If you would like to contribute to the documents, please see the OpenStack Documentation contributor guide.

Bugs

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/openstack-manuals

If you find a security issue in OpenStack, not in the contents of the Security Guide, please see How to Report Security Issues to OpenStack.

Installing

Refer to http://docs.openstack.org/security-guide to see where these documents are published and to learn more about the OpenStack Security Guide.