-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#documentation - Need consolidated Nubis documentation #123
Comments
From @gdestuynder on September 21, 2015 23:15 On https://github.com/Nubisproject/nubis-docs/blob/master/SYSTEM_OVERVIEW.md there is a "TODO add some text" left over, unless more doc was to be written (?) While https://mana.mozilla.org/wiki/display/EA/Mozilla+IT+Application+Migration+to+AWS+-+short+term+solution has good high level doc, it seems that the Nubis documentation repository is https://mana.mozilla.org/wiki/display/EA/AWS (is this correct?) The processes are currently in different places (for ex see https://github.com/Nubisproject/nubis-vpc/issues/46) and if anything that's a problem to fix in priority. In general the minimum expected documentation is:
|
From @gene1wood on October 13, 2016 23:25 We mettup and fleshed out what @gdestuynder means here in more detail. JD and gozer's plan is to create documentation with
This will enable a reader (for example someone in infosec responding to a security incident and trying to understand the environment) to go to a single page and see a diagram of the network communication between the various elements of nubis (jenkins, packer, terraform, consul, confd, fluent client, fluent collector, etc), links to all of the documentation and a description of the SDLC. |
From @gene1wood on November 17, 2016 0:8 @tinnightcap and I met yesterday along with gozer and Corey, he wanted to get a sense if he was going down the right path regarding documentation. These are two docs showing his intent
These docs look good. With the goal in mind that an infosec person could go to these docs when there's a problem and orient themselves I'd suggest making these changes/additions
I'd say don't focus on specifics related to consul but instead just put in details that would help someone in the event of a security incident. |
From @gdestuynder on September 21, 2015 23:11
Imported from risk record
Missing documentation
Recommendation
Improve documentation
Generate diagram of Nubis
Mitigations from Nubis team
We have diagrams and documentation that is appropriate:
Copied from original issue: nubisproject/nubis-meta#29
The text was updated successfully, but these errors were encountered: