Skip to content
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

Open
tinnightcap opened this issue Apr 27, 2017 · 3 comments
Open

#documentation - Need consolidated Nubis documentation #123

tinnightcap opened this issue Apr 27, 2017 · 3 comments

Comments

@tinnightcap
Copy link
Contributor

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:

  1. https://github.com/Nubisproject/nubis-docs/blob/master/SYSTEM_OVERVIEW.md,
  2. https://mana.mozilla.org/wiki/display/EA/Mozilla+IT+Application+Migration+to+AWS+-+short+term+solution

Copied from original issue: nubisproject/nubis-meta#29

@tinnightcap
Copy link
Contributor Author

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:

  • high level overview, diagram (you mostly have that)
  • central documentation place that links to other places if needed (I'm not sure if that's the link i found above - it looks like a good candidate!)
  • centralized processes (or link to them) since these have to be followed
  • SDLC

@tinnightcap
Copy link
Contributor Author

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

  • high level overview, diagram
  • a root page of sorts that is a map to all of the existing documentation which are READMEs in various repos in nubis-project.
  • SDLC (a description of the flow of events and the systems which govern that flow when a developer commits a change in github that results in a change in production deployed application code or production deployed infrastructure)

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.

@tinnightcap
Copy link
Contributor Author

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

  • Add some information about how one would access decryption keys to access configuration files to determine which services are deployed in a specific account https://github.com/nubisproject/nubis-docs/blob/master/DEPLOYMENT_OVERVIEW.md#services-provided
  • Add links to code for a reader that wants to understand things in more detail. For example in the consul doc when you talk about the security group that governs what public IPs can talk to consul, link to the code that defines the security group, when you talk about the IAM instance profile that grants access to KMS keys, link to the code that defines it, and so forth.
  • More detail about what network communication is going on (who's initiating connections? is that https, ssh, something else? what order are the connections made in?)
  • Indications about how to orient oneself in the case of an incident. Naming conventions of the accounts/vpcs/security groups/s3 backup buckets/dynamo dbs etc. How, in the event of an incident, someone in infosec could do incident response from the system level. What delegated permissions does each system have (the web server can do these actions when calling the consul service because it has these certs/shared secrets/etc) to be able to track the impact of a compromise of one element other elements that delegate it permissions.
  • Indicate in the diagrams what the different line types and line colors mean

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant