Documentation work from the OpenStack Security Group (OSSG)
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.
OpenStack Proposal Bot 945abe9999 Imported Translations from Zanata 2 weeks ago
case-studies Replace Chinese quotes to English quotes 1 year ago
common Updated from openstack-manuals 1 month ago
security-guide Imported Translations from Zanata 2 weeks ago
security-notes Update for openstack-dev move 9 months ago
security-threat-analysis Sync Sphinx requirement 3 months ago
tools Update for openstack-doc-tools 2.0 3 weeks ago
.gitignore Adding documentation for security threat analysis 3 years ago
.gitreview OpenDev Migration Patch 5 months ago
.zuul.yaml Remove name from project stanza 1 year ago
README.rst Correct the wrong link URL 1 year ago
bindep.txt Update bindep.txt 2 years ago
doc-tools-check-languages.conf Build tr_TR security-guide 1 year ago
test-requirements.txt Update for openstack-doc-tools 2.0 3 weeks ago
tox.ini Update for openstack-doc-tools 2.0 3 weeks ago

README.rst

Team and repository tags

image

OpenStack Security Documentation

This repository contains the OpenStack Security documentation.

For details on how to contribute to the documentation, 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 to the Security Notes and Security Note Process.

Security Advisories are issued by the Vulnerability Management Team (VMT). For more information about OpenStack's Vulnerability Management Team (VMT) refer to the Vulnerability Management Process.

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-threat-analysis, 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:

Bugs: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.

Release Notes

https://docs.openstack.org/releasenotes/openstack-manuals

Installing

Refer to the OpenStack Security Guide to see where these documents are published and to learn more about the OpenStack Security Guide.