Transcript pierre-luc_dion_Documentation

Infastructure documentations
Flowchart,schemas and usefull informations
Pierre-Luc Dion
[email protected]
devops-mtl
2014
Overview
• Various type of schema
• Usefull Information to provide (Ops
perspective)
• Flowchart (my favorite)
• Share your opinions and ideas
devops-mtl
2014
Usefull tools for your docs
Text
Graphs
Anything that is collaborative and can
be shared and remain protected.
Tool you will be confortable to work
with
• Google apps (doc, spreadsheet,
sites)
• wiki
• docuwiki
• confluence
• mediawiki
• sharepoint
• Visio
• Lucidchart
• Confluence (plugin)
devops-mtl
Lot of Visio shapes available:
http://www.visiocafe.com/
2014
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
devops-mtl
2014
Layer 2 example
devops-mtl
2014
Layer 3 example
devops-mtl
2014
Layer 4 example
devops-mtl
2014
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)
devops-mtl
2014
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
devops-mtl
2014
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,…)
devops-mtl
2014
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
devops-mtl
2014
When to Start the documentation?
1. Before the project begin
2. As you learn the application stack
devops-mtl
2014
Before the project start
Based on:
• assumptions
• Known applications that will be use
• What it should look like
Will allow you to
• Understand dependencies;firewall and
connectivity
• What need to be build as infrastructure
devops-mtl
2014
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
devops-mtl
2014
Enough
• Time to see more examples…
devops-mtl
2014
C’est fini
Thank you
Questions/Comments?
devops-mtl
2014