====== The OPNFV Security Guide ======

The OPNFV Security Guide is the collaborative work of many individuals, involved in both the OPNFV Security Group and the wider OPNFV community.

The purpose of the guide is to provide the best practice security guidelines for deploying the OPNFV platform. 

Developers of all OPNFV projects are encouraged to contribute with security specifics to their projects.

It is a living document that is updated as new changes are merged into it's repository.

Sections are tracked within JIRA, using the label 'SECGUIDE':

https://jira.opnfv.org/browse/SECURITY-12?jql=labels%20%3D%20SECGUIDE

Initial layout pad:

https://etherpad.opnfv.org/p/security-guide

====== How to Contribute ======

Anyone is welcome to make additions, raise bugs, and fix issues within this Documentation. To do so, you will however need to first get an environment set up.

===== Development Environment =====

All project data such as formatting guidelines, and upstream mapping is documented via sphinx which uses reStructuredText

==== Git / Gerrit Setup ====

For the below to work, you will need to have a linux foundation account setup, and have added your public SSH key to gerrit. 

    git clone ssh://<your-username>@gerrit.opnfv.org:29418/opnfvdocs

    cd opnfvdocs/docs/opnfvsecguide

    git review -s

* Git review sets up your env to work with the remote gerrit server, you may get some errors here if your SSH key is not found, or it picks up the wrong one. 

Now make your changes to the documentation, and then perform a git add to 'stage' the changes.

    git add . 

* If you prefer, you can cherry pick a change i.e. git add myfile.txt (git add . #  Add all changes)

    git commit -a --signoff

Add a descriptive change of what you did, and save out of the commit window (so if your in vi then :wq) and make a push for review. 

    git review

Now await for core reviewers to +1 and it will get built to artefacts , you will see the url on the gerrit page returned by git review. Here is an example:

    [hinds@casper opnfvsecguide] $ git review                                                                                                                                       
    remote: Resolving deltas: 100% (6/6)           
    remote: New file detected, please ensure that it has the correct license header        
    remote: Processing changes: new: 1, refs: 1, done            
    remote: 
    remote: New Changes:        
    remote:   https://gerrit.opnfv.org/gerrit/7825        
    remote: 
    To ssh://lukehinds@gerrit.opnfv.org:29418/opnfvdocs.git
    * [new branch]      HEAD -> refs/publish/master