[Openstack-operators] :document an OpenStack production environment
george.shuklin at gmail.com
Mon Jan 26 15:03:25 UTC 2015
In my earlier days I had tried many formal schemes, but it always cause
For now I settle to following scheme:
machine-used database (dns, chef, etc) for explit details like mac
addresses, hardware, rack location, network communication. That database
should be constantly used, not 'write only', otherwise everyone will
starts to forget to update, and suddenly it will loose it authority over
'I wrote you about it in hipchat and than send you update via sms, and
final version is in your other skype account'. Usually it some kind of
'work', or 'control panel', or chef data bags.
All topological schemes should be hand written. Whiteboards is just
perfect for that. Why? Because all tools, except pen/pencil/marker are
restrain you, forcing to use terminology and linking type of that tool.
Even inkscape is restricting, because you can not just 'undersubscribe'
link, or draw funny spiral ("here it goes somewhere...").
And text in corporate wiki in free form. Yes, updates will change
everything, but even after updates original picture and text will be
precious, because they will say history and will help to debug strange
issues with historical reasons. Corporate blogs are perfect place for
updates and ideas for future update.
Yes, it is a mess, but it is better than 'not enough information because
of the format restrictions'.
On 01/26/2015 03:45 PM, matt wrote:
> I really liked using sphinx for documentation back in the day, it has
> the benefit of being community compatible. I also enjoyed graphviz
> integration in sphinx for diagrams... and then there was templating
> but i think I was probably considered a masochist on this front. at
> the very least management types did not like that they couldn't really
> edit our documentation.
> On Mon, Jan 26, 2015 at 5:10 AM, George Shuklin
> <george.shuklin at gmail.com <mailto:george.shuklin at gmail.com>> wrote:
> We using chef to manage hosts. Data bags contains all data of all
> hosts. We keep hardware configuration and DC-wide-name in databags
> For the flowcharts we mostly use markers and whiteboard, sometime
> I sketch stuff in dia  or with wacom tablet in mypaint.
>  http://sourceforge.net/projects/dia-installer/
> On 01/25/2015 04:15 PM, Daniel Comnea wrote:
>> Hi all,
>> Can anyone who runs Openstack in a production environment/ data
>> center share how you document the whole infrastructure, what
>> tools are used for drawing diagrams(i guess you need some
>> pictures otherwise is hard to understand it :)), maybe even an
>> inventory etc?
>> P.S in the past - 10+ - i used to have maintain a red book but i
>> suspect situation is different in 2015
>> OpenStack-operators mailing list
>> OpenStack-operators at lists.openstack.org <mailto:OpenStack-operators at lists.openstack.org>
> OpenStack-operators mailing list
> OpenStack-operators at lists.openstack.org
> <mailto:OpenStack-operators at lists.openstack.org>
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the OpenStack-operators