+ Post New Thread
Results 1 to 5 of 5
How do you do....it? Thread, Documentation in Technical; Hi, Does anyone know and this may be a big ask because I don't know of anything like this that ...
  1. #1
    cpjitservices's Avatar
    Join Date
    Jul 2010
    Location
    Hessle
    Posts
    2,560
    Thank Post
    529
    Thanked 295 Times in 271 Posts
    Rep Power
    84

    Documentation

    Hi,

    Does anyone know and this may be a big ask because I don't know of anything like this that exists... Is there a way to generate Documentation based on Linux Config files ?

    For example: if I built a web server based on CentOS, I could download the config files from the server and Import them to something web based perhaps, from there generate something like a web page with a Contents, Index and Search. Then A new starter technician or apprentice could build a web server and the documentation is based around the config files, the files could even be viewed on page too ?

    I'm hoping this makes sense!

    Anyone know of anything ?

    Thanks
    Chris.

  2. #2

    Domino's Avatar
    Join Date
    Oct 2006
    Location
    Bromley
    Posts
    4,109
    Thank Post
    217
    Thanked 1,343 Times in 821 Posts
    Blog Entries
    4
    Rep Power
    526
    I don't think that'd necessarily help...it'd tell you how a box is configured, but not WHY it's configured like that.

    I also think there's way to many package/config options for anything like that to be viable, but someone else may be able to prove me wrong...

  3. #3
    cpjitservices's Avatar
    Join Date
    Jul 2010
    Location
    Hessle
    Posts
    2,560
    Thank Post
    529
    Thanked 295 Times in 271 Posts
    Rep Power
    84
    Yeah, its because some of our servers are setup in certain ways, and our documentation can be a nightmare, the main one is some of our public servers are setup in such a way that they have to adhere to certain standards due to the data we hold. I was thinking of a sort of way I can document how we build our servers and why they are built like that, from config files something I can generate from config or export config files too.

  4. #4


    Join Date
    Dec 2005
    Location
    In the server room, with the lead pipe.
    Posts
    4,701
    Thank Post
    279
    Thanked 787 Times in 614 Posts
    Rep Power
    226
    Hmm,

    Blueprint (Blueprint) will let you capture an existing server and use it as a template. You can also dump info from the template. I've used it in the past to port odd server configs onto newer hardware.

    You could also (by comparing against the packaged versions) determine which config files have been altered from the default.

    However, both methods lack the "Why" component - your documentation needs to say (at least briefly) why something is configured a particular way, especially for a noob technician, so you don't end up with a cargo cult mentality.

    Does Spacewalk (which IIRC you were posting on here about?) allow you to create a webserver template down to the level of "this file should contain $foo"?

    TLDR: It's better to automagically tell the server "you should be like this" when deploying it and document what config you're pushing and why.

    *realises he's left the tab open too long*

  5. Thanks to pete from:

    cpjitservices (10th March 2014)

  6. #5
    cpjitservices's Avatar
    Join Date
    Jul 2010
    Location
    Hessle
    Posts
    2,560
    Thank Post
    529
    Thanked 295 Times in 271 Posts
    Rep Power
    84
    Blueprint sounds just the ticket, I was using a web server as an example, as we have a wide variety of Linux servers doing different things.

    I'll check it out, see what Blueprint does. I don't need the rollback / track functionality but should still do the job.

    Cheers.



SHARE:
+ Post New Thread

Similar Threads

  1. disaster recovery documentation
    By russdev in forum School ICT Policies
    Replies: 16
    Last Post: 20th March 2006, 12:29 PM
  2. Replies: 6
    Last Post: 17th January 2006, 06:13 PM
  3. Replies: 2
    Last Post: 9th January 2006, 08:43 PM
  4. Replies: 19
    Last Post: 5th December 2005, 02:03 PM
  5. Images in Office 2003 documents
    By mattpant in forum Windows
    Replies: 6
    Last Post: 7th October 2005, 07:12 PM

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •