160 likes | 314 Views
Infastructure documentations Flowchart,schemas and usefull informations. Pierre-Luc Dion pdion@cloudops.com. Overview. Various type of schema Usefull Information to provide ( Ops perspective) Flowchart ( my favorite) Share your opinions and ideas.
E N D
Infastructure documentationsFlowchart,schemas and usefull informations Pierre-Luc Dion pdion@cloudops.com
Overview • Various type of schema • Usefull Information to provide (Ops perspective) • Flowchart (my favorite) • Shareyour opinions and ideas
Usefulltools for your docs • Text • Anything that is collaborative and can be shared and remain protected. • Google apps (doc, spreadsheet, sites) • wiki • docuwiki • confluence • mediawiki • sharepoint • Graphs • Tool you will be confortable to work with • Visio • Lucidchart • Confluence (plugin) • Lot of Visio shapes available: • http://www.visiocafe.com/
Schemas • Separate OSI layer in different schemas • Layer 2 (link layer) • physical connectivity • Ethernet • Layer 3 (network layer) • IP, routing layer • Layer 4 (transport layer) • Flowchart, applications communications
Valuable information in the flowChart Each box is an application (ex: process, webserver, database, JVM,…) • OS type, IP, hostname • Application name/type • Listen port(s) • init script • path to log files • Arrow express connection initiation (not the direction of data)
event more… • Hypervisor (it’s a VM/instance/Bare) • NFS share if it’s required by Apps • Backup: software connectivity and origin • Which system USER is use to execute the app • Automation system connectivity
Flowchart does not contain • SNMP • System admin (RDP, SSH, Telnet,…) • Unreleated to the application stack (system cron, system daemons) • NTP • Hypervisor tool (vmware tools, xentools,…)
Tricks of the trade • Build your own Visio Stencils (shapes) • Top to bottom mean from Insecure to Secure • Have a color coding for app boxes
When to Start the documentation? • Before the project begin • As you learn the application stack
Before the project start Based on: • assumptions • Known applications that will be use • What it should look like Will allow you to • Understand dependencies;firewalland connectivity • What need to be build as infrastructure
As you learn the system • Allow you to validate what you understand on the application stack. • Sometime it help existing team to better understand what they build and/or support
Enough • Time to see more examples…
C’estfini Thank you Questions/Comments?